Placewise API

Performance Cloud

Stores

Overview
Reference
Other
- Webhooks System

Stores

Store Model

Store

id

integer <uint64>

read-onlyrequired

Example:

1

retailer_id

integer <uint64> | null

required

ID of Retailer the Store belongs to

>= 1

Example:

54

name

string

required

Example:

Infinity Store

slug

string

required

When not provided, it's auto-generated from name

Example:

infinity-store

type

enum<string>

optional

Allowed values:

storecinemadiningoffice

Default:

store

Example:

store

description

required

Any of

LocalizedContent | LocalizedContent

null

Example:

{"en":"Text"}

Additional properties

string | null

optional

The actual set of languages depends on LC configuration. See: Localization

Example:

Tekst

zip_code

string | null

required

Example:

33-232

region

string | null

required

Example:

Shire

address

string | null

required

Example:

Bag End

city

string | null

required

Example:

Hobbiton

phone_number

required

Any of

msisdn

null

Example:

4740769126

email

required

Any of

email

null

Example:

somebody@example.com

website_url

required

Any of

url

null

Example:

https://example.com

website_text

required

Text to display along page Website URL

Any of

LocalizedContent | LocalizedContent

null

Example:

{"en":"Text"}

location_description

required

Text describing Store location within Venue

Any of

LocalizedContent | LocalizedContent

null

Example:

{"en":"Text"}

map_key

string | null

required

Identifier of Store on the virtual map

Example:

55

social_profiles

object (cms.social_profiles)

required

URLs on specific social media

facebook

string

optional

Example:

https://example.com

twitter

string

optional

Example:

https://example.com

instagram

string

optional

Example:

https://example.com

linkedin

string

optional

Example:

https://example.com

snapchat

string

optional

Example:

https://example.com

tiktok

string

optional

Example:

https://example.com

youtube

string

optional

Example:

https://example.com

pinterest

string

optional

Example:

https://example.com

opening_hours

required

Any of

OpeningHoursList

null

See: Opening Hours

type

enum<string>

required

Allowed value:

weekday

Example:

weekday

period

required

hours

object | null

required

When null, object is closed at this period

description

object (LocalizedContent) | null

optional

Additional description useful for "day" type

Example:

{"en":"Text"}

opening_hours_text

object (LocalizedContent) | null

required

Free-text description of opening hours

Example:

{"en":"Text"}

opening_hours_inherited

boolean

required

When true, Public API returns opening hours of the whole venue as opening hours of this Store

Default:

false

status

enum<string>

required

Determines visibility in Public API

Allowed values:

draftpublishedunpublished

Example:

published

status_message

object (LocalizedContent) | null

required

Example:

{"en":"Text"}

locales

array[string]

required

Locales the record should be available to - see: Localization

Example:

["en"]

products

array[string]

required

API products the record should be available to - see X-Product-Name Header

Example:

["website"]

sorting_priority

integer

required

Priority of the record during sorting in CMS Public API. Currently read-only.

Example:

0

receipt_names

array[string]

required

Alternative name "hints" for OCR

receipt_addresses

array[string]

required

Alternative address "hints" for OCR

created_at

string <date-time>

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

read-onlyrequired

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

discarded_at

string <date-time> | null

read-onlyrequired

Time of the record archivization

Example:

2022-11-15T16:25:58.099512Z

logo

object (File) | null

read-onlyrequired

url

string <uri>

read-onlyrequired

Example:

https://example.com/image.png

identifier

string

optional

Only present when parent record has many files

Example:

1

mime_type

string | null

read-onlyoptional

Only present in certain circumstances

Example:

image/jpeg

created_at

string <date-time>

required

Example:

2022-11-09T15:46:00.252860Z

updated_at

string <date-time>

read-onlyrequired

Example:

2022-11-09T15:46:00.252860Z

image_details

object | null

optional

images

array[object (File) {6}]

read-onlyrequired

url

string <uri>

read-onlyrequired

Example:

https://example.com/image.png

identifier

string

optional

Only present when parent record has many files

Example:

1

mime_type

string | null

read-onlyoptional

Only present in certain circumstances

Example:

image/jpeg

created_at

string <date-time>

required

Example:

2022-11-09T15:46:00.252860Z

updated_at

string <date-time>

read-onlyrequired

Example:

2022-11-09T15:46:00.252860Z

image_details

object | null

optional

retailer

required

Retailer the Store belongs to

Any of

Retailer

null

id

integer <uint64>

id

read-onlyrequired

Example:

1

name

string

required

Example:

Placewise

slug

string

required

When not provided, it's auto-generated from name

Example:

slug

country

string

country

required

ISO 3166-1 alpha-2

Example:

NO

description

required

phone_number

required

email

required

website_url

required

Address of the external website of Retailer/Retailer

logo

required

Must be uploaded as a file of type: retailer_logo

us_legacy_data

required

external_master

required

social_profiles

object

cms.social_profiles

required

URLs on specific social media

images

array[object (File) {6}]

read-onlyrequired

Must be uploaded as a file of type: retailer_image

created_at

string <date-time>

date_time.created_at

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

date_time.updated_at

read-onlyrequired

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

categories

array [object {3}]

read-onlyrequired

Categories of the Store

id

integer <uint64>

read-onlyrequired

Example:

1

slug

object (LocalizedContent) | null

required

Example:

{"en":"Text"}

title

object (LocalizedContent) | null

required

Example:

{"en":"Text"}

us_legacy_data

object | null

required

Internal

national_deals_sync_policy_mode

enum<string> | enum<null>

required

Internal

Allowed values:

draftdisabledpublish

Default:

publish

Example:

publish

external_master

string | null

required

Internal

external_id

string | null

optional

External id of the store from provider

external_url

string | null

required

Store webisite outside of CMS (from scraped website for example)

floor

string

optional

Floor filter used by TC module

Modified at 2024-07-13 12:36:14

Check Limits Exceeded