Get seat map

This endpoint returns the seating plan of a show: the seats with their price category and the articles valid for them, the layout tree (blocks, rows, tables), the price categories with their colour, and the seat packages (groups) that can only be booked together.

An article is seated when it carries a show object (id, name, description, startDate) in the assortment endpoints. Load the plan once per show and keep it; the live occupancy comes from Get seat availability. A seated article can only be added to the cart with a seatId or seatGroupId (see Add item).

Request

This request does not contain a request body.

• showId (string, path): The ID of the show.

• areaId (string, query, optional): Limits the result to one area node. Required when the plan answers isAreaScopeRequired: true.

• includeSeats (boolean, query, optional): Only valid together with areaId.

Response

• data (object)

  • showId (string): The ID of the show.

  • isSeatingActive (boolean): false when the show has no usable seating plan (also for an unknown show, which answers 200 with layout: null). Seated articles of such a show cannot be booked.

  • areaId (string, nullable): The requested area, otherwise null.

  • seatCount (number): Number of seats in the plan.

  • isAreaScopeRequired (boolean): true when seats must be loaded per area with areaId.

  • seats (array): seatId, categoryId, validArticleIds (articles that can be booked on this seat), label, labelPath (full seat name, e.g. block, row and seat), parentNodeId, areaNodeId, sx/sy (position relative to the parent node) and restriction (null when bookable, otherwise e.g. blocked or nonBookable).

  • layout (object, nullable)

    • nodes (array): Layout tree with id, parentId, nodeType, levelIndex, name, isArea, seatCount, x, y, w, h and rotation.

    • categories (array): categoryId, name, color (hex) and articleIds.

    • groups (array): Seat packages with groupId, name, sortOrder, parentNodeId, seatIds and categoryId. Booking a package books all of its seats; a seat can belong to several packages.

The example response is shortened to one package of two seats; the full plan of this show has 3,689 seats.