AccessToken

GET /api/users/access-token

Fields

Field Type Description Required
client NO
expires NO
accessToken NO
scope NO
user NO

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/users/access-token[/:access_token_id]

Fields

Field Type Description Required
client NO
expires NO
accessToken NO
scope NO
user NO

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/users/access-token[/:access_token_id]

Fields

Field Type Description Required
client NO
expires NO
accessToken NO
scope NO
user NO

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

AuthorizationCode

GET /api/users/authorization-code

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/users/authorization-code[/:authorization_code_id]

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Client

GET /api/users/client

Fields

Field Type Description Required
clientId YES
secret NO
redirectUri NO
grantType NO
accessToken NO
refreshToken NO
authorizationCode NO
jwt NO
jti NO
publicKey NO
scope NO
user NO

Request

Headers

Header Value
Accept
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/client

Fields

Field Type Description Required
clientId YES
secret NO
redirectUri NO
grantType NO
accessToken NO
refreshToken NO
authorizationCode NO
jwt NO
jti NO
publicKey NO
scope NO
user NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/users/client

Fields

Field Type Description Required
clientId YES
secret NO
redirectUri NO
grantType NO
accessToken NO
refreshToken NO
authorizationCode NO
jwt NO
jti NO
publicKey NO
scope NO
user NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/users/client[/:client_id]

Fields

Field Type Description Required
clientId YES
secret NO
redirectUri NO
grantType NO
accessToken NO
refreshToken NO
authorizationCode NO
jwt NO
jti NO
publicKey NO
scope NO
user NO

Request

Headers

Header Value
Accept
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/client[/:client_id]

Fields

Field Type Description Required
clientId YES
secret NO
redirectUri NO
grantType NO
accessToken NO
refreshToken NO
authorizationCode NO
jwt NO
jti NO
publicKey NO
scope NO
user NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Domain

GET /api/users/domains

Fields

Field Type Description Required
type YES
country NO
state NO
name NO
roles NO
extId YES
fulfilmentWarehouses NO
fulfilmentWarehouses NO
deliveryServices NO
defaultShop NO

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/users/domains

Fields

Field Type Description Required
type YES
country NO
state NO
name NO
roles NO
extId YES
fulfilmentWarehouses NO
fulfilmentWarehouses NO
deliveryServices NO
defaultShop NO

Request

Headers

Header Value
Accept
Content-Type

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/users/domains[/:domain_id]

Fields

Field Type Description Required
type YES
country NO
state NO
name NO
roles NO
extId YES
fulfilmentWarehouses NO
fulfilmentWarehouses NO
deliveryServices NO
defaultShop NO

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/domains[/:domain_id]

Fields

Field Type Description Required
type YES
country NO
state NO
name NO
roles NO
extId YES
fulfilmentWarehouses NO
fulfilmentWarehouses NO
deliveryServices NO
defaultShop NO

Request

Headers

Header Value
Accept
Content-Type

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Permission

GET /api/users/permissions

Fields

Field Type Description Required
state YES
parent NO
role NO
object NO
type NO
roleId NO
roleName NO
permission NO
states NO
properties NO
options NO

Request

Headers

Header Value
Accept
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/users/permissions

Fields

Field Type Description Required
state YES
parent NO
role NO
object NO
type NO
roleId NO
roleName NO
permission NO
states NO
properties NO
options NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/permissions

Fields

Field Type Description Required
state YES
parent NO
role NO
object NO
type NO
roleId NO
roleName NO
permission NO
states NO
properties NO
options NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/users/permissions[/:permission_id]

Fields

Field Type Description Required
state YES
parent NO
role NO
object NO
type NO
roleId NO
roleName NO
permission NO
states NO
properties NO
options NO

Request

Headers

Header Value
Accept
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/permissions[/:permission_id]

Fields

Field Type Description Required
state YES
parent NO
role NO
object NO
type NO
roleId NO
roleName NO
permission NO
states NO
properties NO
options NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PUT /api/users/permissions[/:permission_id]

Fields

Field Type Description Required
state YES
parent NO
role NO
object NO
type NO
roleId NO
roleName NO
permission NO
states NO
properties NO
options NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/users/permissions[/:permission_id]

Fields

Field Type Description Required
state YES
parent NO
role NO
object NO
type NO
roleId NO
roleName NO
permission NO
states NO
properties NO
options NO

Request

Headers

Header Value
Accept
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

POST /api/users/permissions[/:permission_id]

Fields

Field Type Description Required
state YES
parent NO
role NO
object NO
type NO
roleId NO
roleName NO
permission NO
states NO
properties NO
options NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

RefreshToken

GET /api/users/refresh-token

Fields

Field Type Description Required
user YES
client YES
scope YES
refreshToken YES
expires YES
isPermanent NO

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/users/refresh-token

Fields

Field Type Description Required
user YES
client YES
scope YES
refreshToken YES
expires YES
isPermanent NO

Request

Headers

Header Value
Accept
Content-Type

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/users/refresh-token[/:refresh_token_id]

Fields

Field Type Description Required
user YES
client YES
scope YES
refreshToken YES
expires YES
isPermanent NO

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/refresh-token[/:refresh_token_id]

Fields

Field Type Description Required
user YES
client YES
scope YES
refreshToken YES
expires YES
isPermanent NO

Request

Headers

Header Value
Accept
Content-Type

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Role

GET /api/users/roles

Fields

Field Type Description Required
state YES
parent NO
roleId YES
roleName NO
permissions NO

Request

Headers

Header Value
Accept
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/users/roles

Fields

Field Type Description Required
state YES
parent NO
roleId YES
roleName NO
permissions NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/roles

Fields

Field Type Description Required
state YES
parent NO
roleId YES
roleName NO
permissions NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/users/roles[/:role_id]

Fields

Field Type Description Required
state YES
parent NO
roleId YES
roleName NO
permissions NO

Request

Headers

Header Value
Accept
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/roles[/:role_id]

Fields

Field Type Description Required
state YES
parent NO
roleId YES
roleName NO
permissions NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PUT /api/users/roles[/:role_id]

Fields

Field Type Description Required
state YES
parent NO
roleId YES
roleName NO
permissions NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/users/roles[/:role_id]

Fields

Field Type Description Required
state YES
parent NO
roleId YES
roleName NO
permissions NO

Request

Headers

Header Value
Accept
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

POST /api/users/roles[/:role_id]

Fields

Field Type Description Required
state YES
parent NO
roleId YES
roleName NO
permissions NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Scope

GET /api/users/scope

Fields

Field Type Description Required
client YES
isDefault NO
accessToken YES
refreshToken NO
authorizationCode NO
scope YES

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/scope

Fields

Field Type Description Required
client YES
isDefault NO
accessToken YES
refreshToken NO
authorizationCode NO
scope YES

Request

Headers

Header Value
Accept
Content-Type

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/users/scope

Fields

Field Type Description Required
client YES
isDefault NO
accessToken YES
refreshToken NO
authorizationCode NO
scope YES

Request

Headers

Header Value
Accept
Content-Type

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/users/scope[/:scope_id]

Fields

Field Type Description Required
client YES
isDefault NO
accessToken YES
refreshToken NO
authorizationCode NO
scope YES

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/scope[/:scope_id]

Fields

Field Type Description Required
client YES
isDefault NO
accessToken YES
refreshToken NO
authorizationCode NO
scope YES

Request

Headers

Header Value
Accept
Content-Type

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/users/scope[/:scope_id]

Fields

Field Type Description Required
client YES
isDefault NO
accessToken YES
refreshToken NO
authorizationCode NO
scope YES

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Settings

GET /api/users/settings

Fields

Field Type Description Required
state NO
user NO
warehouse NO
shop NO
itemsPerPage NO

Request

Headers

Header Value
Accept

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/users/settings

Fields

Field Type Description Required
state NO
user NO
warehouse NO
shop NO
itemsPerPage NO

Request

Headers

Header Value
Accept
Content-Type

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/settings[/:setting_id]

Fields

Field Type Description Required
state NO
user NO
warehouse NO
shop NO
itemsPerPage NO

Request

Headers

Header Value
Accept
Content-Type

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

User

GET /api/users/users

Fields

Field Type Description Required
state NO
parent NO
username NO
email YES
name NO
password YES
passwordVerify NO
roles NO
allowedAdapters NO
domain YES
discr NO
eav NO
senders NO
shops NO
domains NO
deliveryService NO

Request

Headers

Header Value
Accept
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/users/users

Fields

Field Type Description Required
state NO
parent NO
username NO
email YES
name NO
password YES
passwordVerify NO
roles NO
allowedAdapters NO
domain YES
discr NO
eav NO
senders NO
shops NO
domains NO
deliveryService NO

Request

Headers

Header Value
Accept
Content-Type

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/users/users[/:user_id]

Fields

Field Type Description Required
state NO
parent NO
username NO
email YES
name NO
password YES
passwordVerify NO
roles NO
allowedAdapters NO
domain YES
discr NO
eav NO
senders NO
shops NO
domains NO
deliveryService NO

Request

Headers

Header Value
Accept
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/users/users[/:user_id]

Fields

Field Type Description Required
state NO
parent NO
username NO
email YES
name NO
password YES
passwordVerify NO
roles NO
allowedAdapters NO
domain YES
discr NO
eav NO
senders NO
shops NO
domains NO
deliveryService NO

Request

Headers

Header Value
Accept
Content-Type
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
Allow Comma-separated list of all HTTP methods allowed

Body