Skip to main content
GET
Get Purchase

Purchase status

The purchase object 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.

Headers

authorization
string | null
x-api-key
string | null

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:
purchase_type
enum<string> | null

The purchase type: 'in_store', 'online', 'delivery', 'pickup' or 'return'. Null when unknown.

Available options:
online,
in_store,
delivery,
pickup,
return
Example:

"online"

status
enum<string> | null

The purchase status the retailer last showed: 'pending', 'shipped', 'ready_for_pickup', 'completed' or 'cancelled'. Null when never observed.

Available options:
pending,
shipped,
ready_for_pickup,
completed,
cancelled
Example:

"completed"