Skip to main content

Users

Users represent data about a specific customer. Carts, orders, attributes, addresses are associated with users.

In a B2C environment a user is the actual customer ordering products, in a B2B environment a user is often part of a usergroup representing the organisation he/she is working for. Orders in a B2B environment are still placed by a specific user but connected to the organisation by a single debtorIdwhich is associated with the user.

User Lookup keys

KeyTypeDescription
idintegerPropeller user id
sourceIdstringExternal system unique id. sourceId should be combined with source

What are lookup keys?

Fields

NameDescriptionType
debtorIdA unique id representing this user. A debtorId can be automatically generated by Propellorinteger
string
firstNameUser first namestring
middleNameUser middle namestring
lastNameUser last namestring
fullNameUser full namestring
titleUser titlestring
dateOfBirthUser date of birthdate
genderUser genderenum

m=Male
f=Female
u=Undefined
loginLogin name used to login to the webshopstring
phoneUser phone numberinteger
emailA valid email addressstring
companyOrganization the user is working forstring
parentParent usergroupJSON object that identifies the parent. id or sourceId in combination with source
pricelistAmountA pricesheet code in case of special pricing agreementsstring
pricelistPercentageA pricesheet code in case of special pricing agreementsstring
taxNumberThe VAT number of the financial entity this user is part ofstring
cocNumberThe chamber of commerce number of the financial entity this user is part ofstring
primaryLanguageUser primary languagestring
ISO 639-1
sourceIdExternal system unique idstring
sourceExternal systemstring

User Errors

This section describes error codes specific for the User resource.

CodeError TypeStatus CodeMessageReason
70004UserExists400User already existsUser with such lookup key already exists
70005UserMultipleFound400Multuple users found. Please provide additional filtersMultiple users with such lookup key exist
70006UserNotFound404User does not existUser with such lookup key not found
70007ParentUserNotFound404Parent user not foundParent user with such lookup key not found. This error is typical when working with user sub-resources (e.g. attributes, addresses)
90006AddressNotFound404Address does not existUser address does not exist