Create Brand

POST 
/api/v1/brands

Create Brand

Request

application/json

Body

brandId stringrequired

Possible values: non-empty

Custom ID of the brand

description stringnullable

Brand description

name stringrequired

Possible values: non-empty

Name of the brand

Responses

201

Created

application/json

Schema

Schema

data

object

Brand data

brandId stringrequired

Unique identifier of the brand

description string

Brand description

name stringrequired

Brand name

Example (from schema)

{
  "data": {
    "brandId": "brand_1",
    "description": "Modern Menswear",
    "name": "Acme"
  }
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

422

Validation Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "type": [
      "Input type is not valid"
    ]
  },
  "message": "Validation error"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...