Skip to content

Creation of brand

Request

Security
shoptetAccessToken or shoptetPrivateApiToken
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobject, non-empty(brandCreate)required
curl -i -X POST \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/brands \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "name": "Willy Wonka",
      "indexName": "willy-wonka",
      "brandWeb": "https://willywonka.com",
      "postalAddress": "Chocolate Factory, 1234 Candy Lane, Sweet City, SC 56789",
      "contactEmail": "willywonka@shoptet.cz",
      "europeanResellerPostalAddress": "Chocolate Factory, 1234 Candy Lane, Sweet City, SC 56789",
      "europeanResellerContactEmail": "europeanreseller@shoptet.cz",
      "manufacturingCompanyName": "Shoptet a.s.",
      "europeanResellerManufacturingCompanyName": "Shoptet a.s.",
      "showInCategoriesMenu": true,
      "showInBrandList": true,
      "description": "<p>Brand new chocolate <strong>everyday</strong></p>",
      "metaTitle": "Willy Wonka",
      "metaDescription": "Brand new chocolate everyday"
    }
  }'

Responses

Created

Bodyapplication/json
dataobject(brand)required
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "name": "Willy Wonka",
    "indexName": "willy-wonka",
    "description": "<p>Brand new chocolate <strong>everyday</strong></p>",
    "brandWeb": "https://www.willywonka.com",
    "postalAddress": "Chocolate Factory, 1234 Candy Lane, Sweet City, SC 56789",
    "contactEmail": "willywonka@shoptet.cz",
    "europeanResellerPostalAddress": "Chocolate Factory, 1234 Candy Lane, Sweet City, SC 56789",
    "europeanResellerContactEmail": "europeanreseller@shoptet.cz",
    "manufacturingCompanyName": "Shoptet a.s.",
    "europeanResellerManufacturingCompanyName": "Shoptet a.s.",
    "showInCategoriesMenu": true,
    "showInBrandList": false,
    "metaTitle": "Willy Wonka",
    "metaDescription": "Willy Wonka - Chocolate Factory"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}