Skip to content
Docs
Open Backstage
Reference

BackstageClient.inventorySeats

BackstageClient.inventorySeats in @ticketlayer/backstage.

@ticketlayer/backstage

@ticketlayer/backstage / BackstageClient / inventorySeats

inventorySeats: {
  importSeats: (id: string, request: {
     seats: {
        attributes?: Record<string, any>;
        eventLayoutSeatId?: string;
        isAccessible?: boolean;
        isCompanion?: boolean;
        priceCategory?: string;
        rowName: string;
        seatNumber: string;
     }[];
   }, requestOptions?: RequestOptions) => Promise<{
     count: number;
     seats: {
        accountId: string;
        attributes:   | {
         [key: string]: unknown;
         }
           | null;
        createdAt: string;
        eventLayoutSeatId: string | null;
        id: string;
        inventoryId: string;
        isAccessible: boolean;
        isCompanion: boolean;
        organisationId: string;
        priceCategory: string | null;
        reservationId: string | null;
        rowName: string;
        seatNumber: string;
        status: "available" | "held" | "reserved" | "confirmed" | "maintenance";
        updatedAt: string;
        version: number;
     }[];
  }>;
  listSeats: (id: string, options?: {
     isAccessible?: "true" | "false";
     priceCategory?: string;
     rowName?: string;
     status?: "available" | "held" | "reserved" | "confirmed" | "maintenance";
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     attributes:   | {
      [key: string]: unknown;
      }
        | null;
     createdAt: string;
     eventLayoutSeatId: string | null;
     id: string;
     inventoryId: string;
     isAccessible: boolean;
     isCompanion: boolean;
     organisationId: string;
     priceCategory: string | null;
     reservationId: string | null;
     rowName: string;
     seatNumber: string;
     status: "available" | "held" | "reserved" | "confirmed" | "maintenance";
     updatedAt: string;
     version: number;
  }[]>;
};

Defined in: client.ts:4239

Inventory Seats methods

importSeats()#

importSeats: (id: string, request: {
  seats: {
     attributes?: Record<string, any>;
     eventLayoutSeatId?: string;
     isAccessible?: boolean;
     isCompanion?: boolean;
     priceCategory?: string;
     rowName: string;
     seatNumber: string;
  }[];
}, requestOptions?: RequestOptions) => Promise<{
  count: number;
  seats: {
     accountId: string;
     attributes:   | {
      [key: string]: unknown;
      }
        | null;
     createdAt: string;
     eventLayoutSeatId: string | null;
     id: string;
     inventoryId: string;
     isAccessible: boolean;
     isCompanion: boolean;
     organisationId: string;
     priceCategory: string | null;
     reservationId: string | null;
     rowName: string;
     seatNumber: string;
     status: "available" | "held" | "reserved" | "confirmed" | "maintenance";
     updatedAt: string;
     version: number;
  }[];
}>;

Bulk import seats Import seats into an allocated inventory bucket

Parameters#

ParameterType
idstring
request{ seats: { attributes?: Record<string, any>; eventLayoutSeatId?: string; isAccessible?: boolean; isCompanion?: boolean; priceCategory?: string; rowName: string; seatNumber: string; }[]; }
request.seats{ attributes?: Record<string, any>; eventLayoutSeatId?: string; isAccessible?: boolean; isCompanion?: boolean; priceCategory?: string; rowName: string; seatNumber: string; }[]
requestOptions?RequestOptions

Returns#

Promise<{ count: number; seats: { accountId: string; attributes: | { [key: string]: unknown; } | null; createdAt: string; eventLayoutSeatId: string | null; id: string; inventoryId: string; isAccessible: boolean; isCompanion: boolean; organisationId: string; priceCategory: string | null; reservationId: string | null; rowName: string; seatNumber: string; status: "available" | "held" | "reserved" | "confirmed" | "maintenance"; updatedAt: string; version: number; }[]; }>

Operation Id#

bulkImportSeats

listSeats()#

listSeats: (id: string, options?: {
  isAccessible?: "true" | "false";
  priceCategory?: string;
  rowName?: string;
  status?: "available" | "held" | "reserved" | "confirmed" | "maintenance";
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  attributes:   | {
   [key: string]: unknown;
   }
     | null;
  createdAt: string;
  eventLayoutSeatId: string | null;
  id: string;
  inventoryId: string;
  isAccessible: boolean;
  isCompanion: boolean;
  organisationId: string;
  priceCategory: string | null;
  reservationId: string | null;
  rowName: string;
  seatNumber: string;
  status: "available" | "held" | "reserved" | "confirmed" | "maintenance";
  updatedAt: string;
  version: number;
}[]>;

List inventory seats List all seats for an allocated inventory bucket

Parameters#

ParameterType
idstring
options?{ isAccessible?: "true" | "false"; priceCategory?: string; rowName?: string; status?: "available" | "held" | "reserved" | "confirmed" | "maintenance"; }
options.isAccessible?"true" | "false"
options.priceCategory?string
options.rowName?string
options.status?"available" | "held" | "reserved" | "confirmed" | "maintenance"
requestOptions?RequestOptions

Returns#

Promise<{ accountId: string; attributes: | { [key: string]: unknown; } | null; createdAt: string; eventLayoutSeatId: string | null; id: string; inventoryId: string; isAccessible: boolean; isCompanion: boolean; organisationId: string; priceCategory: string | null; reservationId: string | null; rowName: string; seatNumber: string; status: "available" | "held" | "reserved" | "confirmed" | "maintenance"; updatedAt: string; version: number; }[]>

Operation Id#

listInventorySeats