Connect a delivery service

POST/api/crm/v2/integration_courier_services.addv2

operationId: integrationCourierServices.add

Connects a delivery service. Configuration fields are passed as {field}, confidential fields are encrypted. The service is created in a disabled state.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

Request body `application/json`

Key template ${field}

object

One of the options

object

YandexDelivery

service_idintegerrequired

Example: 1

tokenstringrequired

Example: secret

tariff_superexpress_enabledbooleanrequired

First, try the superexpress_d2d tariff; if unsuccessful, use express

Example: false

object

Ipost

service_idintegerrequired

Example: 1

tokenstringrequired

Example: secret

object

Wolt

service_idintegerrequired

Example: 2

tokenstringrequired

Example: secret

merchantstringrequired

Example: secret

venuestringrequired

Example: secret

client_secretstringrequired

Example: secret

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/integration_courier_services.add?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"service_id":1,"token":"secret","tariff_superexpress_enabled":false}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/integration_courier_services.add?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'service_id' => 1,
        'token' => 'secret',
        'tariff_superexpress_enabled' => false,
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/integration_courier_services.add?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "service_id": 1,
        "token": "secret",
        "tariff_superexpress_enabled": false
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/integration_courier_services.add?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "service_id": 1,
        "token": "secret",
        "tariff_superexpress_enabled": False,
    },
)
data = response.json()

Response 200

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

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

Connect a delivery service

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`