Guia de casos de uso da API de status de transação de envio direto do fornecedor v1
Help vendors in the direct fulfillment (DF) program use the Transaction Status API to manage their direct fulfillment operations.
Versão da API: v1
O que é a API Direct Fulfillment Transaction Status?
Os fornecedores podem usar essa API para verificar o status da transação de suas transações POST.
A seguinte operação está incluída:
Operação | Método HTTP | Path | Descrição |
---|---|---|---|
getTransactionStatus | GET | /vendor/directFulfillment/transactions/v1/transactions/{transactionId} | Retorna o status da transação indicada pelo transactionId especificado . |
Obter status da transação
Os fornecedores podem usar a operação getTransactionStatus
para verificar o status de uma transação POST. Quando uma solicitação é publicada na Amazon usando determinadas operações POST nas APIs do fornecedor, como submitAcknowledgement
ou submitShipmentConfirmations
, por exemplo, uma resposta bem-sucedida contém um ID de transação que identifica a transação de forma exclusiva. A Amazon processará a transação de forma assíncrona e a resposta final estará disponível por meio da operação getTransactionStatus
.
Refer to the corresponding integration workflow diagram in the other sections of this guide to understand when to call the getTransactionStatus
operation to get the transaction status.
A Amazon oferece o status final processado para transações POST, como submitAcknowledgement
e submitShipmentConfirmations
por meio dessa API. É altamente recomendável que os fornecedores verifiquem o status usando essa API para garantir que as transações foram processadas com sucesso. Se ocorrer um erro, você receberá os detalhes do erro para poder corrigir a transação e reenviá-la.
Status da transação | Definição |
---|---|
Processing | A transação da API recebida pela Amazon está sendo processada. O processamento ainda não foi concluído. Verifique o SLA de cada operação de API para saber o tempo esperado para concluir o processamento. |
Success | A transação da API foi processada com sucesso pela Amazon. |
Failure | A transação da API falhou durante o processamento. Os detalhes do erro serão fornecidos no corpo de resposta getTransactionStatus . |
O status da transação é compatível com as seguintes APIs de atendimento direto:
Descrição | Seção da API | Operação |
---|---|---|
Confirmar pedido | Pedidos de envio direto | submitAcknowledgement |
Enviar confirmações de envio | Envio de atendimento direto | submitShipmentConfirmations |
Solicitação de etiqueta de endereço | Envio de atendimento direto | submitShippingLabelRequest |
Atualizações do status de envio | Envio de atendimento direto | submitShipmentStatusUpdates |
Atualização de inventário | Inventário de atendimento direto | submitInventoryUpdate |
Fatura | Pagamentos de atendimento direto | submitInvoice |
O status da transação suporta apenas os códigos de status Processing
e Failure
por enquanto. Se o status da transação for Processing
e não foi atualizado para Failure
após 30 minutos, isso indica que a transação foi processada com sucesso em nossos sistemas. O status Success
será suportado no futuro.
Solicitação getTransactionStatus
Para retornar o status da transação, chame a operação getTransactionStatus
e passe o seguinte parâmetro:
Parâmetro de caminho:
Nome | Descrição | Obrigatório |
---|---|---|
transactionId |
Retornado anteriormente na resposta à solicitação POST de uma transação específica. Tipo: string |
Sim |
Exemplo de solicitação:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/transactions/v1/transactions/20190904190535-eef8cad8-418e-4ed3-ac72-789e2ee6214a
Resposta GetTransactionStatus
Uma resposta bem-sucedida inclui o seguinte:
Nome | Descrição | Obrigatório |
---|---|---|
transactionId |
O identificador exclusivo enviado no campo transactionId em resposta à solicitação de postagem de uma transação específica. Tipo: string |
Sim |
status |
Status atual de processamento da transação. enum ( Status ) |
Sim |
errors |
Código de erro e mensagem para a transação com falha. Disponível somente quando o status da transação é “Falha”. Tipo: |
Não |
Exemplo de resposta:
{
"transactionId": "20190918190535-eef8cad8-418e-456f-ac72-789e2ee6813c",
"status": "Failure",
"errors": [
{
"code": "INVALID_ORDER_ID",
"message": "Invalid order ID."
}
]
}
Updated 5 months ago