Sign in
Orders

Add a guest to an order

Add a new guest to an order. If this is the first guest on the order, all existing items will be reassigned to the new guest and they will be marked as the lead booker by default.

If the order doesn't yet have a customer_id and the new guest is linked to a customer via customer_id, that customer is also set as the order's customer.

post/shop/orders/{orderId}/guests

Request body

namestring

The guest's full name. Used when the site does not enforce separate first/last name fields. Optional if first_name/last_name are provided, if the guest is the lead booker, or if customer_id is set.

first_namestring

The guest's first name. Required when the site enforces separate first/last name fields.

last_namestring

The guest's last name. Required when the site enforces separate first/last name fields.

customer_idstring uuid

Identifier of an existing Customer to link this guest to. When provided, the guest's name and email are inherited from the customer record. Omit to create a guest-only entry without a linked customer account.

is_lead_bookerboolean

Whether this guest is the lead booker for the order. Defaults to true when this is the first guest on the order, otherwise false.

Example request

{
  "name": "Jane Doe",
  "first_name": "Jane",
  "last_name": "Doe",
  "customer_id": "5ed2b95f72823c4f98419f20",
  "is_lead_booker": true
}

Response

The guest was successfully created or updated.

Example response

{
  "data": {
    "id": "5dcb47800000000000000000",
    "checked_in_at": "2025-10-01T12:00:00+00:00",
    "checked_out_at": "2025-10-01T16:30:00+00:00",
    "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "email": "jane.doe@example.com",
    "first_name": "Jane",
    "intake_form_submission_id": "5dcb47800000000000000010",
    "last_name": "Doe",
    "name": "Jane Doe"
  }
}

Changes

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