DOCS

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.

Cuidado - A Zonos pode adicionar mais status a qualquer momento; seu sistema deve acomodar a presença de status adicionais.

Os status em produção permanecerão em produção. A Zonos nunca removerá status existentes.

StatusDescriçãoDefinível por
IGLOBAL_FRAUD_REVIEWO pedido está atualmente sob revisão de fraude pela iGlobal.Zonos
IGLOBAL_ORDER_IN_PROCESSO pedido é válido e está pronto para processamento.Zonos
IGLOBAL_ORDER_ON_HOLDO pedido está atualmente em uma retenção temporária de status.Zonos
IGLOBAL_ORDER_CANCELLEDO pedido foi cancelado no sistema iGlobal.Zonos
VENDOR_PREPARING_ORDERO fornecedor marcou o pedido em preparação.Vendor
VENDOR_SHIPMENT_READYO fornecedor marcou o pedido como pronto para envio.Vendor
VENDOR_LABELS_PRINTED_DATEO fornecedor imprimiu as etiquetas de envio.Vendor
VENDOR_CANCELLATION_REQUESTFoi solicitado o cancelamento do pedido.Vendor
VENDOR_END_OF_DAY_COMPLETEO pedido está finalizado e completo.Vendor

vendorOrderStatus não pode ser atualizado pelo fornecedor enquanto o pedido estiver em um dos seguintes status de pedido:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

Solicitação HTTPS

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

CampoValor
Método HTTPPOST
URL do endpointhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ProtocoloHTTPS
Formato da mensagemJSON
Cabeçalho HTTP AcceptAccept: application/json
Cabeçalho HTTP Content-TypeContent-Type: application/json

Pares chave/valor JSON no corpo da solicitação

Formato da mensagem: JSON

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

Definições JSON da solicitação

CampoNotas
orderId OBRIGATÓRIOO 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ÓRIOEste 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 HTTPExemplo/Descrição do corpo da resposta
406 - Not AcceptableEntidade HTML. O cabeçalho HTTP “Accept” é inválido.
415 - Unsupported media typeEntidade 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

MensagemDefinição
successEste parâmetro conterá um resumo da atualização.string
errorEste parâmetro só estará presente na resposta quando tiver ocorrido um erro e conterá uma descrição da causa.string

Esta página foi útil?