Ship Order Items

Ship Order Items

post

Rate limit: 200 requests per minute

Authorizations

APIKeyAuth

X-API-KeystringRequired

Body

application/json

Responses

200

OK

application/json

batchRequestIdstring · uuidRequired

ID of the asynchronous batch request. Identical payloads from the same merchant within the deduplication window return the existing in-flight ID instead of queuing a new batch. Poll the results endpoint with this ID to retrieve the outcome.

Example: 123e4567-e89b-12d3-a456-426614174000

400

Bad Request

application/json

401

Unauthorized

application/json

default

post/api/v1/orders/ship

HTTPcURLJavaScriptPython

POST /api/v1/orders/ship HTTP/1.1
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "items": [
    {
      "order_items": [
        1
      ],
      "carrier_key": "text",
      "shipment_tracking_key": "123456789",
      "return_tracking_key": "123456789"
    }
  ]
}

{
  "batchRequestId": "123e4567-e89b-12d3-a456-426614174000"
}