Obtenir la liste des services de livraison

GET/api/crm/v2/integration_courier_servicesv2

operationId: integrationCourierServices.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 1

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object

valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

settingsobject

expedited_delivery_enabledbooleanobligatoire

Exemple: true

prepayment_enabledbooleanobligatoire

Exemple: true

auto_confirm_delivery_enabledbooleanobligatoire

Exemple: true

minimum_order_amountnumberobligatoire

Exemple: 10.4

additional_cost_of_deliverynumberobligatoire

Exemple: 10.5

listarray of object

idintegerobligatoire

Exemple: 1

service_idintegerobligatoire

Exemple: 1

service_enabledbooleanobligatoire

Exemple: true

wikistring

Exemple: https://wiki.foodsoul.pro/i/97

fieldsarray of objectobligatoire

encryptedbooleanobligatoire

Champ chiffré ; utilisez un champ de type « mot de passe » pour la saisie

Exemple: true

namestringobligatoire

Modèle de clé ${field}

Exemple: token

valueoneOf

L'une des options

string

Текстовое поле

Exemple: secretkey

typestring

Absent for text field

Valeurs:switch

Exemple: switch

sitestringobligatoire

Exemple: https://dostavka.yandex.ru/

system_namestringobligatoire

Exemple: YandexDelivery

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/integration_courier_services", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "fr", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "settings": { "expedited_delivery_enabled": true, "prepayment_enabled": true, "auto_confirm_delivery_enabled": true, "minimum_order_amount": 10.4, "additional_cost_of_delivery": 10.5 }, "list": [ { "id": 1, "service_id": 1, "service_enabled": true, "wiki": "https://wiki.foodsoul.pro/i/97", "fields": [ { "encrypted": true, "name": "token", "type": "switch" } ], "site": "https://dostavka.yandex.ru/", "system_name": "YandexDelivery" } ] } }