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

# List SMS messages

`GET /shop/orders/{orderId}/sms`

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

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

The SMS messages were successfully retrieved

- object
  - `data` SmsMessageSummary[], required
    - `id` string, object-id, required — The ID of the SMS message.
    - `organisation_id` string, uuid, required — The ID of the organisation the SMS message is associated with.
    - `site_id` string, uuid, required — The ID of the site the SMS message is associated with.
    - `customer_id` string, uuid, required — The ID of the customer the SMS message was sent to.
    - `basket_id` string, object-id, required — The ID of the basket the SMS message is associated with.
    - `order_ref` string — The reference of the order the SMS message is associated with.
    - `from` string, required — The sender of the SMS message.
    - `to` string, required — The recipient of the SMS message. This is a valid mobile number.
    - `message` string, required — The contents of the SMS message.
    - `message_type` 'basket_confirmed' | 'basket_cancelled_with_charge' | 'basket_cancelled_without_charge' | 'basket_reminder' | 'basket_follow_up' | 'pay_by_link_request' | 'billing_details_request', required — The type of message the SMS message is.
    - `message_delivered` boolean, required — Whether the SMS message was successfully delivered.
    - `price` integer, required — The price of the SMS message.
    - `created_at` string, date-time, required — The date and time the SMS message was created.
    - `sent_at` string, date-time, required — The date and time the SMS message was sent.
  - `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)