LoginGet started

Order

List all orders

get

Returns a list of orders. The orders are returned in descending order by creation date.

Authorizations
Query parameters
pageintegerOptional

The collection page number

Default: 1
createdAt[before]stringOptional
createdAt[strictly_before]stringOptional
createdAt[after]stringOptional
createdAt[strictly_after]stringOptional
updatedAt[before]stringOptional
updatedAt[strictly_before]stringOptional
updatedAt[after]stringOptional
updatedAt[strictly_after]stringOptional
scheduledDeliveryAt[before]stringOptional
scheduledDeliveryAt[strictly_before]stringOptional
scheduledDeliveryAt[after]stringOptional
scheduledDeliveryAt[strictly_after]stringOptional
Responses
200

Order collection

get
GET /orders HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "createdAt": "2025-08-20T03:44:53.834Z",
    "updatedAt": "2025-08-20T03:44:53.834Z",
    "customerFirstName": "",
    "customerLastName": "",
    "customerName": "",
    "currencyCode": "text",
    "dispatchStatus": "Outstanding",
    "subtotal": 1,
    "total": 1,
    "deliveryAmount": 1,
    "deliveryMethodName": null,
    "channel": "text",
    "discountAmount": 1,
    "deliveryName": "",
    "deliveryAddressLine1": "",
    "deliveryAddressLine2": "",
    "deliveryAddressCity": "",
    "deliveryAddressCounty": "",
    "deliveryAddressPostcode": "",
    "deliveryAddressCountry": "",
    "billingAddressLine1": "",
    "billingAddressLine2": "",
    "billingAddressCity": "",
    "billingAddressCounty": "",
    "billingAddressPostcode": "",
    "billingAddressCountry": "",
    "phoneNumber": "",
    "billingContact": "https://example.com/",
    "customerEmailAddress": "",
    "paymentStatus": "Pending",
    "deliveryContact": "https://example.com/",
    "billingContactAddress": {},
    "deliveryContactAddress": {},
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "emailToRecipient": true,
    "recipientEmailAddress": "text",
    "scheduledDeliveryAt": null,
    "discountCodes": [
      {}
    ],
    "user": {},
    "paymentMethod": "Gateway",
    "offlinePaymentMethod": "",
    "complimentaryReason": "",
    "recipientFirstName": "",
    "recipientLastName": "",
    "gateway": "text",
    "transaction": "https://example.com/",
    "type": "Gift Card",
    "deliveryMethodType": "text",
    "processingFee": 0,
    "userAgent": null,
    "browserInfo": null,
    "ipAddress": null
  }
]

Retrieve an order

get

An order is made up of one or more lines and each represent a gift card, product, or membership purchased by a customer.

Authorizations
Path parameters
idstringRequired

Order identifier

Responses
200

Order resource

get
GET /orders/{id} HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "createdAt": "2025-08-20T03:44:53.834Z",
  "updatedAt": "2025-08-20T03:44:53.834Z",
  "customerFirstName": "",
  "customerLastName": "",
  "customerName": "",
  "currencyCode": "text",
  "dispatchStatus": "Outstanding",
  "subtotal": 1,
  "total": 1,
  "deliveryAmount": 1,
  "deliveryMethodName": null,
  "channel": "text",
  "discountAmount": 1,
  "deliveryName": "",
  "deliveryAddressLine1": "",
  "deliveryAddressLine2": "",
  "deliveryAddressCity": "",
  "deliveryAddressCounty": "",
  "deliveryAddressPostcode": "",
  "deliveryAddressCountry": "",
  "billingAddressLine1": "",
  "billingAddressLine2": "",
  "billingAddressCity": "",
  "billingAddressCounty": "",
  "billingAddressPostcode": "",
  "billingAddressCountry": "",
  "phoneNumber": "",
  "billingContact": "https://example.com/",
  "customerEmailAddress": "",
  "paymentStatus": "Pending",
  "deliveryContact": "https://example.com/",
  "billingContactAddress": {},
  "deliveryContactAddress": {},
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "emailToRecipient": true,
  "recipientEmailAddress": "text",
  "scheduledDeliveryAt": null,
  "discountCodes": [
    {}
  ],
  "user": {},
  "paymentMethod": "Gateway",
  "offlinePaymentMethod": "",
  "complimentaryReason": "",
  "recipientFirstName": "",
  "recipientLastName": "",
  "gateway": "text",
  "transaction": "https://example.com/",
  "type": "Gift Card",
  "deliveryMethodType": "text",
  "processingFee": 0,
  "userAgent": null,
  "browserInfo": null,
  "ipAddress": null
}

Retrieve the lines of an order

get

An order is made up of one or more lines and each represent a gift card, product, or membership purchased.

Authorizations
Path parameters
orderIdstringRequired

OrderLine identifier

Query parameters
pageintegerOptional

The collection page number

Default: 1
Responses
200

OrderLine collection

get
GET /orders/{orderId}/lines HTTP/1.1
Host: api.glu.io
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "attachedOrder": "https://example.com/",
    "variant": {},
    "name": "text",
    "type": "text",
    "total": 1,
    "orderLineTypeVoucher": {},
    "discount_amount": 1,
    "subtotal": 1,
    "refunded": false,
    "description": "",
    "personalMessage": "",
    "selectedOptions": [
      {}
    ],
    "discountCodes": [
      {}
    ],
    "recurringProduct": {},
    "deliveryMethodZoneRate": {}
  }
]
PreviousMemberNextOrganisation