Gauti kurjerių žinynus

GET/api/crm/v2/couriers_list.fieldsv2

operationId: couriersList.fields

Autorizacija

api-token + language + role

Užklausos parametrai

branch_idintegerprivalomas

Pavyzdys: 1

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

district_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

account_idinteger

Pasirinkto branch_id paskyros ID

Pavyzdys: 3922

firm_user_idobject

Visi paskyros naudotojai su operatoriaus požymiais ir susieti su kurjerio nustatymais

typestring

Pavyzdys: select

optionarray of object

valueinteger

Pavyzdys: 825

namestring

Pavyzdys: user@fs.pro

has_operator_settingsboolean

Pavyzdys: false

has_courier_settingsboolean

Pavyzdys: false

distribution_methodobject (FilterEnum)

Filtras-enumeracija — plokščias enumeracijos reikšmių sąrašas

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

timezoneobject (FilterSelect)

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of object

valuestringprivalomas

Pavyzdys: example

namestringprivalomas

Pavyzdys: All

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

default_languagestring

Pavyzdys: 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' => 'lt', '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": "lt", "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": "lt", "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" } }