Casos de uso - Endpoints explicados#

Partner API/Promociones tiene una variedad de funcionalidades diseñadas para asegurar un proceso fácil para crear y administrar tus promociones. Vea una lista de los casos de uso y cómo configurarlos a continuación:

• Administrar Promoción vía PUT

  • Crear promoción

  • Modificar promoción

  • Desactivar promoción

• Verificar el estado de tu Promoción vía GET

Administrar Promoción#

Verificar Especificaciones de la API

Usando el endpoint PUT /promotion, es fácil crear o actualizar promociones para impulsar las ventas del partner e involucrar a los clientes.

A través de este endpoint podrás:

1. Crear una Promoción

2. Modificar una Promoción

3. Desactivar una Promoción

1. Crear una promoción#

El endpoint PUT es usado para crear una promoción. Para hacer esto, necesitarás un token API que ya hayas generado en el Partner Portal y usar el siguiente curl como ejemplo:

Ejemplo de la solicitud:

curl --location --request PUT 'https://pedidosya.partner.deliveryhero.io/v2/chains/f9cc1b05-8610-4e14-b9f5-9dde917e143d/promotion' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data {
"vendors": [
    "s8ym"
  ],
  "type": "STRIKETHROUGH",
        "active": true,
  "reason": "COMPETITIVENESS",
  "display_name": {
    "en_AR": "Promotions"
  },
  "conditions": {
    "start_time": "2025-03-28T15:59:59.895Z",
    "end_time": "2025-03-30T16:59:59.895Z"
  },
  "discount": [
    {
      "discount_subtype": "FINAL_PRICE",
      "discount_value": 15.11,
      "active": true,
      "sku": [
        "ABCEx3"
            ]
        },
        {
      "discount_subtype": "FINAL_PRICE",
      "discount_value": 5.31,
      "active": true,
      "sku": [
        "D14"
            ]
        }
    ]
}

2. Modificar una promoción#

Si quieres modificar la promoción y remover el SKU existente de la promoción en curso, basado en el ejemplo anterior, la solicitud debería verse de la siguiente manera:

curl --location --request PUT 'https://pedidosya.partner.deliveryhero.io/v2/chains/f9cc1b05-8610-4e14-b9f5-9dde917e143d/promotion' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data{
"vendors": [
    "s8ym"
  ],
  "type": "STRIKETHROUGH",
        "active": true,
  "reason": "COMPETITIVENESS",
  "display_name": {
    "en_AR": "Promotions"
  },
  "conditions": {
    "start_time": "2025-03-28T15:59:59.895Z",
    "end_time": "2025-03-30T16:59:59.895Z"
  },
  "discount": [
        {
      "discount_subtype": "FINAL_PRICE",
      "discount_value": 5.31,
      "active": false,
      "sku": [
        "D14"
            ]
        }
    ]
}

En este caso hemos removido el SKU D14 de la promoción en curso. El SKU ABCEx3 permaneció en la promoción y en curso.

3. Desactivar una promoción#

Si quieres detener la promoción en curso, debes enviar otra solicitud con los mismos datos que durante la creación de la promoción y establecer el estado activo como falso en el nivel activo al principio de la solicitud.

curl --location --request PUT 'https://pedidosya.partner.deliveryhero.io/v2/chains/f9cc1b05-8610-4e14-b9f5-9dde917e143d/promotion' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data {
"vendors": [
    "s8ym"
  ],
  "type": "STRIKETHROUGH",
        "active": false,
  "reason": "COMPETITIVENESS",
  "display_name": {
    "en_AR": "Promotions"
  },
  "conditions": {
    "start_time": "2025-03-28T15:59:59.895Z",
    "end_time": "2025-03-30T16:59:59.895Z"
  },
  "discount": [
    {
      "discount_subtype": "FINAL_PRICE",
      "discount_value": 15.11,
      "active": true,
      "sku": [
        "ABCEx3"
            ]
        },
        {
      "discount_subtype": "FINAL_PRICE",
      "discount_value": 5.31,
      "active": true,
      "sku": [
        "D14"
            ]
        }
    ]
}

En los tres casos, la misma URL será utilizada como en el ejemplo anterior.

Verificar el estado de tu Promoción vía GET#

Verificar Especificaciones de la API

El endpoint GET proporciona el estado de la promoción que ha sido creada con el endpoint PUT junto con la información sobre el estado de las promociones.

El estado del trabajo puede tener tres valores:

• QUEUED si el trabajo aún no ha sido procesado

• COMPLETED el trabajo ha terminado exitosamente

• FAILED- el trabajo falló

Puedes ver los detalles de la promoción creada directamente en tu Partner Portal. El Plugin de Promociones de Tiendas mostrará:

1. Si tus Promociones fueron creadas

2. Cómo tu Promoción fue creada

3. Cuál es el estado de tus promociones (Cancelada, Finalizada, En curso, Próxima)

4. Fechas de inicio y fin de las promociones

5. Qué SKUs fueron incluidos en las promociones

6. Cuál es el nombre y la razón de tu promoción