API docs by Redocly

Westfield Queue Service APIs (1)

Download OpenAPI specification:Download

Summary of Westfield API endpoints.

authenticated

Join a queue or create a booking.

Authorizations:
api_keybearerAuth
path Parameters
customerId
required
string

The users' PAS or FID id

query Parameters
centerId
required
string

The string center id for the center to be queried

header Parameters
Authorization
required
string
authType
required
string
Enum: "PAS" "Fid"
Request Body schema: application/json
required

Data to create a customer.

id
string

Identifier of visit (required to update existing one)

firstName
string

First name of customer

lastName
string <= 1 characters

Last name of customer

externalCustomerId
required
string

External identifier of customer

phone
string

Phone number of customer

locationId
required
string

Identifier of location

state
required
string
Enum: "BOOKED" "WAITING" "SERVING" "COMPLETE" "CANCELLED"

State of visit

date
string <date-time>

Date and time of booking, must be in ISO 8601 format (required if state is "BOOKED")

duration
integer

Duration of booking in seconds (required if state is "BOOKED")

partySize
integer

Party size (default is 1)

Responses

Request samples

Content type
application/json
{
  • "id": "75u4O97KSlmZ0GZRxw6W",
  • "firstName": "John",
  • "lastName": "Doe",
  • "externalCustomerId": "wf-1234",
  • "phone": "+1 123 456 7890",
  • "locationId": "TMO3J8PQj1BPXCA7ciZM",
  • "state": "BOOKED",
  • "date": "2020-04-26T23:33:58.646Z",
  • "duration": 1800,
  • "partySize": 1
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": { },
  • "meta": {
    }
}

Get a list of visits for an authenticated customer

Authorizations:
api_key
path Parameters
customerId
required
string

The users' PAS or FID id

query Parameters
centerId
required
string

The string center id for the center to be queried

locationId
string

The string location id for the location to be filtered on

header Parameters
Authorization
required
string
authType
required
string
Enum: "PAS" "Fid"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a visit for an authenticated customer

Authorizations:
api_key
path Parameters
customerId
required
string

The users' PAS or FID id

visitId
required
string

The id of the visit

query Parameters
centerId
required
string

The string center id for the center to be queried

header Parameters
Authorization
required
string
authType
required
string
Enum: "PAS" "Fid"

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": { },
  • "meta": {
    }
}

public

Gets the list of participating retailers by center.

Authorizations:
api_key
query Parameters
centerId
required
string

The string center id for the center to be queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]

gets queing and booking details for a single location

Authorizations:
api_key
path Parameters
locationId
required
string

The WaitWhile location id

query Parameters
centerId
required
string

The string center id for the center to be queried

Responses

Response samples

Content type
application/json
{
  • "_links": {},
  • "id": "A1sLSsaxPtzjDF4TerTb",
  • "store_id": 2345,
  • "name": "Nordstrom",
  • "mobile_logo": "http://sdsf.co/asd.png",
  • "mobile_store_visuals": "http://sdsf.co/asd.png",
  • "mobile_restaurant_visuals": "http://sdsf.co/asd.png",
  • "square_image": "http://sdsf.co/asd.png",
  • "retailer_code": "Nordstrom",
  • "salience": 0,
  • "retailer_name": "string",
  • "store_description": "string",
  • "store_type_ids": [
    ],
  • "store_zone": "string",
  • "status": {
    },
  • "queue_status": {
    },
  • "available_bookings": [
    ]
}

redirects user to connectable auth for waitwhile UI

Authorizations:
api_key
query Parameters
centre_code
required
integer

mallcomm centre code to reverse map from

store_id
required
integer

mallcomm store id to reverse map from

role_id
required
integer

mallcomm role id to reverse map from

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "errors": {
    },
  • "meta": {
    }
}