Purchases

List own GMT wholesale orders

Changed on

Paginated wholesale orders for the authenticated user. Use bulk_purchase_id with the status and archive download endpoints.

get/v1/purchases/bulk

Request

  • Base URL
    https://api.getmytg.com
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

pageinteger

Page number.

Example:1
page_sizeinteger

Number of items per page.

Example:50
sort'date_asc' | 'date_desc'

Sort purchases by creation date

Example:date_desc
status'PENDING' | 'SUCCESS' | 'ERROR' | 'REFUND' | 'EXPIRED'

Legacy status projection: PENDING while the current retail code request is pending or failed, SUCCESS when its code is available. With include=code_request, status describes the durable purchase; code_request describes the current request. REFUND and access rules still apply.

Example:SUCCESS

Response

Response for status 200

Example response

{
  "items": [
    {
      "bulk_purchase_id": 123,
      "total_price": {
        "amount": "1.50",
        "currency_code": "USD"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 50,
    "total_items": 150,
    "total_pages": 3,
    "has_next": true
  }
}

Changes