მიიღეთ ცნობარები კურიერებისთვის

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

ავტორიზაცია

api-token + language + role

მოთხოვნის პარამეტრები

branch_idintegerსავალდებულო

მაგალითი: 1

პასუხები

object

statusstringსავალდებულო

მნიშვნელობები:successerror

მაგალითი: success

dataobject

district_idobject (FilterSelectInteger)

valueinteger

მაგალითი: 8920

typestringსავალდებულო

მაგალითი: select

optionarray of object

valueintegerსავალდებულო

მაგალითი: 8920

namestringსავალდებულო

მაგალითი: Green Basket | Kaliningrad

modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

account_idinteger

არჩეული branch_id-ის ანგარიშის ID

მაგალითი: 3922

firm_user_idobject

ყველა მომხმარებელი ანგარიშის, რომლებსაც აქვთ ოპერატორის ატრიბუტები და კურიერის პარამეტრებთან მიბმა

typestring

მაგალითი: select

optionarray of object

valueinteger

მაგალითი: 825

namestring

მაგალითი: user@fs.pro

has_operator_settingsboolean

მაგალითი: false

has_courier_settingsboolean

მაგალითი: false

distribution_methodobject (FilterEnum)

ფილტრი-ჩამონათვალი — ბრტყელი ჩამონათვალი enum მნიშვნელობების

valuestring

მაგალითი: example

typestringსავალდებულო

მაგალითი: select

optionarray of string

modestring (FilterMode)

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

timezoneobject (FilterSelect)

valuestring

მაგალითი: example

typestringსავალდებულო

მაგალითი: select

optionarray of object

valuestringსავალდებულო

მაგალითი: example

namestringსავალდებულო

მაგალითი: All

modestring (FilterMode)

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

default_languagestring

მაგალითი: ru

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/couriers_list.fields?branch_id=1', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ka', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/couriers_list.fields?branch_id=1", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ka", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/couriers_list.fields?branch_id=1", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ka", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "district_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "account_id": 3922, "firm_user_id": { "type": "select", "option": [ { "value": 825, "name": "user@fs.pro", "has_operator_settings": false, "has_courier_settings": false } ] }, "distribution_method": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "timezone": { "value": "example", "type": "select", "option": [ { "value": "example", "name": "All" } ], "mode": "value_required" }, "default_language": "ru" } }