Conectar serviço de entrega

POST/api/crm/v2/integration_courier_services.addv2

operationId: integrationCourierServices.add

Conecta um serviço de entrega. Os campos de configuração são passados como {field}, campos confidenciais são criptografados. O serviço é criado desativado.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 1

Corpo da solicitação `application/json`

Modelo de chave ${field}

object

Uma das opções

object

YandexDelivery

service_idintegerobrigatório

Exemplo: 1

tokenstringobrigatório

Exemplo: secret

tariff_superexpress_enabledbooleanobrigatório

Tentar primeiro a tarifa superexpress_d2d, em caso de falha — express

Exemplo: false

object

Ipost

service_idintegerobrigatório

Exemplo: 1

tokenstringobrigatório

Exemplo: secret

object

Wolt

service_idintegerobrigatório

Exemplo: 2

tokenstringobrigatório

Exemplo: secret

merchantstringobrigatório

Exemplo: secret

venuestringobrigatório

Exemplo: secret

client_secretstringobrigatório

Exemplo: secret

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: 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: pt' \
  -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' => 'pt',
        '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": "pt",
        "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": "pt",
        "role": "partner",
    },
    json={
        "service_id": 1,
        "token": "secret",
        "tariff_superexpress_enabled": False,
    },
)
data = response.json()

Resposta 200

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

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Conectar serviço de entrega

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`