Modificare il distretto

POST/api/crm/v2/districts.updatev2

operationId: districts.update

Modifica un distretto. I parametri day_mode_{district_id}_1 sono obbligatori, ad esempio, day_mode_55326_1: 1.

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idintegerobbligatorio

Esempio: 8785

Corpo della richiesta `application/json`

object

idintegerobbligatorio

Esempio: 1

namestringobbligatorio

Esempio: Central

colorstring

Colore in formato HEX senza il simbolo iniziale «#». Il colore viene memorizzato nei poligoni, quindi viene salvato solo per il distretto con figure. Se il campo non viene trasmesso, il colore non viene modificato.

Esempio: 3949AB

pickup_address_idinteger

Esempio: 1

operator_idintegerobbligatorio

ID dell'operatore

Esempio: 1

delivery_timeintegerobbligatorio

Tempo di consegna

Esempio: 60

other_delivery_time_enabledboolean

Abilitata la consegna in orari speciali per un periodo specifico

Esempio: true

other_delivery_timeintegerobbligatorio

Tempo di consegna aumentato in un determinato periodo

Esempio: 90

other_delivery_time_periodsstringobbligatorio

Periodo di validità dell'orario di consegna speciale

Esempio: 00:00 - 23:59

paid_delivery_enabledboolean

Consegna a pagamento

Esempio: true

cost_of_deliverynumberobbligatorio

Costo di consegna

Esempio: 100

minimum_order_amountnumberobbligatorio

Importo minimo dell’ordine

Esempio: 200

free_delivery_fromnumberobbligatorio

Importo dell'ordine a partire dal quale la consegna è gratuita

Esempio: 400

other_minimum_order_amount_enabledboolean

Abilitato un importo minimo d'ordine speciale in un periodo specifico

Esempio: true

other_minimum_order_amountnumberobbligatorio

Importo minimo dell'ordine in un determinato periodo

Esempio: 300

other_minimum_order_amount_periodsstringobbligatorio

Esempio: 00:00 - 23:59

other_minimum_order_amount_daysarray of integer

Giorni della settimana per un importo minimo d'ordine speciale

redirect_district_idinteger

Distretto a cui vengono reindirizzati gli ordini dopo la chiusura

Esempio: 55301

timeworkstring

Esempio: 00:00 - 23:59

Risposte

object

statusstringobbligatorio

Valori:successerror

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

Risposta 200

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

Le richieste vengono inviate a foodsoul.pro, che è l’host di questo portale; non è possibile sceglierne un altro.

Modificare il distretto

Autorizzazione

Parametri della richiesta

Corpo della richiesta application/json

Risposte

Corpo della richiesta `application/json`