Create a new enduser

Create a new enduser entry

Request

POST https://api.nexway.store/endusers

Request body

The request body takes a complete EndUser resource, containing the following writable properties:

{
    "accountCreated": "boolean",
    "city": "string",
    "company": {
        "companyId": "string",
        "companyName": "string",
        "vatNumber": "string"
    },
    "country": "string",
    "createdAt": "date-time",
    "email": "string",
    "emails": null,
    "firstName": "string",
    "identity": {
        "identityType": "string",
        "identityValue": "string"
    },
    "lastName": "string",
    "locale": "string",
    "password": "string",
    "storeId": "string",
    "streetAddress": "string",
    "token": "string",
    "zipCode": "string"
}

Properties

Name Type Description Additional
accountCreated boolean Optional
city string

Enduser city

Optional
company object Company Optional
company.companyId string

Company id (like cpnj...)

Optional
company.companyName string

Enduser company name

company.vatNumber string

Company vat number

Optional
country string

End user country (format ISO 3166-1 alpha-2)

createdAt date-time Optional
email string

Enduser email

emails[] array

The list of emails sent to this end user

Optional
firstName string

Enduser first name

identity object Identity Optional
identity.identityType string

The type of entity

identity.identityValue string

The value of entity

lastName string

Enduser last name

locale string

Locale of the end user

password string

password

storeId string

Store id

streetAddress string

Address book street address

token string

Token for init password

Optional
zipCode string

Enduser zipcode

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Success

EndUser
400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

409 Conflict

Conflict

500 Internal Server Error

Failure

503 Service Unavailable

Service not available

Example

{
    "city": "San Francisco",
    "company": {
        "companyId": "86816775000155",
        "companyName": "Nexway",
        "vatNumber": "FR45619122-451"
    },
    "country": "FR",
    "email": "test@gmail.com",
    "firstName": "john",
    "id": "a0253398-b0c5-4c2d-a15f-bd97ea4be608",
    "identity": {
        "identityType": "CPF",
        "identityValue": "12345678909"
    },
    "lastName": "Doe",
    "locale": "fr-FR",
    "password": "XdefH!E",
    "status": "ENABLED",
    "storeId": "a0253398-b0c5-4c2d-a15f-bd97ea4be608",
    "streetAddress": "236 8th street",
    "token": "d7989ea85882d0c4f0acc0247a83bf5b",
    "zipCode": "48250"
}

Explore this API

endUser

endUser

Request Content-Type
Response Content-Type
Try it out!