API

Obtenir la liste des codes promo

GET/api/crm/v2/special_offers_promo_codesv2
operationId: specialOffersPromoCodes.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

La succursale selon laquelle la liste est filtrée. Sans ce paramètre, seules les options de filtrage sont renvoyées, sans la liste. Pour un partenaire avec une seule succursale, le serveur la renseigne automatiquement.

Exemple: 8778

special_offer_idinteger

Exemple: 1

page_numberinteger

Exemple: 1

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

special_offer_idobject (FilterSelect)
valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of object
valuestringobligatoire

Exemple: example

namestringobligatoire

Exemple: All

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

listarray of object
idintegerobligatoire

Exemple: 1

codestringobligatoire

Exemple: CODE1933

countinteger

Exemple: 2

count_activationsintegerobligatoire

Exemple: 0

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

bonuses_sumnumber

Exemple: 2.02

bonuses_validityinteger

Exemple: 3

branch_idintegerobligatoire

Exemple: 8778

special_offer_idinteger

Exemple: 152410

paginationobject (Pagination)
max_countintegerobligatoire

Nombre d'éléments par page

Exemple: 30

page_numberintegerobligatoire

Numéro de la page actuelle ; limité pour que le décalage ne dépasse pas 1000

Exemple: 1

has_nextbooleanobligatoire

Indique s'il existe une page suivante

Exemple: true

has_previousbooleanobligatoire

Y a-t-il une page précédente

Exemple: false

timezonestring

Exemple: Europe/Kaliningrad