Skip to main content
GET
/
purchases
/
{purchase_id}
Get Purchase
curl --request GET \
  --url https://api.example.com/purchases/{purchase_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <x-api-key>'
{
  "purchase_id": "<string>",
  "date": "<string>",
  "total": "<string>",
  "tax": "<string>",
  "subtotal": "<string>",
  "item_count": 123,
  "items": [
    {
      "item_id": "<string>",
      "price": "<string>",
      "quantity": "<string>",
      "product": {
        "description": "<string>",
        "name": "<string>",
        "upc": "049000028911",
        "product_id": "01J51S0JYV6N7K1030CV1ZKSCA",
        "brand": "diet-coke"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.subtotal.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Example:

"01J51S0JYV6N7K1030CV1ZKSCF"

​
date
string
required

The date and time of the purchase

Example:

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

​
total
string
required

The total amount of the purchase

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"9.34"

​
tax
string
required

The tax amount of the purchase

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"0.85"

​
subtotal
string
required

The subtotal amount of the purchase

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"8.49"

​
item_count
integer
required

The number of items in the purchase

Example:

1

​
items
ItemResponse · object[]
required

The list of items in the purchase

Example:
[
  {
    "item_id": "01J51S0JYV6N7K1030CV1ZKSCA",
    "price": "8.49",
    "product": {
      "brand": "diet-coke",
      "description": "Diet Coke - 12pk/12oz cans",
      "name": "Diet Coke 12pk",
      "product_id": "01J51S0JYV6N7K1030CV1ZKSCB",
      "upc": "049000028911"
    },
    "quantity": 1
  }
]