Skip to main content

Bulk Categories by Id

POST 

/categories/bulk/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.

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go here.

A single category'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 categories, this endpoint should be used.

Fields

NameRequired
categories (array of category objects)yes
sourceIdyes
sourceyes
languageyes
namesyes
descriptionsno
shortDescriptionsno
attributes

Read more about attributes
no
parentyes

For more details on attributes field, read this.

Directives

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

What are directives?

Request

Body

    categories

    object[]

  • Array [

  • descriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • id number
    language string

    names

    object[]

  • Array [

  • language string
    value string
  • ]

  • parent

    object

    id number

    shortDescription

    object[]

  • Array [

  • language string
    value string
  • ]

  • shortDescriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • ]

  • directives

    object[]

  • Array [

  • fields string[]
    operation string
  • ]

Responses

Bulk Categories 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...