An order fulfillment refers to the process of preparing and delivering orders to customers. This process usually involves receiving orders, picking the products from inventory, packing them securely, providing tracking information, and shipping them to the customer's address.
A fulfillment object contains information about an order's shipping provider, tracking details, and the line items associated with the fulfillment.
With the Order Fulfillments API you can:
- Create fulfillments for some or all items in an order.
- Create fulfillments for multiple orders at once.
- Retrieve fulfillments associated with one or many orders.
- Listen for changes made to orders' fulfillments.
This article shares a possible use case your app could support, as well as a sample flow that could support the use case. This can be a helpful jumping off point as you plan your app's implementation.
You can use webhooks to listen for when an order is placed, and then create a fulfillment for the new order.
-
Use the Order Approved Webhook to listen for incoming approved orders.
-
When a new order comes in, save the order ID. This can be found as the value of the
entityId
oractionEvent.body.order.id
fields in the Order Approved Webhook's payload. -
Pass the new order ID and the new fulfillment info to the Create Fulfillment endpoint. The response holds information about the newly created fulfillment and the ID of its associated order.
Retrieves fulfillments associated with a specified order.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Retrieves fulfillments associated with multiple specified orders.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Creates an order fulfillment.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Updates a fulfillment's properties.
To update a field's value, include the new value in the fulfillment
field in the body params.
To remove a field's value, pass null
.
Note: Updating line item IDs or fulfilled quantities is not allowed. To update line item IDs or quantities, delete the fulfillment and create it again.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Deletes an existing order fulfillment.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Creates multiple fulfillments for one or more orders.