List all orders
Retrieves a paginated list of orders for the application. Supports optional search filtering by order reference or ID.
GET
/api/v1/{team_slug}/{app_slug}/orders- API
- Management
- OpenAPI
- management-api
- Updated
- Apr 26, 2026
management-api:GET:/api/v1/{team_slug}/{app_slug}/orders
Retrieves a paginated list of orders for the application. Supports optional search filtering by order reference or ID.
API ownership
- API family: Management API
- Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
- Do not use from: Browser-only storefront code or public clients.
- Guide route: /apis/management/latest
The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.
Operation
- Method:
GET - Path:
/api/v1/\{team_slug\}/\{app_slug\}/orders - Summary: List all orders
- Description: Retrieves a paginated list of orders for the application. Supports optional search filtering by order reference or ID.
- OpenAPI contract: management-api
- Operation ID: Not documented in the OpenAPI contract.
Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| app_slug | path | Yes | string | App slug |
| team_slug | path | Yes | string | Team slug |
| page | query | No | integer | Page number |
| per-page | query | No | integer | Items per page |
| search | query | No | string | Search query |
Request body
Not documented in the OpenAPI contract.
Responses
| Status | Description | Content |
|---|---|---|
| 200 | Orders retrieved successfully | application/json (object) |
| 401 | Unauthorized access | application/json (object) |
| 500 | Internal server error | application/json (object) |
200 - object
Order List
| Property | Type | Required | Details |
|---|---|---|---|
data | object[] | No | - |
success | boolean | No | - |
total | integer | No | - |
total_pages | integer | No | - |
Order
| Property | Type | Required | Details |
|---|---|---|---|
billing_address | object | No | - |
bonus_total | number | No | - |
country_code | string | No | - |
created_at | string | No | - |
currency_code | string | No | - |
discount_total | number | No | - |
discounts | object[] | No | - |
gift_card_total | number | No | - |
grand_total | number | No | - |
id | string | No | - |
language_code | string | No | - |
merchant_user | object | No | - |
order_lines | object[] | No | - |
payment_method | string | No | - |
payment_method_id | string | No | - |
payment_method_name | string | No | - |
reference | string | No | - |
session_id | string | No | - |
shipping_address | object | No | - |
shipping_methods | string[] | No | - |
shipping_total | number | No | - |
source | string | No | - |
sub_total | number | No | - |
tax_total | number | No | - |
updated_at | string | No | - |
user_content | object[] | No | - |
Order Address
| Property | Type | Required | Details |
|---|---|---|---|
address_type | string | No | - |
city | string | No | - |
country_code | string | No | - |
created_at | string | No | - |
email | string | No | - |
family_name | string | No | - |
given_name | string | No | - |
id | string | No | - |
postal_code | string | No | - |
state_or_province | string | No | - |
street_address | string | No | - |
street_address_2 | string | No | - |
telephone_number | string | No | - |
updated_at | string | No | - |
Order Discount
| Property | Type | Required | Details |
|---|---|---|---|
created_at | string | No | - |
discount_id | string | No | - |
id | string | No | - |
name | string | No | - |
order_id | string | No | - |
updated_at | string | No | - |
Merchant User Summary
| Property | Type | Required | Details |
|---|---|---|---|
email | string | No | - |
id | string | No | - |
name | string | No | - |
surname | string | No | - |
Order Line
| Property | Type | Required | Details |
|---|---|---|---|
base_price_amount | number | No | - |
created_at | string | No | - |
currency_code | string | No | - |
first_image_path | string | No | - |
id | string | No | - |
order_id | string | No | - |
product_id | string | No | - |
product_name | string | No | - |
product_number | string | No | - |
quantity | integer | No | - |
short_description | string | No | - |
tax_group_id | string | No | - |
total_discount_amount | number | No | - |
total_price_amount | number | No | - |
total_sale_price | number | No | - |
total_tax_amount | number | No | - |
updated_at | string | No | - |
variant_id | string | No | - |
variant_name | string | No | - |
variant_number | string | No | - |
Order User Content
| Property | Type | Required | Details |
|---|---|---|---|
content_type | string | No | - |
filename | string | No | - |
id | string | No | - |
url | string | No | - |
{
"data": [
{
"billing_address": {
"address_type": "string",
"city": "string",
"country_code": "string",
"created_at": "string",
"email": "string",
"family_name": "string",
"given_name": "string",
"id": "string",
"postal_code": "string",
"state_or_province": "string",
"street_address": "string",
"street_address_2": "string",
"telephone_number": "string",
"updated_at": "string"
},
"bonus_total": 0,
"country_code": "string",
"created_at": "string",
"currency_code": "string",
"discount_total": 0,
"discounts": [
{
"created_at": null,
"discount_id": null,
"id": null,
"name": null,
"order_id": null,
"updated_at": null
}
],
"gift_card_total": 0,
"grand_total": 0,
"id": "string",
"language_code": "string",
"merchant_user": {
"email": "string",
"id": "string",
"name": "string",
"surname": "string"
},
"order_lines": [
{
"base_price_amount": null,
"created_at": null,
"currency_code": null,
"first_image_path": null,
"id": null,
"order_id": null,
"product_id": null,
"product_name": null,
"product_number": null,
"quantity": null,
"short_description": null,
"tax_group_id": null,
"total_discount_amount": null,
"total_price_amount": null,
"total_sale_price": null,
"total_tax_amount": null,
"updated_at": null,
"variant_id": null,
"variant_name": null,
"variant_number": null
}
],
"payment_method": "string",
"payment_method_id": "string",
"payment_method_name": "string",
"reference": "string",
"session_id": "string",
"shipping_address": {
"address_type": "string",
"city": "string",
"country_code": "string",
"created_at": "string",
"email": "string",
"family_name": "string",
"given_name": "string",
"id": "string",
"postal_code": "string",
"state_or_province": "string",
"street_address": "string",
"street_address_2": "string",
"telephone_number": "string",
"updated_at": "string"
},
"shipping_methods": [
"string"
],
"shipping_total": 0,
"source": "string",
"sub_total": 0,
"tax_total": 0,
"updated_at": "string",
"user_content": [
{
"content_type": null,
"filename": null,
"id": null,
"url": null
}
]
}
],
"success": false,
"total": 0,
"total_pages": 0
}401 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}500 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}Contract identity
Use these fields to confirm you are implementing the intended endpoint contract.
- API family: Management API
- Method:
GET - Path:
/api/v1/\{team_slug\}/\{app_slug\}/orders - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Orders
- OpenAPI summary: List all orders