Fulfillments
Parts of your orders that the warehouse picks, packs and ships as one shipment. Requires the fulfillments read permission.
Each fulfillment lists its items with picked, packed and skipped quantities. blocked shows that an unresolved incident is blocking it; find it with GET /v2/incidents?orderIds={orderId}&blocking=true. GET /v2/fulfillments/{id} adds the event history. To find the fulfillment of a shipment, use GET /v2/fulfillments?shipmentIds={id}.
List fulfillments
Returns a paginated list of fulfillments, newest first. Event history is not included; use GET /v2/fulfillments/{id}.
Without a date range, fulfillments from the last 60 days are returned. A date range can span up to one year. When orderIds or shipmentIds is set, the date range is ignored.
query Parameters
pagePage number for pagination
pageSizeNumber of items per page
orderIdsOrder IDs, up to 20. Repeat the parameter for multiple values. The date range is ignored.
shipmentIdsShipment IDs, up to 20. Repeat the parameter for multiple values. The date range is ignored.
createdFromFulfillments created from this date and time, inclusive (format yyyy-MM-ddTHH:mm:ss.fff). Defaults to 60 days before createdTo, or before today. Ignored when orderIds or shipmentIds is set.
createdToFulfillments created up to this date and time, inclusive (format yyyy-MM-ddTHH:mm:ss.fff). The range can span up to one year.
statusFulfillment statuses. Repeat the parameter for multiple values.
Headers
Accept-LanguageLanguage code for localized responses
List fulfillments › Responses
Paginated list of fulfillments
pageCurrent page number
pageSizeNumber of items per page
totalPagesTotal number of pages
nextPageWhether a next page exists
previousPageWhether a previous page exists
itemsCountTotal number of items across all pages
Fulfillments, newest first. Event history is not included; use GET /v2/fulfillments/{id}.
Get fulfillment by ID
Returns a fulfillment with its items and event history.
path Parameters
idUnique fulfillment identifier
Headers
Accept-LanguageLanguage code for localized responses
Get fulfillment by ID › Responses
The fulfillment with its event history
idUnique fulfillment identifier
orderIdOrder the fulfillment belongs to
statusStatus of a fulfillment.
pending— waiting to be pickedpicking— being pickedpicking_staged— partly picked, waiting for the missing itemspicked— picked, waiting to be packedpacking— being packedpacked— packed, waiting for the shipmentcompleted— shipment created, or completed manuallycancelled— cancelled; seecancellationSource
blockedWhether an unresolved incident is blocking the fulfillment. Find it with GET /v2/incidents?orderIds={orderId}&blocking=true.
shippingNumbersTracking numbers of the shipment
Items in the fulfillment
createdAtWhen the fulfillment was created (format yyyy-MM-ddTHH:mm:ss.fff)
changedAtWhen the fulfillment was last updated; the same as createdAt if never updated (format yyyy-MM-ddTHH:mm:ss.fff)
Warehouse actions on the fulfillment, oldest first. Not every status change is recorded; use status for the current state.
cancellationSourceWhy the fulfillment was cancelled; null if it is not cancelled or the reason is unknown.
operator— cancelled in Chameleoonsource_deleted— order deleted or cancelled in the source systemsource_emptied— all order lines removed in the source system
Warehouse handling the fulfillment
courierCourier code, such as gls, dpd or packeta
courierProfileCourier delivery profile, such as na_adresu
shipmentIdShipment created for the fulfillment; null until it exists. Use it with GET /v2/shipments/{id}.
expectedShippingDateExpected shipping date (format yyyy-MM-ddTHH:mm:ss.fff)
finishedAtWhen the warehouse last finished picking or packing, or when the shipment was created if that came first; null if none of these has happened yet (format yyyy-MM-ddTHH:mm:ss.fff)