Add contractor

POST/api/crm/v2/contractors.addv2

operationId: contractors.add

Adds a contractor. The set of details fields depends on contractor_type_id — see contractors.fields.

Authorization

api-token + language + role

Query parameters

chain_idintegerrequired

Example: 1

Request body `application/json`

Dynamic fields by contractor_type_id. Take the fields from the fields request and map them to the selected contractor_type_id.

object

contractor_type_idintegerrequired

Example: 1

branch_idintegerrequired

Example: 1

taxation_idintegerrequired

Example: 1

cao_emailstringrequired

Example: example@example.com

cao_phone_format_idinteger (PhoneFormatId) required

Country code: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Example: 1

cao_phone_numberstringrequired

Example: 999-999-99-99

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

curl -X POST 'https://foodsoul.ru/api/crm/v2/contractors.add?chain_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"contractor_type_id":1,"branch_id":1,"taxation_id":1,"cao_email":"example@example.com","cao_phone_format_id":1,"cao_phone_number":"999-999-99-99"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/contractors.add?chain_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'contractor_type_id' => 1,
        'branch_id' => 1,
        'taxation_id' => 1,
        'cao_email' => 'example@example.com',
        'cao_phone_format_id' => 1,
        'cao_phone_number' => '999-999-99-99',
    ],
]);

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/contractors.add?chain_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "contractor_type_id": 1,
        "branch_id": 1,
        "taxation_id": 1,
        "cao_email": "example@example.com",
        "cao_phone_format_id": 1,
        "cao_phone_number": "999-999-99-99"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/contractors.add?chain_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "contractor_type_id": 1,
        "branch_id": 1,
        "taxation_id": 1,
        "cao_email": "example@example.com",
        "cao_phone_format_id": 1,
        "cao_phone_number": "999-999-99-99",
    },
)
data = response.json()

Response 200

{
  "status": "success",
  "data": {}
}

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

Add contractor

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`