Orders

Get Orders

Changed on

Returns a list of orders.

get/v1/orders

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/orders
  • Auth
    HTTP bearer

Query parameters

start_atinteger

Optional start of the time range to filter by order creation time, in Unix timestamp format (seconds)

end_atinteger

Optional end of the time range to filter by order creation time, in Unix timestamp format (seconds)

platform'any' | 'ios' | 'android' | 'other'

Optional platform to filter orders by (e.g. ios, android, other).

limitinteger

A limit on the number of objects to be returned

offsetinteger

Deprecated, use start_after_id. The number of objects to skip

start_after_idstring

The id of the last object of the previous page. The response starts with the object that follows it.

Response

Successful Response

idstring required

The unique ID of the order.

player_idstring required

The unique identifier for the player who placed the order.

amountinteger required

The amount of the order in minor currency units.

currency'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' | 'RP' | 'VC' required
amount_usdinteger nullable

The amount of the order in USD cents. Before payment it is an estimate converted from the order currency and may change once the order is paid.

emailstring nullable

The player's email address.

locale'cs' | 'de' | 'en' | 'es' | 'fr' | 'fr-CA' | 'hi' | 'id' | 'it' | 'ja' | 'ko' | 'ms' | 'nl' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ru' | 'sv' | 'th' | 'tr' | 'uk' | 'vi' | 'zh' | 'zh-Hant'

Language codes according to ISO 639-1.

countrystring nullable

The two-letter country code (ISO 3166-1 alpha-2) of the order.

ip_addressstring nullable

The IP address of the player who placed the order.

payment_numberstring nullable

The payment number associated with the order.

status'created' | 'captured' | 'paid' | 'canceled' | 'refunded' | 'refund_requested' | 'reattempted' | 'disputed' required
platform'any' | 'ios' | 'android' | 'other'
sales_channel'game_hub' | 'checkout' | 'android_sdk' | 'checkout_link' required
created_atinteger required

Order creation date in Unix epoch time.

opened_atinteger nullable

The date the player first opened the order's checkout page, in Unix epoch time (seconds).

Changes

  • 0ef278347679Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 1816e2044c07Revision changes
    • info

      added the optional property / to the response with the status