Fulfillment Provider API (1.0.0)
Download OpenAPI specification:Download
Represents a request to ship products in an order. Use this resource to accept or reject fulfillment requests. You can also retrieve and update the shipping status for a fulfillment request.
This resource only applies to orders routed to a warehouse for fulfillment.
To manage orders routed to stores for fulfillment, contact the support team.
To retrieve a list of fulfillment requests for an order, with the status of items in each fulfillment request, see Store and DC orders.
Note: When shipping, rejecting or canceling order items with the same product ID the service will pick either the cheapest or the most expensive one depending on the action type. Please check each endpoint for more details.
Update shipping status
Marks some or all items of a fulfillment request as shipped.
Note: This only applies to orders routed to a DC or warehouse for fulfillment.
To mark an item as shipped, which was part of an order that is routed to a store for fulfillment, contact the support team.
Authorizations:
path Parameters
uuid required | string Unique ID for a fulfillment request. |
Request Body schema: application/json
required | Array of objects | ||||||||||
Array
|
Responses
Request samples
- Payload
{- "shipments": [
- {
- "item_ids": [
- "94ee7a5e-69a2-4957-ba3a-414fde9bd3bf",
- "cafc321e-be35-4c68-a9ce-20dabed04d37"
]
}, - {
- "tracking_code": "1234"
}, - {
- "carrier": "FEDEX"
}, - {
- "carrier_service_level": "FEDEX_GROUND"
}
]
}
Response samples
- 201
{- "title": "Fulfillment Request Shipment Bad Request Error Response",
- "description": "Fulfillment request shipment error response code and details for bad request.",
- "type": "object",
- "required": [
- "error_code"
], - "properties": {
- "error_code": {
- "type": "string",
- "enum": [
- "already_rejected",
- "fulfillment_request_invalid",
- "conflicting_items",
- "invalid_item",
- "shipment_notification_conversion_failed",
- "item_already_rejected",
- "item_already_shipped",
- "item_already_canceled",
- "already_shipped"
], - "description": "A unique identifier for the error code."
}, - "error_description": {
- "type": "string",
- "description": "A human readable description of the error code."
}, - "conflicting_items": {
- "type": "array",
- "items": {
- "type": "string",
- "description": "Item ID's whose provided shipment details conflict with already existing shipment information."
}
}
}
}