DOCS

Actualizar estado del pedido

Actualizar estado del pedido

Descubra cómo funciona el endpoint para actualizar el estado del pedido.

El endpoint updateVendorOrderStatus se utiliza para actualizar el estado de un pedido dentro del sistema Zonos. Se utilizará para actualizar programáticamente el estado de envío del pedido o para solicitar una cancelación.

Valores actuales del estado del pedido 

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

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

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

EstadoDescripciónEstablecible 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 procesarse.Zonos
IGLOBAL_ORDER_ON_HOLDEl pedido está actualmente en una retención temporal de estado.Zonos
IGLOBAL_ORDER_CANCELLEDEl pedido ha sido cancelado en el sistema iGlobal.Zonos
VENDOR_PREPARING_ORDEREl proveedor ha marcado el pedido en preparación.Vendor
VENDOR_SHIPMENT_READYEl proveedor ha marcado el pedido listo para envío.Vendor
VENDOR_LABELS_PRINTED_DATEEl proveedor ha impreso las etiquetas de envío.Vendor
VENDOR_CANCELLATION_REQUESTSe ha solicitado la cancelación del pedido.Vendor
VENDOR_END_OF_DAY_COMPLETEEl pedido está finalizado y completo.Vendor

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

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 endpointhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ProtocoloHTTPS
Formato del mensajeJSON
Encabezado HTTP AcceptAccept: application/json
Encabezado HTTP Content-TypeContent-Type: application/json

Pares clave/valor JSON en el cuerpo de la solicitud

Formato del mensaje: JSON

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

Definiciones JSON de la solicitud

CampoNotas
orderId REQUERIDOEl ID de pedido de Zonos puede enviarse con o sin el ID de su tienda y el guion (Ejemplo: 123-45678 o 45678). Después de completar el pedido y el pago, el cliente será redirigido a una página de confirmación / agradecimiento 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 Zonos con el nuevo estado de un pedido. Los siguientes estados del pedido son configurables 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 la API proporcionado por Zonos.string | | store REQUERIDO | ID de tienda proporcionado por Zonosinteger |

Respuesta HTTPS

Formato del mensaje: JSON

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

Respuestas HTTP de error

Códigos de respuesta HTTPEjemplo/Descripción del cuerpo de respuesta
406 - Not AcceptableEntidad HTML. El encabezado HTTP "Accept" no es válido.
415 - Unsupported media typeEntidad HTML. El encabezado HTTP "Content-Type" no es válido.
200"error":"could not parse input"
200"error":"Parameter orderId required for updateVendorOrderStatus"
200"error":"Parameter orderStatus required for updateVendorOrderStatus."
200"error":"orderId: 999-99999 is not a valid orderId"
200"error":"Could not retrieve order to updateVendorOrderStatus from orderId: 999-99999"
200"error":"OrderId: 999-99999 has already been cancelled and status cannot be updated."
200"error":"Cannot update order status to status: VENDOR_CANCELLATION_REQUEST"
200"error":"Cannot update order status to invalid status: NEW_ORDER_STATUS"
200"error":"OrderId: 999-99999 already has current status: VENDOR_SHIPMENT_READY"
200"error":"OrderId: 999-99999 cannot be moved to order status: VENDOR_CANCELLATION_REQUEST while in status: VENDOR_END_OF_DAY_COMPLETE"
200"error":"New Status: NEW_ORDER_STATUS is not a valid order status"
200"error":"Could not process updateVendorOrderStatus."
200"error":"Invalid security credentials"

Definiciones JSON de la respuesta

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

¿Fue útil esta página?