Skip to main content
GET
Get Order
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:

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.

Price Components

Once the retailer total is known, job_result.price_components breaks the charge down. All amounts are in cents.

Connect Charge

For orders paid via Stripe Connect, the response includes a connect object with the charge breakdown and its current state. It is null for prepaid-wallet orders. All amounts are in cents. The post-capture fields (order_cost and below) are populated once the order is placed and the actual total is captured; before that they are null and state is secured.

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
handling_days_max
integer | null
is_gift
boolean
default:false
retailer_credentials_uuid
string | null
job_result
OrderJobResult · object | null

Fulfillment result and price breakdown for a completed or failed order; null while processing.

tracking_numbers
TrackingNumberResponse · object[]
created_by
string | null
user_id
integer | null
returns
ReturnRequestSummary · object[]
connect
OrderConnectInfo · object | null

Stripe Connect charge details when this order was paid via Connect; null for prepaid-wallet orders.