Skip to main content
GET
/
purchases
/
{purchase_id}
{
  "purchase_id": "01J51S0JYV6N7K1030CV1ZKSCF",
  "date": "2024-01-01T00:00:00Z",
  "total": "9.34",
  "tax": "0.85",
  "subtotal": "8.49",
  "item_count": 1,
  "items": [
    {
      "brand": "diet-coke",
      "description": "Diet Coke - 12pk/12oz cans",
      "gtin": "049000028911",
      "name": "Diet Coke 12pk",
      "price": "8.49",
      "product_id": "01J51S0JYV6N7K1030CV1ZKSCA",
      "quantity": 1
    }
  ]
}

Authorizations

Authorization
string
header
required

A connection-specific token with access scope

Headers

x-api-key
string
required

The client's API key secret value

Path Parameters

purchase_id
string
required

Response

Successful Response

purchase_id
string
required

The unique identifier for the purchase

Examples:

"01J51S0JYV6N7K1030CV1ZKSCF"

date
string<date-time>
required

The date and time of the purchase

Examples:

"2024-01-01T00:00:00Z"

total
string
required

The total amount of the purchase

Examples:

"9.34"

tax
string
required

The tax amount of the purchase

Examples:

"0.85"

subtotal
string
required

The subtotal amount of the purchase

Examples:

"8.49"

item_count
integer
required

The number of items in the purchase

Examples:

1

items
ItemResponse · object[]
required

The list of items in the purchase

Examples:
[
{
"brand": "diet-coke",
"description": "Diet Coke - 12pk/12oz cans",
"gtin": "049000028911",
"name": "Diet Coke 12pk",
"price": "8.49",
"product_id": "01J51S0JYV6N7K1030CV1ZKSCA",
"quantity": 1
}
]
I