Alterar distrito

POST/api/crm/v2/districts.updatev2

operationId: districts.update

Altera o distrito. Os parâmetros day_mode_{district_id}_1 são obrigatórios — por exemplo, day_mode_55326_1: 1.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 8785

Corpo da solicitação `application/json`

object

idintegerobrigatório

Exemplo: 1

namestringobrigatório

Exemplo: Central

colorstring

Cor em formato HEX sem o símbolo "#" inicial. A cor é armazenada em polígonos, portanto, é salva apenas para o distrito com figuras. Se o campo não for enviado, a cor não será alterada.

Exemplo: 3949AB

pickup_address_idinteger

Exemplo: 1

operator_idintegerobrigatório

ID do operador

Exemplo: 1

delivery_timeintegerobrigatório

Tempo de entrega

Exemplo: 60

other_delivery_time_enabledboolean

Ativado horário especial de entrega em um período específico

Exemplo: true

other_delivery_timeintegerobrigatório

Tempo de entrega aumentado em um determinado período

Exemplo: 90

other_delivery_time_periodsstringobrigatório

Período de validade do horário especial de entrega

Exemplo: 00:00 - 23:59

paid_delivery_enabledboolean

Entrega paga

Exemplo: true

cost_of_deliverynumberobrigatório

Custo de entrega

Exemplo: 100

minimum_order_amountnumberobrigatório

Valor mínimo do pedido

Exemplo: 200

free_delivery_fromnumberobrigatório

Valor mínimo do pedido para entrega gratuita

Exemplo: 400

other_minimum_order_amount_enabledboolean

Valor mínimo de pedido especial ativado para um determinado período

Exemplo: true

other_minimum_order_amountnumberobrigatório

Valor mínimo do pedido em um determinado período

Exemplo: 300

other_minimum_order_amount_periodsstringobrigatório

Exemplo: 00:00 - 23:59

other_minimum_order_amount_daysarray of integer

Dias da semana para valor mínimo de pedido especial

redirect_district_idinteger

Distrito para o qual os pedidos são redirecionados após o fechamento

Exemplo: 55301

timeworkstring

Exemplo: 00:00 - 23:59

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/districts.update?branch_id=8785' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":1,"name":"Central","color":"3949AB","pickup_address_id":1,"operator_id":1,"delivery_time":60,"other_delivery_time_enabled":true,"other_delivery_time":90,"other_delivery_time_periods":"00:00 - 23:59","paid_delivery_enabled":true,"cost_of_delivery":100,"minimum_order_amount":200,"free_delivery_from":400,"other_minimum_order_amount_enabled":true,"other_minimum_order_amount":300,"other_minimum_order_amount_periods":"00:00 - 23:59","other_minimum_order_amount_days":[1],"redirect_district_id":55301,"timework":"00:00 - 23:59"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/districts.update?branch_id=8785', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 1,
        'name' => 'Central',
        'color' => '3949AB',
        'pickup_address_id' => 1,
        'operator_id' => 1,
        'delivery_time' => 60,
        'other_delivery_time_enabled' => true,
        'other_delivery_time' => 90,
        'other_delivery_time_periods' => '00:00 - 23:59',
        'paid_delivery_enabled' => true,
        'cost_of_delivery' => 100,
        'minimum_order_amount' => 200,
        'free_delivery_from' => 400,
        'other_minimum_order_amount_enabled' => true,
        'other_minimum_order_amount' => 300,
        'other_minimum_order_amount_periods' => '00:00 - 23:59',
        'other_minimum_order_amount_days' => [
            1,
        ],
        'redirect_district_id' => 55301,
        'timework' => '00:00 - 23:59',
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/districts.update?branch_id=8785", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "id": 1,
        "name": "Central",
        "color": "3949AB",
        "pickup_address_id": 1,
        "operator_id": 1,
        "delivery_time": 60,
        "other_delivery_time_enabled": true,
        "other_delivery_time": 90,
        "other_delivery_time_periods": "00:00 - 23:59",
        "paid_delivery_enabled": true,
        "cost_of_delivery": 100,
        "minimum_order_amount": 200,
        "free_delivery_from": 400,
        "other_minimum_order_amount_enabled": true,
        "other_minimum_order_amount": 300,
        "other_minimum_order_amount_periods": "00:00 - 23:59",
        "other_minimum_order_amount_days": [
            1
        ],
        "redirect_district_id": 55301,
        "timework": "00:00 - 23:59"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/districts.update?branch_id=8785",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
    json={
        "id": 1,
        "name": "Central",
        "color": "3949AB",
        "pickup_address_id": 1,
        "operator_id": 1,
        "delivery_time": 60,
        "other_delivery_time_enabled": True,
        "other_delivery_time": 90,
        "other_delivery_time_periods": "00:00 - 23:59",
        "paid_delivery_enabled": True,
        "cost_of_delivery": 100,
        "minimum_order_amount": 200,
        "free_delivery_from": 400,
        "other_minimum_order_amount_enabled": True,
        "other_minimum_order_amount": 300,
        "other_minimum_order_amount_periods": "00:00 - 23:59",
        "other_minimum_order_amount_days": [
            1,
        ],
        "redirect_district_id": 55301,
        "timework": "00:00 - 23:59",
    },
)
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.

Alterar distrito

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`