Saltar al contenido

Create a work order bid

Módulo Work

POST/work-order-bidsworkOrderBids.create

A bid on a work order. Creates a work order bid. 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 work.work_order.write.
  • Alcances de OAuth: work.
  • 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: WorkOrderBidCreate

workOrderBids.create: WorkOrderBidCreate
CampoTipoObligatorioDescripción
work_order_idstring (uuid)SíIdentifier of the work order.
bidder_organization_idstring (uuid)SíIdentifier of the bidding organization.
amount_minorinteger (int64) | nullNoBid amount. 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}$
notesstring | nullNoBid notes.Restricciones: length 1 to 20000
{
  "work_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "bidder_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "amount_minor": 790000,
  "currency": "USD",
  "notes": "Includes delivery and install."
}

Respuesta 201: WorkOrderBid

workOrderBids.create: WorkOrderBid
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the work order bid.
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.
work_order_idstring (uuid)SíIdentifier of the work order.
bidder_organization_idstring (uuid)SíIdentifier of the bidding organization.
amount_minorinteger (int64) | nullSíBid amount. 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}$
bid_statestringSíBid state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
notesstring | nullSíBid notes.Restricciones: length 1 to 20000
{
  "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",
  "work_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "bidder_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "amount_minor": 790000,
  "currency": "USD",
  "bid_state": "Quoted",
  "notes": "Includes delivery and install."
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/work-order-bids" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"work_order_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","bidder_organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","amount_minor":790000,"currency":"USD","notes":"Includes delivery and install."}'
const { data } = await xos.workOrderBids.create({
    "work_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "bidder_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "amount_minor": 790000,
    "currency": "USD",
    "notes": "Includes delivery and install."
  });
response = xos.work_order_bids.create({"work_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "bidder_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "amount_minor": 790000, "currency": "USD", "notes": "Includes delivery and install."})
xos work-order-bids create --data '{"work_order_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","bidder_organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","amount_minor":790000,"currency":"USD","notes":"Includes delivery and install."}'