Отримати SEO категорії

GET/api/crm/v2/sites_seo_categoriesv2

operationId: sitesSeoCategories.default

Повертає SEO-поля категорій. При download=yes вибірка повертається як CSV-файл.

Авторизація

api-token + language + role

Параметри запиту

page_numberinteger

Приклад: 1

branch_idinteger

Приклад: 8778

downloadstring

Значення:yes

Приклад: yes

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

listarray of object

idintegerобов’язковий

Приклад: 18103940

namestringобов’язковий

Приклад: Rolls

seo_friendly_urlstringобов’язковий

Приклад: roll

seo_h1string

Приклад: Rolls

seo_breadcrumbstring

Приклад: Rolls

seo_titlestring

Приклад: Rolls

seo_keywordsstring

Приклад: rolls, shrimp

seo_descriptionstring

Приклад: Rolls in Kaliningrad

seo_textstring

HTML

Приклад: <p>Rolls in Kaliningrad<p>

paginationobject (Pagination)

max_countintegerобов’язковий

Кількість елементів на сторінці

Приклад: 30

page_numberintegerобов’язковий

Номер поточноï сторінки; обмежено так, щоб зсув не перевищував 1000

Приклад: 1

has_nextbooleanобов’язковий

Чи є наступна сторінка

Приклад: true

has_previousbooleanобов’язковий

Чи є попередня сторінка

Приклад: false

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/sites_seo_categories", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "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" } }, "list": [ { "id": 18103940, "name": "Rolls", "seo_friendly_url": "roll", "seo_h1": "Rolls", "seo_breadcrumb": "Rolls", "seo_title": "Rolls", "seo_keywords": "rolls, shrimp", "seo_description": "Rolls in Kaliningrad", "seo_text": "<p>Rolls in Kaliningrad<p>" } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false } } }