Skip to main content
Skip to main content

Fulfillment

A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.

Properties

idstringRequired
The fulfillment's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
claim_order_idstringRequired
The ID of the Claim that the Fulfillment belongs to.
claim_orderClaimOrderRequired
The details of the claim that the fulfillment may belong to.
swap_idstringRequired
The ID of the Swap that the Fulfillment belongs to.
swapSwapRequired
The details of the swap that the fulfillment may belong to.
order_idstringRequired
The ID of the Order that the Fulfillment belongs to.
orderOrderRequired
The details of the order that the fulfillment may belong to.
no_notificationbooleanRequired
Flag for describing whether or not notifications related to this should be sent.
provider_idstringRequired
The ID of the Fulfillment Provider responsible for handling the fulfillment.
location_idnull | stringRequired
The ID of the stock location the fulfillment will be shipped from
providerFulfillmentProviderRequired
The details of the fulfillment provider responsible for handling the fulfillment.
itemsFulfillmentItem[]Required
The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.
tracking_numbersstring[]Required
The tracking numbers that can be used to track the status of the fulfillment.
dataRecord<string, unknown>Required
This contains all the data necessary for the Fulfillment provider to handle the fulfillment.
shipped_atDateRequired
The date with timezone at which the Fulfillment was shipped.
canceled_atDateRequired
The date with timezone at which the Fulfillment was canceled.
metadataRecord<string, unknown>Required
An optional key-value map with additional details
idempotency_keystringRequired
Randomly generated key used to continue the completion of the fulfillment in case of failure.
Was this section helpful?