getEnableOffers

Permet d'afficher l'ensemble des offres éditables par le client.

L'appel demande au minimum l'objet "IdentifierRequest", et renvoi alors toutes les offres disponibles dans le compte du client, qu'elles soient éditables au moment de l'appel ou dans X jours, et ce dans n'importe quel magasin.

Deux paramètres optionnels (et cumulables) permettent de filtrer le retour de l'API :

"date" -> L'API ne renverra que les offres éditables à la date indiquée en paramètre.

"entityIdentifier" -> L'API ne renverra que les offres éditables dans le magasin indiqué en paramètre.

Sa disponibilité varie en fonction de la version du Web-Service utilisé. Se renseigner auprès de Kiss The Bride pour valider son utilisation.

Le paramètre "filter" permet d'afficher ou non certaines offres, et doit être défini en amont avec Kiss The Bride pour être utilisé.

Pour éditer une offre, il est nécessaire de récupérer la valeur "offerId" retourné par le Web-Services, pour ensuite utiliser l'appel editOffer.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

Body Params application/json

Example

{
    "IdentifierRequest": {
        "identifierType": 1,
        "identifierValue": "1234567891011"
    },
    "filter": 0,
    "date": "26/09/2025 12:00:00",
    "EntityRequest": {
        "entityIdentifier": "666666"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "responseCode": "000",
    "infos": "Request successfully processed",
    "GetEnableOffersResponses": [
        {
            "used": false,
            "startDate": "24/09/2025 08:00:00",
            "classifications": [],
            "offerNumber": "255551001****",
            "immediateUse": 0,
            "offerId": "40844",
            "channelId": "8",
            "endDate": "04/12/2025 08:00:00",
            "globalMinPrice": 0.0,
            "globalMaxPrice": 0.0,
            "globalMinQuantity": -10000.0,
            "globalMaxQuantity": -9999.0,
            "offerName": "BON D'ACHAT FIDELITE 5 EUROS",
            "offerDescription": "5 EUROS DE REMISE - PALIER 150 POINTS",
            "offerDiscountType": 0,
            "triggerOffer": 1,
            "triggerAccount": 1,
            "triggerLevelMin": 150,
            "triggerLevelMax": 399,
            "triggerDiscount": 150,
            "objApplication": "ARTICLE",
            "typeRestrictionOffer": 0
        }
    ]
}