Get Purchases

curl https://api.thanxsandbox.com/purchases \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}" 

{
  "purchases": [
    {
      "id": "92b7b0dac4",
      "user_id": "weori235",
      "merchant_id": "9a1f0772c9ac",
      "location_id": "e7183da044",
      "purchased_at": "2020-01-01T20:00:00Z",
      "amount": 9.99,
      "order": {
        "provider": "OLO",
        "id": "YWEI2342F"
      }
    }
  ],
  "pagination": {
    "total_page": 1,
    "per_page": 10,
    "current_page": 1
  }
}

GET

purchases

curl https://api.thanxsandbox.com/purchases \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}" 

{
  "purchases": [
    {
      "id": "92b7b0dac4",
      "user_id": "weori235",
      "merchant_id": "9a1f0772c9ac",
      "location_id": "e7183da044",
      "purchased_at": "2020-01-01T20:00:00Z",
      "amount": 9.99,
      "order": {
        "provider": "OLO",
        "id": "YWEI2342F"
      }
    }
  ],
  "pagination": {
    "total_page": 1,
    "per_page": 10,
    "current_page": 1
  }
}

Please review proper request headers here.

Parameters

merchant_id

string

Only return purchases for this merchant

location_id

string

Only return purchases for this location

user_id

string

Only return purchases for this user. Note: the bearer token will be used to determine which user’s purchases are being requested when the request is made by a logged in user.

page

integer

The current page of paginated resources.

Default: 1.

per_page

integer

Number of records to be returned per API request.

Default: 10
Minimum: 1
Maximum: 100

Response

string

The ID of the purchase record

user_id

string

The user ID

merchant_id

string

The merchant ID

location_id

string

Location ID

purchased_at

string

Time the purchase was made in ISO8601-format

amount

decimal

The purchase amount

order

hash

Provides information about the associated order, if any

Show order

string

The ID of the order in the provider’s system

provider

enum

The online ordering provider (OLO, Toast, Other)

pagination

hash

Pagination information

Show pagination

current_page

integer

Current page

per_page

integer

Number of records return per page

total_pages

integer

The total number of available pages

curl https://api.thanxsandbox.com/purchases \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}" 

{
  "purchases": [
    {
      "id": "92b7b0dac4",
      "user_id": "weori235",
      "merchant_id": "9a1f0772c9ac",
      "location_id": "e7183da044",
      "purchased_at": "2020-01-01T20:00:00Z",
      "amount": 9.99,
      "order": {
        "provider": "OLO",
        "id": "YWEI2342F"
      }
    }
  ],
  "pagination": {
    "total_page": 1,
    "per_page": 10,
    "current_page": 1
  }
}

Create Purchase Get Purchase

⌘I

Consumer API

Reference

Get Purchases

Parameters

Response

​Parameters

​Response

Parameters

Response