The Fulfillment APIs support order management and fulfillment workflows based on the Shipment API and its packages, including supporting needs such as pick waves and manifests. Once an order has been placed, it generally cannot be edited at the order-level. Instead, changes to the items, pricing, and other information must be done at the shipment level with the Shipment API. See the Fulfillment user guides for more information about fulfillment in UCP.
When using the Shipment API to transition a shipment through each stage of its fulfillment process, it can be difficult to remember how to format the next step's endpoint and the expected parameters on-the-fly. Additionally, if a call such as cancellation, adding tracking information, or marking the shipment as fulfilled needs to be performed outside of the usual fulfillment flow, it may be confusing to determine how to perform the action without referring to the documentation. To assist with this, the Shipment API provides guidelines within the response body. This response includes two objects, workflowState and\_links, that detail the shipment's next step in the workflow as well as all possible actions currently available to the shipment. Use this walkthrough to better understand how to work with this response data.
Some tips for using different resources of the Fulfillment APIs:
- Use the Customer Survey resource to create surveys and gather data from your customers.
- Use the Manifests resource to create shipping manifests for fulfillment partners such as Canada Post that require manifests for groups of shipments.
- Use the Pick Wave resource to generate and process pick waves for picking groups of items at a fulfillment locations.
- Use the Shipment, Shipment Attributes, Shipment Data, and Shipment Notification resources to manage the actual shipments being fulfilled and perform actions on them.
- Use the Shipment Packages resource to create, update, and delete the individual packages within a shipment.
- Use the Storefront resource to retrieve shipment information for the storefront.
- Use the Workflow Process resource to retrieve BPM configurations and the fulfillment steps based on shipment type.