Valores atuais de status do pedido
Abaixo está uma lista atual de status de pedidos que um pedido pode ter.
Cuidado - 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. Zonos nunca removerá status existentes.
| Status | Descrição | Definido por |
|---|---|---|
| IGLOBAL_FRAUD_REVIEW | O pedido está atualmente sob revisão de fraude pela iGlobal. | Zonos |
| IGLOBAL_ORDER_IN_PROCESS | O pedido é válido e pronto para processamento. | Zonos |
| IGLOBAL_ORDER_ON_HOLD | O pedido está atualmente em espera temporária. | Zonos |
| IGLOBAL_ORDER_CANCELLED | O pedido foi cancelado no Sistema iGlobal. | Zonos |
| VENDOR_PREPARING_ORDER | O fornecedor marcou o pedido como em preparação. | Fornecedor |
| VENDOR_SHIPMENT_READY | O fornecedor marcou o pedido como pronto para envio. | Fornecedor |
| VENDOR_LABELS_PRINTED_DATE | O fornecedor imprimiu etiquetas de envio. | Fornecedor |
| VENDOR_CANCELLATION_REQUEST | O pedido foi solicitado para cancelamento. | Fornecedor |
| VENDOR_END_OF_DAY_COMPLETE | O pedido está finalizado e completo. | Fornecedor |
vendorOrderStatusnã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
| Campo | Valor |
|---|---|
| Método HTTP | POST |
| URL do ponto de extremidade | https://api.iglobalstores.com/v1/updateVendorOrderStatus |
| Protocolo | HTTPS |
| Formato da mensagem | JSON |
| Cabeçalho HTTP de aceitação | Accept: application/json |
| Cabeçalho HTTP de tipo de conteúdo | Content-Type: application/json |
Pares chave/valor JSON no corpo da solicitação
Formato da mensagem: JSON
EXEMPLO
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
}
Definições de JSON de solicitação
| Campo | Notas |
|---|---|
orderId OBRIGATÓRIO | O ID do pedido do Zonos pode ser passado com ou sem o ID da sua loja e hífen (Exemplo: 123-45678 ou 45678). Após a conclusão do pedido e pagamento, o cliente será redirecionado para uma página de conclusão de pedido / página de agradecimento hospedada em seu domínio. A URL conterá um parâmetro de querystring orderID que conterá este valor.integer / string |
orderStatus OBRIGATÓRIO | Este campo é usado para atualizar o sistema do Zonos com o novo status de um pedido. Os seguintes status de pedido podem ser definidos via esta API.- VENDOR_PREPARING_ORDER |
VENDOR_SHIPMENT_READYVENDOR_LABELS_PRINTEDVENDOR_END_OF_DAY_COMPLETEVENDOR_CANCELLATION_REQUEST``string| |secretOBRIGATÓRIO | GUID secreto da API fornecido pelo Zonos.string| |storeOBRIGATÓRIO | ID da loja fornecido pelo Zonosinteger|
Resposta HTTPS
Formato da mensagem: JSON
Exemplo de resposta de sucesso
1
2
3
{
"success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
}
Exemplo de resposta de erro
1
2
3
{
"error": "OrderId: 99999 cannot be moved to order status: VENDOR_PREPARING_ORDER while in status: IGLOBAL_FRAUD_REVIEW"
}
Respostas de erro HTTP
| Códigos de Resposta HTTP | Exemplo/Descrição do Corpo da Resposta |
|---|---|
| 406 - Não Aceitável | Entidade HTML. O cabeçalho HTTP "Accept" é inválido. |
| 415 - Tipo de mídia não suportado | Entidade HTML. O cabeçalho HTTP "Content-Type" é inválido. |
| 200 | "error": "não foi possível analisar a entrada" |
| 200 | "error": "Parâmetro orderId necessário para updateVendorOrderStatus" |
| 200 | "error": "Parâmetro orderStatus necessário para updateVendorOrderStatus." |
| 200 | "error": "orderId: 999-99999 não é um orderId válido" |
| 200 | "error": "Não foi possível recuperar o pedido para updateVendorOrderStatus a partir do orderId: 999-99999" |
| 200 | "error": "OrderId: 999-99999 já foi cancelado e o status não pode ser atualizado." |
| 200 | "error": "Não é possível atualizar o status do pedido para o status: VENDOR_CANCELLATION_REQUEST" |
| 200 | "error": "Não é possível atualizar o status do pedido para o status inválido: NEW_ORDER_STATUS" |
| 200 | "error": "OrderId: 999-99999 já possui o status atual: VENDOR_SHIPMENT_READY" |
| 200 | "error": "OrderId: 999-99999 não pode ser movido para o status do pedido: VENDOR_CANCELLATION_REQUEST enquanto estiver no status: VENDOR_END_OF_DAY_COMPLETE" |
| 200 | "error": "Novo Status: NEW_ORDER_STATUS não é um status de pedido válido" |
| 200 | "error": "Não foi possível processar updateVendorOrderStatus." |
| 200 | "error": "Credenciais de segurança inválidas" |
Definições JSON de Resposta
| Mensagem | Definição |
|---|---|
sucesso | Este parâmetro conterá um resumo da atualização. string |
erro | Este parâmetro estará presente na resposta apenas quando ocorrer um erro e conterá uma descrição da causa. string |
Atualizar status do pedido
Saiba como funciona o ponto de extremidade para atualizar o status do pedido.
O ponto de extremidade
updateVendorOrderStatusé usado para atualizar o status do pedido de um pedido dentro do Sistema Zonos. Isso será usado para atualizar programaticamente o status de envio do pedido ou solicitar um cancelamento.