Skip to main content

Get order fulfillment status

Endpoint: POST /v10/orders/fulfillment-status

Returns everything a help desk needs to answer "where is my order": who the order is for, what has been shipped per line, the shipments with their track & trace and whether the order can still be cancelled.

ParameterRequiredDefaultDescription
order_idYes, if no order_number or shopify_order_id is givenThe ID of the order to get the fulfillment status for
order_numberYes, if no order_id or shopify_order_id is givenThe number of the order to get the fulfillment status for
shopify_order_idYes, if no order_id or order_number is givenThe Shopify order ID of the order to get the fulfillment status for
tip

To find the orders of a customer from their email or phone number, use Get orders with the email or telephone filter.

Data of response​

ParameterRequiredDefaultDescription
fulfillment_status.*YesAn fulfillment status object

Fulfillment status data​

ParameterRequiredDefaultDescription
order_idYesThe ID of the order
order_numberYesThe number of the order
typeYesThe type of the order. Possible values: b2b, b2c
shopify_order_idnullThe Shopify order ID, if the order was imported from Shopify
fulfillment_statusYesThe fulfillment status of the order. Possible values: open, being_packed, completed
can_cancelYesWhether the order can be cancelled. Possible values: true, false
can_cancel_reasonnullThe reason why the order cannot be cancelled. Possible values: shipment_completed, shipment_claimed, order_cancelled
customernullA customer object. null if the API user is not allowed to see the buyer of orders
delivery_addressnullA delivery address object. null if the API user is not allowed to see the delivery address of orders
linesYesAn array of objects line data
shipmentsYesAn array of objects shipment data

Customer data​

For B2B orders the customer is taken from the customer card. For B2C orders the name, email and telephone are taken from the delivery address of the order, since that is where the consumer's details are.

ParameterRequiredDefaultDescription
customer_idnullThe ID of the customer
customer_numbernullThe number of the customer
namenullThe name of the customer
emailnullThe email of the customer
telephonenullThe telephone number of the customer
usersYes[]An array of objects customer user data. The B2B users of the customer, who often write from their own email rather than the customer's. Always empty for B2C orders

Customer user data​

ParameterRequiredDefaultDescription
namenullThe name of the user
emailnullThe email of the user
telephonenullThe telephone number of the user

Delivery address data​

ParameterRequiredDefaultDescription
namenullThe name of the receiver
attnullThe attention of the address
addressnullThe first address line
address_2nullThe second address line
zipnullThe zip code
citynullThe city
regionnullThe region
countrynullThe country as ISO 3166-1 alpha-2 code
emailnullThe email of the receiver
telephonenullThe telephone number of the receiver

Line data​

ParameterRequiredDefaultDescription
order_line_idYesThe ID of the order line
skunullThe SKU of the line
namenullThe product name including variant attributes, e.g. T-shirt / Black / M
quantityYesThe number of pieces ordered
shippedYesThe number of pieces shipped
remainingYesThe number of pieces not shipped yet
estimated_departure_datenullThe date the line is expected to leave the warehouse (ETD), as YYYY-MM-DD. Only available for accounts using sales order dates v2
estimated_delivery_datenullThe date the line is expected to be delivered (ETA), as YYYY-MM-DD. Only available for accounts using sales order dates v2

Shipment data​

ParameterRequiredDefaultDescription
shipment_idYesThe ID of the shipment. Use it with Update shipment
shipment_numberYesThe number of the shipment
statusYesThe status of the shipment. See shipment status mapping
priorityYesWhether the shipment is prioritized in the warehouse
holdYesWhether the shipment is on hold
shipping_methodnullThe name of the shipping method (carrier) of the shipment
shipped_atnullWhen the shipment was shipped, as ISO 8601. Only set for shipped shipments
colliYesAn array of objects colli data. Track & trace is returned as soon as it exists, also before the shipment is completed

Shipment status mapping​

StatusDescription
openThe shipment is waiting to be packed
lockedThe shipment is locked and will not be packed until it is unlocked
being_packedThe warehouse has started packing the shipment. The order can no longer be cancelled
on_holdThe shipment has been put on hold by the warehouse
completedThe shipment has been shipped
cancelledThe shipment has been cancelled

Colli data​

ParameterRequiredDefaultDescription
track_tracenullThe package code of the shipment
track_trace_linknullA direct link to a track & trace page. If null Traede will attempt to generate this from track_trace and carrier
linesYesAn array of objects colli lines

Colli lines data​

ParameterRequiredDefaultDescription
skuYesThe SKU of the line
orderedYesThe number of pieces ordered for this line
packedYesThe number of pieces packed for this line

Request example​

POST /v10/orders/fulfillment-status

{
"order_number": "1000"
}

Response example​

{
"fulfillment_status": {
"order_id": 1,
"order_number": "1000",
"type": "b2c",
"shopify_order_id": "5541239872",
"fulfillment_status": "completed",
"can_cancel": false,
"can_cancel_reason": "shipment_completed",
"customer": {
"customer_id": 12,
"customer_number": "WEBSHOP",
"name": "Jane Consumer",
"email": "jane@example.com",
"telephone": "+45 12 34 56 78",
"users": []
},
"delivery_address": {
"name": "Jane Consumer",
"att": null,
"address": "Consumer street 1",
"address_2": null,
"zip": "2100",
"city": "Copenhagen",
"region": null,
"country": "DK",
"email": "jane@example.com",
"telephone": "+45 12 34 56 78"
},
"lines": [
{
"order_line_id": 101,
"sku": "1000-100-XS",
"name": "T-shirt / Black / XS",
"quantity": 1,
"shipped": 1,
"remaining": 0,
"estimated_departure_date": "2026-11-02",
"estimated_delivery_date": "2026-11-04"
}
],
"shipments": [
{
"shipment_id": 55,
"shipment_number": "1000-1",
"status": "completed",
"priority": false,
"hold": false,
"shipping_method": "GLS",
"shipped_at": "2026-11-02T14:31:00+00:00",
"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
}
]
}
]
}
]
}
}