Get Order
Orders
Get Order
Retrieve a specific order by ID
GET
Get Order
Retrieve detailed information about a specific order using its unique identifier.
The post-capture fields (
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, thejob_result field contains detailed information about the order processing, including:
- Success/failure status
- Retailer confirmation numbers
- Tracking information
- Error details (if failed)
Price Components
Once the retailer total is known,job_result.price_components breaks the charge down. All amounts are in cents.
| Field | Description |
|---|---|
subtotal | Item subtotal before tax and shipping |
tax | Tax charged by the retailer |
shipping | Shipping charged by the retailer |
total | Order total in the order currency (subtotal + tax + shipping) |
converted_payment_total | total converted to the currency actually charged |
currency | Currency of total (e.g. USD) |
payment_currency | Currency the order was paid in |
line_items | Itemized rows, each { description, amount, category } |
Connect Charge
For orders paid via Stripe Connect, the response includes aconnect object with the charge breakdown and its current state. It is null for prepaid-wallet orders. All amounts are in cents.
| Field | Description |
|---|---|
state | secured → captured, or released / refunded on a terminal outcome. |
secured_amount | Amount held on the end-customer’s card when the order was placed (sized from max_price). |
order_cost | Actual order cost (goods), captured once Zinc places the order with the retailer. |
customer_margin | Your margin, transferred to your connected account. |
zinc_fee | Zinc’s platform fee. |
stripe_fee | Stripe’s processing fee on the charge. |
final_charge | Total captured from the end-customer (order_cost + customer_margin + zinc_fee + stripe_fee). |
transfer_amount | Amount transferred to your connected account (your margin). |
payment_intent_id | Stripe PaymentIntent id (pi_…) for the charge. |
connected_account_id | Your connected account id (acct_…). |
simulated | true for test-mode orders that didn’t hit Stripe. |
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
Zinc API key (Bearer zn_...)
Headers
Path Parameters
Response
Successful Response
Response model for order data.
Available options:
pending, in_progress, order_placed, order_failed, cancelled, cancelled_by_retailer Fulfillment result and price breakdown for a completed or failed order; null while processing.
Stripe Connect charge details when this order was paid via Connect; null for prepaid-wallet orders.

