Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic API
Management APIUsers APIOperations APIMessaging APIReporting APIML APIData API
ExplorePublic API
Management APIUsers APIOperations APIMessaging APIReporting APIML APIData API
  1. Stores
  • Introduction
  • Loyalty Club
    • Loyalty Clubs
      • Introduction
      • Show Loyalty Club
      • List Loyalty Clubs
    • Schema
      • Show Schema
    • Legal Information
      • Show Legal Information
    • Translations
      • List Translations (v4)
      • List Translations (v3)
    • Carbon Offset Program
      • Show Carbon Offset Program Info
    • Cars
      • Show Cars Configuration
      • Show Available Cars Colors
    • Programs
      • Introduction
      • List Programs
      • Show Program
    • Receipts
      • Introduction
      • Show Receipts Configuration
  • Member
    • Authentication
      • OAuth Flow
      • One Time Password
        • Send OTP via SMS
        • Send OTP via SMS by Email
        • Send OTP via Email
        • Send OTP via Email by MSISDN
      • Registration Password
        • Send Registration Password SMS
        • Send Registration Password Email
      • Create Token
      • Revoke Token
      • Show Token Info
    • Profile
      • Public Info
        • Show Member Public Info
        • Show Member Public Info by MSISDN
        • Show Member Public Info by Email
      • Person ID
        • Show Member Person ID
        • Show Member Person ID by MSISDN
        • Show Member Person ID by Email
      • Create Member
      • Update Member
      • Validate Member
      • Register Member App Token
      • Show Member
      • Destroy Member
    • Programs
      • Registration
        • Start
        • Confirm
      • Update Member Programs
      • Add Member to Program
      • List Member Programs
      • Remove Member from Program
    • Cars
      • Introduction
      • List Member Cars
      • Create Member Car
      • Show Member Car
      • Update Member Car
      • Renew Member Car
      • Destroy Member Car
      • Lookup a Car
    • Benefits
      • Introduction
      • List Member Benefits
      • Show Member Benefit
    • Verification
      • Send Verification Email
      • Send Verification SMS
      • Verify Email
      • Verify MSISDN
    • Password
      • Update Password
      • Reset Password
      • Send Password Reset Token
    • Integrations
      • Amano Parking Integration
        • Create Card
        • Delete Card
      • Spaycial Integrations
        • Generate Connections URL
        • Generate Connect URL
        • Show Spaycial Connections Status
        • Show Spaycial Feature Settings
        • Update Spaycial Feature Settings
    • Receipts
      • Introduction
      • List Submissions
      • Show Submission
      • Create Submission
      • Update Submission
      • Delete Submission
      • Check Limits Exceeded
    • Misc
      • Checkin to Store
      • Show Member Messages History v2
    • Files
      • Uploads
        • Upload status
        • Start Upload
        • Upload Part
        • Finish Upload
        • Activate Uploaded File
    • Messages
      • Send "delivered" event for push message
      • Send "open" event for push message
  • Offers
    • Introduction
    • Offers
      • Show Offers Meta
      • Show Offer
      • Encode Offer
      • List Offers
      • Use Offer
      • Like Offer
      • Unlike Offer
    • Offers Preview
      • Preview Offers Meta
      • Preview Offer
      • Preview Offers List
    • Events
      • Introduction
      • Register "clicked" Event
      • Register "seen" Event
  • Rewards
    • Introduction
    • Rewards Program
      • Show Rewards Program
      • Join To Rewards Program
      • Leave Rewards Program
      • Show Member Rewards Program Status
      • Show Achievements Summary
    • Rewards
      • List Rewards
      • List Purchased Rewards
      • Purchase Reward
      • Use Reward
  • Games
    • Introduction
    • Games
      • List Games
      • Show Game Details
      • Show Game Ticket
      • Play Game
      • Issue Game Prize
  • CMS Content
    • Introduction
    • Website
      • Introduction
      • Show Website
    • Venue Info
      • Introduction
      • Show Venue Info
    • Components
      • Component Schema Model
      • Show Components Schema
    • Pages
      • Page Model
      • List Pages
      • Show Page
      • Route Page
    • Articles
      • Article Model
      • Articles Categories
        • List Articles Categories
        • Show Articles Categories
      • List Articles
      • Show Article
    • Events
      • Event Model
      • Events Groups
        • Introduction
        • List Events Groups
        • Show Events Group
      • Events Categories
        • List Events Categories
        • Show Events Categories
      • List Events
      • Show Event
    • Job Postings
      • Introduction
      • List Job Postings
      • Show Job Posting
    • Service Messages
      • Introduction
      • List Service Messages
      • Show Service Message
    • Stores
      • Introduction
      • List
        GET
      • Show
        GET
    • Stores Categories
      • Introduction
      • List Stores Categories
      • Show Stores Category
    • Promotions
      • Introduction
      • List Promotions Collections
      • List Promotions
      • Show Promotion
    • Press Releases
      • Press Release Model
      • List Press Releases
      • Show Press Release
    • Attachments
      • Attachment Model
      • List Attachments
  1. Stores

Introduction

This section describes API destined for public use (like websites and mobile apps).
Navigate to Stores V4 API section to see docs for stores management API.

Store model#

Example#

{
  "id": 1,
  "name": "Infinity Store",
  "slug": "infinity",
  "description": "Infinite offers",
  "opening_hours": [
    { "type": "weekday", "period": "monday", "hours": { "opens_at": "10:00", "closes_at": "18:00" } },
    { "type": "weekday", "period": "tuesday", "hours": { "opens_at": "10:00", "closes_at": "15:00" } },
    { "type": "weekday", "period": "tuesday", "hours": { "opens_at": "16:00", "closes_at": "18:00" } },
    { "type": "weekday", "period": "wednesday", "hours": { "opens_at": "10:00", "closes_at": "18:00" } },
    { "type": "weekday", "period": "thursday", "hours": { "opens_at": "10:00", "closes_at": "18:00" } },
    { "type": "weekday", "period": "friday", "hours": {"opens_at": "10:00", "closes_at": "18:00" } },
    { "type": "weekday", "period": "saturday", "hours": { "opens_at": "12:00", "closes_at": "15:00" } },
    { "type": "weekday", "period": "sunday", "hours": null },
    { "type": "day", "period": "2023-05-01", "hours": null },
    { "type": "day", "period": "2023-12-22", "hours": { "opens_at": "12:00", "closes_at": "14:00" } },
    { "type": "day", "period": "2023-12-25", "hours": null, "description": "Christmas" }
  ],
  "opening_hours_text": "<p>Monday-Friday: 09:00-19:00</p><p>Saturday-Sunday: 10:00-17:00</p>",
  "social_profiles": { "twitter": "https://example.com/twitter", "facebook": "https://example.com/facebook" },
  "phone_number": "4740769126",
  "email": "infinity@example.com",
  "address": "Mellomila 88",
  "city": "Trondheim",
  "zip_code": "7018",
  "region": "Trøndelag",
  "map_key": "F-43",
  "url": "articles/{id}-{slug}"
  "website_url": "example.com",
  "website_text": "Website",
  "logo": { "url": "https://cdn-files.dev.placewise.com/files/6ptAfBia0TXKfeIgxUKb5EGOLpmAPtpi3f1VWNll6ZzU5UkJkR2s" },
  "images": [
    {
      "id": "30b90b15-8980-49a8-825c-ada87f59d5fa",
      "url": "https://cdn-files.dev.placewise.com/files/TottfTYe1DIm4Aja8gRsmgDdU8BKrwRaqxTUzVEtScFN6eno4NkQ"
    },
    {
      "id": "7c6f9573-503e-4675-86e3-3f1391e3800e",
      "url": "https://cdn-files.dev.placewise.com/files/TottdI3frZWXfhXawruKilEM0ZYEfcrwHfJdEzVEtScFN6eno4NkQ"
    }
  ],
  "categories": [
    {
      "id": 1,
      "name": "test",
      "slug": "test"
    }
  ],
  "type": "store",
  "external_url": nil
}

Definition#

KeyTypeOptionalDescription
idintegerno
namestringno
slugstringno
descriptionstringyesDepends on X-Locale header
opening_hoursOpeningHoursItem[]yes
opening_hours_textstringyesDepends on X-Locale header
social_profilesobjectyesStore's social media URLs. Available keys: facebook, linkedin, youtube, instagram, twitter
phone_numberstring (E.164 MSISDNyes
emailstringyes
addressstringyes
citystringyes
zip_codestringyes
regionstringyes
emailstringyes
map_keystringyesIdentifies store on location map
website_urlstring (URL)yes
website_textstringyesDisplay text for store website. Depends on X-Locale header
logo.urlstring (URL)yes
images[].identifierstringyes
images[].urlstring (URL)yes
urlstringyesAddress of the entity page within Website
typeenum: ["store", "cinema", "dining", "office"]noType of store (default: "store")
external_urlurlnoStore webpage outside of cms (i.g. for srcaped store
For more information, see Store model in Stores V4 API
Previous
Show Service Message
Next
List
Built with