Skip to main content
GET
Get Purchases

Purchase status

Each purchase object in the response includes a status field. status is the purchase status the retailer last showed. The value is a string, or null when unknown. The possible string values are:
  • pending
  • shipped
  • ready_for_pickup
  • completed
  • cancelled
Status is collected for Amazon, Walmart, and Target. Some purchases from these retailers, and purchases collected before October 2026, have null. completed and cancelled are final. Once a purchase reaches either status, its status does not change again.

Authorizations

X-Api-Key
string
header
required

API key: your Subtotal API key.

Authorization
string
header
required

Connection token: send Authorization: Bearer <connection_token> together with X-Api-Key. Get the token from POST /connections/{connection_id}/token.

Query Parameters

limit
integer
default:10

The maximum number of purchases to return

Required range: 1 <= x <= 50
Example:

10

starting_after
string

The purchase id of the last purchase you processed. The next purchase returned will be the next oldest purchase. An id that isn't one of this connection's purchases returns 400.

Example:

"01J51S0JYV6N7K1030CV1ZJH30"

Response

Successful Response

has_more
boolean
required

Whether there are more purchases available to fetch

Example:

true

purchases
PurchaseSummary · object[]
required

The list of purchases for the connection sorted in descending order by purchase date

Example: