latestOpenAPI 3.1.02026-07-242470655.6 KB
5b9208270ed1
List Orders
get/sites/multiscreen/{site_name}/ecommerce/orders
Path parameters
site_namestring required
The unique identifier for the target site.
Query parameters
offsetinteger
Zero-based offset for elements (0..N)
limitinteger
The size of the page to be returned
sortstring
Property used to sort orders
directionstring
The sort direction, either "asc" or "desc"
Response
200
Example response
{
"results": [
{
"billing_address": {
"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"first_name": "string",
"full_name": "string",
"last_name": "string",
"phone": "string",
"postal_code": "string",
"region": "string",
"street_name": "string",
"street_number": "string",
"sub_locality": "string"
},
"cancellation_reason": "string",
"cancelled": "2024-12-11T18:28:17.853Z",
"created": "2024-12-11T18:28:17.853Z",
"customer_accepts_marketing": true,
"discounts": [
{
"id": "string",
"name": "string",
"type": "string"
}
],
"email": "string",
"external_id": "string",
"id": "string",
"invoice_number": "string",
"ip_address": "string",
"items": [
{
"external_product_id": "string",
"external_variation_id": "string",
"id": "string",
"image": "string",
"metadata": "string",
"name": "string",
"options": [
{
"name": "string",
"value": "string"
}
],
"product_id": "string",
"shippable": true,
"sku": "string",
"variation_id": "string"
}
],
"metadata": "string",
"mode": "LIVE",
"payment": {
"card_brand": "NULL",
"confirmed_method": {
"details": "string",
"display_name": "string",
"gateway": "NONE",
"icon": "string",
"instructions": "string",
"name": "UNKNOWN"
},
"currency": "string",
"status": "PAID",
"transaction_id": "string"
},
"refunds": [
{
"created": "2024-12-11T18:28:17.853Z",
"currency": "string",
"id": "string",
"items": [
{
"id": "string",
"taxes": [
{
"id": "string",
"name": "string",
"provider": "BUILT_IN"
}
]
}
],
"order_id": "string",
"reason": "string",
"tax_provider": {
"avalara_reference_id": "string",
"provider": "BUILT_IN"
},
"taxes": [
{
"id": "string",
"name": "string",
"provider": "BUILT_IN"
}
],
"transaction_id": "string"
}
],
"shipping_address": {
"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"first_name": "string",
"full_name": "string",
"last_name": "string",
"phone": "string",
"postal_code": "string",
"region": "string",
"street_name": "string",
"street_number": "string",
"sub_locality": "string"
},
"shipping_instructions": "string",
"shipping_method": {
"name": "string"
},
"source": "CHECKOUT",
"status": "IN_PROGRESS",
"taxes": [
{
"name": "string"
}
],
"tracking_number": "string",
"tracking_url": "string",
"user_agent": "string"
}
]
}