Skip to main content
GET
/
orders
/
{order_id}
Get Order
curl --request GET \
  --url https://api.zinc.com/orders/{order_id} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "max_price": 123,
  "attempts": 123,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "quantity": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "variant": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "cancellation_reason": "<string>"
    }
  ],
  "shipping_address": {},
  "retailer_credentials_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "po_number": "<string>",
  "tracking_numbers": [],
  "created_by": "<string>",
  "user_id": 123,
  "returns": []
}

Documentation Index

Fetch the complete documentation index at: https://www.zinc.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve detailed information about a specific order using its unique identifier.

​
Path Parameters

  • order_id (required) - The UUID of the order to retrieve

​
Response

Returns a complete order object with:
  • id - Order UUID
  • status - Current order status
  • items - Array of order items with individual statuses
  • shipping_address - Delivery address
  • job_result - Detailed processing results (when available)
  • created_at - Order creation timestamp
  • updated_at - Last update timestamp

​
Item-Level Status

Each item in the order has its own status tracking: 
{
  "id": "item-uuid",
  "url": "https://www.amazon.com/...",
  "quantity": 2,
  "status": "shipped",
  "created_at": "2025-11-24T10:00:00Z",
  "updated_at": "2025-11-24T12:30:00Z"
}

​
Job Results

For completed or failed orders, the job_result field contains detailed information about the order processing, including:
  • Success/failure status
  • Retailer confirmation numbers
  • Tracking information
  • Error details (if failed)
Poll this endpoint to track order progress. We recommend checking every 30-60 seconds while the order is processing.

​
Error Responses

  • 404 Not Found - Order ID does not exist or you don’t have access to it
  • 401 Unauthorized - Invalid or missing authentication

Authorizations

​
Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

​
authorization
string | null

Path Parameters

​
order_id
string<uuid>
required

Response

Successful Response

Response model for order data.

​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
pending,
in_progress,
order_placed,
order_failed,
cancelled,
cancelled_by_retailer
​
max_price
integer
required
​
attempts
integer
required
​
items
OrderItemResponse · object[]
required
​
shipping_address
Shipping Address · object
required
​
retailer_credentials_id
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
metadata
Metadata · object
​
po_number
string | null
​
tracking_numbers
TrackingNumberResponse · object[]
​
created_by
string | null
​
user_id
integer | null
​
returns
ReturnRequestSummary · object[]