Skip to content

Order statuses

REQUESTED ──approve──▶ PROCESSING ──dispatch──▶ SENT ──deliver──▶ COMPLETED
│ │
└────────cancel────────┴──────────▶ CANCELLED
Status Meaning Next step by
REQUESTED Waiting for approval by your team. Work has not started. An Administrator or Coordinator in the workspace.
PROCESSING Approved, or placed without approval. Luxorr is preparing the gift. Luxorr, on dispatch.
SENT Dispatched. shipments has carrier and tracking. Luxorr, on delivery.
COMPLETED Delivered. —
CANCELLED Cancelled by you, your team or Luxorr. cancellationReason explains why. —

Luxorr can correct a status manually, for example to reopen an order cancelled by mistake. The order you read, with its updatedAt, is the current state.

Status Read Correct delivery Cancel Message
REQUESTED yes no yes yes
PROCESSING yes yes yes yes
SENT yes no no: not_cancellable yes
COMPLETED yes no no: not_cancellable yes
CANCELLED yes no 200, unchanged yes

When the tenant requires approval:

  1. A new order answers 201 with status: REQUESTED. Show the player “being confirmed”, not “on its way”.
  2. After approval in the workspace, you receive order.status_changed with previousStatus: REQUESTED and status PROCESSING.
  3. Without approval, the order stays REQUESTED. A key can cancel it but not approve it.

Personal links use the same setting: a link waiting for approval is REQUESTED and cannot be claimed.

On dispatch, the order moves to SENT and shipments gets carrier and tracking:

"shipments": [
{ "carrier": "DHL", "trackingReference": "00340434161234567890", "trackingUrl": "https://…" }
]

You receive order.status_changed. Later tracking corrections arrive as order.updated. shipments holds at most one shipment.

  • Before dispatch (REQUESTED or PROCESSING): POST /orders/{orderId}:cancel with a reason answers 200. The order is CANCELLED and campaign stock is released.

  • Already cancelled: the same request answers 200 unchanged, with no event. Retries are safe.

  • After dispatch (SENT): the request answers 409:

    {
    "type": "https://docs.luxorr.io/errors#not_cancellable",
    "title": "Not cancellable",
    "status": 409,
    "code": "not_cancellable",
    "detail": "The order is SENT and can no longer be cancelled. Post an order message (POST /orders/{orderId}/messages) to ask Luxorr for this change",
    "currentStatus": "SENT"
    }

    Post an order message to ask Luxorr to stop or return the gift. Status changes arrive as events.

receivedOutsideActiveHours: true means the order arrived outside Luxorr’s working hours. Work starts at the next opening. An order with both urgent and afterHoursServiceAccepted alerts Luxorr immediately.