Get Shipped Order Batch Results

Get Ship Order Batch Results

get

Rate limit: 200 requests per minute

Authorizations

APIKeyAuth

X-API-KeystringRequired

Query parameters

batch_request_idstring · uuidRequired

Responses

200

OK

application/json

batchRequestIdstring · uuidRequired

Unique identifier (UUID)

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

statusstring · enumRequired

Status of the batch processing

Example: completedPossible values:

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

default

get

/api/v1/results/ship-orders

HTTPcURLJavaScriptPython

GET /api/v1/results/ship-orders?batch_request_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "batchRequestId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "completed",
  "items": [
    {
      "requestItem": {
        "order_items": [
          1
        ],
        "carrier_key": "text",
        "shipment_tracking_key": "123456789",
        "return_tracking_key": "123456789"
      },
      "success": true,
      "errors": [
        "Could not complete operation due to..."
      ]
    }
  ]
}