Skip to content

Deletion of article section

Request

If the article section cannot be deleted, because it contains article(s), a 409 code is returned.

Optional parameter force with true value allows deletion of article section including permanent deletion of article(s) having this section set as default.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
articleSectionIdintegerrequired

article section ID

Example:1
Query
forceboolean

allows deletion of article section that contains article(s) if set to true

Default:false
Example:force=true
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X DELETE \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/articles/sections/1?force=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" } }