Actualizar distrito

POST/api/crm/v2/districts.updatev2

operationId: districts.update

Modifica un distrito. Los parámetros day_mode_{district_id}_1 son obligatorios, por ejemplo, day_mode_55326_1: 1.

Autorización

api-token + language + role

Parámetros de consulta

branch_idintegerobligatorio

Ejemplo: 8785

Cuerpo de la solicitud `application/json`

object

idintegerobligatorio

Ejemplo: 1

namestringobligatorio

Ejemplo: Central

colorstring

Color en formato HEX sin el símbolo «#» inicial. El color se almacena en los polígonos, por lo que solo se guarda para el distrito con figuras. Si el campo no se envía, el color no se modifica.

Ejemplo: 3949AB

pickup_address_idinteger

Ejemplo: 1

operator_idintegerobligatorio

ID del operador

Ejemplo: 1

delivery_timeintegerobligatorio

Tiempo de entrega

Ejemplo: 60

other_delivery_time_enabledboolean

Habilitado tiempo de entrega especial en un período específico

Ejemplo: true

other_delivery_timeintegerobligatorio

Tiempo de entrega aumentado durante un período específico

Ejemplo: 90

other_delivery_time_periodsstringobligatorio

Período de vigencia del horario especial de entrega

Ejemplo: 00:00 - 23:59

paid_delivery_enabledboolean

Entrega de pago

Ejemplo: true

cost_of_deliverynumberobligatorio

Costo de entrega

Ejemplo: 100

minimum_order_amountnumberobligatorio

Importe mínimo de pedido

Ejemplo: 200

free_delivery_fromnumberobligatorio

Importe del pedido a partir del cual la entrega es gratuita

Ejemplo: 400

other_minimum_order_amount_enabledboolean

Habilitado un monto mínimo de pedido especial durante un período específico

Ejemplo: true

other_minimum_order_amountnumberobligatorio

Importe mínimo de pedido durante un período específico

Ejemplo: 300

other_minimum_order_amount_periodsstringobligatorio

Ejemplo: 00:00 - 23:59

other_minimum_order_amount_daysarray of integer

Días de la semana para un importe mínimo de pedido especial

redirect_district_idinteger

Distrito al que se redirigen los pedidos después del cierre

Ejemplo: 55301

timeworkstring

Ejemplo: 00:00 - 23:59

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: 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: es' \
  -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' => 'es',
        '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": "es",
        "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": "es",
        "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()

Respuesta 200

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

Las solicitudes se envían a foodsoul.pro, que es el host de este portal; no se puede elegir otro.

Actualizar distrito

Autorización

Parámetros de consulta

Cuerpo de la solicitud application/json

Respuestas

Cuerpo de la solicitud `application/json`