Lookup keys
Lookup keys
The REST API offers multiple ways to identify resources. In Propeller terminology these are called lookup keys. For example: a product can be identified by its Propellor internal idbut also by an sku. A sku however, is not guaranteed to be unique in the catalogue, as multiple products with the same sku can exist. If multiple resources are found based on the lookup key / value combination the result of the request will be an error. In case of multiple products with the same sku a GET or PATCH request to this product will result in an error.
| Lookup Key | Description |
|---|---|
id | Unique Propeller id of an object |
externalId | Unique external id |
sourceId/source | External system unique id to a Propeller resource. sourceId always needs to be combined with a source. Source is typically the name of a supplier or ERP system the data originates from. |
sku | Stock-keeping unit code referencing a product |
supplierCode/supplier | Code of a supplier referencing a product |
Source Id/ Source lookup key is most commonly used in Bulk endpoints. If you're creating/ updating products from an external system, the name of that system would typically be the source and sourceId would be the product's id or code in that system. This id should be unique in that system and the combination source/sourceId is unique in Propeller. When using the GET, DELETE, UPDATE endpoints with lookup key sourceId you can use it without source, but if multiple resources are found you will get an error. In that case use source as well.
Supplier code / supplier is another common way of looking up products. The difference between the sourceId is that the combination does not have to be unique. When it's not and you try to use the GET, UPDATE, DELETE endpoints you will get an error that multiple resources have been found.