Customers
Customers represent data about a specific customer. Carts, orders, attributes, addresses are associated with customers.
In a B2C environment a customer is the actual user ordering products.
The customer API is only available on the Propeller cloud version. The legacy version of Propeller does not support this API
Customer Lookup keys
Key | Type | Description |
---|---|---|
id | integer | Propeller customer id |
sourceId | string | External system unique id. sourceId should be combined with source |
Fields
Name | Description | Type |
---|---|---|
debtorId | A unique id representing this customer. A debtorId can be automatically generated by Propellor | integer string |
firstName | Customer first name | string |
middleName | Customer middle name | string |
lastName | Customer last name | string |
abbreviation | Customer abbreviation | string |
title | Customer title | string |
dateOfBirth | Customer date of birth | date |
gender | Customer gender | enum m=Male f=Female u=Undefined |
login | Login name used to login to the webshop | string |
phone | Customer phone number | integer |
email | A valid email address | string |
ssn | Customer ssn | integer |
parent | Parent usergroup | JSON object that identifies the parent. id or sourceId in combination with source |
primaryLanguage | Customer primary language | string ISO 639-1 |
sourceId | External system unique id | string |
source | External system | string |
Customer Errors
This section describes error codes specific for the Customer
resource.
Code | Error Type | Status Code | Message | Reason |
---|---|---|---|---|
60004 | CustomerExists | 400 | Customer already exists | Customer with such lookup key already exists |
60005 | CustomerMultipleFound | 400 | Multuple customers found. Please provide additional filters | Multiple customers with such lookup key exist |
60006 | CustomerNotFound | 404 | Customer does not exist | Customer with such lookup key not found |
60007 | ParentCustomerNotFound | 404 | Parent customer does not exist | Parent customer with such lookup key not found. This error is typical when working with customer sub-resources (e.g. attributes, addresses) |
60008 | CustomerNotAllowed | 405 | Customer is not allowed | Usually when customer is in Recycle Bin and can't be used |
90006 | AddressNotFound | 404 | Address does not exist | Customer address does not exist |
📄️ Get Customer Addresses by type
Use this endpoint to retrieve a list of all customer addresses. Addresses can be filtered by type.
📄️ Create Customer Address
Use this endpoint to create an address for a customer. If the address is successfully created, the response will include the address `id`.