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 debtorId
which is associated with the user.
User Lookup keysβ
Key | Type | Description |
---|---|---|
id | integer | Propeller user id |
sourceId | string | External system unique id. sourceId should be combined with source |
Fieldsβ
Name | Description | Type |
---|---|---|
debtorId | A unique id representing this user. A debtorId can be automatically generated by Propellor | integer string |
firstName | User first name | string |
middleName | User middle name | string |
lastName | User last name | string |
fullName | User full name | string |
title | User title | string |
dateOfBirth | User date of birth | date |
gender | User gender | enum m=Male f=Female u=Undefined |
login | Login name used to login to the webshop | string |
phone | User phone number | string |
email | A valid email address | string |
company | Organization the user is working for | string |
parent | Parent usergroup | JSON object that identifies the parent. id or sourceId in combination with source |
taxNumber | The VAT number of the financial entity this user is part of | string |
cocNumber | The chamber of commerce number of the financial entity this user is part of | string |
primaryLanguage | User primary language | string ISO 639-1 |
sourceId | External system unique id | string |
source | External system | string |
User Errorsβ
This section describes error codes specific for the User
resource.
Code | Error Type | Status Code | Message | Reason |
---|---|---|---|---|
70004 | UserExists | 400 | User already exists | User with such lookup key already exists |
70005 | UserMultipleFound | 400 | Multuple users found. Please provide additional filters | Multiple users with such lookup key exist |
70006 | UserNotFound | 404 | User does not exist | User with such lookup key not found |
70007 | ParentUserNotFound | 404 | Parent user not found | Parent user with such lookup key not found. This error is typical when working with user sub-resources (e.g. attributes, addresses) |
90006 | AddressNotFound | 404 | Address does not exist | User address does not exist |
ποΈ Introduction
The Propeller REST API is based on resource-oriented URL's, returns JSON-encoded responses and uses standard HTTP response codes, authentication and HTTP methods. The main goal of the REST API is efficiently importing/exporting large amounts of data in/out of the Propeller platform.
ποΈ Add Setting to Cluster Config
Use this endpoint to add additional settings to a cluster config. If a cluster config setting is successfully created, the response will include the `id`.
ποΈ attribute-descriptions
7 items
ποΈ attributes
5 items
ποΈ authentication
2 items
ποΈ Authentication
Authentication
ποΈ Bulk Categories by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `id` endpoint, the categories are identified by Propeller category `id`. If a category with such `id` doesn't already exist, it will be created. If it does exist, the category will be updated.
ποΈ Bulk Categories by sourceId
The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `sourceId` endpoint, the categories are identified by `sourceId`, `source`. If a category doesn't already exist, it will be created. If it does exist, the category will be updated.
ποΈ Bulk Cluster Options by lookupKey
The bulk endpoints offer an efficient way of importing/updating large amounts of cluster options with just a single API call. The same lookup key is used for the options as for the cluster. When using the bulk `id` endpoint, the options are identified by Propeller option `id`. If an option with such `id` doesn't already exist, it will be created. If it does exist, the option will be updated.
ποΈ Bulk Cluster Products by sourceId
The bulk endpoints offer an efficient way of importing/updating large amounts of cluster products with just a single API call. The same lookup key is used for the products as for the cluster. When using the bulk `id` endpoint, the products are identified by Propeller product `id`. If a product with such `id` doesn't already exist, it will be created. If it does exist, the product will be updated.
ποΈ Bulk Clusters by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of clusters with just a single API call. When using the bulk `id` endpoint, the clusters are identified by Propeller cluster `id`. If a cluster with such `id` doesn't already exist, it will be created. If it does exist, the cluster will be updated.
ποΈ Bulk Clusters by sourceId
The bulk endpoints offer an efficient way of importing/updating large amounts of clusters with just a single API call. When using the bulk `sourceId` endpoint, the clusters are identified by `sourceId` and `source`. If a cluster doesn't already exist, it will be created. If it does exist, the cluster will be updated.
ποΈ Bulk Companies by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of companies with just a single API call. When using the bulk `id` endpoint, the companies are identified by `id`. If a company with such `id` doesn't already exist, it will be created. If it does exist, the company found will be updated.
ποΈ Bulk Companies by source id
The bulk endpoints offer an efficient way of importing/updating large amounts of companies with just a single API call. When using the bulk `sourceId` endpoint, the companies are identified by `sourceId` and `source`. If a company doesn't already exist, it will be created. If it does exist, the company found will be updated.
ποΈ Company Bulk Addresses
Use this endpoint to create multiple company addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address `id`.
ποΈ Bulk Contacts by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of contacts with just a single API call. When using the bulk `id` endpoint, the contacts are identified by `id`. If a contact doesn't already exist, it will be created. If it does exist, the contact found will be updated.
ποΈ Bulk Contacts by source id
The bulk endpoints offer an efficient way of importing/updating large amounts of contacts with just a single API call. When using the bulk `sourceId` endpoint, the contacts are identified by `sourceId` and `source`. If a contact doesn't already exist, it will be created. If it does exist, the contact found will be updated.
ποΈ bulk-cost-prices
6 items
ποΈ Customer Bulk Addresses
Use this endpoint to create multiple customer addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address `id`.
ποΈ Bulk Customers by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of customers with just a single API call. When using the bulk `id` endpoint, the customers are identified by `id`. If a customer doesn't already exist, it will be created. If it does exist, the customer found will be updated.
ποΈ Bulk Customers by source id
The bulk endpoints offer an efficient way of importing/updating large amounts of customers with just a single API call. When using the bulk `sourceId` endpoint, the customers are identified by `sourceId` and `source`. If a customer doesn't already exist, it will be created. If it does exist, the customer found will be updated.
ποΈ Bulk Inventory by lookup key / inventory type
The bulk inventory endpoint is used to create or update inventory records. The products can be identified based on one of their lookup keys. The inventory record type can be either `local` or `supplier`.
ποΈ Bulk Local Inventory (deprecated)
The bulk local inventory endpoint is used to create or update inventory records.
ποΈ bulk-prices
6 items
ποΈ Bulk Product by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of products with just a single API call. When using the bulk `id` endpoint, the products are identified by Propeller product `id`. If a product with such `id` doesn't already exist, it will be created. If it does exist, the product will be updated.
ποΈ Bulk Product by source id
The bulk endpoints offer an efficient way of importing/updating large amounts of products with just a single API call. When using the bulk `sourceId` endpoint, the products are identified by `sourceId` and `source`. If a product doesn't already exist, it will be created. If it does exist, the product found will be updated.
ποΈ Bulk Supplier Inventory (deprecated)
The bulk supplier inventory endpoint is used to create or update inventory records.
ποΈ Bulk User Addresses
Use this endpoint to create multiple user addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address `id`.
ποΈ Bulk Usergroup Addresses
Use this endpoint to create multiple usergroup addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address `id`.
ποΈ Bulk Usergroups by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of usergroups with just a single API call. When using the bulk `id` endpoint, the usergroups are identified by `id`. If a usergroup with such `id` doesn't already exist, it will be created. If it does exist, the usergroup found will be updated.
ποΈ Bulk Usergroups by source id
The bulk endpoints offer an efficient way of importing/updating large amounts of usergroups with just a single API call. When using the bulk `sourceId` endpoint, the usergroups are identified by `sourceId` and, `source`. If a usergroup doesn't already exist, it will be created. If it does exist, the usergroup found will be updated.
ποΈ Bulk Users by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of user with just a single API call. When using the bulk `id` endpoint, the products are identified by `id`. If a user doesn't already exist, it will be created. If it does exist, the user found will be updated.
ποΈ Bulk Users by source id
The bulk endpoints offer an efficient way of importing/updating large amounts of user with just a single API call. When using the bulk `sourceId` endpoint, the users are identified by `sourceId` and `source`. If a user doesn't already exist, it will be created. If it does exist, the user found will be updated.
ποΈ bundles
9 items
ποΈ categories
8 items
ποΈ Categories
Categories
ποΈ cluster-config
7 items
ποΈ Cluster Config
Cluster Config
ποΈ clusters
21 items
ποΈ Clusters
Clusters
ποΈ companies
15 items
ποΈ Companies
Companies
ποΈ contacts
8 items
ποΈ Contacts
Contacts
ποΈ core-concepts
7 items
ποΈ cost-prices
6 items
ποΈ Create Category
Use this endpoint to create a single category. If a category is successfully created, the response will include the category `id`.
ποΈ Create Cluster Config
Use this endpoint to create a cluster config. If a cluster config is successfully created, the response will include the cluster config `id`.
ποΈ Create Cluster Option
Use this endpoint to create a single cluster option. If a cluster option is successfully created, the response will include the option `id`.
ποΈ Create Cluster
Use this endpoint to create a single cluster. If a cluster is successfully created, the response will include the cluster `id`.
ποΈ Create Company Address
Use this endpoint to create an address for a company. If the address is successfully created, the response will include the address `id`.
ποΈ Create Company
Use this endpoint to create a single company. If a company is successfully created, the response will include the usergroup `id`.
ποΈ Create Contact
Use this endpoint to create a single contact. If a contact is successfully created, the response will include the user `id`.
ποΈ 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`.
ποΈ Create Customer
Use this endpoint to create a single customer. If a customer is successfully created, the response will include the user `id`.
ποΈ Create Option Product
> The same endpoints for option products are used as the cluster products, with a difference that option id is used in lookupValue variable instead if cluster id
ποΈ Create Product Local Inventory
This endpoint allows creating local inventory data for a product based on a lookup key.
ποΈ Create Product Supplier Inventory
This endpoint allows creating supplier inventory data for a product based on a lookup key.
ποΈ Create Product
Use this endpoint to create a single product. If a product is successfully created, the response will include the product`id`.
ποΈ Create User Address
Use this endpoint to create an address for a user. If the address is successfully created, the response will include the address `id`.
ποΈ Create User
Use this endpoint to create a single user. If a user is successfully created, the response will include the user `id`.
ποΈ Create Usergroup Address
Use this endpoint to create an address for a usergroup. If the address is successfully created, the response will include the address `id`.
ποΈ Create Usergroup
Use this endpoint to create a single usergroup. If a usergroup is successfully created, the response will include the usergroup `id`.
ποΈ customers
15 items
ποΈ Customers
Customers
ποΈ Delete Category by lookup key
Use this endpoint to delete category by lookup key.
ποΈ Delete Category translation by lookup key
Use this endpoint to delete category translation by lookup key and the language for which the translation needs to be deleted.
ποΈ Delete Cluster by lookup key
Use this endpoint to delete cluster by lookup key.
ποΈ Delete Company Address
Use this endpoint to delete a company address. The address is identified by `id`.
ποΈ Delete Company by lookup key
Delete a company by a specific lookupKey / lookupId combination. A deleted company will be moved to the Propeller Recycle bin. This means the deleted company can be restored, however, only via the Propeller backoffice.
ποΈ Delete Contact by lookup key
Delete a `contact` by a specific lookupKey / lookupId combination. A deleted `contact` will be moved to the Propeller Recycle bin. This means the deleted contact can be restored, however, only via the Propeller backoffice.
ποΈ Delete Customer Address
Use this endpoint to delete a customer address. The address is identified by `id`.
ποΈ Delete Customer by lookup key
Delete a `customer` by a specific lookupKey / lookupId combination. A deleted `customer` will be moved to the Propeller Recycle bin. This means the deleted customer can be restored, however, only via the Propeller backoffice.
ποΈ Delete Inventory by Id
This endpoint allows deleting inventory record by it's Propeller inventory id.
ποΈ Delete Option by Cluster lookup key and Option Id
Use this endpoint to delete single cluster option by cluster lookup key and option id.
ποΈ Delete Product by Cluster lookup key and Product Id
Use this endpoint to delete single cluster product details by cluster lookup key and product id.
ποΈ Delete Product by lookup key
Use this endpoint to delete product by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g.Β `source`Β andΒ `language`Β for lookup keyΒ `source`).
ποΈ Delete Product translation by lookup key
Use this endpoint to delete product translation by lookup key and the language for which the translation needs to be deleted.
ποΈ Delete User Address
Use this endpoint to delete a user's address. The address is identified by `id`.
ποΈ Delete User by lookup key
Delete a `user` by a specific lookupKey / lookupId combination. A deleted `user` will be moved to the Propeller Recycle bin. This means the deleted user can be restored, however, only via the Propeller backoffice.
ποΈ Delete Usergroup by lookup key
Delete a usergroup by a specific lookupKey / lookupId combination. A deleted usergroup will be moved to the Propeller Recycle bin. This means the deleted usergroup can be restored, however, only via the Propeller backoffice.
ποΈ discounts
7 items
ποΈ favoritelists
10 items
ποΈ Get Access Token
Use this endpoint to retrieve an access token for accessing the REST APIs.
ποΈ Get Addresses by type
Use this endpoint to retrieve a list of all company addresses. Addresses can be filtered by type.
ποΈ Get Category by lookup key
Use this endpoint to retrieve category details by lookup key.
ποΈ Get Cluster by lookup key
Use this endpoint to retrieve cluster details by lookup key.
ποΈ Get Cluster Config by lookup key
Use this endpoint to retrieve cluster config details by lookup key.
ποΈ Get Company Address by Id
Use this endpoint to retrieve details for a company address. The address is identified by `id`.
ποΈ Get Company by lookup key
Use this endpoint to retrieve company details by lookup key.
ποΈ Get Contact by lookup key
Use this endpoint to retrieve contact details by lookup key.
ποΈ Get Customer Address by Id
Use this endpoint to retrieve details for a customer address. The address is identified by `id`.
ποΈ Get Customer Addresses by type
Use this endpoint to retrieve a list of all customer addresses. Addresses can be filtered by type.
ποΈ Get Customer by lookup key
Use this endpoint to retrieve customer details by lookup key.
ποΈ Get Inventory by Id
This endpoint is used to get an inventory data via it's unique inventory record Id.
ποΈ Get Option by Cluster lookup key and Option Id
Use this endpoint to get details of single cluster option by cluster lookup key and option id.
ποΈ Get Options by Cluster lookup key
Use this endpoint to retrieve cluster options by cluster lookup key.
ποΈ Get Product by Cluster lookup key and Product Id
Use this endpoint to retrieve single cluster product details by cluster lookup key and product id.
ποΈ Get Product by lookup key
Use this endpoint to retrieve product details by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. `source` and `language` for lookup key `source`).
ποΈ Get Product Inventory By Warehouse
This endpoint gives cumulative product inventory data by searching on a lookup key and warehouse id.
ποΈ Get Product Inventory
This endpoint gives cumulative product inventory data by searching on a lookup key.
ποΈ Get Products by Cluster lookup key
Use this endpoint to retrieve cluster products by cluster lookup key.
ποΈ Get User Address by Id
Use this endpoint to retrieve details for a user address. The address is identified by `id`.
ποΈ Get User Addresses by type
Use this endpoint to retrieve a list of all user addresses. Addresses can be filtered by type.
ποΈ Get User by lookup key
Use this endpoint to retrieve user details by lookup key.
ποΈ Get Usergroup Address by Id
Use this endpoint to retrieve details for a usergroup address. The address is identified by `id`.
ποΈ Get Usergroup Addresses by type
Use this endpoint to retrieve a list of all usergroup addresses. Addresses can be filtered by type.
ποΈ Get Usergroup by lookup key
Use this endpoint to retrieve usergroup details by lookup key.
ποΈ inventory
14 items
ποΈ Inventory
Inventory
ποΈ media
2 items
ποΈ orderlists
12 items
ποΈ orders
25 items
ποΈ prices
9 items
ποΈ pricesheets
8 items
ποΈ products
8 items
ποΈ Products
Products
ποΈ Remove Cluster Config
Use this endpoint to delete cluster config by lookup key.
ποΈ Remove Setting from Cluster Config
Use this endpoint to delete a setting on the cluster config by cluster config lookup key and setting id.
ποΈ Search Companies
> The companies search endpoint is only available on the Propeller cloud version.
ποΈ Search Contacts
> The contacts search endpoint is only available on the Propeller cloud version.
ποΈ Search Customers
> The customers search endpoint is only available on the Propeller cloud version.
ποΈ Search Inventory
This endpoint allows searching for product inventory cumulative quantities, separated by inventory type.
ποΈ Search Usergroups
> The usergroups search endpoint is only available on the Propeller cloud version.
ποΈ Search Users
> The users search endpoint is only available on the Propeller cloud version.
ποΈ surcharges
9 items
ποΈ taxes
7 items
ποΈ Update Category by lookup key
Use this endpoint to update category by lookup key.
ποΈ Update Cluster by lookup key
Use this endpoint to update a single cluster.
ποΈ Update Cluster Config Setting
Use this endpoint to update a setting on the cluster config by cluster config lookup key and setting id. Attrubute name can't be updated.
ποΈ Update Company Address
Use this endpoint to update a company address. The address is identified by `id`.
ποΈ Update Company by lookup key
Use this endpoint to update company by lookup key.
ποΈ Update Contact by lookup key
Use this endpoint to update contact by lookup key.
ποΈ Update Customer Address
Use this endpoint to update a customer address. The address is identified by `id`.
ποΈ Update Customer by lookup key
Use this endpoint to update customer by lookup key.
ποΈ Update Inventory by Id
This endpoint enables updating inventory record by it's unique id.
ποΈ Update Option by Cluster lookup key and Option Id
Use this endpoint to update single cluster option by cluster lookup key and option id.
ποΈ Update Product by Cluster lookup key and Product Id
Use this endpoint to update single cluster product details by cluster lookup key and product id.
ποΈ Update Product by lookup key
Use this endpoint to update product by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g.Β `source`Β andΒ `language`Β for lookup keyΒ `source`).
ποΈ Update Product Local Inventory
This endpoint allows updating local inventory data for a product based on a lookup key.
ποΈ Update Product Supplier Inventory
This endpoint allows updating supplier inventory data for a product based on a lookup key.
ποΈ Update User Address
Use this endpoint to update a user address. The address is identified byΒ `id`.
ποΈ Update User by lookup key
Use this endpoint to update user by lookup key.
ποΈ Update Usergroup Address
Use this endpoint to update a usergroup address. The address is identified by `id`.
ποΈ Update Usergroup by lookup key
Use this endpoint to update usergroup by lookup key.
ποΈ usergroups
14 items
ποΈ Usergroups
Usergroups
ποΈ users
15 items
ποΈ Users
Users
ποΈ valuesets
10 items
ποΈ zone-tax-codes
6 items