Orders

Add a note to an order

Add a new note to an order. The note will be attributed to the authenticated user, who is recorded as the created_by user on the resulting OrderNote.

post/shop/orders/{orderId}/notes

Request body

contentstring required

The contents of the note. HTML is not permitted — submit plain text only. Use notes to capture operational context for the order (for example, special requests from the guest, or an internal note for the front desk).

Example request

{
  "content": "Guest requested a double treatment room and prefers a female therapist."
}

Response

The order note was successfully retrieved.

Example response

{
  "data": {
    "id": "5ed2b95f72823c4f98419f19",
    "content": "Requested a double treatment room.",
    "order_id": "5ed2b95f72823c4f98419f20",
    "created_at": "2019-01-15T12:00:00+01:00",
    "created_by": {
      "id": "5ed2b95f72823c4f98419f20",
      "name": "Jane Smith"
    },
    "created_by_id": "5ed2b95f72823c4f98419f20"
  }
}

Changes

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