Bulk Product by Id
POST/products/bulk/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.
Product Bulk endpoints support bulk change of product attributes for multiple products as well. To learn more about Attributes, go here.
A single product's attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple products, this endpoint should be used.
Fields
| Name | Required |
|---|---|
products (array of product objects) | yes |
sourceId | yes |
source | yes |
language | yes |
names | no |
sku | no (recommended) |
unit | no Default is 1 |
status | no Default is A |
descriptions | no |
shortDescriptions | no |
taxCode | no Default is H |
supplier | no (recommended) |
supplierCode | no (recommended) |
oemCode | no |
eanCode | no |
minimumQuantity | no Default is 1 |
packageDescriptions | no |
notes | no |
attributes Read more about attributes | no |
parent | no |
metadataTitles | no |
metadataDescriptions | no |
metadataKeywords | no |
metadataCanonicalUrls | no |
priority | no |
hidden | no |
For more details on attributes field, read this. |
Directives
| Name | Description | Fields |
|---|---|---|
skipIfNotEmpty | On update, skip updating fields of an existing product that are not empty | array of field names e.g. names, descriptions, packageDescriptions etc. |
skipMoveOnUpdate | On update, skip moving an existing product in the parent category provided | empty array |
mergeTranslationsOnUpdate | On update, delete all translation for a product that are not provided in the payload | empty array |
Request
Responses
- 200
- 400
Bulk Product by Id - 200
Response Headers
Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id
Bulk Product by Id - 400 (invalid schema)
Response Headers
Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id