Sign in
Orders

List order messages

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

get/shop/orders/{orderId}/order-messages

Query parameters

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The order messages were successfully retrieved

Example response

{
  "data": [
    {
      "recipients": [
        "janedoe@email.uk"
      ],
      "summary": "Hello! Thank you for your order!",
      "created_at": "2024-02-02T12:00:00Z",
      "sent_at": "2024-02-02T12:00:00Z",
      "delivered_at": "2024-02-02T12:00:00Z",
      "opened": true
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.