Store Regions

BSPK Developers Portal

Get Support

API Reference

Dashboard

Welcome

Cloud Platform

Data Security & Privacy

Systems Architecture

Integration with BSPK

Introduction

Importing Data

Prerequisites for Imports

Sample Files

Stores

Sales Associates

Shoppers

Products

Product Variants

Product Prices

Product Inventory

Product Images

Sales

Supported ISO 4217 currencies

Supported ISO 639-1 languages

Supported ISO 3166 countries

Special Orders

Special Order Line Items

Special Order Events

S3 Buckets & Keys Management Guide

Getting started

Schema and Versioning

Authentication

Requests and Responses

Pagination

Rate limiting

Getting Support

Creates or updates a Client (Shopper) in BSPK

Links a BSPK Client with a client present at your backend system like an ERP.

Links a BSPK Client with a Client in an external backend system

Removes the Link from BSPK Client with a client present at your backend system like an ERP.

Removes the Link from a BSPK Client with a Client in an external backend system

Events and Payloads

Secure your webhooks

Webhooks Retry Policy

Creates a webhook endpoint

Delete a webhook endpoint

Updates a webhook endpoint

List Webhook Endpoints

List Appointments

List Calls

List Clients

List Emails

Gets a list of ideabook actions for specified clients. The actions include all reactions to ideabook objects (ideabook object can stand for an item or simply attachment shared by sales associate like image or video). Among type of actions that might be performed by client there are:
- like
- dislike
- adding to wishlist
- like removal
- dislike removal
- removing from wishlist

If there are no clients found with given client IDs the API returns an error about no records found.

If among passed clients IDs in the query parameter there is at least one client who exists in the database the API will return an object with client IDs as keys and an array of ideabook actions as values. IDs of the clients that weren't found in the DB will not be returned in the response object.

File Prefix	`STORE-REGION`
Current Version	`V2`

Attribute	Format	Length	Required	Description	Example
store_region_ref	Alphanumeric	1-255	Yes	Unique store region reference descriptor	R1
name	Alphanumeric	1-255	Yes	Store region name	Europe
privacy_policy_link	Alphanumeric	1-255	No	Url to a public page describing the privacy policy for this store region	https://www.bspk.com/privacy_policy
privacy_policy_email	Alphanumeric	1-255	No	Customer support email for requests about privacy policy for this region	privacy@bspk.com

Get Started

Core Data Integration Guide

Special Orders Integration Guide

S3 Bucket Configuration

Store Regions