Reference

BackstageClient.scans

BackstageClient.scans in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / scans

scans: {
  list: (options?: {
     deviceId?: string;
     eventId?: string;
     from?: string;
     limit?: number;
     occurrenceId?: string;
     status?: "rejected" | "reversed" | "redeemed" | "validated";
     to?: string;
   }, requestOptions?: RequestOptions) => Promise<{
     barcode: string;
     createdAt: string;
     deviceId: string | null;
     entitlementId: string;
     gate: string | null;
     holderName: string | null;
     id: string;
     occurredAt: string | null;
     occurrenceId: string | null;
     passId: string;
     reason: string | null;
     seatLabel: string | null;
     status: string;
     ticketTypeName: string;
  }[]>;
  reverse: (redemptionId: string, request: {
     reason?: string;
   }, requestOptions?: RequestOptions) => Promise<{
     entitlementId: string;
     id: string;
     reversalReason: string | null;
     reversedAt: string | null;
     status: string;
  }>;
};

Defined in: client.ts:9440

Scans methods

list()#

list: (options?: {
  deviceId?: string;
  eventId?: string;
  from?: string;
  limit?: number;
  occurrenceId?: string;
  status?: "rejected" | "reversed" | "redeemed" | "validated";
  to?: string;
}, requestOptions?: RequestOptions) => Promise<{
  barcode: string;
  createdAt: string;
  deviceId: string | null;
  entitlementId: string;
  gate: string | null;
  holderName: string | null;
  id: string;
  occurredAt: string | null;
  occurrenceId: string | null;
  passId: string;
  reason: string | null;
  seatLabel: string | null;
  status: string;
  ticketTypeName: string;
}[]>;

List scans (staff reporting) Redemption/scan history, account-filtered, faceted by occurrence/event/device/status.

Parameters#

Parameter	Type
`options?`	{ `deviceId?`: `string`; `eventId?`: `string`; `from?`: `string`; `limit?`: `number`; `occurrenceId?`: `string`; `status?`: `"rejected"` \| `"reversed"` \| `"redeemed"` \| `"validated"`; `to?`: `string`; }
`options.deviceId?`	`string`
`options.eventId?`	`string`
`options.from?`	`string`
`options.limit?`	`number`
`options.occurrenceId?`	`string`
`options.status?`	`"rejected"` \| `"reversed"` \| `"redeemed"` \| `"validated"`
`options.to?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ barcode: string; createdAt: string; deviceId: string | null; entitlementId: string; gate: string | null; holderName: string | null; id: string; occurredAt: string | null; occurrenceId: string | null; passId: string; reason: string | null; seatLabel: string | null; status: string; ticketTypeName: string; }[]>

Operation Id#

listScans

reverse()#

reverse: (redemptionId: string, request: {
  reason?: string;
}, requestOptions?: RequestOptions) => Promise<{
  entitlementId: string;
  id: string;
  reversalReason: string | null;
  reversedAt: string | null;
  status: string;
}>;

Reverse a redemption Supervisor undo of a mistaken scan: the redemption becomes reversed and the entitlement gets its consumption back. 409 NOT_REVERSIBLE when the entitlement is cancelled (its order cancelled or refunded): reversing would make it redeemable again.

Parameters#

Parameter	Type
`redemptionId`	`string`
`request`	{ `reason?`: `string`; }
`request.reason?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ entitlementId: string; id: string; reversalReason: string | null; reversedAt: string | null; status: string; }>

Operation Id#

reverseRedemption