Guide des cas d'utilisation de l'API Statut des transactions Expédition directe par le fournisseur v1
Help vendors in the direct fulfillment (DF) program use the Transaction Status API to manage their direct fulfillment operations.
Version de l'API : v1
Qu'est-ce que l'API Statut des transactions Expédition directe ?
Les fournisseurs peuvent utiliser cette API pour vérifier le statut de leurs transactions POST.
L'opération suivante est incluse :
Opération | Méthode HTTP | Path | Description |
---|---|---|---|
getTransactionStatus | GET | /vendor/directFulfillment/transactions/v1/transactions/{transactionId} | Renvoie le statut de la transaction indiqué par la valeur transactionId . |
Obtenir le statut de la transaction
Les fournisseurs peuvent utiliser l'opération getTransactionStatus
pour vérifier le statut d'une transaction POST. Lorsqu'une demande est publiée sur Amazon à l'aide de certaines opérations POST dans les API du fournisseur, telles que submitAcknowledgement
ou submitShipmentConfirmations
, par exemple, une réponse réussie contiendra alors un identifiant de transaction qui identifiera la transaction de manière unique. Amazon traitera la transaction de manière asynchrone et la réponse finale sera disponible via l'opération 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.
Amazon propose le statut final traité pour les transactions POST telles que submitAcknowledgement
et submitShipmentConfirmations
via cette API. Nous recommandons vivement aux fournisseurs de vérifier le statut à l'aide de cette API pour s'assurer que les transactions ont été traitées correctement. En cas d'erreur, vous recevrez les détails de l'erreur pour vous permettre de corriger la transaction et la soumettre à nouveau.
Statut de la transaction | Définition |
---|---|
Processing | La transaction d'API reçue par Amazon est en cours de traitement. Le traitement n'est pas encore terminé. Vérifiez l'Accord de niveau de service pour chaque opération d'API pendant la durée prévue pour terminer le traitement. |
Success | La transaction d'API a été traitée avec succès par Amazon. |
Failure | La transaction d'API a échoué pendant le traitement. Les détails de l'erreur seront fournis dans le corps de réponse getTransactionStatus . |
Le statut de la transaction est pris en charge pour les API Expédition directe suivantes :
Description | Section API | Opération |
---|---|---|
Accuser réception de la commande | Commandes à expédition directe | submitAcknowledgement |
Soumettre les confirmations d'expédition | Expédition directe | submitShipmentConfirmations |
Demande d'étiquette d'expédition | Expédition directe | submitShippingLabelRequest |
Mises à jour du statut d’expédition | Expédition directe | submitShipmentStatusUpdates |
Mise à jour du stock | Stock d'expédition directe | submitInventoryUpdate |
Facture | Paiements d'expédition directe | submitInvoice |
Le statut de la transaction ne prend en charge que les codes de statut Processing
et Failure
pour le moment. Si le statut de la transaction est Processing
et n'a pas été mis à jour vers Failure
après 30 minutes, cela indique que la transaction a été traitée avec succès dans nos systèmes. Le statut Success
sera pris en charge à l'avenir.
Demande getTransactionStatus
Pour retourner le statut de la transaction, appelez l'opération getTransactionStatus
et transmettez le paramètre suivant :
Paramètre de chemin d'accès :
Nom | Description | Obligatoire |
---|---|---|
transactionId |
Précédemment renvoyé dans la réponse à la requête POST d'une transaction spécifique. Type : chaîne |
Oui |
Exemple de demande :
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/transactions/v1/transactions/20190904190535-eef8cad8-418e-4ed3-ac72-789e2ee6214a
Réponse getTransactionStatus
Une réponse réussie comprend les éléments suivants :
Nom | Description | Obligatoire |
---|---|---|
transactionId |
L'identifiant unique envoyé dans le champ transactionId en réponse à la demande POST d'une transaction spécifique. Type : chaîne |
Oui |
status |
Statut de traitement actuel de la transaction. enum ( Statut ) |
Oui |
errors |
Code d'erreur et message relatifs à l'échec de la transaction. Disponible uniquement lorsque le statut de la transaction est “Échec”. Type : |
Non |
Exemple de réponse :
{
"transactionId": "20190918190535-eef8cad8-418e-456f-ac72-789e2ee6813c",
"status": "Failure",
"errors": [
{
"code": "INVALID_ORDER_ID",
"message": "Invalid order ID."
}
]
}
Updated 5 months ago