Introducción
API

SFTP
En esta página

Para probar tu integración, necesitarás:
¿Cómo hago un pedido de prueba?
¿Cómo realizo las pruebas E2E?

Prueba la Integración#

Haz clic abajo para ir a los temas:

Para probar tu integración, necesitarás:#

  1. Contar con un usuario de pruebas

    Deberás compartirle a tu Account Manager un correo al que tengas acceso pero no exista en PedidosYa. Con este correo se creará un usuario de pruebas para que puedas ver tu tienda de pruebas desde la aplicación móvil de PedidosYa.

  2. Contar con una tienda de pruebas

    Tu Account Manager deberá probarte el ID, nombre y dirección de tu tienda de pruebas.

  3. Contar con acceso a la tienda de pruebas desde Partner Portal y Pelican

    Tu Account Manager deberá asegurarse de que tengas acceso a la tienda de pruebas en Partner Portal y Pelican. En Partner Portal deberás configurar el webhook y obtener el token.

  4. Validar tu integración

    Debes probar las distintas funcionalidades que desarrolles en tu tienda de pruebas.

¿Cómo hago un pedido de prueba?#

Ingresando a la app móvil de PedidosYa con tu usuario de pruebas, deberás buscar la tienda de pruebas en la dirección compartida por tu Acount Manager. Una vez que encuentres la tienda, podrás hacer pedidos desde la app como si fueras un usuario real.

Luego de hacer el pedido en la app, lo recibirás en Pelican (si ya ingresaste con tu usuario a la app de Pelican) donde deberás gestionarlo. Una vez que en Pelican indiques que el pedido está listo para ser retirado (READY FOR PICKUP), recibirás el payload en el webhook que hayas configurado.

¿Cómo realizo las pruebas E2E?#

Para asegurar que tu integración esté funcionando, es importante que pases por los casos de prueba de extremo a extremo. Verás los casos de uso listados abajo:

  1. Realizar un pedido en la aplicación de la plataforma, cumplir el pedido completamente en Pelican

    1. El Webhook debe recibir el evento READY_FOR_PICKUP

    2. Verificar el estado a nivel de los artículos como IN_CART

  2. Realizar un pedido en la plataforma con al menos 3 productos (de uno de ellos solicita al menos 2 unidades), cumplir el pedido parcialmente en Pelican (al producto que fue solicitado en más de 1 unidad, disminúyele la cantidad pickeada, marca un producto como NOT_FOUND y no lo reemplaces y modifica el precio del tercer producto)

    1. El Webhook debe recibir el evento READY_FOR_PICKUP

    2. Verificar el estado a nivel de los artículos como IN_CART & NOT_FOUND(y revisa la cantidad final pickeada y el precio final de los artículos IN_CART)

  3. Reemplazar los artículos no encontrados (out-of-stock OOS) con un artículo sugerido y cumplir el pedido desde Pelican

    1. El Webhook debe recibir el evento READY_FOR_PICKUP

    2. Verificar el estado a nivel de los artículos como IN_CART & REPLACED

    3. Tanto el artículo OOS como el nuevo artículo sugerido se envían al webhook con el estado REPLACED & IN_CART.

  4. Realizar un pedido en la plataforma con un producto pesable (en el caso de que vendas productos de este tipo en tus tiendas), un producto con una promoción de precio final y otro producto con una promoción del tipo NxM. Modifica el precio de uno de los productos en promoción y ajusta el peso del producto pesable:

    1. El Webhook debe recibir el evento READY_FOR_PICKUP

    2. Verificar el estado a nivel de los artículos como IN_CART y la información de promociones recibida. Ten en cuenta que el arreglo de promociones que se muestra es estático y corresponde a los productos que se arreglaron al carrito (no considera las modificaciones que se realizan en Pelican). Valida el campo quantity para el producto pesable.

  5. Cancelación: Al cabo de unos minutos de realizados los pedidos, recibirás el payload con la cancelación en el webhook. Cancelación de pedidos por parte del cliente, logística y vendor.

Cancelación por parte del cliente después de realizar el pedido:

  1. El pedido se realiza en la aplicación

  2. El Picker recibió el pedido

  3. El cliente canceló el pedido

  4. Tu webhook debería recibir el estado CANCELLED

Cancelación por parte del cliente después del cumplimiento del pedido:

  1. El pedido se realiza en la aplicación

  2. El Picker recibió el pedido y cumplió el pedido

  3. Tu webhook debería recibir el estado READY_FOR_PICKUP

  4. El cliente canceló el pedido

  5. Tu webhook debería recibir el estado CANCELLED

  6. En el payload del pedido de cancelación recibirás un campo adicional post_pickup_flag: true que significa que la cancelación ocurrió después de la recogida del repartidor. (consulta este FAQ)

Cancelación logística después del cumplimiento del pedido:

  1. El pedido se realiza en la aplicación

  2. El Picker recibió el pedido y cumplió el pedido

  3. Tu webhook debería recibir el estado READY_FOR_PICKUP

  4. Los Riders cancelaron el pedido debido a algunos problemas

  5. Tu webhook debería recibir el estado CANCELLED

  6. En la carga útil del pedido de cancelación recibirás un campo adicional post_pickup_flag: true que significa que la cancelación ocurrió después de la recogida del repartidor. (consulta este FAQ)

Cancelación del Vendor después del cumplimiento del pedido:

  1. El pedido se realiza en la aplicación

  2. El Picker recibió el pedido

  3. El Vendor puede CANCELLED el pedido debido a la falta de disponibilidad del artículo o a que la tienda está ocupada

  4. Tu webhook debería recibir el estado CANCELLED

  5. Durante el cumplimiento si el cliente cancela el pedido, el evento CANCELLED se envía al webhook

  6. Verificar el payload del pedido en el webhook para el evento CANCELLED

  7. Verificar el estado a nivel del artículo NOT_PROCESSED o NOT_FOUND

Prueba de endpoints:

  1. GET /vendor_id/orders: Establecer el marco de tiempo y obtener la lista de pedidos a nivel de tienda, tendrán estados de pedido finales como CANCELLED o PICKED_UP

  2. GET /order_id: Recupera el pedido en un id específico, tendrá estados de pedido finales como CANCELLED o PICKED_UP

Si todas las actualizaciones se procesan correctamente sin errores, la integración está lista para ser lanzada. Puedes agendar aquí una reunión con nuestro equipo de Soporte de Integraciones para homologar tu integración.


APICasos de uso - Endpoints explicadosAPIResolución de problemas