Hangi must nimekirja

GET/api/crm/v2/black_listv2

operationId: blackList.default

Autoriseerimine

api-token + language + role

Päringu parameetrid

page_numberinteger

Näide: 1

phone_format_idinteger

Näide: 1

phone_numberstring

Näide: (707) 712-51-19

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

filtersobject

phone_format_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

phone_numberobject (FilterInput)

valuestring

Näide: example

typestringkohustuslik

Näide: integer or string

placeholderstring

Näide: string

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

idobject (FilterId)

valueany

Näide: 0

typestringkohustuslik

Näide: integer

placeholderstring

Näide: integer

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

listarray of object

idintegerkohustuslik

Näide: 82348

datestring (DataTimeFormat) kohustuslik

Näide: 17:45 06/05/2024

chain_idintegerkohustuslik

Näide: 7143

client_account_idinteger

Näide: 0

client_branch_profile_idinteger

Näide: 0

phone_format_idinteger

Näide: 4

phone_numberstring

Näide: 7077125119

blockedbooleankohustuslik

Näide: true

client_namestring

Näide: example

paginationobject (Pagination)

max_countintegerkohustuslik

Elementide arv lehel

Näide: 30

page_numberintegerkohustuslik

Praeguse lehekülje number; piiratud nii, et nihe ei ületaks 1000

Näide: 1

has_nextbooleankohustuslik

Kas on järgmine lehekülg

Näide: true

has_previousbooleankohustuslik

Kas eelmine lehekülg on olemas

Näide: false

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

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

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

{ "status": "success", "data": { "filters": { "phone_format_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "phone_number": { "value": "example", "type": "integer or string", "placeholder": "string", "mode": "value_required" }, "id": { "value": 0, "type": "integer", "placeholder": "integer", "mode": "value_required" } }, "list": [ { "id": 82348, "date": "17:45 06/05/2024", "chain_id": 7143, "client_account_id": 0, "client_branch_profile_id": 0, "phone_format_id": 4, "phone_number": "7077125119", "blocked": true, "client_name": "example" } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false } } }