Skip to main content
GET
Get Purchases

Purchase status

Each purchase object in the response includes a status field. status is the order status the retailer last showed. The value is a string or null. The possible string values are:
  • pending
  • shipped
  • ready_for_pickup
  • completed
  • cancelled
null means no status has been observed. Status is collected for Amazon, Walmart, and Target. Older purchases can also have null. completed and cancelled are final. Once a purchase reaches either status, its status does not change again.

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

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.

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: