Users

Create a User

Create a new User

post

/user

Authorizations

Body

firstNamestringrequired

User first name

Example: John

lastNamestringrequired

User last name

Example: Doe

emailstringrequired

User email

Example: [e-mail]

addressstringrequired

User address

Example: Harcourt 4567

citystringrequired

User city

Example: Toronto

stateProvincestringrequired

User state/province

Example: Ontario

countryCodestringrequired

User ISO 3166 country code

Example: CAN

postalCodestringrequired

User postal code

Example: M4C

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/user' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]",
    "address": "Harcourt 4567",
    "city": "Toronto",
    "stateProvince": "Ontario",
    "countryCode": "CAN",
    "postalCode": "M4C"
  }'

200

401

500

200

{
  "externalClientId": "ABC-123",
  "id": 1
}

Created user

Find a User

Find a User

get

/user

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/user' \
  --header 'Authorization: Bearer JWT'

200

401

500

200

{
  "id": 1,
  "externalClientId": "ABC-123"
}

The found User

Find all Users

Finds all users

get

/merchant/users

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/merchant/users' \
  --header 'Authorization: Bearer JWT'

200

401

500

200

[
  {
    "id": 1,
    "externalClientId": "ABC-123"
  }
]

List of users

Delete User

Delete a User

delete

/user

Authorizations

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/user' \
  --header 'Authorization: Bearer JWT'

200

401

500

200

No body

Ok.

Update User

Update a User

patch

/user

Authorizations

Body

firstNamestring

User first name

Example: John

lastNamestring

User last name

Example: Doe

emailstring

User email

Example: [e-mail]

addressstring

User address

Example: Harcourt 4567

citystring

User city

Example: Toronto

stateProvincestring

User state/province

Example: Ontario

countryCodestring

User ISO 3166 country code

Example: CAN

postalCodestring

User postal code

Example: M4C

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/user' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]",
    "address": "Harcourt 4567",
    "city": "Toronto",
    "stateProvince": "Ontario",
    "countryCode": "CAN",
    "postalCode": "M4C"
  }'

200

401

500

200

{
  "id": 1,
  "externalClientId": "ABC-123"
}

Updated user