Get Order

GET

/partner/v1/orders/{id}

One order by its external (platform or POS) id, with each line's returned, in-progress and still-returnable quantities. Scope: orders:read.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠404Not found

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

curl --location '/partner/v1/orders/' \
--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": {
        "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",
        "items": [
            {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "line_id": "string",
                "product_id": "string",
                "variant_id": "string",
                "name": "string",
                "sku": "string",
                "quantity": 0,
                "unit_price": 0,
                "discount": 0,
                "tax": 0,
                "total": 0,
                "returned_quantity": 0,
                "in_progress_quantity": 0,
                "returnable_quantity": 0
            }
        ]
    }
}

List Orders