API docs by Redocly

Westfield Centre Directory APIs (1)

Download OpenAPI specification:Download

Summary of Westfield Centre Directory API endpoints.

Centre Directory services Information

Endpoints related to Center Directory services

Centre Services

List services.

Request an array of services, outside of those provided by the retailers, filtered by allowed parameters.

Authorizations:
api_key
path Parameters
centre_id
required
string
Example: sanfrancisco,sydney,london

Centre identifier. Request the centre with centre_id. Lowercase code name for a specific centre.

query Parameters
fields
string
Example: fields=_links

Fields in response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.

page
number
Default: 1
Example: page=2

Results page number. Specific page of results to request when paginating.

per_page
number <= 100
Default: 10
Example: per_page=25

Results per page. Number of items per result set when paginating.

service_class
string
Default: "physical"
Enum: "all" "physical" "digital"
Example: service_class=digital

Filter services by service class

updated_since
string <date-time>
Example: updated_since=2015-04-02
locale
string
Example: locale=fr

Retrieve localized versions of all centre services in response body.

strict
string

When retrieving localized centre services with :locale parameter, return an empty string if no applicable translation exists.

active
boolean

Flag indicating if the retailer is enabled in the Westfield system

Responses

Response samples

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

List services (alternative endpoint).

Request an array of services, outside of those provided by the retailers, filtered by allowed parameters.

Authorizations:
api_key
query Parameters
centre_id
required
string
Example: centre_id=sanfrancisco&centre_id=sydney&centre_id=london

Centre identifier. Request services with centre_id. Lowercase code name for a specific centre.

fields
string
Example: fields=_links

Fields in response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.

page
number
Default: 1
Example: page=2

Results page number. Specific page of results to request when paginating.

per_page
number <= 100
Default: 10
Example: per_page=25

Results per page. Number of items per result set when paginating.

service_class
string
Default: "physical"
Enum: "all" "physical" "digital"
Example: service_class=digital

Filter services by service class

updated_since
string <date-time>
Example: updated_since=2015-04-02
locale
string
Example: locale=fr

Retrieve localized versions of all centre services in response body.

strict
string

When retrieving localized centre services with :locale parameter, return an empty string if no applicable translation exists.

Responses

Response samples

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

Create a service.

Request creation of a service from JSON data in the request body.

Authorizations:
api_key
header Parameters
Authorization
required
string^[bB]earer [A-Za-z0-9]{64}$

Staff Access token type and token value.

Request Body schema: application/json
required

Data to create a service.

active
boolean

Whether the service is currently available

booking_link
string

[DEPRECATED]. External booking URL

service_link
string

External service URL

centre_id
required
string

Centre this service is available in

country
required
string
Enum: "us" "uk" "se" "fr" "es" "nl" "at" "de" "sk" "pl" "dk" "cz"

Country in which the centre is

description
required
string

Full description of the service

eligibilities
Array of integers

eligibilities requirements of event.

email
string

Email for the service

external_id
string

external system ID reference for mapping

featured
boolean

Featured

Array of objects (ServiceHourBody)
image_ref
string

Image file name

level_name
string

Level Name

location_id
string

Location identifier

Array of objects (ServiceLocationBody)
long_title
required
string

Long title for the service

loyalty_benefit_label
string or null <= 16 characters

Label for loyalty benefit

loyalty_benefit_description
string or null <= 5000 characters

loyalty benefit description

mobile_picto_off
string

Off state image for mobile app

mobile_picto_on
string

On state image for mobile app

phone_number
string

Phone number for the service

picto_off
string

Off State

picto_on
string

On State

price
string

Price for the service

service_type
required
string

Name of service type

service_tag
required
number

Id of service tag

short_title
required
string

Short title for the service

sort_order
integer

Order in which the service should appear in lists

url
string

URL for the service

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "booking_link": "string",
  • "service_link": "string",
  • "centre_id": "string",
  • "country": "us",
  • "description": "string",
  • "eligibilities": [
    ],
  • "email": "string",
  • "external_id": "string",
  • "featured": true,
  • "hours": [
    ],
  • "image_ref": "string",
  • "level_name": "string",
  • "location_id": "string",
  • "locations": [
    ],
  • "long_title": "string",
  • "loyalty_benefit_label": "string",
  • "loyalty_benefit_description": "string",
  • "mobile_picto_off": "string",
  • "mobile_picto_on": "string",
  • "phone_number": "string",
  • "picto_off": "string",
  • "picto_on": "string",
  • "price": "string",
  • "service_type": "string",
  • "service_tag": 0,
  • "short_title": "string",
  • "sort_order": 0,
  • "url": "string"
}

Response samples

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

Individual service.

Request a single service.

Authorizations:
api_key
path Parameters
service_id
required
integer
Example: 485

Service identifier. Request the service with service_id.

query Parameters
fields
string
Example: fields=_links

Fields in response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.

locale
string
Example: locale=fr

Retrieve localized version of level_name, short_title, long_title, description, price fields in response body.

strict
string

When retrieving localized fields with :locale parameter, return an empty string on each field where no applicable translations exist.

Responses

Response samples

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

Delete a service.

Request deletion of a service.

Authorizations:
api_key
path Parameters
service_id
required
integer
Example: 485

Service identifier. Request the service with service_id.

query Parameters
locale
string
Example: locale=fr

When :locale is present, delete level_name, short_title, long_title, description, price fields instead of the whole record.

header Parameters
Authorization
required
string^[bB]earer [A-Za-z0-9]{64}$

Staff Access token type and token value.

Responses

Response samples

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

Update a service.

Request update of a service from JSON data in the request body.

Authorizations:
api_key
path Parameters
service_id
required
integer
Example: 485

Service identifier. Request the service with service_id.

query Parameters
locale
string
Example: locale=fr

Update version of level_name, short_title, long_title, description, price fields with provided locale.

header Parameters
Authorization
required
string^[bB]earer [A-Za-z0-9]{64}$

Staff Access token type and token value.

Request Body schema: application/json
required

Data to update a service.

active
boolean

Whether the service is currently available

booking_link
string

[DEPRECATED]. External booking URL

service_link
string

External service URL

centre_id
string

Centre this service is available in

description
string

Full description of the service

eligibilities
Array of integers

eligibilities requirements of event.

email
string

Email for the service

external_id
string

external system ID reference for mapping

featured
boolean

Featured

Array of objects (ServiceHourBody)
image_ref
string

Image file name

level_name
string

Level Name

location_id
string

Location identifier

Array of objects (ServiceLocationBody)
long_title
string

Long title for the service

loyalty_benefit_label
string or null <= 16 characters

Label for loyalty benefit

loyalty_benefit_description
string or null <= 5000 characters

loyalty benefit description

phone_number
string

Phone number for the service

mobile_picto_off
string

Off state image for mobile app

mobile_picto_on
string

On state image for mobile app

picto_off
string

Off State

picto_on
string

On State

price
string

Price for the service

service_type
string

Type of service

short_title
string

Short title for the service

sort_order
integer

Order in which the service should appear in lists

url
string

URL for the service

service_tag
number

service tag id

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "booking_link": "string",
  • "service_link": "string",
  • "centre_id": "string",
  • "description": "string",
  • "eligibilities": [
    ],
  • "email": "string",
  • "external_id": "string",
  • "featured": true,
  • "hours": [
    ],
  • "image_ref": "string",
  • "level_name": "string",
  • "location_id": "string",
  • "locations": [
    ],
  • "long_title": "string",
  • "loyalty_benefit_label": "string",
  • "loyalty_benefit_description": "string",
  • "phone_number": "string",
  • "mobile_picto_off": "string",
  • "mobile_picto_on": "string",
  • "picto_off": "string",
  • "picto_on": "string",
  • "price": "string",
  • "service_type": "string",
  • "short_title": "string",
  • "sort_order": 0,
  • "url": "string",
  • "service_tag": 0
}

Response samples

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

List service-types.

Request an array of service-types filtered by allowed parameters.

Authorizations:
api_key
query Parameters
page
number
Default: 1
Example: page=2

Results page number. Specific page of results to request when paginating.

per_page
number <= 100
Default: 10
Example: per_page=25

Results per page. Number of items per result set when paginating.

service_class
string
Enum: "physical" "digital"
Example: service_class=digital

Filter service types by service class

updated_since
string <date-time>
Example: updated_since=2015-04-02T00:00:00.000Z

Updated since. Request the service-types updated since a specific date and time. ISO-8601 format.

locale
string
Example: locale=fr

Retrieve localized versions of all service types in response body.

strict
string

When retrieving localized service types with :locale parameter, return an empty string if no applicable translation exists.

fields
string
Example: fields=_links

Fields in response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.

Responses

Response samples

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

Create a service type.

Request creation of a service-type from JSON data in the request body.

Authorizations:
api_key
header Parameters
Authorization
required
string^[bB]earer [A-Za-z0-9]{64}$

Staff Access token type and token value.

Request Body schema: application/json
required

Data to create a service-type.

country
required
string
Enum: "us" "uk" "se" "fr" "es" "nl" "at" "de" "sk" "pl" "dk" "cz" "global"

Country where the service type is available

name
required
string

Name of service type

service_class
required
string
Enum: "physical" "digital"

Class of the service type

Responses

Request samples

Content type
application/json
{
  • "country": "us",
  • "name": "car_wash",
  • "service_class": "digital"
}

Response samples

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

Individual service-type.

Request a single service-type.

Authorizations:
api_key
path Parameters
service_type_id
required
integer
Example: 15

Service-type identifier. Request the service-type with service_type_id.

Responses

Response samples

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

Delete a service-type.

Request deletion of a service-type.

Authorizations:
api_key
path Parameters
service_type_id
required
integer
Example: 15

Service-type identifier. Request to delete the service-type with service_type_id.

query Parameters
locale
string
Example: locale=fr

When :locale is present, delete name field translation instead of the whole record.

header Parameters
Authorization
required
string^[bB]earer [A-Za-z0-9]{64}$

Staff Access token type and token value.

Responses

Response samples

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

Update a service-type.

Request update of a service-type from JSON data in the request body.

Authorizations:
api_key
path Parameters
service_type_id
required
integer
Example: 15

Service-type identifier. Request to update the service-type with service_type_id.

query Parameters
locale
string
Example: locale=fr

Update version of level_name, short_title, long_title, description, price fields with provided locale.

header Parameters
Authorization
required
string^[bB]earer [A-Za-z0-9]{64}$

Staff Access token type and token value.

Request Body schema: application/json
required

Data to update a service-type.

country
string
Enum: "us" "uk" "se" "fr" "es" "nl" "at" "de" "sk" "pl" "dk" "cz" "global"

Country where the service type is available

name
string

Name of service type

service_class
string
Enum: "physical" "digital"

Class of the service type

Responses

Request samples

Content type
application/json
{
  • "country": "us",
  • "name": "car_wash",
  • "service_class": "digital"
}

Response samples

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

List service-tags.

Request an array of service-tags filtered by allowed parameters.

Authorizations:
api_key
query Parameters
page
number
Default: 1
Example: page=2

Results page number. Specific page of results to request when paginating.

per_page
number <= 100
Default: 10
Example: per_page=25

Results per page. Number of items per result set when paginating.

service_type_id
integer
Example: service_type_id=1

Filter service tags by service types

fields
string
Example: fields=_links

Fields in response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.

Responses

Response samples

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

Returns service versions.

Request service versions.

Authorizations:
api_key
path Parameters
service_id
required
integer
Example: 402495

Service identifier. Request the service version with service_id.

query Parameters
page
number
Default: 1
Example: page=2

Results page number. Specific page of results to request when paginating.

per_page
number <= 100
Default: 10
Example: per_page=25

Results per page. Number of items per result set when paginating.

sort
string
Example: sort=created_at desc,created_at asc

Sort results by one field created_at. Change sort order by adding desc or asc after field name

version_action
string
Enum: "create" "update" "destroy"

Version Action. Request for versions with action.

header Parameters
Authorization
required
string^[bB]earer [A-Za-z0-9]{64}$

Staff Access token type and token value.

Responses

Response samples

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

Returns service type versions.

Request service type versions.

Authorizations:
api_key
path Parameters
service_type_id
required
integer
Example: 402495

Service type identifier. Request the service type version with service_id.

query Parameters
page
number
Default: 1
Example: page=2

Results page number. Specific page of results to request when paginating.

per_page
number <= 100
Default: 10
Example: per_page=25

Results per page. Number of items per result set when paginating.

sort
string
Example: sort=created_at desc,created_at asc

Sort results by one field created_at. Change sort order by adding desc or asc after field name

version_action
string
Enum: "create" "update" "destroy"

Version Action. Request for versions with action.

header Parameters
Authorization
required
string^[bB]earer [A-Za-z0-9]{64}$

Staff Access token type and token value.

Responses

Response samples

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