API

Get SEO fields of items

GET/api/crm/v2/sites_seo_itemsv2
operationId: sitesSeoItems.default

Returns SEO fields of products. If download=yes, the response is a CSV file.

Authorization

api-token + language + role

Query parameters

page_numberinteger

Example: 1

branch_idinteger

Example: 8778

downloadstring

Values:yes

Example: yes

Responses

OK

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

listarray of object
idintegerrequired

Example: 1

namestringrequired

Example: Fried rolls → Fried roll with shrimp and tuna

seo_friendly_urlstringrequired

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

seo_h1string

Example: Fried roll with shrimp and tuna

seo_breadcrumbstring

Example: Fried roll with shrimp and tuna

seo_titlestring

Example: Fried roll with shrimp and tuna

seo_keywordsstring

Example: rolls, shrimp

seo_descriptionstring

Example: Fried roll with shrimp and tuna in Kaliningrad

seo_textstring

Content in HTML format

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

paginationobject (Pagination)
max_countintegerrequired

Number of items per page

Example: 30

page_numberintegerrequired

Current page number; limited so that the offset does not exceed 1000

Example: 1

has_nextbooleanrequired

Is there a next page

Example: true

has_previousbooleanrequired

Is there a previous page

Example: false