Add district

POST/api/crm/v2/districts.addv2

operationId: districts.add

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

Request body `application/json`

object

namestringrequired

Example: Central

pickup_address_idinteger

Example: 1

operator_idintegerrequired

Example: 1

delivery_timeintegerrequired

Delivery time

Example: 60

other_delivery_time_enabledboolean

Special delivery time enabled for a specific period

Example: true

other_delivery_timeintegerrequired

Increased delivery time during a specific period

Example: 90

other_delivery_time_periodsstringrequired

Special delivery time period

Example: 00:00 - 23:59

paid_delivery_enabledboolean

Paid delivery

Example: true

cost_of_deliverynumberrequired

Delivery cost

Example: 100

minimum_order_amountnumberrequired

Minimum order amount

Example: 200

free_delivery_fromnumberrequired

Order amount for free delivery

Example: 400

other_minimum_order_amount_enabledboolean

Special minimum order amount enabled for a specific period

Example: true

other_minimum_order_amountnumberrequired

Minimum order amount for a specific period

Example: 300

other_minimum_order_amount_periodsstringrequired

Example: 00:00 - 23:59

other_minimum_order_amount_daysarray of integer

Days of the week for a special minimum order amount

day_mode_add_1integerrequired

Values:123

Example: 1

day_mode_add_2integerrequired

Values:123

Example: 1

day_mode_add_3integerrequired

Values:123

Example: 1

day_mode_add_4integerrequired

Values:123

Example: 1

day_mode_add_5integerrequired

Values:123

Example: 1

day_mode_add_6integerrequired

Values:123

Example: 1

day_mode_add_7integerrequired

Values:123

Example: 1

day_timearray of stringrequired

redirect_district_idinteger

District to which orders are redirected after closure

Example: 1

timeworkstring

Example: 00:00 - 23:59

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

rowobject

The newly created district in the same format as a list item

curl -X POST 'https://foodsoul.pro/api/crm/v2/districts.add?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Central","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],"day_mode_add_1":1,"day_mode_add_2":1,"day_mode_add_3":1,"day_mode_add_4":1,"day_mode_add_5":1,"day_mode_add_6":1,"day_mode_add_7":1,"day_time":["00:00 - 23:59"],"redirect_district_id":1,"timework":"00:00 - 23:59"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/districts.add?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'name' => 'Central',
        '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,
        ],
        'day_mode_add_1' => 1,
        'day_mode_add_2' => 1,
        'day_mode_add_3' => 1,
        'day_mode_add_4' => 1,
        'day_mode_add_5' => 1,
        'day_mode_add_6' => 1,
        'day_mode_add_7' => 1,
        'day_time' => [
            '00:00 - 23:59',
        ],
        'redirect_district_id' => 1,
        'timework' => '00:00 - 23:59',
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/districts.add?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "name": "Central",
        "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
        ],
        "day_mode_add_1": 1,
        "day_mode_add_2": 1,
        "day_mode_add_3": 1,
        "day_mode_add_4": 1,
        "day_mode_add_5": 1,
        "day_mode_add_6": 1,
        "day_mode_add_7": 1,
        "day_time": [
            "00:00 - 23:59"
        ],
        "redirect_district_id": 1,
        "timework": "00:00 - 23:59"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/districts.add?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "name": "Central",
        "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,
        ],
        "day_mode_add_1": 1,
        "day_mode_add_2": 1,
        "day_mode_add_3": 1,
        "day_mode_add_4": 1,
        "day_mode_add_5": 1,
        "day_mode_add_6": 1,
        "day_mode_add_7": 1,
        "day_time": [
            "00:00 - 23:59",
        ],
        "redirect_district_id": 1,
        "timework": "00:00 - 23:59",
    },
)
data = response.json()

Response 200

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

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

Add district

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`