Add an item parameter to the stop list

POST/api/crm/v2/items_stop_list.addv2

operationId: itemsStopList.add

Adds an item parameter to the stop list. If the parameter is already in the stop list, an error is returned.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 8785

Request body `application/json`

object

idintegerrequired

Example: 94060221

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

statusstring

Example: success

descriptionstring

Example: Successfully saved

rowobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/items_stop_list.add?branch_id=8785' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":94060221}'

<?php

$client = new \GuzzleHttp\Client();

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

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

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

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/items_stop_list.add?branch_id=8785",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "id": 94060221,
    },
)
data = response.json()

Response 200

{
  "status": "success",
  "data": {
    "status": "success",
    "description": "Successfully saved",
    "row": {
      "id": "94060221"
    }
  }
}

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

Add an item parameter to the stop list

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`