Get order fulfillment status

Endpoint: POST /v10/orders/fulfillment-status

Parameter	Required	Default	Description
order_id	Yes, if no order_number or shopify_order_id is given		The ID of the order to get the fulfillment status for
order_number	Yes, if no order_id or shopify_order_id is given		The number of the order to get the fulfillment status for
shopify_order_id	Yes, if no order_id or order_number is given		The Shopify order ID of the order to get the fulfillment status for

Data of response

Parameter	Required	Default	Description
fulfillment_status.*	Yes		An fulfillment status object

Fulfillment status data

Parameter	Required	Default	Description
order_id	Yes		The ID of the order
fulfillment_status	Yes		The fulfillment status of the order. Possible values: open, being_packed, completed
can_cancel	Yes		Whether the order can be cancelled. Possible values: true, false
can_cancel_reason	Yes		The reason why the order cannot be cancelled. Possible values: shipment_completed, shipment_claimed
shipments	Yes		An array of objects shipment data

Shipment data

Parameter	Required	Default	Description
shipment_number	Yes		The number of the shipment
status	Yes		The status of the shipment. Possible values: open, being_packed, completed
colli	Yes		An array of objects colli data

Colli data

Parameter	Required	Default	Description
track_trace		null	The package code of the shipment
track_trace_link		null	A direct link to a track & trace page. If null Traede will attempt to generate this from track_trace and carrier
lines	Yes		An array of objects colli lines

Colli lines data

Parameter	Required	Default	Description
sku	Yes		The SKU of the line
ordered	Yes		The number of pieces ordered for this line
packed	Yes		The number of pieces packed for this line

Request example

POST /v10/orders/fulfillment-status

{
  "order_id": 1
}

Response example

{
  "fulfillment_status": {
    "fulfillment_status": "completed",
    "can_cancel": false,
    "can_cancel_reason": "shipment_completed",
    "shipments": [
      {
        "shipment_number": "1000-1",
        "status": "completed",
        "colli": [
          {
            "track_trace": "1234567890",
            "track_trace_link": "https://gls-group.eu/EU/en/parcel-tracking?match=1234567890",
            "lines": [
              {
                "sku": "1000-100-XS",
                "ordered": 1,
                "packed": 1
              }
            ]
          }
        ]
      }
    ]
  }
}