Casos de uso - Endpoints Explicados#

La integración Partner API/Catálogo tiene una variedad de funcionalidades diseñadas para asegurar que tu gestión de catálogo sea lo más fluida posible. Consulta la lista de casos de uso a continuación:

• Actualizar productos individuales o masivos vía PUT

• Recuperar una lista de productos disponibles vía GET

• Averiguar tus categorías de productos vía GET

• Exportar una instantánea de tu catálogo vía POST

Actualizar productos individuales o masivos#

Ver Especificaciones del API

Con el endpoint PUT /catalog, puedes actualizar los atributos del producto, como el precio y la disponibilidad. sku, barcode, quantity, price, active & maximum_sales_quantity.

El endpoint se puede utilizar de dos maneras:

1. Actualizaciones de un solo producto (O)

2. Actualizaciones masivas de productos. Si un partner configura un webhook (recomendado).

   • Es un proceso asíncrono y el estado de las actualizaciones de SKU se envía al webhook

   • Es posible actualizar todo el surtido por tienda usando el endpoint

Actualización de un solo producto#

Solicitud:

curl --location --globoff --request PUT 'https://pedidosya.partner.deliveryhero.io/v2/chains/{chain_id}/vendors/{vendor_id}/catalog' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
  "products": [
    {
      "sku": "LS-33",
      "active": false,
      "price": 10
    }  ]
}'

Respuesta: 200 puedes encontrar la estructura de la respuesta aquí

{
      "sku": "3671"
}

Actualizaciones masivas de productos#

Solicitud:

curl --location --globoff --request PUT 'https://pedidosya.partner.deliveryhero.io/v2/chains/{chain_id}/vendors/{vendor_id}/catalog' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
  "products": [
    {
      "sku": "LS-33",
      "active": false,
      "price": 10
    },
    {
      "sku": "LS-22",
      "active": true
    },
    {
      "sku": "LS-24",
      "price": 369
    } ]
}'

Respuesta: 202 se crea un trabajo asíncrono en nuestro catálogo y puedes encontrar la estructura de la respuesta aquí

{
"job_id": "a946a2c7-f4e7-46ac-ae63-8a59",
"job_status": "QUEUED"
}

Recuperar una lista de productos disponibles#

Ver Especificaciones del API

Con el endpoint GET /catalog, puedes recuperar la información de los productos listados, como el título, las imágenes, el estado, el precio y la categoría de cada tienda en un formato paginado. Puedes utilizar esta función para buscar en tu selección de productos.

El endpoint puede admitir los siguientes parámetros de consulta:

• query_term, busca productos por nombre o SKU

• category_global_ids, filtra por categorías específicas

• locale, refina los resultados por locale, por ejemplo, en_GB

• is_active, filtra por productos activos. Si no se proporciona este parámetro, se recuperan todos los productos.

• page_size, controla el número de resultados por página

• page, navega por las páginas

Solicitud:

curl --location --requets GET 'https://pedidosya.partners.deliveryhero.io/v2/chains/{chain_id}/vendors/{vendor_id}/catalog?query_term=milk&locale=en_GB&page=10&page_size=10' \
--header 'Authorization: Bearer test'

Respuesta: 200 puedes encontrar el ejemplo de respuesta aquí

Averiguar tus categorías de productos#

Ver Especificaciones del API

Usando el endpoint GET /categories, puedes recuperar las categorías listadas para cada tienda. Este endpoint te permite acceder rápidamente a la estructura de categorías asociada a un vendor específico.

Solicitud:

curl --location --request GET 'https://pedidosya.partner.deliveryhero.io/v2/chains/{chain_id}/vendors/{vendor_id}/categories' \
--header 'Authorization: Bearer test'

Respuesta: 200 puedes encontrar los detalles de la respuesta aquí

Exportar una instantánea de tu catálogo#

Ver Especificaciones del API

Usando el endpoint POST /export, puedes descargar y verificar los datos de todo el catálogo de la tienda. Este endpoint inicia un trabajo de exportación asíncrono para recuperar información detallada del producto. Una vez que la exportación se completa, los datos se enviarán al webhook configurado en tu Partner Portal.

Solicitud:

curl --location --globoff --request POST 'https://pedidosya.partner.deliveryhero.io/v2/chains/{chain_id}/vendors/{vendor_id}/catalog/export'

Respuesta: 200 encontrarás más detalles sobre la estructura de la respuesta aquí