Orders List

The Order list endpoint shows the general points of the order in the Customer panel.

GET https://example.com/orders?<yourEmailParameter>=$EmailAddress

Parameters

NameRequiredDescription
$EmailAddressYesThe email address of the customer

Response body

{
    "orders":
    [
        {
            "order_number": "CMO1234",
            "list_view": {
                "order_number": "CMO1234",
                "date": "29-01-2021 12:34",
                "status": "In progress"
            }
        }
    ]
}                           

Response body when customer has no order

{
    "orders":
    []
}                           

Response schema

NameTypeRequiredDescription
ordersArrayYesThe parent object to store all order_number objects in
order_numberStringYesThe number of the order which is also used as parameter for the Order details endpoint.
list_viewObjectYesInside list_view you can add custom fields to show information per order in the panel
custom_fieldStringNoThis variable is placed inside list_view. You can rename the key and the value to anything you'd like -- as long as the value is returned in a string form

Did this page help you?