About the Order Fulfillments API

The Order Fulfillments API lets you manage how an order's items are prepared and delivered to customers. You can track each fulfillment from creation through delivery, with standard shipping carriers or your own fulfillment solution.

With the Order Fulfillments API, you can:

• Create and manage fulfillments for individual orders.
• Handle bulk fulfillment operations across multiple orders.
• Track fulfillment status through predefined stages.
• Integrate with major shipping carriers through automatic tracking link generation.
• Support custom fulfillment providers with flexible tracking information.
• Monitor fulfillment updates through webhooks.

Before you begin

It's important to note the following points before starting to code:

• Fulfillments can only be created for orders that are in an approved state.
• In the site dashboard, merchants manage fulfillment from the Sales > Orders page.
• Marking an order as fulfilled in the site dashboard doesn't create a fulfillment. The order's fulfillmentStatus changes to FULFILLED, but it has no fulfillments. Learn how to get the date an order was fulfilled.
• A line item's quantity can be split across multiple fulfillments. Each fulfillment can include up to the line item's remaining unfulfilled quantity.
• When using predefined shipping providers, tracking links are generated automatically.
• Custom shipping providers require manual tracking link management.
• The API supports up to 300 line items per fulfillment.
• Bulk operations are limited to 100 orders at a time.

Use cases

• Create fulfillments with a standard shipping provider.
• Implement custom fulfillment provider integration.
• Process bulk fulfillments for multiple orders.
• Track fulfillment status progression.

Terminology

• Fulfillment: A record tracking the delivery process for specific items in an order.
• Line item: A specific product quantity from an order being fulfilled.
• Shipping provider
  • Predefined provider: Standard carriers (FedEx, UPS, USPS, DHL, Canada Post, Hermes) with automatic tracking.
  • Custom provider: Any other shipping service requiring manual tracking management.
• Tracking information
  • Tracking number: Carrier-specific identifier for package tracking.
  • Tracking link: URL where customers can check delivery status.
• Fulfillment status
  • Pending: Initial state when fulfillment is created.
  • Accepted: Order validated and ready for processing.
  • Ready: Items picked and packed for shipping.
  • In_Delivery: Handed over to shipping carrier.
  • Fulfilled: Delivery completed successfully.