v9

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-071292691.1 MB

fulfillment-order-shipments

Create a shipment on a fulfillment order (synchronous)

Creates a shipment (status SHIPMENT_CREATED — not yet dispatched by the carrier) linked to the fulfillment order and opens its tracking timeline with a matching event, in a single transaction. It does not change the fulfillment order status. Validates that the fulfillment order, the carrier and every package SKU exist. accountCode comes from the JWT.

post/api/v1/fulfillment-orders/{fulfillmentOrderId}/shipments

Path parameters

fulfillmentOrderIdstring uuid required

Example:01920000-0000-7000-8000-000000000000

Parent fulfillment order identifier (UUID).

Request body

carrier_idstring required

Identificador (UUID) da transportadora cadastrada.

tracking_codestring nullable

Código de rastreio, quando já atribuído pela transportadora. Ausente na criação até o despacho.

labelstring nullable

Referência da etiqueta de transporte, quando o carrier a emite.

metadataobject nullable

Example request

{
  "carrier_id": "9a29b0c5-faff-4149-b7dd-5eeca344d157",
  "tracking_code": "BR123456789BR",
  "packages": [
    {
      "weight_kg": 1.5,
      "dimensions": {
        "length_cm": 20,
        "width_cm": 15,
        "height_cm": 10
      },
      "items": [
        {
          "sku": "SKU-001",
          "quantity": 2
        }
      ]
    }
  ]
}

Response

Shipment created (status SHIPMENT_CREATED, awaiting dispatch). Fulfillment order status unchanged.

metadataobject nullable required

shipment_idstring required

fo_statusstring required

fulfillment_order_idstring required

order_idstring required

carrier_idstring required

tracking_codestring nullable required

labelstring nullable required

dispatched_atstring nullable required

delivered_atstring nullable required

created_atstring required

updated_atstring required