Batch Create Categories

POST

/v1/categories/{companyId}/{brandId}/batch-create

curl --request POST \
  --url https://api.dev.caspeco.net/api/am/v1/categories/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/batch-create \
  --header 'Content-Type: application/json' \
  --data '{ "items": [ { "name": "example", "description": "example", "externalId": "example", "parentExternalId": "example", "parentCategoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ] }'

Creates up to 50 categories in a single all-or-nothing batch

Parameters

Path Parameters

companyId

required

string format: uuid

brandId

required

string format: uuid

Request Body

object

items

required

Array<object>

object

name

required

string

description

string

nullable

externalId

string

nullable

parentExternalId

string

nullable

parentCategoryId

string format: uuid

nullable

Example^generated

{
  "items": [
    {
      "name": "example",
      "description": "example",
      "externalId": "example",
      "parentExternalId": "example",
      "parentCategoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ]
}

object

items

required

Array<object>

object

name

required

string

description

string

nullable

externalId

string

nullable

parentExternalId

string

nullable

parentCategoryId

string format: uuid

nullable

Example^generated

{
  "items": [
    {
      "name": "example",
      "description": "example",
      "externalId": "example",
      "parentExternalId": "example",
      "parentCategoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ]
}

object

items

required

Array<object>

object

name

required

string

description

string

nullable

externalId

string

nullable

parentExternalId

string

nullable

parentCategoryId

string format: uuid

nullable

Example^generated

{
  "items": [
    {
      "name": "example",
      "description": "example",
      "externalId": "example",
      "parentExternalId": "example",
      "parentCategoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ]
}

Responses

200

Returns created categories

object

items

required

Array<object>

object

categoryId

required

string format: uuid

parentCategoryId

string format: uuid

nullable

name

required

string

description

required

string

nullable

externalId

string

nullable

parentExternalId

string

nullable

object

items

required

Array<object>

object

categoryId

required

string format: uuid

parentCategoryId

string format: uuid

nullable

name

required

string

description

required

string

nullable

externalId

string

nullable

parentExternalId

string

nullable

Example^generated

{
  "items": [
    {
      "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "parentCategoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "description": "example",
      "externalId": "example",
      "parentExternalId": "example"
    }
  ]
}

object

items

required

Array<object>

object

categoryId

required

string format: uuid

parentCategoryId

string format: uuid

nullable

name

required

string

description

required

string

nullable

externalId

string

nullable

parentExternalId

string

nullable

Example^generated

{
  "items": [
    {
      "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "parentCategoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "description": "example",
      "externalId": "example",
      "parentExternalId": "example"
    }
  ]
}

400

Bad Request

object

statusCode

integer format: int32

message

string

validationErrors

Array<object>

nullable

object

field

required

string

errorId

required

string

entity

string

nullable

object

statusCode

integer format: int32

message

string

validationErrors

Array<object>

nullable

object

field

required

string

errorId

required

string

entity

string

nullable

Example^generated

{
  "statusCode": 1,
  "message": "example",
  "validationErrors": [
    {
      "field": "example",
      "errorId": "example"
    }
  ],
  "entity": "example"
}

object

statusCode

integer format: int32

message

string

validationErrors

Array<object>

nullable

object

field

required

string

errorId

required

string

entity

string

nullable

Example^generated

{
  "statusCode": 1,
  "message": "example",
  "validationErrors": [
    {
      "field": "example",
      "errorId": "example"
    }
  ],
  "entity": "example"
}

401

Unauthorized

403

Forbidden

500

Internal Server Error