Obter a lista de fontes de vendas adicionais

GET/api/crm/v2/additional_salesv2

operationId: additionalSales.default

Retorna uma lista de fontes de vendas adicionais da filial com filtro por tipo de fonte (item, item_parameter, category). Para cada fonte, são retornados os produtos, categorias e parâmetros de produtos relacionados; a lista é ordenada e paginada.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 1

link_typestring

Valores:itemitem_parametercategory

page_numberinteger

Exemplo: 1

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobjectobrigatório

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

link_typeobject

typestringobrigatório

Exemplo: radio

optionarray of string

listarray of object

link_itemobjectobrigatório

idintegerobrigatório

Exemplo: 1

typestringobrigatório

Valores:itemitem_parametercategory

Exemplo: item

namestringobrigatório

Exemplo: Example item

strategystringpode ser nulo

Estratégia que criou a fonte; null — criado manualmente

Valores:sales_statisticsai_compatibilityai_prompt

Exemplo: sales_statistics

related_objectsarray of objectobrigatório

idintegerobrigatório

Exemplo: 1

typestringobrigatório

Valores:itemitem_parametercategory

Exemplo: item

namestringobrigatório

Exemplo: Recommended item

strategystringpode ser nulo

Estratégia que criou a ligação; null — adicionada manualmente

Valores:sales_statisticsai_compatibilityai_prompt

Exemplo: ai_compatibility

sortintegerobrigatório

Exemplo: 1

idintegerobrigatório

Exemplo: 1

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.ru/api/crm/v2/additional_sales', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'pt', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/additional_sales", { 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.ru/api/crm/v2/additional_sales", 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" }, "link_type": { "type": "radio", "option": [ "item" ] } }, "list": [ { "link_item": { "id": 1, "type": "item", "name": "Example item" }, "strategy": "sales_statistics", "related_objects": [ { "id": 1, "type": "item", "name": "Recommended item", "strategy": "ai_compatibility" } ], "sort": 1, "id": 1 } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false } } }