Skip to main content

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

KeyTypeDescription
idintegerPropeller product id, auto-generated
sourceIdstringExternal system unique id. sourceId should be combined with source
skustringProduct SKU/ code
code (deprecated)stringProduct code
supplierCodestringProduct code as known to the product supplier. supplierCode should be combined with supplier

What are lookup keys?

Fields

NameDescriptionType
namesProduct namearray[LocalizedString]
languageProduct default languagestring
ISO 639-1
parentParent categoryJSON object that identifies the parent. id or sourceId in combination with source
skuProduct SKU (code)string
unitThe number of packages that need to be ordered when adding an item to the basketinteger
statusProduct statusenum

A=Available
N=Not available
T=Out of stock
P=Phase out
S=Presale
R=Restricted
priceSales pricedecimal
costPriceCost pricedecimal
suggestedPriceSuggested/ advised pricedecimal
discountPriceDiscount pricedecimal
discountPriceFromDiscount price from datedate
discountPriceToDiscount price to datedate
priceDisplayType of price displayenum

default = Only display price
onrequest = Do not show price, show "Price on request"
from = Show cheapest price
fromfor = Show old (suggested) price vs. new price
perpackage = price per type of package (e.g. Price from € 125.50 per box)
peruom = Cheapest price per package unit (e.g. Price from € 125.50 per piece)
descriptionsProduct descriptionarray[LocalizedString]
shortNameProduct short namestring
shortDescriptionsProduct short descriptionsarray[LocalizedString]
taxCodeProduct tax codeenum

H=High
L=Low
N=None
supplierProduct supplierstring
supplierCodeProduct code as known to the product supplierstring
manufacturerManufacturerstring
oemCodeProduct manufacturer codestring
eanCodeProduct EAN codestring
minimumQuantityMinimum orderable quantityinteger
packagePackage (e.g. piece, sheet, etc.)string
packageDescriptionsDescription of package and
package units inside a
package (e.g. Box of 650 sheets of paper)
array[LocalizedString]
notesProduct notes/ remarksarray[LocalizedString]
sourceIdExternal system unique idstring
sourceExternal systemstring

Product Errors

This section describes error codes specific for the Product resource.

CodeError TypeStatus CodeMessageReason
80004ProductExists400Product already existsCategory with such lookup key already exists
80005ProductMultipleFound400Multuple products found. Please provide additional filtersMultiple products with such lookup key exist
80006ProductNotFound404Product does not existProduct with such lookup key not found
80007ParentProductNotFound404Parent product not foundParent product with such lookup key not found. This error is typical when working with product sub-resources (e.g. attributes)
80008ProductNotAllowed405Product is not allowedNo permission for the product