Menu

Fulfillments API Routes

A fulfillment is created for items in an order, return, exchanges, or claims to deliver items to/from the customer.

These API routes allow admin users to manage fulfillments.

POST /admin/fulfillments#

Create Fulfillment

Create a fulfillment for an order, return, exchange, and more.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Query parameters

fieldsstringOptional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Request body (application/json)

location_idstring
The ID of the location the items are fulfilled from.
provider_idstring
The ID of the provider handling this fulfillment.
delivery_addressobject
The address to deliver the items to.
itemsobject[]
The items to fulfill.
labelsobject[]
The labels for the fulfillment's shipments.
order_idstring
The ID of the order this fulfillment is created for.
shipping_option_idstringOptional
The ID of the shipping option used in the order.
dataobjectOptional
Any data useful for the fulfillment provider to handle the fulfillment.
packed_atstringOptional
The date and time the fulfillment was packed.
shipped_atstringOptional
The date and time the fulfillment was shipped.
delivered_atstringOptional
The date and time the fulfillment was delivered.
canceled_atstringOptional
The date and time the fulfillment was canceled.
metadataobjectOptional
The fulfillment's metadata, used to store custom key-value pairs. Learn more in the Manage Metadata section.

Request examples

Responses

200 OK

fulfillmentobject
The fulfillment's details.

400, 401, 404, 409, 422, 500: an error response is returned.

POST /admin/fulfillments/{id}/cancel#

Cancel a Fulfillment

Cancel a fulfillment. The fulfillment can't be shipped or delivered.

To cancel the fulfillment, the cancelFulfillment method of the associated fulfillment provider is used.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Path parameters

idstring
The fulfillment's ID.

Query parameters

fieldsstringOptional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Request examples

Responses

200 OK

fulfillmentobject
The fulfillment's details.

400, 401, 404, 409, 422, 500: an error response is returned.

POST /admin/fulfillments/{id}/shipment#

Create a Shipment for a Fulfillment

Create a shipment for a fulfillment. The fulfillment must not be shipped or canceled.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Path parameters

idstring
The fulfillment's ID.

Query parameters

fieldsstringOptional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Request body (application/json)

labelsobject[]
The shipment's labels.

Request examples

Responses

200 OK

fulfillmentobject
The fulfillment's details.

400, 401, 404, 409, 422, 500: an error response is returned.

Found a problem with this page?Report Issue
Edited Nov 14·Edit this page