fulfillments

List fulfillments

Obtains a list of fulfillments that match the specified criteria.

Note: Orders that have been marked as shipped either through the UI or API will appear in the response as they are considered fulfillments.

get/fulfillments

Query parameters

fulfillmentIdinteger

Returns the fulfillment with the specified fulfillment ID

orderIdinteger

Returns fulfillments whose orders have the specified order ID

orderNumberstring

Returns fulfillments whose orders have the specified order number

trackingNumberstring

Returns fulfillments with the specified tracking number

recipientNamestring

Returns fulfillments shipped to the specified recipient name

createDateStartstring date-time

Returns fulfillments created on or after the specified date

createDateEndstring date-time

Returns fulfillments created on or before the specified date

shipDateStartstring date

Returns fulfillments with shipDate on or after the specified date

shipDateEndstring date

Returns fulfillments with shipDate on or before the specified date

sortBy'ShipDate' | 'CreateDate'

Sort the responses by a set value

sortDir'ASC' | 'DESC'

Sort direction

pageinteger

Page number

pageSizeinteger

Number of results per page. Maximum 500.

List of fulfillments retrieved successfully

totalinteger

pageinteger

pagesinteger