Skip to main content
GET
/
v3
/
orders
/
{orderId}
Get an order by id
curl --request GET \
  --url https://api.snappy.com/v3/orders/{orderId} \
  --header 'X-Api-Key: <api-key>'
{
  "data": {
    "id": "G7nR4bD9mK",
    "status": "active",
    "fulfillmentStatus": "unfulfilled",
    "tags": [],
    "cancellationDetails": {
      "cancelledAt": "2026-05-27T15:57:00.000Z",
      "cancellationReason": "customer_requested"
    },
    "lineItems": [
      {
        "variantId": "v_abc12345",
        "quantity": 1,
        "title": "Premium Gift Card"
      }
    ],
    "fulfillments": [
      {
        "fulfillmentLineItems": [
          {
            "variantId": "v_abc12345",
            "quantity": 1,
            "title": "Premium Gift Card"
          }
        ],
        "id": "tr_abc123",
        "status": "in_transit",
        "trackingCompany": "UPS",
        "trackingInfo": {
          "number": "1Z9999W99999999999",
          "url": "https://www.ups.com/track?tracknum=1Z9999W99999999999"
        }
      }
    ],
    "recipient": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+15555555555"
    },
    "shippingAddress": {
      "address1": "123 Main St",
      "address2": "Suite A",
      "city": "New York",
      "provinceCode": "NY",
      "countryCode": "US",
      "postalCode": "10001"
    },
    "metadata": {
      "externalRecipientId": "crm-user-987",
      "campaign": "q4-vip"
    },
    "idempotencyKey": "order-2026-05-13-abc"
  }
}

Authorizations

X-Api-Key
string
header
required

Partner API key. Finalized per partner integration agreement.

Headers

Snappy-Account-Id
string

Optional account identifier for scoping/validation/filtering.

Snappy-Company-Id
string

Optional company identifier for scoping/validation/filtering.

Path Parameters

orderId
string
required

Order identifier.

Response

Order.

JSON:API single-resource envelope for an order.

data
object
required

Order details including line items, recipient, shipping address, fulfillments, and tracking information.

Last modified on June 3, 2026