Westfield Store APIs (1)

Download OpenAPI specification:Download

Summary of Westfield Store API endpoints.

Retailers

Endpoints related to Retailers

List retailers

Request an array of retailers filtered by allowed parameters

Authorizations:
api_key
query Parameters
campaign_id
integer

Campaign identifier. Request retailers with campaign_id

category_id
integer
Example: category_id=54

Category identifier. Request the retailers with category_id

centre_id
string
Default: "sanfrancisco"
Example: centre_id=sanfrancisco&centre_id=sydney&centre_id=london

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

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

Country code. Request the retailers with country code. Lowercase two-character code for country.

enabled
boolean
Default: true
Example: enabled=true

Select enabled retailers. Request to include only enabled (true) or not enabled (false) retailers

branded
boolean
Default: false

Include or exclude results from non-Westfield branded centers. Select true apply exclusion filter, removing {retailers}{stores} from debranded centers. False (default) will return all results.

features
Array of strings
Default: ""
Items Enum: "products" "can_syndicate"
Example: features=products

Retailer features. Request the retailers with features.

fields
string
Example: fields=_links

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

name
string <= 255 characters
Example: name=Nord*

Retailer name. Request the retailers with a partial name match with wildcards.

page
integer
Default: 1
Example: page=2

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

per_page
integer <= 100
Default: 25
Example: per_page=25

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

q
string

Query. Request retailers based on partial match of name or retailer code.

retailer_code
Array of strings[ items <= 255 characters ]
Example: retailer_code=us-adidas,us-aldo,us-gap

Retailer code. Request the list of retailers with retailer_codes.

retailer_id
Array of integers
Example: retailer_id=926

Retailer identifier. Request the list of retailers with retailer_id.

statuses
string
Enum: "pending" "preview" "live" "expired" "invalid" "disabled"
updated_since
string <date-time>
Example: updated_since=2015-04-02T00:00:00.000Z

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

locale
string
Example: locale=fr

Retrieve localized versions of all retailers in response body

strict
string

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

lease_id
string <= 255 characters

Lease ID or Mercury ID. Request the list of retailers with lease_id.

without_lease
string
Value: "true"

Without Lease ID. Request the list of retailers without lease_id.

Responses

Response samples

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

Create a retailer

Request creation of a Retailer from JSON data in the request body

Authorizations:
(api_keybearerAuth)
Request Body schema: application/json
cam_ref
string

Conversion tracking provider identifier

campaign_id
string

ID of a Westfield campaign for the retailer

category_ids
required
Array of integers
Default: []

List of Category identifiers associated with the retailer

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

Two letter code of the country the retailer operates in

currency_code
string <= 16 characters
Default: "AUD"

Three letter code of the currency the retailer uses

email_address
string <= 255 characters

E-mail address of the retailer

external_id
string
Default: ""

External system id reference for mapping

features
Array of strings
Default: []
Items Enum: "products" "can_syndicate"

List of features the retailer has. If 'products' is present the retailer can upload products to the Westfield system. If 'can_syndicate' is present the product data for this retailer can be redistributed by a third party.

enabled
boolean

Flag indicating if the retailer is enabled in the Westfield system

lease_id
string

Identifier of the retailer's lease with Westfield

logo_ref
string <= 255 characters

URL of the retailer's logo image

name
required
string

Name of the retailer

product_tier
integer
Default: 3
Enum: 1 2 3

Tiers for grouping similar retailers

retailer_code
required
string <= 255 characters ^[-0-9a-z]*$

Code of the retailer, generally its lowercase, dasherized name. Note: follows pattern /A[-0-9a-z]z/ for PCRE and ^[-0-9a-z]$ for everything else.

retailer_front_image_ref
string <= 255 characters

URL for retailers main image

retailer_website
string <= 255 characters

URL of the retailer's website

retailer_logo_svg
string <= 255 characters

URL of the retailer's logo in svg format

retailer_logo_background_image
string <= 255 characters

URL of the retailer's logo in background format

service_category_ids
Array of integers
Default: []

List of Service Category identifiers associated with the retailer

store_profile
string

Long description of the retailer

storefront_ref
string <= 255 characters

Storage provider ID of the image of a store front of the retailer

Responses

Request samples

Content type
application/json
{
  • "cam_ref": "string",
  • "campaign_id": "string",
  • "category_ids": [ ],
  • "country": "us",
  • "currency_code": "AUD",
  • "email_address": "string",
  • "external_id": "",
  • "features": [ ],
  • "enabled": true,
  • "lease_id": "string",
  • "logo_ref": "string",
  • "name": "string",
  • "product_tier": 1,
  • "retailer_code": "string",
  • "retailer_front_image_ref": "string",
  • "retailer_website": "string",
  • "retailer_logo_svg": "string",
  • "retailer_logo_background_image": "string",
  • "service_category_ids": [ ],
  • "store_profile": "string",
  • "storefront_ref": "string"
}

Response samples

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

Individual retailer

Request a single retailer

Authorizations:
api_key
path Parameters
retailer_code
required
string <= 255 characters
Example: us-adidas

Retailer code. Request the retailer with retailer_code.

query Parameters
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": {
    }
}

Update a retailer

Request update of a retailer from JSON data in the request body

Authorizations:
(api_keybearerAuth)
path Parameters
retailer_code
required
string <= 255 characters
Example: us-adidas

Retailer code. Update the retailer with retailer_code.

query Parameters
locale
string
Example: locale=fr

Update store_profile field with provided locale.

Request Body schema: application/json
Array of objects (RetailerAffiliateField)

List of affiliate fields for a retailer.

cam_ref
string

Conversion tracking provider ID.

campaign_id
string

Identifier of a Westfield campaign for the retailer.

category_ids
Array of integers

List of Category IDs associated with the retailer.

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

Two letter code of the country the retailer operates in.

currency_code
string <= 16 characters
Default: "AUD"

Three letter code of the currency the retailer uses.

email_address
string <= 255 characters

E-mail address of the retailer.

external_id
string

external system id reference for mapping

features
Array of strings
Items Enum: "products" "can_syndicate"

List of features the retailer has. If 'products' is present the retailer can upload products to the Westfield system. If 'can_syndicate' is present the product data for this retailer can be redistributed by a third party.

enabled
boolean

Flag indicating if the retailer is enabled in the Westfield system.

lease_id
string

Identifier of the retailer's lease with Westfield.

logo_ref
string <= 255 characters

Storage provider ID of the retailer's logo image.

name
string

Name of the retailer.

product_tier
integer
Enum: 1 2 3

Tiers for grouping similar retailers.

retailer_front_image_ref
string <= 255 characters

URL for retailers main image.

retailer_website
string <= 255 characters

URL of the retailer's website.

retailer_logo_svg
string <= 255 characters

URL of the retailer's logo in svg format

retailer_logo_background_image
string <= 255 characters

URL of the retailer's logo in background format

service_category_ids
Array of integers

List of Service Category identifiers associated with the retailer.

store_profile
string

Long description of the retailer.

storefront_ref
string <= 255 characters

Storage provider ID of the image of a store front of the retailer.

Responses

Request samples

Content type
application/json
{
  • "affiliate_fields": [
    ],
  • "cam_ref": "string",
  • "campaign_id": "string",
  • "category_ids": [
    ],
  • "country": "us",
  • "currency_code": "AUD",
  • "email_address": "string",
  • "external_id": "string",
  • "features": [
    ],
  • "enabled": true,
  • "lease_id": "string",
  • "logo_ref": "string",
  • "name": "string",
  • "product_tier": 1,
  • "retailer_front_image_ref": "string",
  • "retailer_website": "string",
  • "retailer_logo_svg": "string",
  • "retailer_logo_background_image": "string",
  • "service_category_ids": [
    ],
  • "store_profile": "string",
  • "storefront_ref": "string"
}

Response samples

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

Returns retailer versions

Request retailer versions

Authorizations:
(api_keybearerAuth)
path Parameters
retailer_code
required
string
Example: 402495

Retailer identifier. Request the retailer version with retailer_code.

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.

Responses

Response samples

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

Stores

Endpoints related to Stores

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": {
    }
}

List stores

Request an array of stores filtered by allowed parameters

Authorizations:
api_key
query Parameters
category_id
integer or null
Example: category_id=54

Category identifier. Request the stores with category_id

centre_id
string <= 64 characters
Default: "sanfrancisco"
Example: centre_id=sanfrancisco&centre_id=sydney&centre_id=london

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

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

Country code. Request the stores with country code. Lowercase two-character code for country.

destination_type_ids
Array of integers

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

enabled
boolean

Select enabled stores. Request to include only enabled (true) or not enabled (false) stores. This will be deprecated. Please remove from future queries and uses statuses parameter instead.

branded
boolean
Default: false

Include or exclude results from non-Westfield branded centers. Select true apply exclusion filter, removing {retailers}{stores} from debranded centers. False (default) will return all results.

fields
string
Example: fields=_links

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

lease_id
string <= 64 characters

Lease ID or Mercury ID. Request the list of retailers with lease_id.

page
integer
Default: 1
Example: page=2

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

per_page
integer <= 500
Default: 25
Example: per_page=25

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

q
string

Query. Request stores based on partial match on name

retailer_code
string
Example: retailer_code=us-adidas

Retailer code. Request the stores with retailer_code. Lowercase code name assigned a specific retailer.

retailer_id
integer
Example: retailer_id=926

Retailer identifier. Request the stores with retaler_id.

sort
string
Default: "name asc"
Enum: "abn asc" "centre_id asc" "dining_cuisine asc" "dining_image_ref asc" "dining_menu_ref asc" "email_address asc" "lease_id asc" "name asc" "phone_no asc" "retailer_website asc" "salience asc" "shop_no asc" "store_front_image_ref asc" "abn desc" "centre_id desc" "dining_cuisine desc" "dining_image_ref desc" "dining_menu_ref desc" "email_address desc" "lease_id desc" "name desc" "phone_no desc" "retailer_website desc" "salience desc" "shop_no desc" "store_front_image_ref desc"
Example: sort=centre_id desc,name asc

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

statuses
string
Enum: "pending" "preview" "live" "expired" "invalid" "disabled"
store_ids
Array of integers

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

store_type_ids
Array of integers

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

trading_hour
boolean
Default: false

Trading hours. Request the stores with trading hours

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

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

with_first_letter
string
Example: with_first_letter=n

First letter of store. Request the stores by the normalized first letter of the store name

locale
string
Example: locale=fr

Retrieve localized versions of all stores in response body

strict
string

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

Responses

Response samples

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

Create a store

Request creation of a store from JSON data in the request body

Authorizations:
(api_keybearerAuth)
Request Body schema: application/json
attachment_document
string

Link to an attachment resource.

category_ids
required
Array of integers
Default: []

List of Category IDs associated with the store.

centre_id
required
string <= 64 characters

Identifier of the centre where the store is located.

connect_id
string <= 255 characters

Identifier for external MallCom Connect service.

destination_type_ids
Array of integers
Default: []

List of destination type IDs the store belongs to.

object (DiningCreateBody)

Parameters for the dining section in a store

dining_cuisine
string <= 20 characters

[DEPRECATED]. Cuisine offered by the store if it provides dining facilities.

dining_image_ref
string <= 255 characters

[DEPRECATED]. Storage provider identifier of the dining image of the store if it provides dining facilities.

dining_menu_ref
string <= 255 characters

[DEPRECATED]. Storage provider identifier of the menu of the store if it provides dining facilities.

dining_price_guide
integer <= 4

[DEPRECATED]. Number indicating the relative price of dining at the store.

dining_vendor_id
string

[DEPRECATED]. Dining vendor identifier if the store is a dining facility that participates in Open Dining Network; an empty string otherwise.

disabled_at
string or null <date-time>

Date the store was disabled in the Westfield system.

email_address
string <= 255 characters

E-mail address of the store.

enabled_at
string or null <date-time>

Date the store was enabled in the Westfield system.

external_id
string or null

external system ID reference for mapping.

external_name
string or null

external system name reference.

features
Array of strings
Items Enum: "cinema" "foodordering" "giftcards" "products" "afterpay"

List of features the store has. If 'foodordering' is present the store supports ordering food via the Food App. If 'giftcards' is present the store accepts giftcards.

google_places_id
string <= 255 characters

The stores google_places_id.

icon_description
string <= 255 characters

Icon description of the store.

icon_ref
string <= 255 characters

Link of the store's icon.

lease_number
string <= 64 characters

Number of the store's lease with Westfield.

Array of objects (StoreLocation)

List of jibestream locations and meta data.

location_levels
Array of strings

List of level names sourced form Jibestream locations.

loyalty_enabled
boolean
Default: false

Flag indicating if the store is participating in loyalty.

Array of objects (StoreCreateMetadataDining)

Create parameters of dining metadata.

mobile_logo
string or null

The link to the logo for the mobile app.

mobile_restaurant_visuals
string or null

The link to the restaurant's image for the mobile app.

mobile_store_visuals
string or null

The link to the store's image for the mobile app.

name
required
string <= 1000 characters

Name of the store.

parking_instructions
string <= 5000 characters

Instructions for parking at the store.

phone_number
string <= 64 characters

Phone number of the store.

click_and_collect
string or null

Click and collect URL.

queue_location_id
string or null <= 255 characters

Identifier for the store record in the external queuing service.

retailer_id
required
integer

Identifier of the retailer the store belongs to.

retailer_website
string

URL of the store's website.

salience
required
integer
Default: 0

Numeric value used for wayfinding applications.

service_category_ids
Array of integers

List of Service Category identifiers associated with the store.

shop_number
string or null <= 16 characters

The shop number in the Westfield centre the store occupies.

object (StoreSocialMediaList)
square_image
string or null

The link to the square image for the store.

object (StatusCreateBody)

Status information for a store.

store_description
string or null

Store's description.

store_logo_svg
string or null

The link to the logo in svg format.

store_logo_background_image
string or null

The link to the image in background of the logo.

store_front_image_ref
string or null <= 255 characters

Storage provider identifier of the store's store front image.

store_level
string or null

Front-end store level descriptor.

store_type_ids
required
Array of integers

List of store type IDs the store belongs to.

store_zone
string or null

Front-end store zone descriptor.

curbside_only
boolean
Default: false

Whether the store is only offering curbside service only.

Responses

Request samples

Content type
application/json
{
  • "attachment_document": "string",
  • "category_ids": [ ],
  • "centre_id": "string",
  • "connect_id": "string",
  • "destination_type_ids": [ ],
  • "dining": {
    },
  • "dining_cuisine": "string",
  • "dining_image_ref": "string",
  • "dining_menu_ref": "string",
  • "dining_price_guide": 4,
  • "dining_vendor_id": "string",
  • "disabled_at": "2018-03-21T21:43:56Z",
  • "email_address": "string",
  • "enabled_at": "2018-03-21T21:43:56Z",
  • "external_id": "string",
  • "external_name": "string",
  • "features": [
    ],
  • "google_places_id": "string",
  • "icon_description": "string",
  • "icon_ref": "string",
  • "lease_number": "string",
  • "locations": [
    ],
  • "location_levels": [
    ],
  • "loyalty_enabled": false,
  • "metadata_dinings": [
    ],
  • "mobile_logo": "string",
  • "mobile_restaurant_visuals": "string",
  • "mobile_store_visuals": "string",
  • "name": "string",
  • "parking_instructions": "string",
  • "phone_number": "string",
  • "click_and_collect": "string",
  • "queue_location_id": "string",
  • "retailer_id": 0,
  • "retailer_website": "string",
  • "salience": 0,
  • "service_category_ids": [
    ],
  • "shop_number": "string",
  • "social_media": {},
  • "square_image": "string",
  • "status": {
    },
  • "store_description": "string",
  • "store_logo_svg": "string",
  • "store_logo_background_image": "string",
  • "store_front_image_ref": "string",
  • "store_level": "string",
  • "store_type_ids": [
    ],
  • "store_zone": "string",
  • "curbside_only": false
}

Response samples

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

Individual store

Request a single store

Authorizations:
api_key
path Parameters
store_id
required
integer
Example: 402495

Store identifier. Request the store with store_id

query Parameters
locale
string
Example: locale=fr

Retrieve localized version of dining.allergen_info, icon.description, parking_instructions 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

trading_hour
boolean
Default: false

Request the stores with trading hours

Responses

Response samples

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

Update a store

Request update of a store from JSON data in the request body

Authorizations:
(api_keybearerAuth)
path Parameters
store_id
required
integer
Example: 402495

Store identifier. Update the store with store_id

query Parameters
locale
string
Example: locale=fr

Update dining.allergen_info, icon.description, parking_instructions fields in with provided locale

Request Body schema: application/json
attachment_document
string or null

Link to an attachment resource.

category_ids
Array of integers

List of Service Category identifiers associated with the store.

centre_id
string <= 64 characters

Identifier of the centre where the store is located.

connect_id
string <= 255 characters

Identifier for external MallCom Connect service.

destination_type_ids
Array of integers

List of destination type IDs the store belongs to.

object (DiningCreateBody)

Parameters for the dining section in a store

dining_cuisine
string <= 20 characters

[DEPRECATED]. Cuisine offered by the store if it provides dining facilities.

dining_image_ref
string <= 255 characters

[DEPRECATED]. Storage provider identifier of the dining image of the store if it provides dining facilities.

dining_menu_ref
string <= 255 characters

[DEPRECATED]. Storage provider identifier of the menu of the store if it provides dining facilities.

dining_price_guide
integer <= 4

[DEPRECATED]. Number indicating the relative price of dining at the store.

dining_vendor_id
string

[DEPRECATED]. Dining vendor identifier if the store is a dining facility that participates in Open Dining Network; an empty string otherwise.

disabled_at
string or null <date-time>

Date the store was disabled in the Westfield system.

email_address
string or null <= 255 characters

E-mail address of the store.

enabled_at
string or null <date-time>

Date the store was enabled in the Westfield system.

external_id
string or null

external system ID reference for mapping.

external_name
string or null

external system name reference.

features
Array of strings
Items Enum: "cinema" "foodordering" "giftcards" "products" "afterpay"

List of features the store has. If 'foodordering' is present the store supports ordering food via the Food App. If 'giftcards' is present the store accepts giftcards.

google_places_id
string <= 255 characters

The stores google_places_id

lease_number
string or null <= 64 characters

Number of the store's lease with Westfield.

Array of objects (StoreLocation)

List of jibestream locations and meta data

location_levels
Array of strings

List of level names sourced form Jibestream locations.

loyalty_enabled
boolean

Flag indicating if the store is participating in loyalty.

Array of objects (StoreUpdateMetadataDining)

Update parameters of dining metadata.

metadata_dining_delete
boolean

Parameter used to prevent dining metadata from automatic deletion if data not passed. (Default : true, true - deletes not passed data in metadata_dinings array, false - prevents deletion ).

mobile_logo
string

The link to the logo for the mobile app.

mobile_restaurant_visuals
string

The link to the restaurant's image for the mobile app.

mobile_store_visuals
string

The link to the store's image for the mobile app.

name
string <= 1000 characters

Name of the store.

parking_instructions
string <= 5000 characters

Instructions for parking at the store.

phone_number
string <= 64 characters

Phone number of the store.

click_and_collect
string or null

Click and collect URL.

queue_location_id
string or null <= 255 characters

Identifier for the store record in the external queuing service.

retailer_id
integer

Identifier of the retailer the store belongs to.

retailer_website
string

URL of the store's website.

salience
integer

Numeric value used for wayfinding applications.

service_category_ids
Array of integers

List of Service Category identifiers associated with the store.

shop_number
string or null <= 16 characters

The shop number in the Westfield centre the store occupies.

object (StoreSocialMediaList)
square_image
string or null

The link to the square image for the store.

object (StatusUpdateBody)

Status information for a store.

store_description
string or null <= 5000 characters

Store's description.

store_logo_svg
string or null

The link to the logo in svg format.

store_logo_background_image
string or null

The link to the image in background of the logo.

store_front_image_ref
string <= 255 characters

Storage provider identifier of the store's store front image.

store_level
string or null

Front-end store level descriptor.

store_type_ids
Array of integers
Default: []

List of store type IDs the store belongs to.

store_zone
string or null

Front-end store zone descriptor.

curbside_only
boolean

Whether the store is only offering curbside service only.

Responses

Request samples

Content type
application/json
{
  • "attachment_document": "string",
  • "category_ids": [
    ],
  • "centre_id": "string",
  • "connect_id": "string",
  • "destination_type_ids": [
    ],
  • "dining": {
    },
  • "dining_cuisine": "string",
  • "dining_image_ref": "string",
  • "dining_menu_ref": "string",
  • "dining_price_guide": 4,
  • "dining_vendor_id": "string",
  • "disabled_at": "2018-03-21T21:43:56Z",
  • "email_address": "string",
  • "enabled_at": "2018-03-21T21:43:56Z",
  • "external_id": "string",
  • "external_name": "string",
  • "features": [
    ],
  • "google_places_id": "string",
  • "lease_number": "string",
  • "locations": [
    ],
  • "location_levels": [
    ],
  • "loyalty_enabled": true,
  • "metadata_dinings": [
    ],
  • "metadata_dining_delete": true,
  • "mobile_logo": "string",
  • "mobile_restaurant_visuals": "string",
  • "mobile_store_visuals": "string",
  • "name": "string",
  • "parking_instructions": "string",
  • "phone_number": "string",
  • "click_and_collect": "string",
  • "queue_location_id": "string",
  • "retailer_id": 0,
  • "retailer_website": "string",
  • "salience": 0,
  • "service_category_ids": [
    ],
  • "shop_number": "string",
  • "social_media": {},
  • "square_image": "string",
  • "status": {
    },
  • "store_description": "string",
  • "store_logo_svg": "string",
  • "store_logo_background_image": "string",
  • "store_front_image_ref": "string",
  • "store_level": "string",
  • "store_type_ids": [ ],
  • "store_zone": "string",
  • "curbside_only": true
}

Response samples

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

Create a store location

Request creation of a store location from JSON data in the request body

Authorizations:
(api_keybearerAuth)
path Parameters
store_id
required
integer
Example: 402495

Store identifier. Request to create the store location with store_id

Request Body schema: application/json
disabled_at
required
string or null <date-time>

Datetime location is disabled

enabled_at
required
string or null <date-time>

Datetime location is enabled

level_description
required
string

Floor description

level_id
required
string

Floor identifier

level_name
required
string

Floor name

location_id
required
string

Location identifier

name
required
string <= 1000 characters

Location description

primary
required
boolean
Default: false

Primary level

published_at
required
string or null <date-time>

Datetime location is published

Responses

Request samples

Content type
application/json
{
  • "disabled_at": "2018-03-21T21:43:56.000Z",
  • "enabled_at": "2018-03-21T21:43:56Z",
  • "level_description": "string",
  • "level_id": "string",
  • "level_name": "Floor 1",
  • "location_id": "string",
  • "name": "Next to Bloomingdale",
  • "primary": false,
  • "published_at": "2018-03-21T21:43:56Z"
}

Response samples

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

Update a store location

Request update of a store location from JSON data in the request body

Authorizations:
(api_keybearerAuth)
path Parameters
location_id
required
string

Location identifier. Request to update the store location with location_id

store_id
required
integer
Example: 402495

Store identifier. Request to update the store location with store_id

Request Body schema: application/json
disabled_at
required
string or null <date-time>

Datetime location is disabled

enabled_at
required
string or null <date-time>

Datetime location is enabled

level_description
required
string

Floor description

level_id
required
string

Floor identifier

level_name
required
string

Floor name

location_id
required
string

Location identifier

name
required
string <= 1000 characters

Location description

primary
required
boolean
Default: false

Primary level

published_at
required
string or null <date-time>

Datetime location is published

Responses

Request samples

Content type
application/json
{
  • "disabled_at": "2018-03-21T21:43:56.000Z",
  • "enabled_at": "2018-03-21T21:43:56Z",
  • "level_description": "string",
  • "level_id": "string",
  • "level_name": "Floor 1",
  • "location_id": "string",
  • "name": "Next to Bloomingdale",
  • "primary": false,
  • "published_at": "2018-03-21T21:43:56Z"
}

Response samples

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

Dining metadata list

Request a list of dining metadata

Authorizations:
api_key
path Parameters
store_id
required
integer
Example: 402495

Store identifier. Request the store with store_id

query Parameters
locale
string
Example: locale=fr-FR

Retrieve localized version of metadata_dining.url_description field 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": {
    }
}

Create a store dining metadata

Request creation of a store dining metadata from JSON data in the request body

Authorizations:
(api_keybearerAuth)
path Parameters
store_id
required
integer
Example: 402495

Store identifier. Request to create the store dining metadata with store_id

Request Body schema: application/json
category_id
integer or null
Default: 0

Category id of the source (needful when dining_type: 1).

dining_type
required
integer or null
Default: 0

Dining type (0 - menu / 1 - online_ordering)

source
string or null

Name of the source (needful when dining_type: 1).

image
string or null

Image of the source (needful when dining_type: 1).

url
required
string

Dining URL value (needful for both types)

url_description
string or null

URL description (needful when dining_type: 0 and translatable field).

Responses

Request samples

Content type
application/json
{
  • "category_id": 0,
  • "dining_type": 0,
  • "source": "string",
  • "image": "string",
  • "url": "string",
  • "url_description": "string"
}

Response samples

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

Individual dining metadata

Request a single dining metadata

Authorizations:
api_key
path Parameters
id
required
integer

Dining metadata identifier. Request to update the store dining metadata with id.

store_id
required
integer
Example: 402495

Store identifier. Request to update the store dining metadata with store_id.

query Parameters
locale
string
Example: locale=fr-FR

Retrieve localized version of metadata_dining.url_description field 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": {
    }
}

Update a store dining metadata

Request update of a store dining metadata from JSON data in the request body

Authorizations:
(api_keybearerAuth)
path Parameters
id
required
integer

Dining metadata identifier. Request to update the store dining metadata with id

store_id
required
integer
Example: 402495

Store identifier. Request to update the store dining metadata with store_id

Request Body schema: application/json
category_id
integer or null
Default: 0

Category id of the source (required when dining_type: 1).

dining_type
integer or null
Default: 0

Dining type (0 - menu / 1 - online_ordering)

source
string or null

Name of the source (needful when dining_type: 1).

image
string or null

Image of the source (needful when dining_type: 1).

url
string or null

Dining URL value (needful for both types)

url_description
string or null

URL description (needful when dining_type: 1 and translatable field).

Responses

Request samples

Content type
application/json
{
  • "category_id": 0,
  • "dining_type": 0,
  • "source": "string",
  • "image": "string",
  • "url": "string",
  • "url_description": "string"
}

Response samples

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

Delete a dining metadata

Request deletion of a dining metadata

Authorizations:
(api_keybearerAuth)
path Parameters
id
required
integer
Example: 24585

Dining metedata identifier. Request to delete the dining metadata with id

store_id
required
integer
Example: 402495

Store identifier. Request to update the store dining metadata with store_id

Responses

Response samples

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

Returns store versions

Request store versions

Authorizations:
(api_keybearerAuth)
path Parameters
store_id
required
integer
Example: 402495

Store identifier. Request the store version with store_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.

Responses

Response samples

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

Retailers Mercury Autocomplete

Returns autocomplete

Request retailer versions

Authorizations:
api_key
query Parameters
q
string
Example: q=clothing

Query. Request retailers

Responses