Skip to main content
GET
/
api
/
commerce
/
orders
List orders for the caller
curl --request GET \
  --url https://app.vaultgraph.com/api/commerce/orders \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "orders": [
      {
        "id": "<string>",
        "created_at": "2026-06-23T10:15:00.000Z",
        "checkout_id": "<string>",
        "currency": "GBP",
        "permalink_url": "<string>",
        "line_items": [
          {
            "id": "<string>",
            "item": {
              "id": "<string>",
              "price": 123,
              "title": "<string>",
              "image_url": "<string>"
            },
            "quantity": {
              "fulfilled": 123,
              "total": 123
            },
            "totals": [
              {
                "amount": 123,
                "display_text": "<string>"
              }
            ],
            "parent_id": "<string>",
            "properties": [
              {
                "name": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "totals": [
          {
            "amount": 123,
            "display_text": "<string>"
          }
        ],
        "fulfillment": {
          "expectations": [
            {
              "id": "<string>",
              "method": {
                "id": "<string>",
                "name": "<string>"
              },
              "line_items": [
                {
                  "id": "<string>",
                  "quantity": 1
                }
              ],
              "destination": {
                "full_name": "<string>",
                "first_name": "<string>",
                "last_name": "<string>",
                "phone_number": "<string>",
                "street_address": "<string>",
                "extended_address": "<string>",
                "address_locality": "<string>",
                "address_region": "<string>",
                "postal_code": "<string>",
                "address_country": "<string>",
                "instructions": "<string>"
              },
              "fulfillable_on": "<string>"
            }
          ],
          "events": [
            {
              "id": "<string>",
              "type": "<string>",
              "occurred_at": "<string>",
              "line_items": [
                {
                  "id": "<string>",
                  "quantity": 1
                }
              ],
              "description": "<string>",
              "carrier": "<string>",
              "tracking_number": "<string>",
              "tracking_url": "<string>"
            }
          ]
        },
        "ucp": {
          "capabilities": [
            {
              "name": "<string>",
              "version": "<string>",
              "config": {},
              "extends": "<string>",
              "schema": "<string>",
              "spec": "<string>"
            }
          ],
          "version": "<string>"
        },
        "display_id": "ORD_1042",
        "messages": [
          {
            "id": "<string>",
            "body": "<string>",
            "created_at": "<string>"
          }
        ]
      }
    ],
    "pagination": {
      "has_next_page": true,
      "cursor": "<string>",
      "total_count": 123
    }
  }
}

Authorizations

x-api-key
string
header
required

Query Parameters

limit
integer

Maximum orders to return on this page.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from a previous response's pagination.cursor. Omit for the first page.

Response

One page of orders, with optional next-page pagination

data
object