Offers

L'objet Offer représente une offre d'assurance pour un produit spécifique. Il contient des informations sur le contrat, la durée, le prix, la catégorie et les données marketing associées.

ENDPOINTS

  • GET api/v2/store/{store_id}/offers — Récupère une liste d'offres en fonction des paramètres de requête optionnels suivants :
    • category_id — Filtrer les offres par nom de catégorie
    • product_price — Récupérer les offres pour un prix de produit spécifique, dont le product_price est inclus entre price_band_min et price_band_max
    • product_reference_id — Récupérer les offres correspondant à un produit spécifique lorsque la synchronisation du catalogue produit est effectuée.
    • includes — Récupérer les attributs de la category (marketing_data, legal_document_url).

Exemple d'utilisation

  1. Récupérer une liste d'offres pour la catégorie "smartphone" :
GET api/v2/store/{store_id}/offers?category_id=smartphone
  1. Récupérer une liste d'offres pour un produit de la catégorie "smartphone" à 2299,99 €
GET api/v2/store/{store_id}/offers?category_id=smartphone&product_price=2299.99
  1. Récupérer une liste d'offres pour un produit dont la référence est "320813" synchronisé avec Estaly.
GET api/v2/store/{store_id}/offers?product_reference_id=320813


L'objet Offer

Attributs

  • reference_id (string) : L'identifiant unique de l'offre. Cet identifiant est communiqué à Estaly lors de la création des offres dans votre CMS.
  • contract_id (string) : L'identifiant unique du contrat associé à l'offre.
  • term_length (string) : La durée de l'offre.
  • price (integer) : Le prix de l'offre en centimes d'euro.
  • currency_code (string) : Le code de devise de l'offre.
  • price_band_min (integer) : Le prix minimum du produit pour lequel l'offre s'applique.
  • price_band_max (integer) : Le prix maximum du produit pour lequel l'offre s'applique.
  • billing (string) : monthly ou annually
  • title (string) : Le titre de l'offre.
  • category_id (string) : Le nom de la catégorie associée à l'offre.
  • category (object) : L'objet Category associé à l'offre.

Exemple de l'objet Offer

{
  "reference_id": "1051",
  "contract_id": "CO36BI250NTA",
  "term_length": "3 ans",
  "price": 12900,
  "currency_code": "EUR",
  "price_band_min": 00,
  "price_band_max": 50000,
  "billing": "annually",
  "title": "Assurance smartphone Casse/Vol - 3 ans",
  "category_id": "smartphone",
  "category": {
    "id": "smartphone",
    "marketing_data": {
      "buttons": {
        "link_text": "En savoir plus",
        "headline": "Protégez votre smartphone contre la casse et le vol"
      },
      "modal": {
        "headline": "Protégez votre smartphone contre la casse et le vol avec Estaly",
        "coverage_bullets_heading": "Cette protection comprend :",
        "bullet_points": [
          "Couverture contre le vol total, le vol des accessoires et la casse accidentelle",
          "Indemnisation au prix d'achat du smartphone pendant 2 ans, sans décôte",
          "Franchise minimale : 0€ pour la casse, 5% du prix du smartphone pour le vol",
          "1, 2 ou 3 ans de protection, vous choisissez"
        ],
        "link_text": "Voir le détail des garanties",
        "buy_text": "Ajouter une protection",
        "decline_text": "Je ne veux pas protéger mon smartphone",
        "legal_text": "Protection proposée par Estaly",
        "image": "https://estaly-image-smartphone.png",
        "merchant_logo": "https://merchant_logo.png",
        "marketing_page_url": "https://smartphones.estaly.co"
      },
      "cart": {
        "simple_offer_button_text": "Protégez votre smartphone pour"
      },
    },
    "legal_documents":{
    	"cg_url": "https://smartphones-cg-estaly.pdf",
    	"ipid_url" :"https://smartphones-ipid-estaly.pdf"
    }
  }
}

Dans cet exemple, l'offre correspond à un contrat d'assurance d'une durée de 3 ans pour la catégorie "smartphone".

Le prix de l'offre d'assurance est de 129 €.

Cet offre est valable pour les produits entre 0 € et 500 €.