Create shop category

Create a new shop category

Rate Limit: 300 Max attempts within 1 minute.

Path Parameters

Parameter	Details
shopKey required	string Example: ms

Request body

required

Parameter	Details
id readonly	integer Example: 3
parentId nullable	integer Example: 1
leftSiblingId nullable	integer Example: 2
name MinProps: 1	object Example: { "de_DE": "Meine Shop-Kategorie", "en_GB": "My Shop Category" }
productSets MinProps: 1 MaxProps: 4	object referencedProductSetId integer includeProductIds array MaxItems: 10000 integer excludeProductIds array MaxItems: 10000 integer isNew boolean Enum: true attributes array MinItems: 1 object
supportedFilterGroups	string
properties	object key string Example: myKey value string Example: myValue
isActive	boolean Example: true
isVisible	boolean Example: true
isExcludedFromSearch nullable	boolean Example: true
customData nullable	object MinProps: 1
countries MinProps: 1	object isActive boolean Example: true isVisible boolean Example: true isExcludedFromSearch boolean nullable Example: true properties array MaxItems: 1000 object customData nullable object MinProps: 1

Responses

201

Shop category was successfully created.

application/json

Success

integer

Example:

parentId

integer

Example:

leftSiblingId

integer

Example:

object

Example:

{
  "de_DE": "Meine Shop-Kategorie",
  "en_GB": "My Shop Category"
}

Array of object

supportedFilterGroups

Array of string

Array of object

isActive

boolean

Example:

true

isVisible

boolean

Example:

true

isExcludedFromSearch

boolean

Example:

true

null

Array of object

400

Bad Request

application/json

Error

401

Unauthorized

application/json

Error

404

Not Found

application/json

Error

POST/shops/{shopKey}/categories

Request samples

Response samples

201

Shop Category:

Content type: application/json