Casos de uso - Endpoints explicados#

La API de Partner/Órdenes (Pelican Picking) tiene una variedad de funcionalidades diseñadas para asegurar que tu proceso de gestión de órdenes sea lo más fluido posible. Ve una lista de los casos de uso a continuación:

Recuperar información de la orden en:

Recuperar detalles de una orden individual#

Propósito:
Si deseas verificar el estado de una orden individual usando el endpoint GET /order_id

Cómo funciona:
El endpoint GET Order ID te permite recuperar los detalles de una orden específica desde nuestro Servicio de Transmisión de Órdenes.

El Order ID debe estar en formato UUID (ej. 807c225f-ac6d-445d-a074-ea960c892ca7).
Consulta el campo order_id en el payload de la orden.
Solo se puede acceder a las órdenes de los últimos 60 días a través de este endpoint.

Note

Es probable que recibas el estado final del pedido como PICKED_UP o CANCELLED. Para fines de conciliación, puedes confiar en el estado PICKED_UP para confirmar los pedidos completados.
Si el tipo uuid de orderID no está disponible para recuperar pedidos, utiliza el endpoint GET vendorID (/vendors/{vendor_id}).

Solicitud:

curl --location  --request GET 'https://pedidosya.partner.deliveryhero.io/v2/orders/807c225f-ac6d-445d-a074-ea960c892ca7' \
--header 'Accept: application/json' \
--header 'Authorization: ***

Respuesta: HTTP 200 con objeto de orden

Recuperar detalles de múltiples órdenes#

Propósito:
Si tu webhook no está disponible temporalmente y necesitas recuperar el historial de órdenes de una tienda específica.

Cómo funciona:
El endpoint Vendor ID te permite especificar un rango de fechas para recuperar las órdenes de la tienda. Solo se puede acceder a las órdenes de los últimos 60 días.

Parámetros de solicitud GET permitidos:

start_time – La fecha y hora de inicio deben estar en UTC (ej., 2024-09-11T10:40:00).
end_time – La fecha y hora de finalización deben estar en UTC (ej., 2024-08-12T12:40:00, rango máximo de 60 días).
page_size – Número de órdenes por página (por defecto: 20).
page – Número de página de resultados (por defecto: 1).

Note

VendorID se refiere al identificador de la tienda por defecto \\\`store_id\\\` el campo del payload debe ser utilizado como vendorID. Si un Partner tiene configuraciones internas de la tienda, \\\`external_partner_config_id\\\` debe ser utilizado en el endpoint como vendorID.

Solicitud:

curl --location 'https://pedidosya.partner.deliveryhero.io/v2/chains/{chain_id}/vendors/7253942?start_time=2024-09-11T10%3A40%3A00&end_time=2024-09-12T12%3A40%3A00&page_size=&page=' \
--header 'Content-Type: application/json' \
--header 'Authorization: ***' \
--data ''

Respuesta: 200 con objeto de array de órdenes

A continuación se encuentran los Códigos de error observados al integrarse con los endpoints GET:

400 bad request se observa cuando el cuerpo de la solicitud no es válido
401 Unauthorised se observa cuando el token no es válido
404 Not found se observa cuando la orden no está disponible en nuestra BD

API≪ Cómo integrarte APIPrueba la Integración ≫