getAvailableOffers

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

L'appel demande au minimum l'objet "IdentifierRequest", et renvoi alors toutes les offres disponibles dans le compte du client, qu'elle soit utilisable au moment de l'appel ou valable 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 utilisables à la date indiquée en paramètre.

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

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é.

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"
    },
    "EntityRequest": {
        "entityIdentifier": "666666"
    },
    "date": "26/09/2025 12:00:00",
    "filter": 0
}

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",
    "GetOffersResponses": [
        {
            "used": false,
            "startDate": "24/09/2025 11:20:00",
            "classifications": [
                {
                    "LabelResponse": "ROSIERS",
                    "CodeResponse": "19",
                    "LevelResponse": "1",
                    "LevelNameResponse": "RAYON"
                },
                {
                    "LabelResponse": "sellerie ",
                    "CodeResponse": "710801",
                    "LevelResponse": "3",
                    "LevelNameResponse": "SOUS FAMILLE"
                },
                {
                    "LabelResponse": "produits alimentaires ",
                    "CodeResponse": "5008",
                    "LevelResponse": "2",
                    "LevelNameResponse": "FAMILLE"
                }
            ],
            "offerNumber": "2558001057274",
            "immediateUse": 0,
            "offerId": "57384",
            "channelId": "8",
            "endDate": "23/11/2025 11:20:00",
            "sendDate": "24/09/2025 11:20:00",
            "globalMinPrice": 30.0,
            "offerName": "BIENVENUE_BA_CAISSE_2025",
            "offerDescription": "5€ de réduction dès 30€",
            "offerDiscountType": 1,
            "offerDiscountValue": 5.0,
            "triggerOffer": 0,
            "objApplication": "ARTICLE",
            "typeRestrictionOffer": 0
        }
    ]
}