Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
  1. API Contexts
  • Introduction
  • Global Headers
  • Common HTTP Error Codes
  • API Permits
  • Rate Limiting
  • Authorization
    • Token Authorization
    • Member Authorization
    • User Authorization
  • API Contexts
    • Customer Context
    • LoyaltyClub Context
    • Global Context
  • Common Concepts
    • Localization
    • System URLs
    • Params Validation
    • Pagination
    • Sorting
  • Common Models
    • Common Data Formats
    • Member Model
    • API Entity Model
    • Opening Hours Model
  1. API Contexts

Customer Context

Customer is the most basic entity representing a party that uses our system.
When endpoint is in Customer context there are two ways to indicate which customer(s) you want to use:
include X-Loyalty-Club-Slug header which internally translates to correct customer
use X-Customer header
The X-Customer header is the only way to make cross-customer requests (for endpoints which supports cross-customer contexts).

X-Customer header specification#

Make request in context of customer with id#

id=<id_of_customer>
Example
X-Customer: id=1000941

Make request in context of multiple customers via ids#

Join ids of customers with _ and set them after id= prefix.
id=<id_of_customer1>_<id_of_customer2>
Example
X-Customer: 1000941_1000942
X-Customer: 1000941_1000942_1000943
NOTE
Too long list of customer ids isn't allowed as headers have finite buffer limit. We recommend to use always less than 40.

Make requests in context of all customers available#

all=all
Example
X-Customer: all=all

Make requests in context of customers filtered by provided filters#

<filter>=<filter_value>
You can join filters with AND logical condition by joining them with ;: <filter>=<filter_value>;<filter2>=<filter2_value>
Example
X-Customer: chain=Cats
X-Customer: chain=Cats;country=PL
NOTE
In order to receive list of available filters, contact our support.
Previous
API Contexts
Next
LoyaltyClub Context
Built with