Skip to content

Deletion of brand

Request

If the brand cannot be deleted, because it is used by some product, a 409 code is returned.

Optional parameter deleteUsed with true value allows deletion of brand used by products.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
codestringrequired

brand GUID

Example:1e3f3f3f-3f3f-63ca-b93f-02423f1f0005
Query
deleteUsedboolean

allows deletion of brand used by products if set to true

Default:false
Example:deleteUsed=true
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X DELETE \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/brands/1e3f3f3f-3f3f-63ca-b93f-02423f1f0005?deleteUsed=true' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobject or nullrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {},
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}