Orders

List orders

Retrieve a paginated list of orders with powerful filtering options. Orders represent purchases made by customers, including one-time purchases, subscription initiation, and free product claims. Subscription renewal payments are tracked as separate payment objects, not orders. Results are sorted by creation date (newest first) by default.

Authorization

Public key
x-fngs-public-key<token>

In: header

Query Parameters

orderDirection?string

GET /v0/orders/list Parameter

Value in

  • "ASC"
  • "DESC"
skip?|

GET /v0/orders/list Parameter

Formatdouble
Range0 <= value <= 1.7976931348623157e+308
take?|

GET /v0/orders/list Parameter

Formatdouble
Range0 <= value <= 1.7976931348623157e+308
archived?|

GET /v0/orders/list Parameter

withArchived?|

GET /v0/orders/list Parameter

returnCount?|

GET /v0/orders/list Parameter

term?string

GET /v0/orders/list Parameter

ids?array<>

GET /v0/orders/list Parameter

number?string

GET /v0/orders/list Parameter

Match^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$
userId?string

GET /v0/orders/list Parameter

Formatuuid
subscriptionId?string

GET /v0/orders/list Parameter

subscriptionNumber?string

GET /v0/orders/list Parameter

Match^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$
checkoutIds?unknown

Filter by checkout (checkoutElement) UUID(s). Pass a single checkoutId or multiple checkoutIds — returns orders/payments that originated from any of them. Single value: ?checkoutIds=. Multiple: ?checkoutIds=&checkoutIds=.

Formatarray (preprocessed)
customFields?string

Filter by custom field values. Pass a JSON object of fieldId/value pairs, e.g. {"playerName":"john_doe"}. Matches records that have a cart item whose custom fields contain all of the provided pairs (exact match). The JSON must be URL-encoded in the query string.

statuses?array<>

GET /v0/orders/list Parameter

types?array<>

GET /v0/orders/list Parameter

valueFrom?|

GET /v0/orders/list Parameter

Formatdouble
Range-1.7976931348623157e+308 <= value <= 1.7976931348623157e+308
valueTo?|

GET /v0/orders/list Parameter

Formatdouble
Range-1.7976931348623157e+308 <= value <= 1.7976931348623157e+308
currency?string

GET /v0/orders/list Parameter

Value in

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

GET /v0/orders/list Parameter

Value in

  • "AF"
  • "AX"
  • "AL"
  • "DZ"
  • "AD"
  • "AO"
  • "AI"
  • "AQ"
  • "AG"
  • "AR"
  • "AM"
  • "AW"
  • "AU"
  • "AT"
  • "AZ"
  • "BS"
  • "BH"
  • "BD"
  • "BB"
  • "BY"
  • "BE"
  • "BZ"
  • "BJ"
  • "BM"
  • "BT"
  • "BO"
  • "BA"
  • "BW"
  • "BV"
  • "BR"
  • "IO"
  • "VG"
  • "BN"
  • "BG"
  • "BF"
  • "BI"
  • "KH"
  • "CM"
  • "CA"
  • "CV"
  • "BQ"
  • "KY"
  • "CF"
  • "TD"
  • "CL"
  • "CN"
  • "CO"
  • "KM"
  • "CG"
  • "CD"
  • "CK"
  • "CR"
  • "CI"
  • "HR"
  • "CW"
  • "CY"
  • "CZ"
  • "DK"
  • "DJ"
  • "DM"
  • "DO"
  • "EC"
  • "EG"
  • "SV"
  • "GQ"
  • "ER"
  • "EE"
  • "SZ"
  • "ET"
  • "FK"
  • "FO"
  • "FJ"
  • "FI"
  • "FR"
  • "GF"
  • "PF"
  • "TF"
  • "GA"
  • "GM"
  • "GE"
  • "DE"
  • "GH"
  • "GI"
  • "GR"
  • "GL"
  • "GD"
  • "GP"
  • "GU"
  • "GT"
  • "GG"
  • "GN"
  • "GW"
  • "GY"
  • "HT"
  • "HN"
  • "HK"
  • "HU"
  • "IS"
  • "IN"
  • "ID"
  • "IQ"
  • "IE"
  • "IM"
  • "IL"
  • "IT"
  • "JM"
  • "JP"
  • "JE"
  • "JO"
  • "KZ"
  • "KE"
  • "KI"
  • "XK"
  • "KW"
  • "KG"
  • "LA"
  • "LV"
  • "LB"
  • "LS"
  • "LR"
  • "LY"
  • "LI"
  • "LT"
  • "LU"
  • "MO"
  • "MG"
  • "MW"
  • "MY"
  • "MV"
  • "ML"
  • "MT"
  • "MQ"
  • "MR"
  • "MU"
  • "YT"
  • "MX"
  • "MD"
  • "MC"
  • "MN"
  • "ME"
  • "MS"
  • "MA"
  • "MZ"
  • "MM"
  • "NA"
  • "NR"
  • "NP"
  • "NL"
  • "NC"
  • "NZ"
  • "NI"
  • "NE"
  • "NG"
  • "NU"
  • "MK"
  • "NO"
  • "OM"
  • "PK"
  • "PS"
  • "PA"
  • "PG"
  • "PY"
  • "PE"
  • "PH"
  • "PN"
  • "PL"
  • "PT"
  • "PR"
  • "QA"
  • "RE"
  • "RO"
  • "RU"
  • "RW"
  • "WS"
  • "SM"
  • "ST"
  • "SA"
  • "SN"
  • "RS"
  • "SC"
  • "SL"
  • "SG"
  • "SX"
  • "SK"
  • "SI"
  • "SB"
  • "SO"
  • "ZA"
  • "GS"
  • "KR"
  • "SS"
  • "ES"
  • "LK"
  • "BL"
  • "SH"
  • "KN"
  • "LC"
  • "MF"
  • "PM"
  • "VC"
  • "SD"
  • "SR"
  • "SJ"
  • "SE"
  • "CH"
  • "TW"
  • "TJ"
  • "TZ"
  • "TH"
  • "TL"
  • "TG"
  • "TK"
  • "TO"
  • "TT"
  • "TN"
  • "TR"
  • "TM"
  • "TC"
  • "TV"
  • "UG"
  • "UA"
  • "AE"
  • "GB"
  • "US"
  • "UY"
  • "UZ"
  • "VU"
  • "VA"
  • "VE"
  • "VN"
  • "WF"
  • "EH"
  • "YE"
  • "ZM"
  • "ZW"
createdFrom?|

GET /v0/orders/list Parameter

Formatint64
Range0 <= value <= 9007199254740991
createdTo?|

GET /v0/orders/list Parameter

Formatint64
Range0 <= value <= 9007199254740991
orderBy?string

GET /v0/orders/list Parameter

Value in

  • "createdAt"
  • "orderNumber"
  • "value"

Response Body

application/json

application/json

GET
/v0/orders/list
curl -X GET "https://example.com/v0/orders/list"
{  "status": "success",  "data": {    "orders": [      {        "object": "order",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "number": "string",        "status": "PENDING",        "value": 0,        "tax": 0,        "fee": 0,        "totalItems": 0,        "country": null,        "currency": "AFN",        "currencyDecimals": null,        "createdAt": 0,        "userId": null,        "user": null,        "lastPaymentId": null,        "lastPaymentNumber": null,        "lastPayment": null,        "subscriptionId": null,        "subscription": null,        "checkoutId": null,        "orderNumber": "string"      }    ],    "count": -1.7976931348623157e+308  }}

Remove specific unsold key DELETE

Remove a specific unsold key from an offer by its ID. Only unsold keys can be removed. Sold keys cannot be deleted.

Get order details GET

Retrieve detailed information about a specific order by its ID or order number. Returns the full order object including associated user, cart items, subscription (if applicable), and payment details. For subscription orders, also returns the current subscription status.