Obter campos de SEO dos produtos

GET/api/crm/v2/sites_seo_itemsv2

operationId: sitesSeoItems.default

Retorna os campos de SEO dos produtos. Com download=yes, a seleção é retornada como um arquivo CSV.

Autorização

api-token + language + role

Parâmetros de consulta

page_numberinteger

Exemplo: 1

branch_idinteger

Exemplo: 8778

downloadstring

Valores:yes

Exemplo: yes

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

listarray of object

idintegerobrigatório

Exemplo: 1

namestringobrigatório

Exemplo: Fried rolls → Fried roll with shrimp and tuna

seo_friendly_urlstringobrigatório

Exemplo: zarenyj-roll-s-krevetkoj-i-tuncom

seo_h1string

Exemplo: Fried roll with shrimp and tuna

seo_breadcrumbstring

Exemplo: Fried roll with shrimp and tuna

seo_titlestring

Exemplo: Fried roll with shrimp and tuna

seo_keywordsstring

Exemplo: rolls, shrimp

seo_descriptionstring

Exemplo: Fried roll with shrimp and tuna in Kaliningrad

seo_textstring

Conteúdo em formato HTML

Exemplo: <p>Fried roll with shrimp and tuna in Kaliningrad<p>

paginationobject (Pagination)

max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/sites_seo_items", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "pt", "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": 1, "name": "Fried rolls → Fried roll with shrimp and tuna", "seo_friendly_url": "zarenyj-roll-s-krevetkoj-i-tuncom", "seo_h1": "Fried roll with shrimp and tuna", "seo_breadcrumb": "Fried roll with shrimp and tuna", "seo_title": "Fried roll with shrimp and tuna", "seo_keywords": "rolls, shrimp", "seo_description": "Fried roll with shrimp and tuna in Kaliningrad", "seo_text": "<p>Fried roll with shrimp and tuna in Kaliningrad<p>" } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false } } }