Gauti juodąjį sąrašą

GET/api/crm/v2/black_listv2

operationId: blackList.default

Autorizacija

api-token + language + role

Užklausos parametrai

page_numberinteger

Pavyzdys: 1

phone_format_idinteger

Pavyzdys: 1

phone_numberstring

Pavyzdys: (707) 712-51-19

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

filtersobject

phone_format_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

phone_numberobject (FilterInput)

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: integer or string

placeholderstring

Pavyzdys: string

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

idobject (FilterId)

valueany

Pavyzdys: 0

typestringprivalomas

Pavyzdys: integer

placeholderstring

Pavyzdys: integer

modestring (FilterMode)

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

listarray of object

idintegerprivalomas

Pavyzdys: 82348

datestring (DataTimeFormat) privalomas

Pavyzdys: 17:45 06/05/2024

chain_idintegerprivalomas

Pavyzdys: 7143

client_account_idinteger

Pavyzdys: 0

client_branch_profile_idinteger

Pavyzdys: 0

phone_format_idinteger

Pavyzdys: 4

phone_numberstring

Pavyzdys: 7077125119

blockedbooleanprivalomas

Pavyzdys: true

client_namestring

Pavyzdys: example

paginationobject (Pagination)

max_countintegerprivalomas

Elementų skaičius puslapyje

Pavyzdys: 30

page_numberintegerprivalomas

Dabartinio puslapio numeris; apribotas taip, kad poslinkis neviršytų 1000

Pavyzdys: 1

has_nextbooleanprivalomas

Ar yra kitas puslapis

Pavyzdys: true

has_previousbooleanprivalomas

Ar yra ankstesnis puslapis

Pavyzdys: false

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/black_list", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "lt", "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 } } }