This endpoint allows you to retrieve a list of your orders from the Airalo Partners API. By using various filters, you can customize the results to match specific criteria. The access token, obtained from the "Request Access Token" endpoint, should be included in the request.For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ
Request
Query Params
include
string
optional
Optional. A comma-separated string to include related data in the response. Possible values are "sims", "user", and "status".
Example:
sims,user,status
filter[created_at]
string
optional
Optional. A string to filter orders by their creation date. Specify the date range using a dash (-) as a delimiter for correct parsing.
Example:
Y-m-d - Y-m-d
filter[code]
string
optional
Optional. Filter orders by their order code. This performs a like search using the format '%ORDER_CODE%'.
Example:
20221021-003188
filter[order_status]
string
optional
Optional. A string to filter orders by their status. Possible values could be obtained from the "Get Order Statuses List" endpoint, and currently limited to"completed", "failed", and "refunded".
Example:
completed
filter[iccid]
string
optional
Optional. Filter orders by the sim's ICCID. This performs a like search using the format '%SIM_ICCID%'.
Example:
891000000000001868
filter[description]
string
optional
Optional. A string to filter orders by their description. This performs a like search using the format '%DESCRIPTION%'.
Example:
Your order description
limit
string
optional
Optional. An integer specifying how many orders will be returned on each page.
Example:
50
page
string
optional
Optional. An integer specifying the pagination's current page.
Example:
1
Header Params
Accept
string
required
Example:
application/json
Authorization
string
required
Example:
Bearer {{token}}
Body Params multipart/form-data
object{0}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request GET '/v2/orders' \
--header'Accept: application/json' \
--header'Authorization: Bearer {{token}}'
Responses
🟠422Order List (422)
application/json
Body
data
object
required
limit
string
required
page
string
required
meta
object
required
message
string
required
Example
{"data":{"limit":"The limit must be an integer.","page":"The page must be an integer."},"meta":{"message":"the parameter is invalid"}}
