Enable or disable inclusion in the free delivery amount

POST/api/crm/v2/categories.toggle_free_deliveryv2

operationId: categories.toggleFreeDelivery

Enables or disables the inclusion of category items in the free delivery threshold calculation. If free_delivery_enabled is disabled, the cost of items in this category is not counted towards the free delivery threshold.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

Request body `application/json`

object

idintegerrequired

Example: 1

activebooleanrequired

Example: true

Responses

object (Response)

statusstringrequired

Values:successerror

Example: success

One of the options

object

Error details

errorobjectrequired

codeintegerrequired

Error code

variablesobject

descriptionstringrequired

Error description

object

Data array (structure depends on the action, see examples)

dataobjectrequired

curl -X POST 'https://foodsoul.pro/api/crm/v2/categories.toggle_free_delivery?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":1,"active":true}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/categories.toggle_free_delivery?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 1,
        'active' => true,
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/categories.toggle_free_delivery?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "id": 1,
        "active": true
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/categories.toggle_free_delivery?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "id": 1,
        "active": True,
    },
)
data = response.json()

Response 200

{
  "error": {
    "code": 0,
    "variables": {},
    "description": "string"
  }
}

Requests are sent to foodsoul.pro — the host of this portal; you cannot choose another one.

Enable or disable inclusion in the free delivery amount

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`