Westfield Search Service 2 (1)

Download OpenAPI specification:Download

Westfield Support: help@westfieldsupport.com URL: http://www.westfieldstatus.com License: Apache 2 License

Searche Westfield APIs

SEARCH

Search all content types.

Search results from all APIs.

Authorizations:

api_key

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
sort	string Enum: "price_low_high_sort" "price_high_low_sort" "store_name_sort" "product_name_sort" "largest_discount_sort" "most_recent_sort" Sort results. Order of results (product results only)
centre_id	string centre_id. Facet by centre_id. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
country	string country. Facet by country. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
primary_category	string primary_category. Facet by primary_category. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
retailer_code	string retailer_code. Facet by retailer_code. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
is_discounted	string is_discounted. Facet by is_discounted. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
brand	string brand. Facet by brand. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
variants.attributes.color	string variants.attributes.color. Facet by variants.attributes.color. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
category_hierarchy	string category_hierarchy. Facet by category_hierarchy. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
price	string price. Facet by price. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
sale_price	string sale_price. Facet by sale_price. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
is_featured	string is_featured. Facet by is_featured. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
category_ids	string category_ids. Facet by category_ids. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
category_paths	string category_paths. Facet by category_paths. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
category_path_hierarchy	string category_path_hierarchy. Facet by category_path_hierarchy. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
updated_since	string updated_since. Facet by updated_since. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
service_category_ids	string service_category_ids. Facet by service_category_ids. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
dining_price_guide	string dining_price_guide. Facet by dining_price_guide. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
dining_cuisine	string dining_cuisine. Facet by dining_cuisine. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
has_dining	string has_dining. Facet by has_dining. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
location_levels	string location_levels. Facet by location_levels. Note that the datatype of this facet as specified in the swagger may be incorrect, all facets are documented as being strings.
types	Array of strings Items Enum: "services" "deals" "events" "movies" "notices" "products" "productcurations" "stores" Types of results. Request search limited to specified types. Default is all types. Example: movies
locale	string Default: "empty" Returns fields that are translated to the specified values. If field does not contain requested locale, it will return blank or empty. If omitted in query it will default to null or default language which is generic.
strict	string Default: "empty" When retrieving localized results with :locale parameter, return an empty string if no applicable translation exists.

Responses

Response samples

Content type

application/json

{"data": [{ }
],
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
},
"errors": { }
}

Search 'services'

Search content of the 'services' content type

Authorizations:

api_key

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
centre_id	string centre_id. Facet by centre_id.
country	string country. Facet by country.
locale	string Default: "empty" Returns fields that are translated to the specified values. If field does not contain requested locale, it will return blank or empty. If omitted in query it will default to null or default language which is generic.
strict	string Default: "empty" When retrieving localized results with :locale parameter, return an empty string if no applicable translation exists.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_links": {"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"image": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"centre": {"centre_id": "string",
"href": "https://api.westfield.io/centres/sydney"
}
},
"active": true,
"booking_link": "string",
"centre_id": "string",
"country": "us",
"description": "string",
"eligibilities": [0
],
"external_id": "string",
"featured": true,
"hours": [{"label": "string",
"name": "string",
"display_order": 0,
"value": "string"
}
],
"level_name": "string",
"location_id": "string",
"locations": [{"label": "string",
"name": "string",
"display_order": 0,
"value": "string"
}
],
"long_title": "string",
"mobile_picto_off": "string",
"mobile_picto_on": "string",
"picto_off": "string",
"picto_on": "string",
"price": "string",
"service_id": 0,
"service_class": "digital",
"service_type": "string",
"short_title": "string",
"sort_order": 0,
"loyalty_benefit_label": "string",
"loyalty_benefit_description": "string"
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Search 'deals'

Search content of the 'deals' content type

Authorizations:

api_key

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
centre_id	string centre_id. Facet by centre_id.
country	string country. Facet by country.
locale	string Default: "empty" Returns fields that are translated to the specified values. If field does not contain requested locale, it will return blank or empty. If omitted in query it will default to null or default language which is generic.
strict	string Default: "empty" When retrieving localized results with :locale parameter, return an empty string if no applicable translation exists.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_links": {"image": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"retailer": {"href": "string",
"name": "string",
"retailer_id": 0
},
"retailer_logo": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"bar_code": "string",
"bar_code_timer": 0,
"category_ids": [0
],
"deal_id": 0,
"description": "string",
"destination_type_ids": [0
],
"eligibilities": [0
],
"ends_at": "2018-03-21T21:43:56.000Z",
"external_id": "string",
"external_name": "string",
"external_offer_logo": "string",
"external_url": "string",
"featured": true,
"limit_per_person": 0,
"limit_per_person_period": 0,
"mobile_offer_visual": "string",
"offer_types": [0
],
"published_at": "2018-03-21T21:43:56.000Z",
"quantity_limit": 0,
"quantity_limit_period": 0,
"redeemable": true,
"redeemable_period": 0,
"redemption_text": "string",
"redemption_image": "string",
"starts_at": "2018-03-21T21:43:56.000Z",
"state": "string",
"state_events": ["submit"
],
"sticker": "string",
"stores": [{"centre_id": "string",
"locations": [{"level_description": "string",
"level_id": "string",
"level_name": "Floor 1",
"location_id": "string",
"name": "Next to Bloomingdales",
"primary": true
}
],
"store_id": 0,
"phone_number": "string",
"retailer_website": "string"
}
],
"subtitle": "string",
"support_diffusions": [0
],
"terms_and_conditions": "string",
"title": "string",
"created_at": "2018-03-21T21:43:56.000Z",
"updated_at": "2018-03-21T21:43:56.000Z",
"modified_by": "user@urw.com"
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Search 'events'

Search content of the 'events' content type

Authorizations:

api_key

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
centre_id	string centre_id. Facet by centre_id.
country	string country. Facet by country.
locale	string Default: "empty" Returns fields that are translated to the specified values. If field does not contain requested locale, it will return blank or empty. If omitted in query it will default to null or default language which is generic.
strict	string Default: "empty" When retrieving localized results with :locale parameter, return an empty string if no applicable translation exists.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_embedded": {"retailers": [{"_links": {"logo": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"retailer_front": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
}
}
]
},
"_links": {"centre": {"centre_id": "string",
"href": "https://api.westfield.io/centres/sydney"
},
"image": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"video_url": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"retailers": [{"href": "https://api.westfield.io/centres/sanfrancisco"
}
],
"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"booking_id": "string",
"browser_title": "string",
"category_ids": [0
],
"centre_id": "string",
"comment": "string",
"description": "string",
"destination_type_ids": [0
],
"disabled_at": "2018-03-21T12:34:56.000Z",
"eligibilities": [0
],
"event_id": 0,
"external_buy_url": "string",
"external_id": "string",
"external_name": "string",
"external_url": "string",
"external_url_description": "string",
"featured": true,
"locations": [{"level_description": "string",
"level_id": "string",
"level_name": "Floor 1",
"location_id": "string",
"name": "string",
"primary": true
}
],
"meta_description": "string",
"meta_keywords": "string",
"mobile_event_visual": "string",
"name": "string",
"news_type_ids": [0
],
"occurrences": [{"finishes_at": "2018-03-21T12:34:56.000Z",
"starts_at": "2018-03-21T12:34:56.000Z"
}
],
"page_title": "string",
"published_at": "2018-03-21T12:34:56.000Z",
"rectangle_image": "string",
"retailers": [{"retailer_name": "string",
"retailer_code": "string",
"retailer_id": 0,
"store_ids": [0
]
}
],
"support_diffusions": [0
],
"time_zone": "string",
"updated_at": "2018-03-21T12:34:56.000Z"
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Search 'movies'

Search content of the 'movies' content type

Authorizations:

api_key

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
centre_id	string centre_id. Facet by centre_id.
country	string country. Facet by country.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_links": {"booking_url": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"image": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"classification": {"body": "string",
"detail": "moderate fantasy violence, threat",
"rating": "M"
},
"directors": ["string"
],
"genres": ["string"
],
"movie_id": 0,
"sessions": [{"_links": {"booking_url": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"centre": {"centre_id": "string",
"href": "https://api.westfield.io/centres/sydney"
},
"store": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"session_type": "string",
"start_time": "2018-03-21T21:43:56.000Z",
"store_id": 0
}
],
"source_attribution_text": "string",
"source_attribution_uri": "string",
"synopsis": "string",
"time_zone": "string",
"title": "string",
"top_cast": ["string"
],
"updated_at": "2018-03-21T21:43:56.000Z"
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Search 'notices'

Search content of the 'notices' content type

Authorizations:

api_key

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
centre_id	string centre_id. Facet by centre_id.
country	string country. Facet by country.
locale	string Default: "empty" Returns fields that are translated to the specified values. If field does not contain requested locale, it will return blank or empty. If omitted in query it will default to null or default language which is generic.
strict	string Default: "empty" When retrieving localized results with :locale parameter, return an empty string if no applicable translation exists.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_links": {"image": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"centre_id": "string",
"expires_at": "2018-03-21T21:43:56.000Z",
"name": "string",
"notice_id": 0,
"published_at": "2018-03-21T21:43:56.000Z",
"salience": 0,
"type": "standard",
"updated_at": "2018-03-21T21:43:56.000Z"
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Search 'products'

Search content of the 'products' content type

Authorizations:

api_key

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
sort	string Enum: "price_low_high_sort" "price_high_low_sort" "store_name_sort" "product_name_sort" "largest_discount_sort" "most_recent_sort" Sort results.
primary_category	string primary_category. Facet by primary_category.
retailer_code	string retailer_code. Facet by retailer_code.
is_discounted	string is_discounted. Facet by is_discounted.
brand	string brand. Facet by brand.
centre_id	string centre_id. Facet by centre_id.
variants.attributes.color	string variants.attributes.color. Facet by variants.attributes.color.
category_hierarchy	string category_hierarchy. Facet by category_hierarchy.
country required	string country. Facet by country.
price	string price. Facet by price.
sale_price	string sale_price. Facet by sale_price.
is_featured	string is_featured. Facet by is_featured.
category_ids	string category_ids. Facet by category_ids.
category_paths	string category_paths. Facet by category_paths.
category_path_hierarchy	string category_path_hierarchy. Facet by category_path_hierarchy.
updated_since	string updated_since. Facet by updated_since.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_links": {"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"brand": "string",
"categories": ["string"
],
"category_ids": [0
],
"category_paths": ["string"
],
"centres": [{"centre_id": "string",
"name": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"detailed_description": "string",
"disabled_at": "2019-08-24T14:15:22Z",
"is_featured": true,
"is_discounted": true,
"item_code": "string",
"name": "string",
"name_slug": "string",
"price": 0,
"primary_category": "string",
"primary_category_id": 0,
"product_id": "string",
"retailer": {"affiliate_fields": [{"name": "string",
"value": "string"
}
],
"country": "au",
"features": ["products"
],
"name": "string",
"retailer_code": "string"
},
"retailer_code": "string",
"sale_price": 0,
"short_description": "string",
"stores": [{"centre_id": "string",
"name": "string",
"store_id": 0
}
],
"updated_at": "2019-08-24T14:15:22Z",
"variants": [{"attributes": {"color": "string",
"size": "string"
},
"description": "string",
"ean": "string",
"images": ["string"
],
"is_default": true,
"price": {"amount": 0,
"is_discounted": true,
"rrp": 0
},
"retailer_attributes": {"color": "string",
"size": "string"
},
"retailer_product_url": "string",
"sku": "string"
}
]
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Search 'productcurations'

Search content of the 'productcurations' content type

Authorizations:

api_key

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
centre_id	string centre_id. Facet by centre_id.
country required	string country. Facet by country.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_links": {"image": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"category_ids": [0
],
"product_category_ids": [0
],
"centre_ids": ["string"
],
"code": "my-curation",
"curation_id": 0,
"description": "string",
"ends_at": "2018-03-21T21:43:56.000Z",
"featured": true,
"name": "string",
"product_ids": ["string"
],
"seo_title": "string",
"starts_at": "2018-03-21T21:43:56.000Z",
"state": "live",
"updated_at": "2018-03-21T21:43:56.000Z"
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Search 'stores'

Search content of the 'stores' content type

Authorizations:

api_key

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
centre_id	string centre_id. Facet by centre_id.
country	string country. Facet by country.
category_ids	string category_ids. Facet by category_ids.
service_category_ids	string service_category_ids. Facet by service_category_ids.
dining_price_guide	string dining_price_guide. Facet by dining_price_guide.
dining_cuisine	string dining_cuisine. Facet by dining_cuisine.
has_dining	string has_dining. Facet by has_dining.
location_levels	string location_levels. Facet by location_levels.
locale	string Default: "empty" Returns fields that are translated to the specified values. If field does not contain requested locale, it will return blank or empty. If omitted in query it will default to null or default language which is generic.
strict	string Default: "empty" When retrieving localized results with :locale parameter, return an empty string if no applicable translation exists.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_links": {"bookable_services": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"deals": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"dining": {"food_ordering": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"image": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"menu": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"events": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"icon": {"href": "string",
"description": "string"
},
"logo": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"store_front": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"curbside": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"click_and_collect": {"href": "string"
}
},
"attachment_document": "string",
"category_codes": ["string"
],
"category_ids": [0
],
"centre_id": "string",
"connect_id": "string",
"destination_type_ids": [0
],
"description": "string",
"dining": {"_links": {"food_ordering": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"image": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"menu": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"allergen_info": "string",
"cuisine": "string",
"price_guide": 4,
"vendor_id": "string"
},
"dining_cuisine": "string",
"dining_price_guide": 4,
"dining_sources": {"menu": [{"id": 0,
"url": "string",
"url_description": "string"
}
],
"online_ordering": [{"id": 0,
"category_id": 0,
"url": "string",
"source": "string",
"source_image": "string"
}
]
},
"dining_vendor_id": "string",
"email_address": "string",
"enabled": true,
"external_id": "string",
"external_name": "string",
"features": ["cinema"
],
"google_places_id": "string",
"has_deals": true,
"has_events": true,
"has_dining": true,
"lease_number": "string",
"locations": [{"level_description": "string",
"level_id": "string",
"level_name": "Floor 1",
"location_id": "string",
"name": "Next to Bloomingdales",
"primary": true
}
],
"location_levels": ["string"
],
"loyalty_enabled": true,
"mobile_logo": "string",
"mobile_restaurant_visuals": "string",
"mobile_store_visuals": "string",
"name": "string",
"parking_instructions": "string",
"queue_location_id": "string",
"retailer_code": "string",
"retailer_name": "string",
"salience": 0,
"service_category_ids": [0
],
"shop_number": "string",
"social_media": {"facebook": "string",
"google_plus": "string",
"instagram": "string",
"pinterest": "string",
"twitter": "string",
"youtube": "string"
},
"square_image": "string",
"status": {"state": "pending"
},
"store_description": "string",
"store_id": 0,
"store_level": "string",
"store_type_ids": [0
],
"store_zone": "string",
"curbside_only": true
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Search 'products' for a specific country

Search content of the 'products' content type for a specific country

Authorizations:

api_key

path Parameters

country

required

string

country. Facet by country.

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
sort	string Enum: "price_low_high_sort" "price_high_low_sort" "store_name_sort" "product_name_sort" "largest_discount_sort" "most_recent_sort" Sort results.
primary_category	string primary_category. Facet by primary_category.
retailer_code	string retailer_code. Facet by retailer_code.
is_discounted	string is_discounted. Facet by is_discounted.
brand	string brand. Facet by brand.
centre_id	string centre_id. Facet by centre_id.
variants.attributes.color	string variants.attributes.color. Facet by variants.attributes.color.
category_hierarchy	string category_hierarchy. Facet by category_hierarchy.
price	string price. Facet by price.
sale_price	string sale_price. Facet by sale_price.
is_featured	string is_featured. Facet by is_featured.
category_ids	string category_ids. Facet by category_ids.
category_paths	string category_paths. Facet by category_paths.
category_path_hierarchy	string category_path_hierarchy. Facet by category_path_hierarchy.
updated_since	string updated_since. Facet by updated_since.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_links": {"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"brand": "string",
"categories": ["string"
],
"category_ids": [0
],
"category_paths": ["string"
],
"centres": [{"centre_id": "string",
"name": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"detailed_description": "string",
"disabled_at": "2019-08-24T14:15:22Z",
"is_featured": true,
"is_discounted": true,
"item_code": "string",
"name": "string",
"name_slug": "string",
"price": 0,
"primary_category": "string",
"primary_category_id": 0,
"product_id": "string",
"retailer": {"affiliate_fields": [{"name": "string",
"value": "string"
}
],
"country": "au",
"features": ["products"
],
"name": "string",
"retailer_code": "string"
},
"retailer_code": "string",
"sale_price": 0,
"short_description": "string",
"stores": [{"centre_id": "string",
"name": "string",
"store_id": 0
}
],
"updated_at": "2019-08-24T14:15:22Z",
"variants": [{"attributes": {"color": "string",
"size": "string"
},
"description": "string",
"ean": "string",
"images": ["string"
],
"is_default": true,
"price": {"amount": 0,
"is_discounted": true,
"rrp": 0
},
"retailer_attributes": {"color": "string",
"size": "string"
},
"retailer_product_url": "string",
"sku": "string"
}
]
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Search 'productcurations' for a specific country

Search content of the 'productcurations' content type for a specific country

Authorizations:

api_key

path Parameters

country

required

string

country. Facet by country.

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
centre_id	string centre_id. Facet by centre_id.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_links": {"image": {"href": "https://api.westfield.io/centres/sanfrancisco"
},
"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"category_ids": [0
],
"product_category_ids": [0
],
"centre_ids": ["string"
],
"code": "my-curation",
"curation_id": 0,
"description": "string",
"ends_at": "2018-03-21T21:43:56.000Z",
"featured": true,
"name": "string",
"product_ids": ["string"
],
"seo_title": "string",
"starts_at": "2018-03-21T21:43:56.000Z",
"state": "live",
"updated_at": "2018-03-21T21:43:56.000Z"
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Search 'products' that syndicate

Search syndicated content of the 'products' content type

Authorizations:

api_key

path Parameters

country

required

string

country. Facet by country.

query Parameters

debug	boolean Default: false Include debug information (such as ranking and analytics data) in the response
excludeFromSearch	Array of strings List of attributes you do not want to use for search
fields	Array of strings Fields in 'hits' response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.
limit	integer <= 100 Default: 5 Limit. Maximum number of results to return per result type.
maxValuesPerFacet	integer <= 5000 Default: 10 Maximum Values Per Facet. Maximum number of values to return per facet.
page	integer Default: 1 Results page number. Specific page of results to request when paginating.
term	string Search term. Contents of search term.
sort	string Enum: "price_low_high_sort" "price_high_low_sort" "store_name_sort" "product_name_sort" "largest_discount_sort" "most_recent_sort" Sort results.
primary_category	string primary_category. Facet by primary_category.
retailer_code	string retailer_code. Facet by retailer_code.
is_discounted	string is_discounted. Facet by is_discounted.
brand	string brand. Facet by brand.
centre_id	string centre_id. Facet by centre_id.
variants.attributes.color	string variants.attributes.color. Facet by variants.attributes.color.
category_hierarchy	string category_hierarchy. Facet by category_hierarchy.
price	string price. Facet by price.
sale_price	string sale_price. Facet by sale_price.
is_featured	string is_featured. Facet by is_featured.
category_ids	string category_ids. Facet by category_ids.
category_paths	string category_paths. Facet by category_paths.
category_path_hierarchy	string category_path_hierarchy. Facet by category_path_hierarchy.
updated_since	string updated_since. Facet by updated_since.

Responses

Response samples

Content type

application/json

{"data": {"exhaustiveFacetsCount": true,
"facets": { },
"facets_stats": { },
"hits": [{"_links": {"self": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"brand": "string",
"categories": ["string"
],
"category_ids": [0
],
"category_paths": ["string"
],
"centres": [{"centre_id": "string",
"name": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"detailed_description": "string",
"disabled_at": "2019-08-24T14:15:22Z",
"is_featured": true,
"is_discounted": true,
"item_code": "string",
"name": "string",
"name_slug": "string",
"price": 0,
"primary_category": "string",
"primary_category_id": 0,
"product_id": "string",
"retailer": {"affiliate_fields": [{"name": "string",
"value": "string"
}
],
"country": "au",
"features": ["products"
],
"name": "string",
"retailer_code": "string"
},
"retailer_code": "string",
"sale_price": 0,
"short_description": "string",
"stores": [{"centre_id": "string",
"name": "string",
"store_id": 0
}
],
"updated_at": "2019-08-24T14:15:22Z",
"variants": [{"attributes": {"color": "string",
"size": "string"
},
"description": "string",
"ean": "string",
"images": ["string"
],
"is_default": true,
"price": {"amount": 0,
"is_discounted": true,
"rrp": 0
},
"retailer_attributes": {"color": "string",
"size": "string"
},
"retailer_product_url": "string",
"sku": "string"
}
]
}
],
"hitsPerPage": 0,
"index": "string",
"nbHits": 0,
"nbPages": 0,
"page": 0,
"params": "string",
"processingTimeMS": 0,
"query": "string"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}

Request to run task

Authorizations:

api_keytask

Request Body schema: application/json

task

required

string

Task name

Responses

Request samples

Payload

Content type

application/json

{"task": "populate-centers"
}

Response samples

Content type

application/json

{"data": {"taskArn": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z"
},
"errors": { },
"meta": {"api_version": "1",
"deprecation_information": {"deprecated_at": "2018-03-21T00:00:00Z",
"goes_away_at": "2018-06-21T00:00:00Z",
"more_info": {"href": "https://api.westfield.io/centres/sanfrancisco"
}
},
"origin": "CenterDirectoryService",
"page": 1,
"page_count": 10,
"per_page": 25,
"total": 100
}
}