Saltar al contenido

Create a bid line

Módulo Opportunities

POST/bid-linesbidLines.create

A line of a sealed bid. Creates a bid line. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad me.work_details.write.
  • Alcances de OAuth: me.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: BidLineCreate

bidLines.create: BidLineCreate
CampoTipoObligatorioDescripción
bid_idstring (uuid)SíIdentifier of the bid.
descriptionstringSíLine description.Restricciones: length 1 to 300
quantitynumberNoQuantity; defaults to 1.
unit_price_minorinteger (int64) | nullNoUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
{
  "bid_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Line array rental",
  "quantity": 2,
  "unit_price_minor": 1800000
}

Respuesta 201: BidLine

bidLines.create: BidLine
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the bid line.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
bid_idstring (uuid)SíIdentifier of the bid.
descriptionstringSíLine description.Restricciones: length 1 to 300
quantitynumberSíQuantity; defaults to 1.
unit_price_minorinteger (int64) | nullSíUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
currencystringSíISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "bid_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Line array rental",
  "quantity": 2,
  "unit_price_minor": 1800000,
  "currency": "USD"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/bid-lines" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"bid_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Line array rental","quantity":2,"unit_price_minor":1800000}'
const { data } = await xos.bidLines.create({
    "bid_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "description": "Line array rental",
    "quantity": 2,
    "unit_price_minor": 1800000
  });
response = xos.bid_lines.create({"bid_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Line array rental", "quantity": 2, "unit_price_minor": 1800000})
xos bid-lines create --data '{"bid_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Line array rental","quantity":2,"unit_price_minor":1800000}'