Glue API: Retrieve customer orders

Last updated:
Edit on GitHub

This endpoint allows retrieving a customer’s orders.

Installation

For details on the modules that provide the API functionality and how to install them, see Install the Order Management Glue API.

Retrieve customer’s orders

To retrieve a customer’s orders, send the request:

GET /customers/{{customerId}}/orders

Note

Alternatively, you can retrieve all orders made by a customer through the /orders endpoint. For details, see Retrieving orders.

PATH PARAMETER DESCRIPTION
{{customerId}} Customer unique identifier to retrieve orders of. To get it, retrieve a customer or create a customer.

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string ✓ Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by authenticating as a customer.
STRING PARAMETER DESCRIPTION POSSIBLE VALUES
offset Offset of the order at which to begin the response. Works only together with page[limit]. To work correctly, the value should be devisable by the value of page[limit]. The default value is 0. From 0 to any.
limit Maximum number of entries to return. Works only together with page[offset]. The default value is 10. From 1 to any.

Response

Response sample: Retrieve a customer’s order 
{
    "data": [
        {
            "type": "orders",
            "id": "DE--1",
            "attributes": {
                "merchantReferences": [],
                "itemStates": [
                    "exported"
                ],
                "createdAt": "2021-04-28 14:29:50.871313",
                "currencyIsoCode": "EUR",
                "priceMode": "GROSS_MODE",
                "totals": {
                    "expenseTotal": 490,
                    "discountTotal": 0,
                    "taxTotal": 1116,
                    "subtotal": 6500,
                    "grandTotal": 6990,
                    "canceledTotal": 0,
                    "remunerationTotal": 0
                }
            },
            "links": {
                "self": "https://glue.mysprykershop.com/orders/DE--1?offset=20"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/customers/DE--1/orders?offset=20"
    }
}
ATTRIBUTE TYPE DESCRIPTION
merchantReferences Array Array of merchant references. A merchant reference assigned to every merchant.
itemStates Array State of the item in the order.
createdAt String Date and time when the order was created.
currencyIsoCode String ISO 4217 code of the currency that was selected when placing the order.
priceMode String Price mode that was active when placing the order. Possible values: NET_MODE—prices before tax. GROSS_MODE—prices after tax.
expenseTotal Integer Total amount of expenses (e.g., shipping costs).
discountTotal Integer Total amount of discounts applied.
taxTotal Integer Total amount of taxes paid.
subtotal Integer Subtotal of the order.
grandTotal Integer Grand total of the order.
canceledTotal Integer Total canceled amount.
remunerationTotal Integer Total sum of remuneration.

Possible errors

CODE REASON
001 Access token is invalid.
002 Access token is missing.
402 Customer with the specified ID was not found.
802 Request is unauthorized.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.