Sign in
Orders

List the emails sent for an order

Retrieve a paginated list of every email message that has been sent in relation to an order. Each entry includes delivery, open and bounce status; use Retrieve an order email to fetch the rendered HTML body for an individual message.

get/shop/orders/{orderId}/emails

Query parameters

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The email messages for the order were successfully retrieved.

Example response

{
  "data": [
    {
      "id": "5ed2b95f72823c4f98419f19",
      "organisation_id": "5ed2b95f72823c4f98419f10",
      "site_id": "5ed2b95f72823c4f98419f11",
      "customer_id": "5ed2b95f72823c4f98419f12",
      "basket_id": "5ed2b95f72823c4f98419f13",
      "from": "bookings@example-spa.com",
      "to": [
        "jane.doe@example.com"
      ],
      "subject": "Your booking is confirmed",
      "type": "BookingConfirmation",
      "created_at": "2024-02-02T12:00:00+00:00",
      "sent_at": "2024-02-02T12:00:01+00:00",
      "delivered_at": "2024-02-02T12:00:05+00:00",
      "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.