Skip to main content

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.

fulfillment-requests

Fulfillment requests

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:
newStoreAccessToken
path Parameters
uuid
required
string

Unique ID for a fulfillment request.

Request Body schema: application/json
required
Array of objects
Array
item_ids
Array of strings
tracking_code
string
carrier
string
carrier_service_level
string

Refers to the speed and type of a shipment offered by a carrier, e.g. Ground, First, UPSStandard, FEDEX_GROUND.

tracking_url
string non-empty

Responses

Request samples

Content type
application/json
{
  • "shipments": []
}

Response samples

Content type
application/json
{
  • "title": "Fulfillment Request Shipment Bad Request Error Response",
  • "description": "Fulfillment request shipment error response code and details for bad request.",
  • "type": "object",
  • "required": [
    ],
  • "properties": {
    }
}