---
title: "Get Orders"
method: GET
path: "/v1/orders"
tags: ["Orders"]
---

# Get Orders

`GET /v1/orders`

Returns a list of orders.

## Query parameters

- `limit` integer — A limit on the number of objects to be returned
- `offset` integer — The number of objects to skip

## Response `200`

Successful Response

- Order[]
  - `id` string, required — The unique ID of the order.
  - `player_id` string, required — The unique identifier for the player who placed the order.
  - `amount` integer, required — The amount of the order in minor [currency units](https://docs.aghanim.com/currencies/).
  - `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
  - `email` string, 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.
  - `country` string, nullable — The two-letter country code (ISO 3166-1 alpha-2) of the order.
  - `ip_address` string, nullable — The IP address of the player who placed the order.
  - `payment_number` string, nullable — The payment number associated with the order.
  - `status` 'created' | 'captured' | 'paid' | 'canceled' | 'refunded' | 'refund_requested' | 'reattempted' | 'disputed', required — An enumeration.
  - `items` Item[], required — The list of items included in the order.
    - `id` string, required — The unique ID of the item.
    - `sku` string, required — Stock Keeping Unit (SKU) identifier.
    - `name` string, required — The name of the item.
    - `source` 'order' | 'bonus' | 'bundle' | 'coupon' | 'lootbox' | 'free_item' | 'liveops' | 'daily_reward' | 'loyalty_reward' | 'progression_program' | 'rolling_offer' | 'pick_one_offer', required
    - `description` string, nullable — The description of the item
    - `image_url` string — The URL of the image for the item
    - `quantity` integer, required — The quantity of the item.
    - `nested_items` Item[] — Nested items of the bundle.
  - `coupons` Coupon[] — The list of coupons applied to the order.
    - `id` string, required — The unique ID of the coupon.
    - `code` string, required — The coupon code.
    - `name` string, required — The name of the coupon.
    - `type` 'bonus' | 'discount' | 'free_item' | 'vc' | 'non_benefit' | 'discount_fixed' | 'discount_reward_point', required — An enumeration.
    - `discount_percent` integer — Discount percent for `discount` coupons.
    - `bonus_percent` integer — Bonus percent for `bonus` coupons.
    - `bonus_fixed` integer — Fixed bonus quantity for `bonus` coupons.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/aghanim/apis/aghanim-server-to-server-api.md) · [All operations](https://skmtc.net/aghanim/apis/aghanim-server-to-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aghanim/aghanim-server-to-server-api/versions/0c1b4ac1865b/schema)