API docs by Redocly

Westfield APIs (1)

Download OpenAPI specification:Download

Summary of Westfield API endpoints.

Centre Information

Endpoints related to Centre Information

List centers.

Request an array of centers filtered by allowed parameters.

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

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

centre_fid_id
string

Center FID identifier. Request the center with centre_fid_id.

country
string
Enum: "US" "UK" "SE" "FR" "ES" "NL" "AT" "DE" "SK" "PL" "DK" "CZ"
Example: country=us
enabled
boolean
Default: true
Example: enabled=true

Enabled centers. Request only enabled (true) or not enabled (false) centers.

fields
string
Example: fields=_links

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

max_distance
number
Example: max_distance=100

Distance limit (in kilometers). Combines with 'near_to' center to set maximum distance to search for up to three centers.

near_to
string

Center identifier. Request the three closest centers within 'max_distance' of the given center, sorted by distance from the given center.

state
string
Example: state=ca

State or region code in uppercase. Request the centers with state. Currently only the AU and US states are available.

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.

statuses
string
Enum: "pending" "preview" "live" "expired" "invalid" "disabled"
updated_since
string <date-time>
Example: updated_since=2015-04-02
locale
string
Example: locale=fr

Retrieve localized versions of all centers in response body.

strict
string

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

westfield_branded
string
Default: "true"
Enum: "true" "false" "all"

Retrieve centers that are either Westfield branded or not. If the parameter is not passed, only Westfield branded centers are retrieved.

Responses

Response samples

Content type
application/json
{}

Create a center.

Request creation of a center 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 center.

business_unit_code
string or null

Business unit code

centre_id
required
string

Center identifier

centre_fid_id
string or null

Center FID identifier

centre_pc_id
string or null

Center PC identifier

country
required
string
Enum: "US" "UK" "SE" "FR" "ES" "NL" "AT" "DE" "SK" "PL" "DK" "CZ"

Country

dining_image_ref
required
string

Dining image filename or pass in an empty string ''

dining_image_medium_ref
required
string

Medium-sized dining image filename or pass in an empty string ''

dining_image_small_ref
required
string

Small-sized dining image filename or pass in an empty string ''

email_address
required
string

Email address

hero_image_ref
required
string

Hero image filename or pass in an empty string ''

latitude
required
number <double>

Latitude

longitude
required
number <double>

Longitude

loyalty
boolean or null

Loyalty

westfield_branded
boolean or null

Westfield Branded

time_zone
string or null

Center time_zone

centre_logo
string or null

URI to obtain center logo image

Array of objects (CenterFloor)
name
required
string

Name

map_initial_x
number or null

X position of map for initialization

map_initial_y
number or null

Y position of map for initialization

map_level
string or null

Map level label

map_provider
string or null

Mapping Provider is one of visioglobe or jibestream

mobile_app_centre_image
string or null

URI to obtain center image for mobile app

phone_number
required
string

Phone number

queue_enabled
boolean or null

Opt-in for queuing system

street_address
required
string

Street address

disabled_at
string or null <date-time>

Date center will-be/was disabled

enabled
boolean or null

Center is enabled (true/false)

enabled_at
string or null <date-time>

Date center is/was enabled

external_id
string or null

external system id reference for mapping

external_name
string or null

External name reference

features
Array of strings or null
generic_title
string or null

Fallback title

object (GeofenceList)
map_id
string or null

Map location identifier

number_of_levels
number or null

Number of floor levels

owner
string or null

Owner of center

postcode
string or null

Valid PostCode For Country

salesforce_app_id
string or null

Salesforce App ID

salesforce_access_token
string or null

Salesforce Access Token

short_name
string or null

Short name

object (SocialMediaList)
state
string or null

State

suburb
string or null

City/Suburb

theme
string or null

Tier of Center

type
string or null

Type of asset

Responses

Request samples

Content type
application/json
{
  • "business_unit_code": "string",
  • "centre_id": "string",
  • "centre_fid_id": "string",
  • "centre_pc_id": "string",
  • "country": "US",
  • "dining_image_ref": "string",
  • "dining_image_medium_ref": "string",
  • "dining_image_small_ref": "string",
  • "email_address": "string",
  • "hero_image_ref": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "loyalty": true,
  • "westfield_branded": true,
  • "time_zone": "string",
  • "centre_logo": "string",
  • "floors": [
    ],
  • "name": "string",
  • "map_initial_x": 0,
  • "map_initial_y": 0,
  • "map_level": "string",
  • "map_provider": "string",
  • "mobile_app_centre_image": "string",
  • "phone_number": "string",
  • "queue_enabled": true,
  • "street_address": "string",
  • "disabled_at": "2018-03-21T21:43:56Z",
  • "enabled": true,
  • "enabled_at": "2018-03-21T21:43:56Z",
  • "external_id": "string",
  • "external_name": "string",
  • "features": [
    ],
  • "generic_title": "string",
  • "geofences": {
    },
  • "map_id": "string",
  • "number_of_levels": 0,
  • "owner": "string",
  • "postcode": "string",
  • "salesforce_app_id": "string",
  • "salesforce_access_token": "string",
  • "short_name": "string",
  • "social_media": {
    },
  • "state": "string",
  • "suburb": "string",
  • "theme": "string",
  • "type": "string"
}

Response samples

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

Individual center.

Request a single center.

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.

locale
string
Example: locale=fr

Retrieve localized version of center in response body.

strict
string

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

Responses

Response samples

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

Update a center.

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

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
locale
string
Example: locale=fr

Update version of generic_title field 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 center.

business_unit_code
string or null

Business unit code

centre_id
string

Center identifier

centre_fid_id
string or null

Center FID identifier

centre_pc_id
string or null

Center PC identifier

country
string
Enum: "US" "UK" "SE" "FR" "ES" "NL" "AT" "DE" "SK" "PL" "DK" "CZ"

Country

dining_image_ref
string

Dining image filename or pass in an empty string ''

dining_image_medium_ref
string

Medium-sized dining image filename or pass in an empty string ''

dining_image_small_ref
string

Small-sized dining image filename or pass in an empty string ''

email_address
string

Email address

hero_image_ref
string

Hero image filename or pass in an empty string ''

latitude
number <double>

Latitude

longitude
number <double>

Longitude

loyalty
boolean or null

Loyalty

westfield_branded
boolean or null

Westfield Branded

Array of objects (CenterFloor)
name
string

Name

phone_number
string

Phone number

queue_enabled
boolean or null

Opt-in for queuing system

street_address
string

Street address

disabled_at
string or null <date-time>

Date center will-be/was disabled

enabled
boolean or null

Center is enabled (true/false)

enabled_at
string or null <date-time>

Date center is/was enabled

external_id
string or null

external system id reference for mapping

external_name
string or null

External name reference

features
Array of strings or null
generic_title
string or null

Fallback title

object (GeofenceList)
map_id
string or null

Map location identifier

number_of_levels
number or null

Number of floor levels

owner
string or null

Owner of center

postcode
string or null

Valid PostCode For Country

salesforce_app_id
string or null

Salesforce App ID

salesforce_access_token
string or null

Salesforce Access Token

short_name
string or null

Short name

object (SocialMediaList)
state
string or null

State

suburb
string or null

City/Suburb

theme
string or null

Tier of Center

type
string or null

Type of asset

Responses

Request samples

Content type
application/json
{
  • "business_unit_code": "string",
  • "centre_id": "string",
  • "centre_fid_id": "string",
  • "centre_pc_id": "string",
  • "country": "US",
  • "dining_image_ref": "string",
  • "dining_image_medium_ref": "string",
  • "dining_image_small_ref": "string",
  • "email_address": "string",
  • "hero_image_ref": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "loyalty": true,
  • "westfield_branded": true,
  • "floors": [
    ],
  • "name": "string",
  • "phone_number": "string",
  • "queue_enabled": true,
  • "street_address": "string",
  • "disabled_at": "2018-03-21T21:43:56Z",
  • "enabled": true,
  • "enabled_at": "2018-03-21T21:43:56Z",
  • "external_id": "string",
  • "external_name": "string",
  • "features": [
    ],
  • "generic_title": "string",
  • "geofences": {
    },
  • "map_id": "string",
  • "number_of_levels": 0,
  • "owner": "string",
  • "postcode": "string",
  • "salesforce_app_id": "string",
  • "salesforce_access_token": "string",
  • "short_name": "string",
  • "social_media": {
    },
  • "state": "string",
  • "suburb": "string",
  • "theme": "string",
  • "type": "string"
}

Response samples

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

Returns center versions.

Request center versions.

Authorizations:
api_key
path Parameters
centre_id
required
string
Example: centurycity

centre identifier. Request the centre version with centre_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": {
    }
}

List newsletters.

List of newsletters associated with each center.

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

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

Responses

Response samples

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

Information about a list of newsletters

Request the centre_ids and countries of a list of newsletters

Authorizations:
api_key
query Parameters
newsletter_ids
Array of strings
Example: newsletter_ids=belconnen_food,airportwest_fashion

Newsletter identifiers. Request information about newsletters with newsletter_ids. Lowercase code name for a specific newsletter. Example: ['airportwest_fashion','parramatta_family','belconnen_food']

Responses

Response samples

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

List countries.

Request an array of countries.

Authorizations:
api_key

Responses

Response samples

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

Lists states filtered by allowed parameters.

Returns a list of states

Authorizations:
api_key
query Parameters
country
string
Enum: "US" "UK" "SE" "FR" "ES" "NL" "AT" "DE" "SK" "PL" "DK" "CZ"
Example: country=us

Responses

Response samples

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

Centre Notices

Endpoints related to Centre Notices

List centre notices.

Request an array of notices filtered by allowed parameters.

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

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

featured
boolean
Example: featured=true

Featured notices. Request to include only featured (true) or not featured (false) notices.

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.

sort
string
Example: sort=expires_at asc, featured asc

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

status
string
Enum: "pending" "active" "expired"

Filter by status

statuses
string
Enum: "pending" "preview" "live" "expired" "invalid" "disabled"
type
string
Enum: "standard" "emergency"
Example: type=standard

Type

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

Responses

Response samples

Content type
application/json
{}

Create a notice.

Request creation of a notice 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 notice.

centre_id
required
string

Center identifier

detail
required
string >= 2 characters

Notice content text

expires_at
required
string <date-time>

Notice expiry date

image_ref
required
string

Image filename

img_alt_text
required
string

Image alternative text

name
required
string [ 2 .. 40 ] characters

Notice name

published_at
required
string <date-time>

Notice publication date

attachment_ref
string

Attachment filename

featured
boolean

Notice is featured (true/false)

salience
number [ 0 .. 100 ]
type
string
Enum: "standard" "emergency"

Type

Responses

Request samples

Content type
application/json
{
  • "centre_id": "string",
  • "detail": "string",
  • "expires_at": "2018-03-21T21:43:56Z",
  • "image_ref": "string",
  • "img_alt_text": "string",
  • "name": "string",
  • "published_at": "2018-03-21T21:43:56Z",
  • "attachment_ref": "string",
  • "featured": true,
  • "salience": 100,
  • "type": "standard"
}

Response samples

Content type
application/json
{}

Individual notice.

Request a single notice.

Authorizations:
api_key
path Parameters
notice_id
required
number
Example: 485

Notice identifier. Request to delete the notice with notice_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.

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.

status
string
Enum: "pending" "active" "expired"

Filter by status

Responses

Response samples

Content type
application/json
{}

Delete a notice.

Request deletion of a notice.

Authorizations:
api_key
path Parameters
notice_id
required
number
Example: 485

Notice identifier. Request to delete the notice with notice_id.

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 notice.

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

Authorizations:
api_key
path Parameters
notice_id
required
number
Example: 485

Notice identifier. Request to delete the notice with notice_id.

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 deal.

centre_id
string

Center identifier

detail
string >= 2 characters

Notice content text

expires_at
string <date-time>

Notice expiry date

image_ref
string

Image filename

img_alt_text
string

Image alternative text

name
string [ 2 .. 40 ] characters

Notice name

published_at
string <date-time>

Notice publication date

attachment_ref
string

Attachment filename

featured
boolean

Notice is featured (true/false)

salience
number [ 0 .. 100 ]
type
string
Enum: "standard" "emergency"

Type

Responses

Request samples

Content type
application/json
{
  • "centre_id": "string",
  • "detail": "string",
  • "expires_at": "2018-03-21T21:43:56Z",
  • "image_ref": "string",
  • "img_alt_text": "string",
  • "name": "string",
  • "published_at": "2018-03-21T21:43:56Z",
  • "attachment_ref": "string",
  • "featured": true,
  • "salience": 100,
  • "type": "standard"
}

Response samples

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