API docs by Redocly

Westfield Category APIs (1)

Download OpenAPI specification:Download

Summary of Westfield Category API endpoints.

Categories

Endpoints related to Categories

List categories.

Request an array of categories.

Authorizations:
api_key
query Parameters
depth
integer
Example: depth=1

Category depth. Request categories with depth.

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.

name
string
Example: name=Retailer

Category name. Request categories with name.

path
string
Example: path=retailer

Category path. Request categories with path.

page
integer
Default: 1
Example: page=1

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

per_page
integer
Default: 25
Example: per_page=25

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

statuses
Array of strings

Statuses. Requests categories that include one of the listed statuses.

Responses

Response samples

Content type
application/json
{}

Create a category.

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

enabled
required
boolean

Enabled category. Category is enabled (true) or not enabled (false).

parent_id
required
integer

Parent category identifier. Identifiers to retrieve the parent category related to this category.

external_id
string

External system ID reference for mapping.

external_type
string

External Type reference for Commercial Operations.

icon
string

Icon association to the category.

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "parent_id": 0,
  • "external_id": "string",
  • "external_type": "string",
  • "icon": "string"
}

Response samples

Content type
application/json
{}

Individual category.

Request a single category.

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 12345

Category identifier. Request the category with category_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.

Responses

Response samples

Content type
application/json
{}

Delete a category.

Request deletion of a category.

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 12345

Category identifier. Request to delete the category with category_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 category.

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

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 12345

Category identifier. Request to update the category with category_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
optional

Data to update a category.

enabled
boolean

Enabled category. Category is enabled (true) or not enabled (false).

external_id
string

External system ID reference for mapping.

external_type
string

External Type reference for Commercial Operations.

icon
string

Icon association to the category.

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "external_id": "string",
  • "external_type": "string",
  • "icon": "string"
}

Response samples

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

List category locales.

Request an array of category locales.

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 12345

Category identifier. Request the category locales with category_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.

Responses

Response samples

Content type
application/json
{}

Create a locale for category.

Request creation of a locale for category from JSON data in the request body.

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 24585

Category identifier. Request to update the locale with category_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 create a locale for category.

category_id
required
integer

Category identifier. Identifier to retrieve the category.

external_id
string or null

External system ID reference for mapping.

name
required
string

Name of locale.

slug
string

Slug of locale.

westfield_locale
required
string
Enum: "en_US" "en_UK" "en_GB" "de_AT" "fr_FR" "en_FR" "pl_PL" "ca_ES" "es_ES" "eu_ES" "cs_CZ" "da_DK" "de_DE" "it_IT" "nl_BE" "de_BE" "fr_BE" "nl_NL" "pt_PT" "sk_SK" "sv_SE" "uk_UA" "default"

Westfield locale. Four letter ISO code with hyphen or underscore.

image
string or null
description
string or null
indexable
boolean or null

Indexable status.

seo_title
string or null <= 90 characters \\A[ a-zA-Z0-9\\-|!?&$':()\\\\/]*\\z

Locale title for SEO purposes.

state_event
string
Enum: "live" "disable"
children_sort_order
Array of integers

Locale identifiers. Array of identifiers to order children.

Responses

Request samples

Content type
application/json
{
  • "category_id": 0,
  • "external_id": "string",
  • "name": "string",
  • "slug": "string",
  • "westfield_locale": "en_US",
  • "image": "string",
  • "description": "string",
  • "indexable": true,
  • "seo_title": "string",
  • "state_event": "live",
  • "children_sort_order": [
    ]
}

Response samples

Content type
application/json
{}

Get locales for a list of categories.

Get list of locales for a list of categories.

Authorizations:
api_key
path Parameters
westfield_locale
required
string
Enum: "en_US" "en_UK" "en_GB" "de_AT" "fr_FR" "en_FR" "pl_PL" "ca_ES" "es_ES" "eu_ES" "cs_CZ" "da_DK" "de_DE" "it_IT" "nl_BE" "de_BE" "fr_BE" "nl_NL" "pt_PT" "sk_SK" "sv_SE" "uk_UA" "default"
Example: en-US | en_US

Locale identifier. Four letter ISO code with hyphen or underscore. Request the locale with westfield_locale.

query Parameters
category_ids
required
Array of integers
Example: category_ids=12345,2344

Category identifiers. Request categories with these category_ids.

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.

statuses
Array of strings
Items Enum: "pending" "preview" "live" "expired" "invalid" "disabled"

Statuses. Requests locales that include one of the listed statuses.

strict
string
Default: "false"
Example: strict=false

If set to false, default/fallback data to be returned if fields for translations does not exist for {westfield_locale}

Responses

Response samples

Content type
application/json
{}

Individual category locale.

Request a single category locale.

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 12345

Category identifier. Request the category with category_id.

westfield_locale
required
string
Enum: "en_US" "en_UK" "en_GB" "de_AT" "fr_FR" "en_FR" "pl_PL" "ca_ES" "es_ES" "eu_ES" "cs_CZ" "da_DK" "de_DE" "it_IT" "nl_BE" "de_BE" "fr_BE" "nl_NL" "pt_PT" "sk_SK" "sv_SE" "uk_UA" "default"
Example: en-US | en_US

Locale identifier. Four letter ISO code with hyphen or underscore. Request the locale with westfield_locale.

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.

strict
string
Default: "false"
Example: strict=false

If set to false, default/fallback data to be returned if fields for translations does not exist for {westfield_locale}

Responses

Response samples

Content type
application/json
{}

Delete a locale.

Request deletion of a locale.

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 24585

Category identifier. Request to update the locale with category_id.

westfield_locale
required
string
Enum: "en_US" "en_UK" "en_GB" "de_AT" "fr_FR" "en_FR" "pl_PL" "ca_ES" "es_ES" "eu_ES" "cs_CZ" "da_DK" "de_DE" "it_IT" "nl_BE" "de_BE" "fr_BE" "nl_NL" "pt_PT" "sk_SK" "sv_SE" "uk_UA" "default"
Example: en-US | en_US

Locale identifier. Four letter ISO code with hyphen or underscore. Request the locale with westfield_locale.

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

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

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 24585

Category identifier. Request to update the locale with category_id.

westfield_locale
required
string
Enum: "en_US" "en_UK" "en_GB" "de_AT" "fr_FR" "en_FR" "pl_PL" "ca_ES" "es_ES" "eu_ES" "cs_CZ" "da_DK" "de_DE" "it_IT" "nl_BE" "de_BE" "fr_BE" "nl_NL" "pt_PT" "sk_SK" "sv_SE" "uk_UA" "default"
Example: en-US | en_US

Locale identifier. Four letter ISO code with hyphen or underscore. Request the locale with westfield_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 locale.

category_id
integer

Category identifier. Identifier to retrieve the category.

external_id
string or null

External system ID reference for mapping.

external_type
string or null

External type of category.

name
string

Name of locale.

slug
string

Slug of locale.

westfield_locale
string
Enum: "en_US" "en_UK" "en_GB" "de_AT" "fr_FR" "en_FR" "pl_PL" "ca_ES" "es_ES" "eu_ES" "cs_CZ" "da_DK" "de_DE" "it_IT" "nl_BE" "de_BE" "fr_BE" "nl_NL" "pt_PT" "sk_SK" "sv_SE" "uk_UA" "default"

Westfield locale. Four letter ISO code with hyphen or underscore.

image
string or null
description
string or null
indexable
boolean or null

Indexable status.

seo_title
string or null <= 90 characters \\A[ a-zA-Z0-9\\-|!?&$':()\\\\/]*\\z

Locale title for SEO purposes.

state_event
string
Enum: "live" "disable"
children_sort_order
Array of integers

Locale identifiers. Array of identifiers to order children.

Responses

Request samples

Content type
application/json
{
  • "category_id": 0,
  • "external_id": "string",
  • "external_type": "string",
  • "name": "string",
  • "slug": "string",
  • "westfield_locale": "en_US",
  • "image": "string",
  • "description": "string",
  • "indexable": true,
  • "seo_title": "string",
  • "state_event": "live",
  • "children_sort_order": [
    ]
}

Response samples

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

Category list children.

Request the children list for a single category and locale.

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 12345

Category identifier. Request the child categories of the parent with category_id.

westfield_locale
required
string
Enum: "en_US" "en_UK" "en_GB" "de_AT" "fr_FR" "en_FR" "pl_PL" "ca_ES" "es_ES" "eu_ES" "cs_CZ" "da_DK" "de_DE" "it_IT" "nl_BE" "de_BE" "fr_BE" "nl_NL" "pt_PT" "sk_SK" "sv_SE" "uk_UA" "default"
Example: en-US | en_US

Locale identifier. Four letter ISO code with hyphen or underscore. Request the locale with westfield_locale.

query Parameters
depth
integer
Example: depth=1

Category depth. Request categories with depth.

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.

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

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

strict
string
Default: "false"
Example: strict=false

If set to false, default/fallback data to be returned if fields for translations does not exist for {westfield_locale}

Responses

Response samples

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

Category tree.

Request the children tree for a single category and locale.

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 12345

Category identifier. Filter child categories of the parent with category_id.

westfield_locale
required
string
Enum: "en_US" "en_UK" "en_GB" "de_AT" "fr_FR" "en_FR" "pl_PL" "ca_ES" "es_ES" "eu_ES" "cs_CZ" "da_DK" "de_DE" "it_IT" "nl_BE" "de_BE" "fr_BE" "nl_NL" "pt_PT" "sk_SK" "sv_SE" "uk_UA" "default"
Example: en-US | en_US

Locale identifier. Four letter ISO code with hyphen or underscore. Request the locale with westfield_locale.

query Parameters
depth
integer
Example: depth=1

Category depth. Request categories with depth.

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.

strict
string
Default: "false"
Example: strict=false

If set to false, default/fallback data to be returned if fields for translations does not exist for {westfield_locale}

Responses

Response samples

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

Category list parents.

Request all parents for a single category as a list. The list is ordered from the top parent down to the category.

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 12345

Category identifier. Filter child categories of the parent with category_id.

westfield_locale
required
string
Enum: "en_US" "en_UK" "en_GB" "de_AT" "fr_FR" "en_FR" "pl_PL" "ca_ES" "es_ES" "eu_ES" "cs_CZ" "da_DK" "de_DE" "it_IT" "nl_BE" "de_BE" "fr_BE" "nl_NL" "pt_PT" "sk_SK" "sv_SE" "uk_UA" "default"
Example: en-US | en_US

Locale identifier. Four letter ISO code with hyphen or underscore. Request the locale with westfield_locale.

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.

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

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

strict
string
Default: "false"
Example: strict=false

If set to false, default/fallback data to be returned if fields for translations does not exist for {westfield_locale}

Responses

Response samples

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

List groups.

Request an array of groups.

Authorizations:
api_key
query Parameters
country
string
Example: country=<%= COUNTRIES[0] %>

Country filter.

group_ids
Array of integers
Example: group_ids=1

Group identifiers to use as a filter.

category_ids
Array of integers
Example: category_ids=1

Category identifiers to use as a filter.

page
integer
Default: 1
Example: page=1

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

per_page
integer
Default: 25
Example: per_page=25

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

Responses

Response samples

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

Create a group.

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

name
required
string

Group name.

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

Country. One per group.

category_ids
required
Array of integers

Identifiers for categories in this group.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "country": "us",
  • "category_ids": [
    ]
}

Response samples

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

Individual category group.

Request a single category group.

Authorizations:
api_key
path Parameters
group_id
required
integer
Example: 12345

Group identifier. Request the group with group_id.

Responses

Response samples

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

Delete a group.

Request deletion of a group.

Authorizations:
api_key
path Parameters
group_id
required
integer
Example: 12345

Group identifier. Request to delete the group with group_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 group.

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

Authorizations:
api_key
path Parameters
group_id
required
integer
Example: 12345

Group identifier. Request to update the group with group_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
optional

Data to update a group.

name
string

Group name.

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

Country. One per group.

category_ids
Array of integers

Identifiers for categories in this group.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "country": "us",
  • "category_ids": [
    ]
}

Response samples

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

Returns category versions.

Request category versions.

Authorizations:
api_key
path Parameters
category_id
required
integer
Example: 402495

Category identifier. Request the category version with category_id.

westfield_locale
required
string
Enum: "en_US" "en_UK" "en_GB" "de_AT" "fr_FR" "en_FR" "pl_PL" "ca_ES" "es_ES" "eu_ES" "cs_CZ" "da_DK" "de_DE" "it_IT" "nl_BE" "de_BE" "fr_BE" "nl_NL" "pt_PT" "sk_SK" "sv_SE" "uk_UA" "default"
Example: en-US | en_US

Locale identifier. Four letter ISO code with hyphen or underscore. Request the locale with westfield_locale.

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