Obter a lista de códigos promocionais

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Filial pelo qual a lista é filtrada. Sem ele, a resposta contém apenas os filtros, sem a lista. Para parceiros com um único filial, o servidor o define automaticamente.

Exemplo: 8778

special_offer_idinteger

Exemplo: 1

page_numberinteger

Exemplo: 1

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

special_offer_idobject (FilterSelect)

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of object

valuestringobrigatório

Exemplo: example

namestringobrigatório

Exemplo: All

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

listarray of object

idintegerobrigatório

Exemplo: 1

codestringobrigatório

Exemplo: CODE1933

countinteger

Exemplo: 2

count_activationsintegerobrigatório

Exemplo: 0

date_availablestring (DataTimeFormatSQL)

Exemplo: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Exemplo: 2024-05-02 08:31:16

bonuses_sumnumber

Exemplo: 2.02

bonuses_validityinteger

Exemplo: 3

branch_idintegerobrigatório

Exemplo: 8778

special_offer_idinteger

Exemplo: 152410

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

timezonestring

Exemplo: Europe/Kaliningrad

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/special_offers_promo_codes', [ '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/special_offers_promo_codes", { 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/special_offers_promo_codes", 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" }, "special_offer_id": { "value": "example", "type": "select", "option": [ { "value": "example", "name": "All" } ], "mode": "value_required" } }, "list": [ { "id": 1, "code": "CODE1933", "count": 2, "count_activations": 0, "date_available": "2024-05-02 08:31:16", "date_expiration": "2024-05-02 08:31:16", "bonuses_sum": 2.02, "bonuses_validity": 3, "branch_id": 8778, "special_offer_id": 152410 } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false }, "timezone": "Europe/Kaliningrad" } }