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.
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
Campo↕
Notas↕
orderId REQUERIDO
El 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 REQUERIDO
Este 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 HTTP↕
Ejemplo/Descripción del cuerpo de respuesta↕
406 - Not Acceptable
Entidad HTML. El encabezado HTTP "Accept" no es válido.
415 - Unsupported media type
Entidad 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
Mensaje↕
Definición↕
success
Este parámetro contendrá un resumen de la actualización.string
error
Este parámetro solo estará presente en la respuesta cuando haya ocurrido un error y contendrá una descripción de la causa.string
Actualizar estado del pedido
Actualizar estado del pedido
Descubra cómo funciona el endpoint para actualizar el estado del pedido.
El endpoint
updateVendorOrderStatusse 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.
Solicitud HTTPS
POST |
https://api.iglobalstores.com/v1/updateVendorOrderStatushttps://api.iglobalstores.com/v1/updateVendorOrderStatusPares clave/valor JSON en el cuerpo de la solicitud
Formato del mensaje: JSON
{"store": "999","secret": "f5bde245-f55e-414d-b722-80b25161c12c","orderId": "999-9999","orderStatus": "VENDOR_END_OF_DAY_COMPLETE"}Definiciones JSON de la solicitud
orderIdREQUERIDOorderIDque contendrá este valor.integer / stringorderStatusREQUERIDOVENDOR_PREPARING_ORDERVENDOR_SHIPMENT_READYVENDOR_LABELS_PRINTEDVENDOR_END_OF_DAY_COMPLETEVENDOR_CANCELLATION_REQUEST``string| |secretREQUERIDO | GUID secreto de la API proporcionado por Zonos.string| |storeREQUERIDO | ID de tienda proporcionado por Zonosinteger|Respuesta HTTPS
Formato del mensaje: JSON
{"success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"}Respuestas HTTP de error
Definiciones JSON de la respuesta
successstringerrorstring¿Fue útil esta página?