Reference

BackstageClient.inventoryHolds

BackstageClient.inventoryHolds in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / inventoryHolds

inventoryHolds: {
  createHold: (request: {
     accountId: string;
     expiresAt?: string;
     heldBy: string;
     inventoryId: string;
     quantity?: number;
     reason: string;
     seatIds?: string[];
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     createdAt: string;
     expiresAt: string | null;
     heldBy: string | null;
     id: string;
     inventoryId: string;
     metadata:   | {
      [key: string]: unknown;
      }
        | null;
     organisationId: string;
     quantity: number;
     reason: string | null;
     referenceId: string | null;
     referenceType: "subscription" | "order" | "hold" | null;
     seatIds: string[] | null;
     type: "confirmed" | "maintenance" | "hold" | "temporary";
     updatedAt: string;
  }>;
  releaseHold: (id: string, request: {
     accountId: string;
  }, requestOptions?: RequestOptions) => Promise<string>;
};

Defined in: client.ts:4403

Inventory Holds methods

createHold()#

createHold: (request: {
  accountId: string;
  expiresAt?: string;
  heldBy: string;
  inventoryId: string;
  quantity?: number;
  reason: string;
  seatIds?: string[];
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  createdAt: string;
  expiresAt: string | null;
  heldBy: string | null;
  id: string;
  inventoryId: string;
  metadata:   | {
   [key: string]: unknown;
   }
     | null;
  organisationId: string;
  quantity: number;
  reason: string | null;
  referenceId: string | null;
  referenceType: "subscription" | "order" | "hold" | null;
  seatIds: string[] | null;
  type: "confirmed" | "maintenance" | "hold" | "temporary";
  updatedAt: string;
}>;

Create hold Create a hold on inventory (for VIPs, promoters, etc.)

Parameters#

Parameter	Type
`request`	{ `accountId`: `string`; `expiresAt?`: `string`; `heldBy`: `string`; `inventoryId`: `string`; `quantity?`: `number`; `reason`: `string`; `seatIds?`: `string`[]; }
`request.accountId`	`string`
`request.expiresAt?`	`string`
`request.heldBy?`	`string`
`request.inventoryId?`	`string`
`request.quantity?`	`number`
`request.reason?`	`string`
`request.seatIds?`	`string`[]
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ accountId: string; createdAt: string; expiresAt: string | null; heldBy: string | null; id: string; inventoryId: string; metadata: | { [key: string]: unknown; } | null; organisationId: string; quantity: number; reason: string | null; referenceId: string | null; referenceType: "subscription" | "order" | "hold" | null; seatIds: string[] | null; type: "confirmed" | "maintenance" | "hold" | "temporary"; updatedAt: string; }>

Operation Id#

createHold

releaseHold()#

releaseHold: (id: string, request: {
  accountId: string;
}, requestOptions?: RequestOptions) => Promise<string>;

Release hold Release a hold and return inventory to available

Parameters#

Parameter	Type
`id`	`string`
`request`	{ `accountId`: `string`; }
`request.accountId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<string>

Operation Id#

releaseHold