Products

Products are the sellable goods in an e-commerce shop on the Propeller platform. They are usually organized hierarchically in categories. The Product API can be used to consult, create, update or delete a Product.

Product Lookup keys

Key	Type	Description
id	integer	Propeller product id, auto-generated
sourceId	string	External system unique id. sourceId should be combined with source
sku	string	Product SKU/ code
code (deprecated)	string	Product code
supplierCode	string	Product code as known to the product supplier. supplierCode should be combined with supplier

What are lookup keys?

Fields

Name	Description	Type
names	Product name	array[LocalizedString]
language	Product default language	string ISO 639-1
parent	Parent category	JSON object that identifies the parent. id or sourceId in combination with source
sku	Product SKU (code)	string
unit	The number of packages that need to be ordered when adding an item to the basket	integer
status	Product status	enum A=Available N=Not available T=Out of stock P=Phase out S=Presale R=Restricted
descriptions	Product description	array[LocalizedString]
shortName	Product short name	string
shortDescriptions	Product short descriptions	array[LocalizedString]
taxCode	Product tax code	enum H=High L=Low N=None
supplier	Product supplier	string
supplierCode	Product code as known to the product supplier	string
manufacturer	Manufacturer	string
oemCode	Product manufacturer code	string
eanCode	Product EAN code	string
minimumQuantity	Minimum orderable quantity	integer
package	Package (e.g. piece, sheet, etc.)	string
packageDescriptions	Description of package and package units inside a package (e.g. Box of 650 sheets of paper)	array[LocalizedString]
notes	Product notes/ remarks	array[LocalizedString]
sourceId	External system unique id	string
source	External system	string
keywords	Keywords of this product per language. Added by the supplier	array[LocalizedString]
customKeywords	Additional keywords of this product per language. Added via the PIM	array[LocalizedString]
statusExtra	The extra status of this product, commonly linked to a custom valueset	string
orderable	Indicates whether the product is orderable	enum Y = Yes N = No
orderableFrom	The orderable from date of this product	date
orderableTo	The orderable from to of this product	date
releaseDate	The release date of this product	date
returnable	Indicates whether the product is returnable	enum Y = Yes N = No
physical	Is it a physical product or a service, download or warranty	enum Y = Yes N = No
barCode	The bar code of this product	string
width	Product width	string
height	Product height	string
depth	Product depth	string
weight	Product weight	string
packageUnit	The amount of items per package	string
packageUnitQuantity	The quantifier for the package unit, i.e.: PIECE or BOX	string
purchaseMinimumQuantity	The minimum quantity of products that can be ordered when creating a purchase order	integer
purchaseUnit	The unit in which the product can be ordered when creating a purchase order	integer
economicOrderQuantity	The quantity that provides the best value for money for this product	integer
metadataTitles	Metadata title	array[LocalizedString]
metadataDescriptions	Metadata description	array[LocalizedString]
metadataKeywords	Metadata keywords	array[LocalizedString]
metadataCanonicalUrls	Metadata canonical URL	array[LocalizedString]
priority	Sort products based on the priority in search results	integer
hidden	Controls product visibility	enum Y = Yes N = No

Product Errors

This section describes error codes specific for the Product resource.

Code	Error Type	Status Code	Message	Reason
80004	ProductExists	400	Product already exists	Category with such lookup key already exists
80005	ProductMultipleFound	400	Multuple products found. Please provide additional filters	Multiple products with such lookup key exist
80006	ProductNotFound	404	Product does not exist	Product with such lookup key not found
80007	ParentProductNotFound	404	Parent product not found	Parent product with such lookup key not found. This error is typical when working with product sub-resources (e.g. attributes)
80008	ProductNotAllowed	405	Product is not allowed	No permission for the product

📄️ 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

10 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

8 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