Saiba como o endpoint para atualizar o status do pedido funciona.
O endpoint updateVendorOrderStatus é usado para atualizar o status de um pedido dentro do sistema da Zonos. Ele será usado para atualizar programaticamente o status de envio do pedido ou para solicitar um cancelamento.
O ID de pedido da Zonos pode ser enviado com ou sem o ID da sua loja e o hífen (Exemplo: 123-45678 ou 45678). Depois de concluir o pedido e o pagamento, o cliente será redirecionado para uma página de conclusão / agradecimento hospedada no seu domínio. A URL conterá um parâmetro de query string orderID com este valor.integer / string
orderStatus OBRIGATÓRIO
Este campo é usado para atualizar o sistema da Zonos com o novo status de um pedido. Os seguintes status de pedido podem ser definidos via esta API.- VENDOR_PREPARING_ORDER
VENDOR_SHIPMENT_READY
VENDOR_LABELS_PRINTED
VENDOR_END_OF_DAY_COMPLETE
VENDOR_CANCELLATION_REQUEST``string |
| secret OBRIGATÓRIO | GUID secreto da API fornecido pela Zonos.string |
| store OBRIGATÓRIO | ID da loja fornecido pela Zonosinteger |
Resposta HTTPS
Formato da mensagem: JSON
1{
2"success":"Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
3}
Respostas HTTP de erro
Códigos de resposta HTTP↕
Exemplo/Descrição do corpo da resposta↕
406 - Not Acceptable
Entidade HTML. O cabeçalho HTTP “Accept” é inválido.
415 - Unsupported media type
Entidade HTML. O cabeçalho HTTP “Content-Type” é invá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”
Definições JSON da resposta
Mensagem↕
Definição↕
success
Este parâmetro conterá um resumo da atualização.string
error
Este parâmetro só estará presente na resposta quando tiver ocorrido um erro e conterá uma descrição da causa.string
Atualizar status do pedido
Atualizar status do pedido
Saiba como o endpoint para atualizar o status do pedido funciona.
O endpoint
updateVendorOrderStatusé usado para atualizar o status de um pedido dentro do sistema da Zonos. Ele será usado para atualizar programaticamente o status de envio do pedido ou para solicitar um cancelamento.Valores atuais do status do pedido
Abaixo está uma lista atual dos status que um pedido pode ter.
Solicitação HTTPS
POST |
https://api.iglobalstores.com/v1/updateVendorOrderStatushttps://api.iglobalstores.com/v1/updateVendorOrderStatusPares chave/valor JSON no corpo da solicitação
Formato da mensagem: JSON
{"store": "999","secret": "f5bde245-f55e-414d-b722-80b25161c12c","orderId": "999-9999","orderStatus": "VENDOR_END_OF_DAY_COMPLETE"}Definições JSON da solicitação
orderIdOBRIGATÓRIOorderIDcom este valor.integer / stringorderStatusOBRIGATÓRIOVENDOR_PREPARING_ORDERVENDOR_SHIPMENT_READYVENDOR_LABELS_PRINTEDVENDOR_END_OF_DAY_COMPLETEVENDOR_CANCELLATION_REQUEST``string| |secretOBRIGATÓRIO | GUID secreto da API fornecido pela Zonos.string| |storeOBRIGATÓRIO | ID da loja fornecido pela Zonosinteger|Resposta HTTPS
Formato da mensagem: JSON
{"success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"}Respostas HTTP de erro
Definições JSON da resposta
successstringerrorstringEsta página foi útil?