docs
  1. Admin Api
  2. Resources
  3. Shop Categories
  4. Configuration
  5. Create Configuration

Create configuration

Create or update a shop category country configuration

Rate Limit: 300 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms
countryCode
  • required
string
Example:
de
shopCategoryId
  • required
integer
Example:
1

Request body

required
ParameterDetails
countryCode
  • readonly
  • MinLength: 2
  • MaxLength: 2
string
Example:
DE
shopCountryId
  • readonly
integer
Example:
1
path
  • readonly
  • MaxLength: 255
string
Example:
/my-shop-category
isActive
boolean
Example:
true
isVisible
boolean
Example:
true
isExcludedFromSearch
  • nullable
boolean
Example:
true
properties
object
key
string
Example:
myKey
value
string
Example:
myValue
customData
  • nullable
object
  • MinProps: 1

Responses

200
Shop category country configuration was succesfully updated or created.
application/json
Success
countryCode
string
Example:
DE
shopCountryId
integer
Example:
1
path
string
Example:
/my-shop-category
isActive
boolean
Example:
true
isVisible
boolean
Example:
true
isExcludedFromSearch
boolean
Example:
true
Array of object
null
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
POST/shops/{shopKey}/countries/{countryCode}/categories/{shopCategoryId}

Request samples

Response samples

200
Shop Category Country:
Content type: application/json

Last updated: June 19, 2024

Provide Feedback