List Orders

GET

/partner/v1/orders

Paginated orders of the store, read from Yamm's copy (never calls the e-commerce platform). Scope: orders:read.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠422Validation failed

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

curl --location '/partner/v1/orders?page=1&per_page=20' \
--header 'X-Store-Id: {{partner_store_id}}' \
--header 'Accept-Language: en' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "records": [
            {
                "id": "string",
                "number": "string",
                "platform": "string",
                "status": "string",
                "payment_status": "string",
                "shipment_status": "string",
                "currency": "string",
                "sub_total": 0,
                "tax": 0,
                "shipping": 0,
                "discount": 0,
                "total": 0,
                "delivered_at": "2019-08-24T14:15:22.123Z",
                "purchased_at": "2019-08-24T14:15:22.123Z"
            }
        ],
        "total": 0,
        "page": 0,
        "limit": 0,
        "total_pages": 0
    }
}

Get Store

Get Order