API Reference
  1. WSHOP API
  2. Users

Create a single user

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

Creates a back-office user. Errors are returned with HTTP 200 as {id, success: false, errors}.

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

Login (must be a valid email address and unique, USER0023)

integer
required

Profile ID (must exist, USER0017)

string
required
length ≤ 50

Last name

string
required
length ≤ 30
string
required
length ≤ 100

Contact email address (validated)

string
length ≤ 50

Parsed and stored in E.164 format (default region FR). Must not be empty if sent.

password

Back-office password. Hashed server-side.

integer
enum
required
Allowed:
string
required
length between 2 and 2

ISO 639-1 language code; must exist

integer
enum
required

Back-office access

Allowed:
integer
enum
required

API access

Allowed:
string

Code of the default store / point of sale (must exist, USER0014)

stores
array of strings

Store codes the user can access. ["*"] = all stores, [] = no store. Each code must exist (USER0015).

stores
string
length ≤ 100
date

Entry date (YYYY-MM-DD). Any other length is stored as 0000-00-00.

date

Leaving date (YYYY-MM-DD). Any other length is stored as 0000-00-00.

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?