List Stores - Placewise API

Request

Query Params

status

string

optional

Filter stores by status (draft, published, unpublished)

Example:

published

type

string

optional

Filter stores by type (store, cinema, dining, office)

Example:

store

category_id[]

array[integer]

optional

Filter stores by id of the categories

Example:

["12"]

external_id

string

optional

Filter stores by external id

Example:

string

optional

Filter stores by search query on name, slug and type

Example:

store

ids[]

array[string]

optional

Filter stores by ids

Example:

["1","2"]

per_page

integer

optional

Number of results to be returned per request. See: API Pagination

page_no

integer

optional

Number of results page. See: API Pagination

>= 1

Default:

sort_by[]

string

optional

See: Sorting params

Default:

sort_directions[]

enum<string>

optional

See: Sorting params

Allowed values:

ASCDESC

Default:

DESC

Examples:

ASCDESC

with_archived

boolean

optional

When true, also archived record will be treated as accessible

Default:

false

only_archived

boolean

optional

When true, only archived record will be treated as accessible

Default:

false

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

stores

array[object (Store) {40}]

required

integer <uint64>

read-onlyrequired

Example:

retailer_id

integer <uint64> | null

required

ID of Retailer the Store belongs to

>= 1

Example:

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

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

website_url

required

website_text

required

Text to display along page Website URL

location_description

required

Text describing Store location within Venue

map_key

string | null

required

Identifier of Store on the virtual map

Example:

social_profiles

object (cms.social_profiles)

required

URLs on specific social media

opening_hours

required

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:

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

images

array[object (File) {6}]

read-onlyrequired

retailer

required

Retailer the Store belongs to

categories

array [object {3}]

read-onlyrequired

Categories of the Store

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

pagination_info

object (PaginationInfo) | null

read-onlyrequired

count

integer

read-onlyrequired

Actual number of results returned in request

Example:

1000

total_count

integer

required

Number of all available results

>= 1

Example:

2050

per_page

integer

read-onlyrequired

Number of results returned per request

Example:

1000

total_pages

integer

read-onlyrequired

Number of all available pages

Example:

current_page

integer

read-onlyrequired

Example:

next_page

integer | null

read-onlyrequired

Next available page (null when it's a last page)

Example:

prev_page

integer | null

read-onlyrequired

Next available page (null when it's a first page)

Example:

null

is_first_page

boolean

read-onlyrequired

Example:

true

is_last_page

boolean

read-onlyrequired

Example:

false

is_out_of_range

boolean

read-onlyrequired

Is given per_page param out of range?

Example:

false

offset

integer

read-onlyrequired

Example:

Example

{
  "stores": [
    {
      "id": 1,
      "retailer_id": 54,
      "name": "Infinity Store",
      "slug": "infinity-store",
      "type": "store",
      "description": {
        "en": "Text"
      },
      "zip_code": "33-232",
      "region": "Shire",
      "address": "Bag End",
      "city": "Hobbiton",
      "phone_number": "4740769126",
      "email": "somebody@example.com",
      "website_url": "https://example.com",
      "website_text": {
        "en": "Text"
      },
      "location_description": {
        "en": "Text"
      },
      "map_key": "55",
      "social_profiles": {
        "facebook": "https://example.com",
        "twitter": "https://example.com",
        "instagram": "https://example.com",
        "linkedin": "https://example.com",
        "snapchat": "https://example.com",
        "tiktok": "https://example.com",
        "youtube": "https://example.com",
        "pinterest": "https://example.com"
      },
      "opening_hours": [
        {
          "type": "weekday",
          "period": "monday",
          "hours": {
            "opens_at": "09:00",
            "closes_at": "18:00"
          },
          "description": {
            "en": "Text"
          }
        }
      ],
      "opening_hours_text": {
        "en": "Text"
      },
      "opening_hours_inherited": false,
      "status": "draft",
      "status_message": {
        "en": "Text"
      },
      "locales": [
        "en"
      ],
      "products": [
        "website"
      ],
      "sorting_priority": 0,
      "receipt_names": [
        "string"
      ],
      "receipt_addresses": [
        "string"
      ],
      "created_at": "2022-11-05T16:25:58.099512Z",
      "updated_at": "2022-11-15T16:25:58.099512Z",
      "discarded_at": "2022-11-15T16:25:58.099512Z",
      "logo": {
        "url": "https://example.com/image.png",
        "identifier": "1",
        "mime_type": "image/jpeg",
        "created_at": "2022-11-09T15:46:00.252860Z",
        "updated_at": "2022-11-09T15:46:00.252860Z",
        "image_details": {
          "width": 1,
          "height": 1
        }
      },
      "images": [
        {
          "url": "https://example.com/image.png",
          "identifier": "1",
          "mime_type": "image/jpeg",
          "created_at": "2022-11-09T15:46:00.252860Z",
          "updated_at": "2022-11-09T15:46:00.252860Z",
          "image_details": {
            "width": 1,
            "height": 1
          }
        }
      ],
      "retailer": {
        "id": 1,
        "name": "Placewise",
        "slug": "slug",
        "country": "NO",
        "description": {
          "en": "Text"
        },
        "phone_number": "4740769126",
        "email": "somebody@example.com",
        "website_url": "https://example.com",
        "logo": {
          "url": "https://example.com/image.png",
          "identifier": "1",
          "mime_type": "image/jpeg",
          "created_at": "2022-11-09T15:46:00.252860Z",
          "updated_at": "2022-11-09T15:46:00.252860Z",
          "image_details": {
            "width": 1,
            "height": 1
          }
        },
        "us_legacy_data": {},
        "external_master": "scraper",
        "social_profiles": {
          "facebook": "https://example.com",
          "twitter": "https://example.com",
          "instagram": "https://example.com",
          "linkedin": "https://example.com",
          "snapchat": "https://example.com",
          "tiktok": "https://example.com",
          "youtube": "https://example.com",
          "pinterest": "https://example.com"
        },
        "images": [
          {
            "url": "https://example.com/image.png",
            "identifier": "1",
            "mime_type": "image/jpeg",
            "created_at": "2022-11-09T15:46:00.252860Z",
            "updated_at": "2022-11-09T15:46:00.252860Z",
            "image_details": {
              "width": 1,
              "height": 1
            }
          }
        ],
        "created_at": "2022-11-05T16:25:58.099512Z",
        "updated_at": "2022-11-15T16:25:58.099512Z"
      },
      "categories": [
        {
          "id": 1,
          "slug": {
            "en": "Text"
          },
          "title": {
            "en": "Text"
          }
        }
      ],
      "us_legacy_data": {},
      "national_deals_sync_policy_mode": "publish",
      "external_master": "string",
      "external_id": "string",
      "external_url": "string",
      "floor": "string"
    }
  ],
  "pagination_info": {
    "count": 1000,
    "total_count": 2050,
    "per_page": 1000,
    "total_pages": 3,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "is_first_page": true,
    "is_last_page": false,
    "is_out_of_range": false,
    "offset": 0
  }
}