Placewise API

Performance Cloud

Retailers

Overview
Reference
Other
- Webhooks System

Retailers

Retailer Model

Retailer model

Retailer

id

integer <uint64>

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

required

ISO 3166-1 alpha-2

Example:

NO

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

phone_number

required

Any of

msisdn

null

Example:

4740769126

email

required

Any of

email

null

Example:

somebody@example.com

website_url

required

Address of the external website of Retailer/Retailer

Any of

url

null

Example:

https://example.com

logo

required

Must be uploaded as a file of type: retailer_logo

Any of

File | File

null

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

us_legacy_data

required

Any of

cms.us_legacy_data

null

Extra content for migrated content from legacy system

Additional properties

integer | number | string | boolean

optional

external_master

required

Any of

cms.external_master

null

When present, the record is being synced from given external source

Example:

scraper

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

images

array[object (File) {6}]

read-onlyrequired

Must be uploaded as a file of type: retailer_image

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

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 record last update

Example:

2022-11-15T16:25:58.099512Z

Modified at 2024-09-16 09:36:13

Update Store receipt information