Orders List

GET /orders/list

The /orders/list endpoint retrieves a comprehensive list of all orders placed within the Fungies.io platform. It enables developers to access detailed order information while supporting optional filtering and pagination for efficient data retrieval.

Request Method: GET

Endpoint URL: https://api.fungies.io/v0/orders/list

Headers: x-fngs-public-key: <api-key>

Example: Authorization: x-fngs-public-key: <api-key>

Note: This endpoint requires an API key for authentication. Refer to this guide to generate your API key.

Query Parameters

The query parameters are provided for the "List orders" API endpoint are as follows:

  • orderDirection (string): Specifies the sorting order of the returned list. Available options are: ASC, DESC.

  • skip (number | null): Specifies the number of records to skip from the beginning of the result set. Useful for pagination. Required range: 0 <= x <= 1.7976931348623157e+308

  • take (number | null): Defines the number of records to retrieve in the response. Helps in limiting the result set for pagination. Required range: 0 <= x <= 1.7976931348623157e+308

  • archived (string): Filters the orders by their archive status.

  • withArchived (string): Includes archived orders in the response when specified.

  • returnCount (string): Indicates whether to return the count of matching orders.

  • term (string): Allows filtering orders based on a search term.

  • ids (string): Filters the orders by a list of specific order IDs.

  • number (string): Filters orders based on the order number.

  • userId (string): Filters orders associated with a specific user ID.

  • subscriptionId (string): Filters orders linked to a particular subscription ID.

  • statuses (string): Filters orders based on their status. Available options include: PENDING, PAID, FAILED, UNPAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, EXPIRED.

  • types (string): Filters orders based on their type. Available options include: one_time, subscription_initial, subscription_update, subscription_interval, claim_free.

  • valueFrom (number | null): Filters orders with a value greater than or equal to the specified amount. Required range: -1.7976931348623157e+308 <= x <= 1.7976931348623157e+308

  • valueTo (number | null): Filters orders with a value less than or equal to the specified amount. Required range: -1.7976931348623157e+308 <= x <= 1.7976931348623157e+308

  • currency (string): Filters orders by the currency in which they were processed. The available options include a comprehensive list of global currencies: AFN (Afghanistan), ALL (Albania), DZD (Algeria), AOA (Angola), ARS (Argentina), AMD (Armenia), AWG (Aruba), AUD (Australia), AZN (Azerbaijan), BSD (Bahamas), BDT (Bangladesh), BBD (Barbados), BZD (Belize), BMD (Bermuda), BOB (Bolivia), BAM (Bosnia and Herzegovina), BWP (Botswana), BRL (Brazil), BHD (Bahrain), GBP (United Kingdom), BND (Brunei), BGN (Bulgaria), BIF (Burundi), BYN (Belarus), KHR (Cambodia), CAD (Canada), CVE (Cape Verde), KYD (Cayman Islands), KWD (Kuwait), XAF (Central African CFA), XPF (CFP Franc), CLP (Chile), CNY (China), COP (Colombia), KMF (Comoros), CDF (Congo - Kinshasa), CRC (Costa Rica), HRK (Croatia), CZK (Czech Republic), DKK (Denmark), DJF (Djibouti), DOP (Dominican Republic), XCD (East Caribbean Dollar), EGP (Egypt), ETB (Ethiopia), EUR (Eurozone), FKP (Falkland Islands), FJD (Fiji), GMD (Gambia), GEL (Georgia), GIP (Gibraltar), GTQ (Guatemala), GNF (Guinea), GYD (Guyana), HTG (Haiti), HNL (Honduras), HKD (Hong Kong), HUF (Hungary), ISK (Iceland), INR (India), IDR (Indonesia), ILS (Israel), JMD (Jamaica), JPY (Japan), JOD (Jordan), KZT (Kazakhstan), KES (Kenya), KGS (Kyrgyzstan), LAK (Laos), LBP (Lebanon), LSL (Lesotho), LRD (Liberia), MOP (Macau), MKD (North Macedonia), MGA (Madagascar), MWK (Malawi), MYR (Malaysia), MVR (Maldives), MRO (Mauritania), MUR (Mauritius), MXN (Mexico), MDL (Moldova), MNT (Mongolia), MAD (Morocco), MZN (Mozambique), MMK (Myanmar), NAD (Namibia), NPR (Nepal), ANG (Netherlands Antilles), TWD (Taiwan), NZD (New Zealand), NIO (Nicaragua), NGN (Nigeria), NOK (Norway), OMR (Oman), PKR (Pakistan), PAB (Panama), PGK (Papua New Guinea), PYG (Paraguay), PEN (Peru), PHP (Philippines), PLN (Poland), QAR (Qatar), RON (Romania), RUB (Russia), RWF (Rwanda), SHP (Saint Helena), SVC (El Salvador), WST (Samoa), STD (São Tomé and Príncipe), SAR (Saudi Arabia), RSD (Serbia), SCR (Seychelles), SLL (Sierra Leone), SGD (Singapore), SBD (Solomon Islands), SOS (Somalia), ZAR (South Africa), KRW (South Korea), LKR (Sri Lanka), SRD (Suriname), SZL (Eswatini), SEK (Sweden), CHF (Switzerland), TJS (Tajikistan), TZS (Tanzania), THB (Thailand), TND (Tunisia), TOP (Tonga), TTD (Trinidad and Tobago), TRY (Turkey), UGX (Uganda), UAH (Ukraine), AED (United Arab Emirates), UYU (Uruguay), USD (United States), UZS (Uzbekistan), VUV (Vanuatu), VEF (Venezuela), VND (Vietnam), XOF (West African CFA), YER (Yemen), ZMW (Zambia), SLE (Sierra Leone).

  • country (string): Filters orders by country code from a predefined list of global country codes. The available options include a comprehensive list of country codes representing various countries and regions worldwide. AF (Afghanistan), AX (Aland Islands), AL (Albania), DZ (Algeria), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua and Barbuda), AR (Argentina), AM (Armenia), AW (Aruba), AU (Australia), AT (Austria), AZ (Azerbaijan), BS (Bahamas), BH (Bahrain), BD (Bangladesh), BB (Barbados), BY (Belarus), BE (Belgium), BZ (Belize), BJ (Benin), BM (Bermuda), BT (Bhutan), BO (Bolivia), BA (Bosnia and Herzegovina), BW (Botswana), BV (Bouvet Island), BR (Brazil), IO (British Indian Ocean Territory), VG (British Virgin Islands), BN (Brunei), BG (Bulgaria), BF (Burkina Faso), BI (Burundi), KH (Cambodia), CM (Cameroon), CA (Canada), CV (Cape Verde), BQ (Caribbean Netherlands), KY (Cayman Islands), CF (Central African Republic), TD (Chad), CL (Chile), CN (China), CO (Colombia), KM (Comoros), KM (Congo - Brazzaville), CD (Congo - Kinshasa), CK (Cook Islands), CR (Costa Rica), CI (Côte d’Ivoire), HR (Croatia), CW (Curaçao), CY (Cyprus), CZ (Czechia), DK (Denmark), DJ (Djibouti), DM (Dominica), DO (Dominican Republic), EC (Ecuador), EG (Egypt), SV (El Salvador), GQ (Equatorial Guinea), ER (Eritrea), EE (Estonia), SZ (Eswatini), ET (Ethiopia), FK (Falkland Islands), FO (Faroe Islands), FJ (Fiji), FI (Finland), FR (France), GF (French Guiana), PF (French Polynesia), TF (French Southern Territories), GA (Gabon), GM (Gambia), GE (Georgia), DE (Germany), GH (Ghana), GI (Gibraltar), GR (Greece), GL (Greenland), GD (Grenada), GP (Guadeloupe), GU (Guam), GT (Guatemala), GG (Guernsey), GN (Guinea), GW (Guinea-Bissau), GY (Guyana), HT (Haiti), HN (Honduras), HK (Hong Kong), HU (Hungary), IS (Iceland), IN (India), ID (Indonesia), IQ (Iraq), IE (Ireland), IM (Isle of Man), IL (Israel), IT (Italy), JM (Jamaica), JP (Japan), JE (Jersey), JO (Jordan), KZ (Kazakhstan), KE (Kenya), KI (Kiribati), XK (Kosovo), KW (Kuwait), KG (Kyrgyzstan), LA (Laos), LV (Latvia), LB (Lebanon), LS (Lesotho), LR (Liberia), LY (Libya), LI (Liechtenstein), LT (Lithuania), LU (Luxembourg), MO (Macau), MG (Madagascar), MW (Malawi), MY (Malaysia), MV (Maldives), ML (Mali), MT (Malta), MQ (Martinique), MR (Mauritania), MU (Mauritius), YT (Mayotte), MX (Mexico), MD (Moldova), MC (Monaco), MN (Mongolia), ME (Montenegro), MS (Montserrat), MA (Morocco), MZ (Mozambique), MM (Myanmar), NA (Namibia), NP (Nauru), NP (Nepal), NL (Netherlands), NC (New Caledonia), NZ (New Zealand), NI (Nicaragua), NE (Niger), NG (Nigeria), NU (Niue), NF (Norfolk Island), KP (North Korea), MK (North Macedonia), MP (Northern Mariana Islands), NO (Norway), OM (Oman), PK (Pakistan), PS (Palestine), PA (Panama), PG (Papua New Guinea), PY (Paraguay), PE (Peru), PH (Philippines), PN (Pitcairn Islands), PL (Poland), PT (Portugal), PR (Puerto Rico), QA (Qatar), RO (Romania), RU (Russia), RW (Rwanda), WS (Samoa), SM (San Marino), ST (São Tomé and Príncipe), SA (Saudi Arabia), SN (Senegal), RS (Serbia), SC (Seychelles), SL (Sierra Leone), SG (Singapore), SX (Sint Maarten), SK (Slovakia), SI (Slovenia), SB (Solomon Islands), SO (Somalia), ZA (South Africa), KR (South Korea), ES (Spain), LK (Sri Lanka), BL (Saint Barthélemy), SH (Saint Helena), KN (Saint Kitts and Nevis), LC (Saint Lucia), MF (Saint Martin), PM (Saint Pierre and Miquelon), VC (Saint Vincent and the Grenadines), SD (Sudan), SR (Suriname), SJ (Svalbard and Jan Mayen), SE (Sweden), CH (Switzerland), SY (Syria), TW (Taiwan), TJ (Tajikistan), TZ (Tanzania), TH (Thailand), TL (Timor-Leste), TG (Togo), TK (Tokelau), TK (Tonga), TT (Trinidad and Tobago), TN (Tunisia), TR (Turkey), TM (Turkmenistan), TC (Turks and Caicos Islands), TV (Tuvalu), UG (Uganda), UA (Ukraine), AE (United Arab Emirates), GB (United Kingdom), US (United States), UY (Uruguay), UZ (Uzbekistan), VU (Vanuatu), VA (Vatican City), VE (Venezuela), VN (Vietnam), WF (Wallis and Futuna), EH (Western Sahara), YE (Yemen), ZM (Zambia), ZM (Zimbabwe).

  • createdFrom (integer | null): Filters orders created on or after a specific timestamp. The value must be within the range 0 <= x <= 9007199254740991.

  • createdTo (integer | null): Filters orders created on or before a specific timestamp. The value must also be within the range 0 <= x <= 9007199254740991.

  • orderBy (string): Specifies the sorting criteria for the orders. Available options include: createdAt, orderNumber, value

Responses Body

Response (200) - Success

  1. status (string) required: Indicates the response status of the API call. The allowed value is success, meaning the request was processed successfully.

  2. data (object) required: The data is an object that contains the following children:

— data.orders (array of objects) required: Contains a list of order objects with the following attributes:

  • data.orders.id (string) required: A unique identifier for each order.

  • data.orders.number (string) required: The order number assigned to the transaction.

  • data.orders.status (enum<string>) required: The current status of the order. Available options are: PENDING, FAILED, UNPAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, EXPIRED

  • data.orders.createdAt (integer) required: The timestamp indicating when the order was created. Required range: 0 <= x <= 9007199254740991

  • data.orders.userId (string) required: The unique identifier of the user who placed the order.

  • data.orders.orderNumber (string) required: The reference number assigned to the order for tracking purposes.

  • data.orders.object (enum<string>) default order: Defines the type of object returned in the response. Available options: order

  • data.orders.value (integer | null) default 0 : The total value of the order. Required range: -9007199254740991 <= x <= 9007199254740991

  • data.orders.tax (integer | null) default: 0: The tax amount is applied to the order. Required range: -9007199254740991 <= x <= 9007199254740991

  • data.orders.fee (integer | null) default:0 : The additional fee applied to the order (e.g., service or processing fee). Required range: -9007199254740991 <= x <= 9007199254740991

  • data.orders.totalItems (integer | null) default:0: The total number of items included in the order. Required range: 0 <= x <= 9007199254740991

  • data.orders.country (string | null): The country associated with the order is represented by its country code.

  • data.orders.currency (enum<string> | null): The currency in which the order was placed. Available options: AFN (Afghanistan), ALL (Albania), DZD (Algeria), AOA (Angola), ARS (Argentina), AMD (Armenia), AWG (Aruba), AUD (Australia), AZN (Azerbaijan), BSD (Bahamas), BDT (Bangladesh), BBD (Barbados), BZD (Belize), BMD (Bermuda), BOB (Bolivia), BAM (Bosnia and Herzegovina), BWP (Botswana), BRL (Brazil), BHD (Bahrain), GBP (United Kingdom), BND (Brunei), BGN (Bulgaria), BIF (Burundi), BYN (Belarus), KHR (Cambodia), CAD (Canada), CVE (Cape Verde), KYD (Cayman Islands), KWD (Kuwait), XAF (Central African CFA), XPF (CFP Franc), CLP (Chile), CNY (China), COP (Colombia), KMF (Comoros), CDF (Congo - Kinshasa), CRC (Costa Rica), HRK (Croatia), CZK (Czech Republic), DKK (Denmark), DJF (Djibouti), DOP (Dominican Republic), XCD (East Caribbean Dollar), EGP (Egypt), ETB (Ethiopia), EUR (Eurozone), FKP (Falkland Islands), FJD (Fiji), GMD (Gambia), GEL (Georgia), GIP (Gibraltar), GTQ (Guatemala), GNF (Guinea), GYD (Guyana), HTG (Haiti), HNL (Honduras), HKD (Hong Kong), HUF (Hungary), ISK (Iceland), INR (India), IDR (Indonesia), ILS (Israel), JMD (Jamaica), JPY (Japan), JOD (Jordan), KZT (Kazakhstan), KES (Kenya), KGS (Kyrgyzstan), LAK (Laos), LBP (Lebanon), LSL (Lesotho), LRD (Liberia), MOP (Macau), MKD (North Macedonia), MGA (Madagascar), MWK (Malawi), MYR (Malaysia), MVR (Maldives), MRO (Mauritania), MUR (Mauritius), MXN (Mexico), MDL (Moldova), MNT (Mongolia), MAD (Morocco), MZN (Mozambique), MMK (Myanmar), NAD (Namibia), NPR (Nepal), ANG (Netherlands Antilles), TWD (Taiwan), NZD (New Zealand), NIO (Nicaragua), NGN (Nigeria), NOK (Norway), OMR (Oman), PKR (Pakistan), PAB (Panama), PGK (Papua New Guinea), PYG (Paraguay), PEN (Peru), PHP (Philippines), PLN (Poland), QAR (Qatar), RON (Romania), RUB (Russia), RWF (Rwanda), SHP (Saint Helena), SVC (El Salvador), WST (Samoa), STD (São Tomé and Príncipe), SAR (Saudi Arabia), RSD (Serbia), SCR (Seychelles), SLL (Sierra Leone), SGD (Singapore), SBD (Solomon Islands), SOS (Somalia), ZAR (South Africa), KRW (South Korea), LKR (Sri Lanka), SRD (Suriname), SZL (Eswatini), SEK (Sweden), CHF (Switzerland), TJS (Tajikistan), TZS (Tanzania), THB (Thailand), TND (Tunisia), TOP (Tonga), TTD (Trinidad and Tobago), TRY (Turkey), UGX (Uganda), UAH (Ukraine), AED (United Arab Emirates), UYU (Uruguay), USD (United States), UZS (Uzbekistan), VUV (Vanuatu), VEF (Venezuela), VND (Vietnam), XOF (West African CFA), YER (Yemen), ZMW (Zambia), SLE (Sierra Leone).

  • data.orders.currencyDecimals (integer | null): The number of decimal places supported by the specified currency. Required range: -9007199254740991 <= x <= 9007199254740991

— data.orders.user (object | null): This is the user details object; it will have the children listed below:

  • data.orders.user.id (string) required: A unique identifier for the user who placed the order.

  • data.orders.user.object (enum<string>) default: user: Defines the type of object returned in the response. Available options: user

  • data.orders.user.username (string | null): The username of the user associated with the order, if available.

— data.count (number | null) required: Represents the total number of orders that match the request criteria. Required range: -1.7976931348623157e+308 <= x <= 1.7976931348623157e+308

Response (400) - Error

  1. status (string) required: Represents the status of the response. The allowed value is an error.

  2. error (object) required: Contains details about the error, including the following child attributes:

  • error.message (string) required: A descriptive message explaining the reason for the error.

Example of Endpoint Usage

Examples of how to use the endpoint across different programming languages.

  1. cURL:

curl --request GET \
  --url https://api.fungies.io/v0/orders/list \
  --header 'x-fngs-public-key: <api-key>'

  1. Python:

import requests

url = "https://api.fungies.io/v0/orders/list"

headers = {"x-fngs-public-key": "<api-key>"}

response = requests.request("GET", url, headers=headers)

print(response.text)

  1. JavaScript:

const options = {method: 'GET', headers: {'x-fngs-public-key': '<api-key>'}};

fetch('https://api.fungies.io/v0/orders/list', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

  1. PHP:

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fungies.io/v0/orders/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-fngs-public-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

  1. Go:

package main

import (
"fmt"
"net/http"
"io/ioutil"
)

func main() {

url := "https://api.fungies.io/v0/orders/list"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-fngs-public-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

fmt.Println(res)
fmt.Println(string(body))

}

  1. JAVA:

HttpResponse<String> response = Unirest.get("https://api.fungies.io/v0/orders/list")
  .header("x-fngs-public-key", "<api-key>")
  .asString();

Example of a Successful Response (200)

200 OK – The list of orders is successfully retrieved.

{
  "status": "<string>",
  "data": {
    "orders": [
      {
        "object": "order",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "number": "<string>",
        "status": "PENDING",
        "value": 0,
        "tax": 0,
        "fee": 0,
        "totalItems": 0,
        "country": null,
        "currency": null,
        "currencyDecimals": null,
        "createdAt": 4503599627370495,
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "user": null,
        "orderNumber": "<string>"
      }
    ],
    "count": 0
  }
}

Example of Error Response (400)

400 Bad Request – Invalid query parameters.

{
  "status": "error",
  "error": {
    "message": "Sample error message"
  }
}

PreviousManaging Orders through APINextCancel Order

Last updated