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
canceled_at
DateRequiredThe date with timezone at which the Fulfillment was canceled.
The details of the claim that the fulfillment may belong to.
claim_order_id
stringRequiredThe ID of the Claim that the Fulfillment belongs to.
created_at
DateRequiredThe date with timezone at which the resource was created.
data
Record<string, unknown>RequiredThis contains all the data necessary for the Fulfillment provider to handle the fulfillment.
id
stringRequiredThe fulfillment's ID
idempotency_key
stringRequiredRandomly generated key used to continue the completion of the fulfillment in case of failure.
The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.
location_id
null | stringRequiredThe ID of the stock location the fulfillment will be shipped from
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
no_notification
booleanRequiredFlag for describing whether or not notifications related to this should be sent.
The details of the order that the fulfillment may belong to.
order_id
stringRequiredThe ID of the Order that the Fulfillment belongs to.
The details of the fulfillment provider responsible for handling the fulfillment.
provider_id
stringRequiredThe ID of the Fulfillment Provider responsible for handling the fulfillment.
shipped_at
DateRequiredThe date with timezone at which the Fulfillment was shipped.
The details of the swap that the fulfillment may belong to.
swap_id
stringRequiredThe ID of the Swap that the Fulfillment belongs to.
The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.
tracking_numbers
string[]RequiredThe tracking numbers that can be used to track the status of the fulfillment.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
Was this section helpful?