API docs by Redocly

Westfield Event Service (1)

Download OpenAPI specification:Download

Information about events for Westfield centres and retailers.

Centre Events

Endpoints related to Centre Events

CENTRE EVENTS

List events.

Request an array of events filtered by allowed parameters.

Authorizations:
api_key
query Parameters
available_on_or_after
string <date-time>

On or after this date. Request the events available on or after the date. If centre_id is supplied then the date-time is local, otherwise it is UTC.

category_ids
Array of integers

List of category Ids to be used for additional filtering of results.

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.

destination_type_ids
Array of integers

List of destination type category Ids to be used for additional filtering of results.

eligibilities
Array of integers

List of eligibility category Ids to be used for additional filtering of results.

event_ids
Array of integers

List of event ids to be used for additional filtering of results.

featured
boolean
Default: false
Example: featured=true

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

fields
Array of strings
Example: fields=_links

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

news_type_ids
Array of integers

List of news type category Ids to be used for additional filtering of results.

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.

published
boolean
Default: false

Published events. Request to include only published (true) or all (false) events.

retailer_code
string

Retailer code. Request the events with retailer_code.

sort
string

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"
support_diffusions
Array of integers

List of support diffusion category Ids to be used for additional filtering of results.

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

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

locale
string
Example: locale=fr

Retrieve localized versions of all events in response body.

strict
string

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

Responses

Response samples

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

Create an event.

Request creation of an event 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 an event.

booking_id
string

External ID for booking partner (e.g. booking bug).

browser_title
string

Browser title.

category_ids
Array of integers

Identifiers of categories the event belongs to

centre_id
required
string

Centre the event belongs to

comment
string

Comment

description
string

Event description

destination_type_ids
Array of integers
disabled_at
string <date-time>

Ending date and time of the last occurrence

eligibilities
Array of integers

Eligibility requirements of event.

external_buy_url
string

External URL to buy tickets to event

external_name
string

External name reference.

external_id
string

External system ID reference for mapping.

external_url
string

External URL for event information

external_url_description
string

External URL information description

featured
boolean

Featured

image_ref
string or null

Image filename of event location

video_url
string

Video url for event

rectangle_image
string or null

The link to the rectangle image for the event

location
string

Description of event location

Array of objects (Location)
meta_description
string

Meta description.

meta_keywords
string

Meta keywords.

mobile_event_visual
string or null

The link to the mobile app image for the event.

name
required
string

Event name

news_type_ids
Array of integers
required
Array of objects (Occurrence)

One or more occurrences of event

page_title
string

Page title.

published_at
required
string <date-time>

The date-time the event was published

Array of objects (EventRetailer)

Retailers and stores associated with the event

support_diffusions
required
Array of integers

Identifiers of channel diffusion (web/mobile/digital directory).

Responses

Request samples

Content type
application/json
{
  • "booking_id": "string",
  • "browser_title": "string",
  • "category_ids": [
    ],
  • "centre_id": "string",
  • "comment": "string",
  • "description": "string",
  • "destination_type_ids": [
    ],
  • "disabled_at": "2018-03-21T12:34:56.000Z",
  • "eligibilities": [
    ],
  • "external_buy_url": "string",
  • "external_name": "string",
  • "external_id": "string",
  • "external_url": "string",
  • "external_url_description": "string",
  • "featured": true,
  • "image_ref": "string",
  • "video_url": "string",
  • "rectangle_image": "string",
  • "location": "string",
  • "locations": [
    ],
  • "meta_description": "string",
  • "meta_keywords": "string",
  • "mobile_event_visual": "string",
  • "name": "string",
  • "news_type_ids": [
    ],
  • "occurrences": [
    ],
  • "page_title": "string",
  • "published_at": "2018-03-21T12:34:56.000Z",
  • "retailers": [
    ],
  • "support_diffusions": [
    ]
}

Response samples

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

Individual event.

Request a single event.

Authorizations:
api_key
path Parameters
event_id
required
integer
Example: 485

Event identifier. Request the event with event_id.

query Parameters
fields
Array of strings
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 store_profile field in response body.

strict
string

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

Responses

Response samples

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

Delete an event.

Request deletion of an event.

Authorizations:
api_key
path Parameters
event_id
required
integer
Example: 485

Event identifier. Request the event with event_id.

query Parameters
locale
string
Example: locale=fr

Deletes a translation from the data. By passing this query param with a locale you are removing the translation based off of the locale and not the complete event data

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 an event.

Request update of an event from JSON data in the request body.

Authorizations:
api_key
path Parameters
event_id
required
integer
Example: 485

Event identifier. Request the event with event_id.

query Parameters
locale
string
Example: locale=fr

Update name, description, page_title, meta_description, meta_keywords, browser_title fields in 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 an event.

booking_id
string

External ID for booking partner (e.g. booking bug).

browser_title
string

Browser title.

category_ids
Array of integers

Identifiers of categories the event belongs to

centre_id
string

Centre the event belongs to

comment
string

Comment

description
string

Event description

destination_type_ids
Array of integers
disabled_at
string <date-time>

Ending date and time of the last occurrence

eligibilities
Array of integers

Eligibility requirements of event.

enabled_at
string or null <date-time>

Starting date and time of the first occurrence

external_buy_url
string

External URL to buy tickets to event

external_id
string

External system ID reference for mapping.

external_name
string

External name reference.

external_url
string

External URL for event information

external_url_description
string

External URL information description

featured
boolean

Featured

image_ref
string or null

Image filename of event location

video_url
string

Video url for event

rectangle_image
string or null

The link to the rectangle image for the event

location
string

Description of event location

Array of objects (Location)
meta_description
string

Meta description.

meta_keywords
string

Meta keywords.

mobile_event_visual
string or null

The link to the mobile app image for the event.

name
string

Event name

news_type_ids
Array of integers
Array of objects (Occurrence)

One or more occurrences of event

page_title
string

Page title.

published_at
string <date-time>

The date-time the event was published

Array of objects (EventRetailer)

Retailers and stores associated with the event

support_diffusions
Array of integers

Identifiers of channel diffusion (web/mobile/digital directory).

Responses

Request samples

Content type
application/json
{
  • "booking_id": "string",
  • "browser_title": "string",
  • "category_ids": [
    ],
  • "centre_id": "string",
  • "comment": "string",
  • "description": "string",
  • "destination_type_ids": [
    ],
  • "disabled_at": "2018-03-21T12:34:56.000Z",
  • "eligibilities": [
    ],
  • "enabled_at": "2018-03-21T12:34:56.000Z",
  • "external_buy_url": "string",
  • "external_id": "string",
  • "external_name": "string",
  • "external_url": "string",
  • "external_url_description": "string",
  • "featured": true,
  • "image_ref": "string",
  • "video_url": "string",
  • "rectangle_image": "string",
  • "location": "string",
  • "locations": [
    ],
  • "meta_description": "string",
  • "meta_keywords": "string",
  • "mobile_event_visual": "string",
  • "name": "string",
  • "news_type_ids": [
    ],
  • "occurrences": [
    ],
  • "page_title": "string",
  • "published_at": "2018-03-21T12:34:56.000Z",
  • "retailers": [
    ],
  • "support_diffusions": [
    ]
}

Response samples

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

Returns event versions.

Request event versions.

Authorizations:
api_key
path Parameters
event_id
required
integer
Example: 402495

Event identifier. Request the event version with event_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=featured desc, ends_at asc

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

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

Version Action. Request the retailer 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": {
    }
}

Request to run task

Request to run task

Authorizations:
api_keytask
Request Body schema: application/json
task
required
string

Task name

Responses

Request samples

Content type
application/json
{
  • "task": "populate-centers"
}

Response samples

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