Obtener la lista de configuraciones de los couriers

GET/api/crm/v2/couriers_listv2

operationId: couriersList.default

Autorización

api-token + language + role

Parámetros de consulta

branch_idintegerobligatorio

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

settingsobject

distribution_methodstringobligatorio

Valores:manuallyautomatically

Ejemplo: manually

independencebooleanobligatorio

Ejemplo: true

listarray of object

idintegerobligatorio

Ejemplo: 1

namestringobligatorio

Ejemplo: example

firm_user_idinteger

Ejemplo: 1

districts_idsarray of integer

curl -X GET 'https://foodsoul.pro/api/crm/v2/couriers_list?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: es' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/couriers_list?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'es',
        'role' => 'partner',
    ],
]);

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

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

import requests

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

Respuesta 200

{
  "status": "success",
  "data": {
    "filters": {
      "branch_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      }
    },
    "settings": {
      "distribution_method": "manually",
      "independence": true
    },
    "list": [
      {
        "id": 1,
        "name": "example",
        "firm_user_id": 1,
        "districts_ids": [
          1
        ]
      }
    ]
  }
}

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