Skip to main content

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

NameRequired
products (array of product objects)yes
sourceIdyes
sourceyes
languageyes
namesno
skuno (recommended)
unitno
Default is 1
statusno
Default is A
priceDisplayno
Default is default
descriptionsno
shortDescriptionsno
taxCodeno
Default is H
supplierno (recommended)
supplierCodeno (recommended)
oemCodeno
eanCodeno
minimumQuantityno
Default is 1
packageDescriptionsno
notesno
attributes

Read more about attributes
no
parentno

For more details on attributes field, read this.

Directives

NameDescriptionFields
skipIfNotEmptyOn update, skip updating fields of an existing product that are not emptyarray of field names
e.g. names, descriptions, packageDescriptions etc.
skipMoveOnUpdateOn update, skip moving an existing product in the parent category providedempty array
mergeTranslationsOnUpdateOn update, delete all translation for a product that are not provided in the payloadempty array

What are directives?

Request

Body

    directives

    object[]

  • Array [

  • fields string[]
    operation string
  • ]

  • products

    object[]

  • Array [

  • attributes

    object[]

  • Array [

  • class string
    name string
    type string

    value

    object[]

  • Array [

  • language string
    value string
  • ]

  • ]

  • brand string

    descriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • eanCode string
    id number
    language string
    minimumQuantity number

    name

    object[]

  • Array [

  • language string
    value string
  • ]

  • names

    object[]

  • Array [

  • language string
    value string
  • ]

  • notes

    object[]

  • Array [

  • language string
    value string
  • ]

  • oemCode string
    package string

    packageDescriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • parent

    object

    id number

    shortDescriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • shortName string
    sku string
    status string
    supplier string
    supplierCode string
    taxCode string
    unit number
  • ]

Responses

Bulk Product by Id - 200

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • server

    string

  • x-request-id

    string

Schema

    data

    object[]

  • Array [

  • action string
    id number
    key number
    lookupKey string
    success boolean
  • ]

  • messages string[]
    total number
Loading...