Obtenir la liste des points de retrait

GET/api/crm/v2/pickupv2

operationId: pickup.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 8778

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

cityobject

idintegerobligatoire

Exemple: 7109

namestringobligatoire

Exemple: Kaliningrad

timezonestring

Exemple: Europe/Kaliningrad

latitudenumber

Exemple: 40.172197

longitudenumber

Exemple: 44.513278

settingsobject

operator_idinteger

Exemple: 7109

preparation_timeinteger

Exemple: 60

other_preparation_timeinteger

Exemple: 90

other_preparation_time_periodsarray of string

other_preparation_time_enabledboolean

Exemple: true

minimum_order_amountnumber

Exemple: 200.34

other_minimum_order_amountnumber

Exemple: 300.55

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Exemple: false

work_timearray of object (WorkTimePrepared)

dayintegerobligatoire

Valeurs:1234567

Exemple: 1

parameterinteger

Valeurs:123

Exemple: 1

timesarray of string

pickup_force_enabledboolean

Exemple: false

available_environment_enabledboolean

Exemple: false

listarray of object

idintegerobligatoire

Exemple: 1

namestringobligatoire

Exemple: Pickup point

publishedbooleanobligatoire

Exemple: false

sortintegerobligatoire

Exemple: -1715598315

addressstringobligatoire

Exemple: Kirov, Lenina st. 1

longitudenumber

Exemple: 49.6677406

latitudenumber

Exemple: 58.6041385

operator_idintegerobligatoire

Exemple: 7109

work_timearray of object (WorkTimePrepared) obligatoire

dayintegerobligatoire

Valeurs:1234567

Exemple: 1

parameterinteger

Valeurs:123

Exemple: 1

timesarray of string

preparation_timeintegerobligatoire

Exemple: 60

other_preparation_timeintegerobligatoire

Exemple: 90

other_preparation_time_periodsstring

Exemple: 00:00 - 23:59

other_preparation_time_enabledboolean

Exemple: false

minimum_order_amountnumber

Exemple: 200

other_minimum_order_amountnumber

Exemple: 300

other_minimum_order_amount_daysarray of integer

Jours de la semaine

other_minimum_order_amount_periodsstring

Exemple: 00:00 - 23:59

other_minimum_order_amount_enabledboolean

Exemple: false

timeworkstring

Exemple: 00:00 - 23:59

branch_idintegerobligatoire

Exemple: 1

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/pickup', [ '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/pickup", { 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/pickup", 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" } }, "city": { "id": 7109, "name": "Kaliningrad", "timezone": "Europe/Kaliningrad", "latitude": 40.172197, "longitude": 44.513278 }, "settings": { "operator_id": 7109, "preparation_time": 60, "other_preparation_time": 90, "other_preparation_time_periods": [ "00:00 - 23:59" ], "other_preparation_time_enabled": true, "minimum_order_amount": 200.34, "other_minimum_order_amount": 300.55, "other_minimum_order_amount_days": [ 1 ], "other_minimum_order_amount_periods": [ "00:00 - 23:59" ], "other_minimum_order_amount_enabled": false, "work_time": [ { "day": 1, "parameter": 1, "times": [ "00:00 - 23:59" ] } ], "pickup_force_enabled": false, "available_environment_enabled": false }, "list": [ { "id": 1, "name": "Pickup point", "published": false, "sort": -1715598315, "address": "Kirov, Lenina st. 1", "longitude": 49.6677406, "latitude": 58.6041385, "operator_id": 7109, "work_time": [ { "day": 1, "parameter": 1, "times": [] } ], "preparation_time": 60, "other_preparation_time": 90, "other_preparation_time_periods": "00:00 - 23:59", "other_preparation_time_enabled": false, "minimum_order_amount": 200, "other_minimum_order_amount": 300, "other_minimum_order_amount_days": [ 1 ], "other_minimum_order_amount_periods": "00:00 - 23:59", "other_minimum_order_amount_enabled": false, "timework": "00:00 - 23:59", "branch_id": 1 } ] } }