# Lire une promotion par code promo

Récupère des informations sur une promotion par code promo spécifique.

Endpoint: GET /v3/project/{project_id}/admin/promocode/{external_id}
Version: 2.0.0
Security: basicAuth

## Path parameters:

  - `project_id` (integer, required)
    ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
    Example: 44056

  - `external_id` (integer, required)
    External ID de la promotion. Identifiant unique de la promotion au sein du projet.
    Example: "coupon_44056_1"

## Response 200 fields (application/json):

  - `attribute_conditions` (array)
    Conditions de validation des attributs utilisateur.
Déterminez la disponibilité de la promotion selon la correspondance des attributs utilisateur avec l'ensemble des conditions définies.

  - `bonus` (array,null)

  - `bonus.quantity` (number)
    Quantité de l'objet.

  - `bonus.sku` (string)
    UGS de l'objet.

  - `discount` (object,null)
    Example: {"discount":{"percent":"10.99"}}

  - `discount.percent` (string,null)
    Pourcentage de la remise.
Le prix du panier sera réduit d'une valeur calculée à l'aide de ce pourcentage et arrondie à 2 décimales.
    Example: "10.00"

  - `discounted_items` (array,null)
    Liste des objets bénéficiant d'une remise grâce à un code promo.

  - `excluded_promotions` (array)
    Liste des ID de promotion à exclure lors de l'application de cette promotion. Example: [12, 789]
    Example: [12,789]

  - `external_id` (string)
    ID unique de la promotion. Le external_id ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas.
    Example: "coupon_external_id"

  - `is_enabled` (boolean)

  - `item_price_conditions` (array,null)
    Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion à certains biens du panier.
Le prix de chaque bien du panier de l'utilisateur est comparé à la fourchette de prix spécifiée dans la condition. Les [bonus](/fr/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request) et les [réductions](/fr/api/shop-builder/operation/create-promo-code/#!path=discount&t=request) ne s'appliquent qu'aux biens du panier dont le prix répond à la condition.
Si vous passez ce tableau, définissez la valeur du tableau [discounted_items](/fr/api/shop-builder/operation/create-promo-code/#!path=discounted_items&t=request) sur null.

  - `item_price_conditions.operator` (string, required)
    Opérateur de comparaison pour définir la fourchette de prix pour l'application de la promotion.
    Enum: "ge", "gt", "le", "lt", "eq", "ne"

  - `item_price_conditions.value` (string, required)
    Valeur permettant de déterminer la fourchette de prix pour l'application de la promotion.

  - `name` (object)
    Nom de la promotion. Doit comprendre des paires clé/valeur
où la clé est une région au format "^[a-z]{2}-[A-Z]{2}$", la valeur est une chaîne.
    Example: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

  - `price_conditions` (array,null)
    Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion à l'ensemble du panier.
Le prix total de tous les biens du panier de l'utilisateur est comparé à la fourchette de prix spécifiée dans la condition. Les [bonus](/fr/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request) et les [réductions](/fr/api/shop-builder/operation/create-promo-code/#!path=discount&t=request) s'appliquent à tous les biens du panier si le prix du panier répond à la condition spécifiée.
Si vous passez ce tableau, définissez la valeur du tableau [discounted_items](/fr/api/shop-builder/operation/create-promo-code/#!path=discounted_items&t=request) sur null.

  - `promotion_periods` (array)
    Périodes de validité de la promotion. Si plusieurs périodes sont spécifiées, les paramètres date_from et date_until sont tous deux requis.

  - `promotion_periods.date_from` (string, required)
    Date de début de la promotion spécifiée.
    Example: "2020-08-11T10:00:00+03:00"

  - `promotion_periods.date_until` (string,null)
    Date de fin de la promotion. Si la valeur est null, la promotion est illimitée. null n'est autorisé que si une seule période de validité est définie.
    Example: "2020-08-11T20:00:00+03:00"

  - `redeem_code_limit` (integer,null)
    Nombre d'échanges par code.
    Example: 10

  - `redeem_total_limit` (integer,null)
    Limite le nombre total de coupons.
    Example: 10

  - `redeem_user_limit` (integer,null)
    Limite le nombre total de coupons pouvant être échangés par un seul utilisateur.
    Example: 10

  - `total_limit_state` (object,null)
    Limites pour chaque code promo unique.

  - `total_limit_state.available` (integer)
    Nombre restant de fois qu'un code promo peut être utilisé.
    Example: 3

  - `total_limit_state.reserved` (integer)
    Numéro réservé d'un code promo.
    Example: 3

  - `total_limit_state.used` (integer)
    Nombre de fois qu'un code promo est utilisé.
    Example: 5

## Response 401 fields (application/json):

  - `errorCode` (integer)
    Example: 1020

  - `errorMessage` (string)
    Example: "[0401-1020]: Error in Authentication method occurred"

  - `statusCode` (integer)
    Example: 401

## Response 404 fields (application/json):

  - `errorCode` (integer)
    Example: 4001

  - `errorMessage` (string)
    Example: "[0401-9802]: Promocode not found"

  - `statusCode` (integer)
    Example: 404

  - `transactionId` (string)
    Example: "x-x-x-x-transactionId-mock-x-x-x"