Skip to content
Elara One docs
Orders

Get an order

GET
/v1/orders/{reference}

Authorization

tenantKeybearerAuth
headerX-Tenant-Key<token>

The public store key (pk_live_…). Required on every call.

headerAuthorizationBearer <token>

A customer token from POST /v1/auth/login, or a merchant API key, on routes that need one.

Path Parameters

reference*string

Header Parameters

X-Client-IP?string

Optional. IP address of the shopper (one IPv4/IPv6, no port, no list). Honoured only together with a valid X-Tenant-Secret; ignored otherwise. Used for rate limits and recorded with form submissions.

X-Tenant-Secret?string

Optional here. Server secret of the store: server-to-server only, never from a browser. Enables X-Client-IP.

Response Body

Success.

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.elaraone.app/api/v1/orders/string' \  -H 'X-Tenant-Key: pk_live_…' \  -H 'X-Tenant-Secret: your-server-secret'
Example Response
{  "data": {    "id": 0,    "reference": "string",    "status": "string",    "status_label": "string",    "placed_at": "string",    "dispatched_at": "string",    "delivered_at": "string",    "cancelled_at": "string",    "lines": [      {        "id": 0,        "type": "string",        "description": "string",        "identifier": "string",        "option": "string",        "quantity": 0,        "unit_price": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "sub_total": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "discount_total": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "discounts": [          {            "id": 0,            "amount": {              "amount": 0,              "currency": "string",              "formatted": "string"            }          }        ],        "tax_total": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "total": {          "amount": 0,          "currency": "string",          "formatted": "string"        }      }    ],    "shipping_method": {      "identifier": "string",      "name": "string",      "kind": "collect",      "collection_location": {        "id": 0,        "name": "string",        "line_one": "string",        "line_two": "string",        "city": "string",        "state": "string",        "postcode": "string",        "country": "string",        "instructions": "string",        "opening_hours": {          "property1": "string",          "property2": "string"        }      }    },    "shipments": [      {        "carrier": "string",        "carrier_label": "string",        "service": "string",        "tracking_number": "string",        "tracking_url": "string",        "dispatched_at": "string"      }    ],    "addresses": {      "shipping": {        "title": "string",        "first_name": "string",        "last_name": "string",        "company_name": "string",        "line_one": "string",        "line_two": "string",        "line_three": "string",        "city": "string",        "state": "string",        "postcode": "string",        "country_id": 0,        "delivery_instructions": "string",        "contact_email": "string",        "contact_phone": "string"      },      "billing": {        "title": "string",        "first_name": "string",        "last_name": "string",        "company_name": "string",        "line_one": "string",        "line_two": "string",        "line_three": "string",        "city": "string",        "state": "string",        "postcode": "string",        "country_id": 0,        "delivery_instructions": "string",        "contact_email": "string",        "contact_phone": "string"      }    },    "sub_total": {      "amount": 0,      "currency": "string",      "formatted": "string"    },    "discount_total": {      "amount": 0,      "currency": "string",      "formatted": "string"    },    "coupon_code": "string",    "discounts": [      {        "id": 0,        "name": "string",        "label": "string",        "kind": "string",        "coupon": "string",        "amount": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "items_amount": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "shipping_amount": {          "amount": 0,          "currency": "string",          "formatted": "string"        }      }    ],    "shipping_discount": {      "amount": 0,      "currency": "string",      "formatted": "string"    },    "savings": {      "amount": 0,      "currency": "string",      "formatted": "string"    },    "shipping_total": {      "amount": 0,      "currency": "string",      "formatted": "string"    },    "tax_breakdown": [      {        "identifier": "string",        "description": "string",        "percentage": "string",        "price": {          "amount": 0,          "currency": "string",          "formatted": "string"        }      }    ],    "tax_total": {      "amount": 0,      "currency": "string",      "formatted": "string"    },    "total": {      "amount": 0,      "currency": "string",      "formatted": "string"    }  }}