Customer

Customer

List customers

get
/tenants/{tenantUid}/customers

List all customers.

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
customerExternalIdstringOptional

External reference to a customer.

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Responses
chevron-right
200

CustomerListResponse

application/json
get
/tenants/{tenantUid}/customers
200

CustomerListResponse

Create a new customer

post
/tenants/{tenantUid}/customers

Create a new customer

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
Responses
post
/tenants/{tenantUid}/customers
201

Example response

Search customers

post
/tenants/{tenantUid}/customers/search

The query field searches on: firstName, lastName, city, postalCode, companyName, mobile, email and vatNumber. If scope is not set, customer scope is used. When mobile, email or vatNumber is specified, the according field is not searched by the query field value.

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Body
exactMatchbooleanOptional
querystringOptional
mobilestringOptional
emailstringOptional
vatNumberstringOptional
storeUidstringOptionalPattern: ^[A-Za-z0-9-_]+
customerParentUidstringOptionalPattern: ^[A-Za-z0-9-_]+
createdAtstring · date-timeOptional
Responses
chevron-right
200

CustomerListResponse

application/json
post
/tenants/{tenantUid}/customers/search
200

CustomerListResponse

External search for customers

post
/tenants/{tenantUid}/customers/search/external

External search for customers

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Body
querystringOptional
Responses
chevron-right
200

CustomerExternalListResponse

application/json
post
/tenants/{tenantUid}/customers/search/external
200

CustomerExternalListResponse

Export customer data in structured form. JSON is the only available format now

get
/tenants/{tenantUid}/customers/{customerUid}/export

Intended for GDPR Compliance Export customer data in structured form. JSON is the only available format now \

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
Responses
chevron-right
200

Example response

get
/tenants/{tenantUid}/customers/{customerUid}/export
200

Example response

Print customer membership card

post
/tenants/{tenantUid}/customers/{customerUid}/print

Print a label or a receipt with a barcode that can be used to scan for easy customer registration

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
Body
printerUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
post
/tenants/{tenantUid}/customers/{customerUid}/print
204

No Content

No content

Get customer details

get
/tenants/{tenantUid}/customers/{customerUid}

Get details for a customer.

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
chevron-right
200

Example response

application/json
get
/tenants/{tenantUid}/customers/{customerUid}
200

Example response

Update customer details

put
/tenants/{tenantUid}/customers/{customerUid}

Partial updates are allowed.

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
addressstringOptional
citystringOptional
companyNamestringOptional
countryCodestringOptional

ISO 3166-1: 2 characters representation of country

customerTypestring · enumOptionalPossible values:
emailstringOptional
externalIdstringOptional
firstnamestringOptional
lastnamestringOptional
ledgerNumberstringOptional

Ledger number must be a valid number with possible leading zeros

mobilestringOptional
postalCodestringOptional
vatNumberstringOptional

VAT identification number for value added tax reporting purposes.

pricelistUidstringOptionalPattern: ^[A-Za-z0-9-_]*
originstringOptional
loyaltyIdstringOptional
paymentTermsintegerOptional

Number of days to calculate due date on invoice

internalNotestringOptional
ehfEnabledbooleanOptionalDeprecated

This field is deprecated. Use ehf -> enabled instead

customerGroupUidsstring[]Optional
defaultStoreUidstringOptionalPattern: ^[A-Za-z0-9-_]+
customerParentUidstringOptional

References another customer, establishing it as a department under the main customer. Only applicable when customerType is COMPANY.

Pattern: ^[A-Za-z0-9-_]*
Responses
chevron-right
200

Example response

application/json
put
/tenants/{tenantUid}/customers/{customerUid}
200

Example response

Delete a customer

delete
/tenants/{tenantUid}/customers/{customerUid}

Deletes a customer.

Required permissions: CUSTOMER

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
delete
/tenants/{tenantUid}/customers/{customerUid}
204

No Content

No content

Add an extension to a customer

post
/tenants/{tenantUid}/customers/{customerUid}/extensions/{customerExtensionCode}

Add an extension to a customer

Required permissions: CUSTOMER

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
customerExtensionCodestring · enumRequired
ENUM Description
TWO_INVOICE The Two Invoice extension.
Possible values:
Body
storeUidstringRequiredPattern: ^[A-Za-z0-9-_]+
Responses
chevron-right
200

Example response

application/json
post
/tenants/{tenantUid}/customers/{customerUid}/extensions/{customerExtensionCode}
200

Example response

Delete an extension to a customer

delete
/tenants/{tenantUid}/customers/{customerUid}/extensions/{customerExtensionCode}

Delete an extension to a customer

Required permissions: CUSTOMER

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
customerExtensionCodestring · enumRequired
ENUM Description
TWO_INVOICE The Two Invoice extension.
Possible values:
Body
storeUidstringRequiredPattern: ^[A-Za-z0-9-_]+
Responses
delete
/tenants/{tenantUid}/customers/{customerUid}/extensions/{customerExtensionCode}
204

No Content

No content

BATCH Create customers

post
/tenants/{tenantUid}/customers/batch

Creates customers Items in:

  • create : will be created.

  • update : will be updated.

  • delete: will be deleted.

  • upsert: will create or update if needed.

The response http status is either:

  • 200: all items in request was processed successfully,

  • 207: one or more item was processed with an error.

Required permissions: CUSTOMER

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
Responses
chevron-right
200

Example response

application/json
post
/tenants/{tenantUid}/customers/batch

Get customer details for a store

get
/tenants/{tenantUid}/stores/{storeUid}/customers/{customerUid}

Return a complete customer with store specific details.

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
Responses
chevron-right
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/customers/{customerUid}
200

Example response

Last updated