The Fulfillments resource is a crucial component of the order management system. It allows, allowing you to track the progression of an order from initial requisition to the delivery of goods or services. This resource facilitates real-time updates on the status of both physical logistics and digital deliveries, ensuring seamless operational workflows and enhanced customer satisfaction. With comprehensive details about the type and quantity of items fulfilled, it provides a transparent view of the supply chain process. See for more information.
Returns a list of Fulfillments
get
Gets all the Fulfillments specified in the request.
Authorizations
Query parameters
createdTimeobjectoptional
A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
gt—return values where the createdTime field is after this timestamp
gte—return values where the createdTime field is after or equal to this timestamp
lt—return values where the createdTime field is before this timestamp
lte—return values where the createdTime field is before or equal to this timestamp
Example: createdTime[gt]=2020-09-22T12:09:44Z
endingBeforestringoptional
A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
startingAfterstringoptional
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
limitinteger · min: 1 · max: 100optional
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
idsstring[]optional
Only return objects with these IDs.
orderIdstringoptional
The identifier of the order associated with the Fulfillment you want to retrieve.
skuIdstringoptional
The identifier of the SKU associated with the Fulfillments you want to retrieve.
trackingCompanystringoptional
The tracking company associated with the Fulfillments you want to retrieve.
trackingNumberstringoptional
The tracking number associated with the Fulfillments you want to retrieve.
The identifier of the Order associated with this Fulfillment.
Example: 5678901234
shipmentIdstringoptional
The unique identifier associated to the shipment
Example: 321765
itemsobject[]required
An array of items to fulfill and/or cancel.
currencystringoptional
A valid ISO 4217 code that represents the currency the distributor should be paid in. If items[].distributorCost or items[].shippingCost are specified, then currency is required. The value doesn't have to be the same as the Order's currency.
Example: USD
metadataobjectoptional
Key-value pairs used to store additional data. Value can be string, boolean or integer types.
Example: {"coupon":"iOS"}
trackingCompanystringoptional
The name of the tracking company.
Example: Fedex
trackingNumberstringoptional
The tracking number provided by the shipping company.
