---
title: "Get an order by reference"
method: GET
path: "/shop/order-by-ref/{orderRef}"
tags: ["Orders"]
---

# Get an order by reference

`GET /shop/order-by-ref/{orderRef}`

Looks up an `Order` by the short customer-facing reference Trybe
issues (e.g. `TRY1234`). Equivalent to
`GET /shop/orders/{orderId}` but keyed by the human-readable
reference printed on receipts and emails — useful when an operator
has the reference but not the order ID.

The lookup is scoped to the sites the calling user belongs to.
Pass `site_id` to narrow further. Returns `404` if the reference
doesn't match any in-scope order.

Requires the `RESERVATIONS_VIEW` permission on the matching
order's site.

## Query parameters

- `site_id` string, uuid
- `generic_items_array` boolean

## Response `200`

The `Order` was successfully retrieved

- object
  - `data` Order, required — A customer order containing items and payments. This format replaces an older version of the order schema, and must be requested explicitly by passing `generic_items_array=true` as a query parameter.
    - `id` string, object-id — The ID of the order.

## Other responses

- `401` — The user is unauthenticated
- `403` — The authenticated user does not have permission.
- `404` — The resource couldn't be found

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)