The Order Fulfillments API enables managing the process of preparing and delivering orders to customers in an e-commerce system. With this API, you can track the entire fulfillment lifecycle from initial creation through final delivery, supporting both standard shipping carriers and custom fulfillment solutions.
The API provides functionality to:
- 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.
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.
- Each line item in an order can only be included in one fulfillment.
- 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.
- 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) 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