# Consumo de cupón

Este servicio permite consultar el información sobre el consumo de un cupón.

| Método | URL                      |
| ------ | ------------------------ |
| `GET`  | `https://{ApiURL}/cupon` |

## Request

| Clave              | Tipo        | Descripción                  |
| ------------------ | ----------- | ---------------------------- |
| **`email`**        | String(255) | Email del usuario.           |
| **`codigocupon*`** | String(128) | Código del cupón a consumir. |

{% hint style="info" %}
El código de cupón debe empezar siempre con la misma sintaxis de 3 o 4 dígitos para
\
reconocerlo. En el ejemplo PRExxxxx
{% endhint %}

### Ejemplo

<pre class="language-json"><code class="lang-json">{
<strong> "email":"test@fenicio.io",
</strong> "codigocupon":"PRE123456";
}
</code></pre>

## Response

| Clave                                                                                                         | Tipo                                                                                              | Descripción                                                                                                                                                     |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`codigocupon*`**                                                                                            | String(128)                                                                                       | Código del cupón.                                                                                                                                               |
| **`tipodescuento*`**                                                                                          | String(32)                                                                                        | <p>Tipo de descuento (montofijo</p><p>o porcentaje).</p>                                                                                                        |
| **`valordescuento*`**                                                                                         | Numeric                                                                                           | <p>Valor del descuento                                                                                                                                          |
| <br>(porcentaje o monto de                                                                                    |                                                                                                   |                                                                                                                                                                 |
| <br>descuento).</p>                                                                                           |                                                                                                   |                                                                                                                                                                 |
| **`monedadescuento`**                                                                                         | String(4)                                                                                         | Moneda del descuento M1 \| M2. Ej.: UYU \| USD.                                                                                                                 |
| **`montominimo`**                                                                                             | Numeric                                                                                           | Monto mínimo para aplicar el cupón.                                                                                                                             |
| **`grupos`**                                                                                                  | String(128)                                                                                       | Número del grupo de productos a asociar al cupón, el mismo se encuentra en la URL. Ej.: "URL: <https://tutienda.com.uy/catalogo?grp=54>, número a ingresar 54". |
| **`descripcion*`**                                                                                            | String(32)                                                                                        | Breve descripción del cupón, condiciones, etc. Es visible al cliente en el checkout, luego de ingresarse el cupón.                                              |
| **`validodesde`**                                                                                             | [**DateTime**](https://guia.fenicio.help/developers/referencia/tipos-de-valores#datetime) \| null | <p>Fecha y hora desde la cuál comenzará a ser válido el cupón descuento. Si no se indica, el descuento será válido a partir del momento                         |
| <br>de su creación o de su                                                                                    |                                                                                                   |                                                                                                                                                                 |
| <br>activación manual.</p>                                                                                    |                                                                                                   |                                                                                                                                                                 |
| **`validohasta`**                                                                                             | [**DateTime**](https://guia.fenicio.help/developers/referencia/tipos-de-valores#datetime) \| null | <p>Fecha y hora hasta la cuál                                                                                                                                   |
| <br>será válido el cupón. Si no se indica, continuará válido hasta su eliminación o desactivación manual.</p> |                                                                                                   |                                                                                                                                                                 |
| **`enviogratis*`**                                                                                            | bool                                                                                              | TRUE / FALSE&#xD; (Aplica envío gratis).                                                                                                                        |
| **`acumuladescproducto*`**                                                                                    | bool                                                                                              | TRUE / FALSE&#xD; (Si el cupón es de monto fijo obligatorio en TRUE).                                                                                           |
| **`acumuladmp*`**                                                                                             | bool                                                                                              | TRUE / FALSE&#xD; (Si el cupón es de monto fijo obligatorio en TRUE).                                                                                           |

### Caso de exitoso

<pre class="language-json"><code class="lang-json">{
 "status": "OK",
<strong> "mensaje": "Cupón procesado con éxito",
</strong> "data": {
  "codigocupon": "PRE123456",
<strong>  "tipodescuento": "montofijo",
</strong>  "valordescuento": "1000",
  "monedadescuento": "M1",
  "montominimo": "500",
  "grupos": "54,32",
  "descripcion": "Cupón de descuento",
  "validodesde": "2024-10-28 00:00:00",
  "validohasta": "2024-10-28 23:59:00",
  "enviogratis": true,
  "acumuladescproducto": true,
  "acumuladmp": true
<strong>  }
</strong><strong> }
</strong></code></pre>

### Caso de error

```json
{
 "status": "ERROR",
 "mensaje": "Error al obtener el cupón",
 "data": null
}
```