Skip to main content
GET
/
v1
/
orders
List Orders
curl --request GET \
  --url https://api.zinc.io/v1/orders \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "_type": "order_response",
    "price_components": {
      "converted_payment_total": 123,
      "currency": "<string>",
      "payment_currency": "<string>",
      "shipping": 123,
      "subtotal": 123,
      "tax": 123,
      "total": 123
    },
    "merchant_order_ids": [
      {
        "merchant_order_id": "<string>",
        "merchant": "<string>",
        "account": "<string>",
        "placed_at": "2023-11-07T05:31:56Z"
      }
    ],
    "tracking": [
      {
        "product_id": "<string>",
        "merchant_order_id": "<string>",
        "carrier": "<string>",
        "tracking_number": "<string>",
        "obtained_at": "2023-11-07T05:31:56Z"
      }
    ],
    "request": {},
    "delivery_dates": [
      "<any>"
    ],
    "account_status": {
      "prime": true,
      "fresh": true,
      "business": true,
      "charity": "<string>"
    }
  }
]
To get a list of all orders within a specific timestamp range, use the order query and include these additional query parameters. The timestamps are unix timestamps in milliseconds, which you can read about here. To easily convert a human-readable date / time to a unix timestamp, you can use this converter. Sample code that includes an example of a bulk order query can be found in this GitHub repo.

Authorizations

​
Authorization
string
header
required

Use your client token as the username. Leave the password blank.

Query Parameters

​
limit
integer
default:10

Maximum number of orders to return in the results (defaults to 10)

​
skip
integer

Number of order responses to skip before including up to limit orders in results

​
starting_after
integer

Timestamp of start of the range (inclusive)

​
ending_before
integer

Timestamp of end of the range (exclusive)

​
retailer
string

Name of the retailer to include orders from. See Supported Retailers for a list of supported retailers.

Response

200 - application/json

List of orders retrieved successfully

​
_type
enum<string>

Response type

Available options:
order_response
​
price_components
object
​
merchant_order_ids
object[]

A merchant order ids object which contains details about the retailer's order identifiers

​
tracking
object[]

An array of tracking objects that contain the order's tracking information

​
request
object

The original request that was sent to the Zinc API

​
delivery_dates
any[]

An array of ordered products and their given delivery dates

​
account_status
object

(Amazon only) An account status object that gives details about the ordering account

⌘I