API Reference
  1. WSHOP API
  2. POS Events

Create a POS event

post
https://{instance}.wshop.cloud/api/v1/pos/events/create

Records an in-store (POS) event. The store must exist (POS0004), the seller must exist (POS0005) and be attached to that store (POS0006); a positive customerId must be a known customer (POS0007). Unknown root fields are ignored; unknown fields inside data are rejected.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Event name, e.g. basket.shared, wishlist.shared

integer
required
≥ 1

Internal store identifier (not the store code)

integer
required
≥ 1

Identifier of the seller user attached to the store

integer
required

Customer identifier; 0 for an anonymous customer

string
length ≥ 1

Unique identifier of the event (used by the update endpoint)

data
object

Event payload

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?