---
title: "List order messages"
method: GET
path: "/shop/orders/{orderId}/order-messages"
tags: ["Orders"]
---

# List order messages

`GET /shop/orders/{orderId}/order-messages`

This endpoint retrieves all the SMS messages and emails relating to an order.

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

The order messages were successfully retrieved

- object
  - `data` OrderMessageSummary[], required
    - `id` string, object-id, required — The ID of the order message.
    - `type` 'email' | 'sms', required — The medium through which the order message is sent.
    - `recipients` string[], required — The recipients of the order message.
    - `summary` string, required — A summary of the order message. For an email, this will be the subject, and for an SMS message, this will be an excerpt of the message.
    - `message_type` 'basket_confirmed' | 'basket_cancelled' | 'basket_cancelled_with_charge' | 'basket_cancelled_without_charge' | 'basket_reminder' | 'basket_follow_up' | 'pay_by_link_request', required — The type of message the order message is.
    - `created_at` string, date-time, required — The date and time the order message was created.
    - `sent_at` string, date-time, required — The date and time the order message was sent.
    - `delivered_at` string, date-time, nullable, required — The date and time the email was delivered. For an SMS message, this will be null.
    - `opened` boolean, nullable, required — Whether the email was opened. For an SMS message, this will be null.
    - `bounced` boolean, nullable, required — Whether the email bounced. For an SMS message, this will be null.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated
- `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)