DOCS

Update order status

/

Actualizar estado del pedido

Aprenda cómo funciona el punto final para actualizar el estado del pedido.

El punto final updateVendorOrderStatus se utiliza para actualizar el estado del pedido de un pedido dentro del Sistema Zonos. Esto se utilizará para actualizar programáticamente el estado de envío del pedido o para solicitar una cancelación.

Valores actuales de estado del pedido 

A continuación se muestra una lista actual de los estados de pedido que un pedido puede tener.

Precaución - Zonos puede agregar más estados en cualquier momento; su sistema debe poder manejar la presencia de estados adicionales.

Los estados en producción permanecerán en producción. Zonos nunca eliminará estados existentes.

EstadoDescripciónEstablecido por
IGLOBAL_FRAUD_REVIEWEl pedido está actualmente bajo revisión de fraude por iGlobal.Zonos
IGLOBAL_ORDER_IN_PROCESSEl pedido es válido y está listo para ser procesado.Zonos
IGLOBAL_ORDER_ON_HOLDEl pedido está actualmente en espera de estado temporal.Zonos
IGLOBAL_ORDER_CANCELLEDEl pedido ha sido cancelado en el Sistema iGlobal.Zonos
VENDOR_PREPARING_ORDEREl proveedor ha marcado el pedido en preparación.Proveedor
VENDOR_SHIPMENT_READYEl proveedor ha marcado el pedido como listo para envío.Proveedor
VENDOR_LABELS_PRINTED_DATEEl proveedor ha impreso etiquetas de envío.Proveedor
VENDOR_CANCELLATION_REQUESTSe ha solicitado la cancelación del pedido.Proveedor
VENDOR_END_OF_DAY_COMPLETEEl pedido está finalizado y completo.Proveedor

vendorOrderStatus no se puede actualizar por el proveedor mientras el pedido se encuentre en uno de los siguientes estados de pedido:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

Solicitud HTTPS

POST | https://api.iglobalstores.com/v1/updateVendorOrderStatus

CampoValor
Método HTTPPOST
URL del punto finalhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ProtocoloHTTPS
Formato del mensajeJSON
Encabezado HTTP de aceptaciónAccept: application/json
Encabezado HTTP de tipo de contenidoContent-Type: application/json

Pares clave/valor JSON en el cuerpo de la solicitud

Formato del mensaje: JSON

EJEMPLO

1
2
3
4
5
6
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-9999",
  "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
}

Definiciones de JSON de solicitud

CampoNotas
orderId REQUERIDOEl ID de pedido de Zonos puede pasarse con o sin el ID de su tienda y guion (Ejemplo: 123-45678 o 45678). Después de la finalización del pedido y el pago, el cliente será redirigido a una página de finalización de pedido / página de agradecimiento de pedido alojada en su dominio. La URL contendrá un parámetro de cadena de consulta orderID que contendrá este valor.integer / string
orderStatus REQUERIDOEste campo se utiliza para actualizar el sistema de Zonos con el nuevo estado de un pedido. Los siguientes estados de pedido se pueden establecer a través de esta API.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``string | | secret REQUERIDO | GUID secreto de API proporcionado por Zonos.string | | store REQUERIDO | ID de tienda proporcionado por Zonosinteger |

Respuesta HTTPS

Formato del mensaje: JSON

Example success response

1
2
3
{
  "success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
}

Respuesta de error de ejemplo

1
2
3
{
  "error": "OrderId: 99999 cannot be moved to order status: VENDOR_PREPARING_ORDER while in status: IGLOBAL_FRAUD_REVIEW"
}

Respuestas de error HTTP

Códigos de respuesta HTTPEjemplo/Descripción del cuerpo de la respuesta
406 - No aceptableEntidad HTML. La cabecera HTTP "Accept" no es válida.
415 - Tipo de medio no soportadoEntidad HTML. La cabecera HTTP "Content-Type" no es válida.
200"error": "no se pudo analizar la entrada"
200"error": "Se requiere el parámetro orderId para updateVendorOrderStatus"
200"error": "Se requiere el parámetro orderStatus para updateVendorOrderStatus."
200"error": "orderId: 999-99999 no es un orderId válido"
200"error": "No se pudo recuperar la orden para updateVendorOrderStatus a partir del orderId: 999-99999"
200"error": "OrderId: 999-99999 ya ha sido cancelado y no se puede actualizar el estado."
200"error": "No se puede actualizar el estado de la orden a estado: VENDOR_CANCELLATION_REQUEST"
200"error": "No se puede actualizar el estado de la orden a un estado inválido: NEW_ORDER_STATUS"
200"error": "OrderId: 999-99999 ya tiene el estado actual: VENDOR_SHIPMENT_READY"
200"error": "OrderId: 999-99999 no se puede mover al estado de la orden: VENDOR_CANCELLATION_REQUEST mientras esté en el estado: VENDOR_END_OF_DAY_COMPLETE"
200"error": "Nuevo estado: NEW_ORDER_STATUS no es un estado de orden válido"
200"error": "No se pudo procesar updateVendorOrderStatus."
200"error": "Credenciales de seguridad inválidas"

Definiciones JSON de respuesta

MensajeDefinición
successEste parámetro contendrá un resumen de la actualización. string
errorEste parámetro solo estará presente en la respuesta cuando se haya producido un error y contendrá una descripción de la causa. string

¿Fue útil esta página?