Get a list of pickup points

GET/api/crm/v2/pickupv2

operationId: pickup.default

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 8778

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

cityobject

idintegerrequired

Example: 7109

namestringrequired

Example: Kaliningrad

timezonestring

Example: Europe/Kaliningrad

latitudenumber

Example: 40.172197

longitudenumber

Example: 44.513278

settingsobject

operator_idinteger

Example: 7109

preparation_timeinteger

Example: 60

other_preparation_timeinteger

Example: 90

other_preparation_time_periodsarray of string

other_preparation_time_enabledboolean

Example: true

minimum_order_amountnumber

Example: 200.34

other_minimum_order_amountnumber

Example: 300.55

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Example: false

work_timearray of object (WorkTimePrepared)

dayintegerrequired

Values:1234567

Example: 1

parameterinteger

Values:123

Example: 1

timesarray of string

pickup_force_enabledboolean

Example: false

available_environment_enabledboolean

Example: false

listarray of object

idintegerrequired

Example: 1

namestringrequired

Example: Pickup point

publishedbooleanrequired

Example: false

sortintegerrequired

Example: -1715598315

addressstringrequired

Example: Kirov, Lenina st. 1

longitudenumber

Example: 49.6677406

latitudenumber

Example: 58.6041385

operator_idintegerrequired

Example: 7109

work_timearray of object (WorkTimePrepared) required

dayintegerrequired

Values:1234567

Example: 1

parameterinteger

Values:123

Example: 1

timesarray of string

preparation_timeintegerrequired

Example: 60

other_preparation_timeintegerrequired

Example: 90

other_preparation_time_periodsstring

Example: 00:00 - 23:59

other_preparation_time_enabledboolean

Example: false

minimum_order_amountnumber

Example: 200

other_minimum_order_amountnumber

Example: 300

other_minimum_order_amount_daysarray of integer

Days of the week

other_minimum_order_amount_periodsstring

Example: 00:00 - 23:59

other_minimum_order_amount_enabledboolean

Example: false

timeworkstring

Example: 00:00 - 23:59

branch_idintegerrequired

Example: 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' => 'en', '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": "en", "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": "en", "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 } ] } }