Obtener la lista de códigos promocionales

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Sucursal por la que se filtra la lista. Sin este parámetro, la respuesta solo contiene los filtros, sin la lista. Para un socio con una sola sucursal, el servidor la asigna automáticamente.

Ejemplo: 8778

special_offer_idinteger

Ejemplo: 1

page_numberinteger

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

special_offer_idobject (FilterSelect)

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of object

valuestringobligatorio

Ejemplo: example

namestringobligatorio

Ejemplo: All

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

listarray of object

idintegerobligatorio

Ejemplo: 1

codestringobligatorio

Ejemplo: CODE1933

countinteger

Ejemplo: 2

count_activationsintegerobligatorio

Ejemplo: 0

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

bonuses_sumnumber

Ejemplo: 2.02

bonuses_validityinteger

Ejemplo: 3

branch_idintegerobligatorio

Ejemplo: 8778

special_offer_idinteger

Ejemplo: 152410

paginationobject (Pagination)

max_countintegerobligatorio

Cantidad de elementos por página

Ejemplo: 30

page_numberintegerobligatorio

Número de la página actual; limitado para que el desplazamiento no supere 1000

Ejemplo: 1

has_nextbooleanobligatorio

¿Hay una página siguiente?

Ejemplo: true

has_previousbooleanobligatorio

¿Hay una página anterior?

Ejemplo: false

timezonestring

Ejemplo: Europe/Kaliningrad

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

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

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/special_offers_promo_codes", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "es", "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" } }