Endpoints
Números de pedido
Recupera una lista de números de pedido.
Detalles del pedido
Recupera información detallada de un pedido.
Uso del endpoint Retrieve an Order de la API
Hay dos formas comunes de usar estos endpoints.
- (Parte 1 + Parte 2) – Utilice una página de confirmación / éxito de pedido personalizada en su dominio para activar su sistema y llamar al endpoint
orderDetaile importar un pedido completado. Además, llame regularmente al endpointorderNumberspara conciliar cualquier pedido en el sistema Zonos que no haya sido importado en su sistema. - (Solo Parte 2) – Utilice la página básica de confirmación / éxito de pedido de Zonos o una página estática en su dominio para indicar al cliente la finalización del pedido. Programe su sistema para llamar regularmente al endpoint
orderNumberspara determinar cuándo un nuevo pedido está listo para importarse en su sistema. Cuando se encuentre un pedido pendiente, llame al endpointorderDetailpara obtener los datos de esos pedidos.
Parte 1: Página de éxito en su dominio
Cada vez que un comprador completa un pedido en Zonos Checkout, se le redirige inmediatamente a una URL de página de éxito del pedido. El ID del pedido completado se agregará a la URL de redirección como una cadena de consulta. La URL de la página de éxito del pedido debe proporcionarse a Zonos. La URL también puede pasarse como parámetro en el endpoint createTempCart al crear el carrito temporal en el sistema Zonos.
Ejemplo: http://www.examplestore.com/internationalThankYou?orderId=999-99999
Cuando un cliente es redirigido a esta página, su sistema deberá analizar el valor de orderId de la URL. Luego utilizará el orderId para llamar al endpoint orderDetail y recuperar los datos del pedido.
Parte 2: Utilizar un trabajo programado
Además de solicitar los detalles del pedido cuando se activa la página de éxito, le recomendamos configurar una llamada programada para todos los pedidos y sus detalles como red de seguridad. De esta manera, puede recuperar cualquier pedido completado en el sistema Zonos que aún no haya sido importado en su sistema.
Este proceso debe ser un trabajo/script programado, como un trabajo Cron, ejecutado una vez por hora/turno/día/etc. (programe con la frecuencia que sus procesos comerciales consideren necesaria). El script debe solicitar todos los pedidos y sus detalles que hayan ocurrido desde la última llamada de pedidos. El endpoint orderNumbers le permite recuperar pedidos sinceOrderId o sinceDate como se demuestra en la GUI de prueba de API ubicada aquí. Todos los pedidos recuperados a través de esta llamada programada deben conciliarse con los pedidos insertados en su sistema cada vez que se activó la página de éxito. Cualquier pedido que aún no esté en su sistema debe insertarse en su sistema y tratarse como pedidos legítimos.
Estado inicial del pedido
IGLOBAL_ORDER_IN_PROCESS o IGLOBAL_FRAUD_REVIEW
Al llamar al endpoint orderDetail, recomendamos que su sistema verifique primero la propiedad orderStatus de los datos del pedido.
Los pedidos que no requieren revisión de fraude se inicializarán con orderStatus : IGLOBAL_ORDER_IN_PROCESS. Un pedido en este estado está listo para procesarse y enviarse.
Los pedidos que sí requieren revisión de fraude se inicializarán en orderStatus : IGLOBAL_FRAUD_REVIEW. Un pedido en este estado está siendo examinado y revisado por fraude sospechoso. Recomendamos colocar este pedido en un estado de revisión o retención en su sistema y continuar llamando al endpoint orderDetail hasta que el pedido avance más allá del proceso de revisión de fraude de Zonos.
Una vez que se completa el proceso de detección de fraude de Zonos, el pedido pasará a uno de los siguientes estados:
-
El pedido pasa la detección de fraude
- El pedido pasará a
orderStatus:IGLOBAL_ORDER_IN_PROCESSy puede continuar hacia el envío.
- El pedido pasará a
-
El pedido no pasa la detección de fraude
- El pedido pasará a
orderStatus:IGLOBAL_ORDER_CANCELLEDy debe cancelarse en su sistema.
- El pedido pasará a
GUI de prueba de API
Comuníquese con soporte para obtener las credenciales de su cuenta.
Recuperar un pedido
Recupere una lista de números de pedido o información detallada sobre un pedido.
Este endpoint de la API "Retrieve an Order" se utiliza para recuperar datos de un pedido completado dentro del sistema Zonos. La respuesta contendrá un objeto JSON que representa toda la información disponible del pedido, incluidas las direcciones de facturación y envío, el método de envío, los totales del pedido y el estado.