Guía de casos de uso de la API de estado de transacciones de gestión logística directa del proveedor v1
Help vendors in the direct fulfillment (DF) program use the Transaction Status API to manage their direct fulfillment operations.
Versión de API: v1
¿Qué es la API de estado de transacciones de gestión logística directa?
Los proveedores pueden utilizar esta API para comprobar el estado de sus transacciones POST.
Incluye la siguiente operación:
Operación | Método HTTP | Path | Descripción |
---|---|---|---|
getTransactionStatus | GET | /vendor/directFulfillment/transactions/v1/transactions/{transactionId} | Devuelve el estado de la transacción indicada por el transactionId especificado. |
Obtener el estado de la transacción
Los proveedores pueden utilizar la operación getTransactionStatus
para comprobar el estado de una transacción POST. Cuando se publica una solicitud para Amazon utilizando determinadas operaciones POST en las API de proveedor, como submitAcknowledgement
o submitShipmentConfirmations
, por ejemplo, una respuesta correcta contiene un ID de transacción que identifica la transacción de forma exclusiva. Amazon procesará la transacción de forma asincrónica y la respuesta final estará disponible a través de la operación 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 ofrece el estado de procesamiento final de las transacciones POST, como submitAcknowledgement
y submitShipmentConfirmations
a través de esta API. Recomendamos que los proveedores comprueben el estado mediante esta API para asegurarse de que las transacciones se han procesado correctamente. Si se produce un error, recibirás los detalles del error para que puedas corregir la transacción y volver a enviarla.
Estado de la transacción | Definición |
---|---|
Processing | Amazon ha recibido la transacción de la API y se está procesando. El procesamiento aún no se ha completado. Consulta el Acuerdo de nivel de servicio de cada operación de la API para conocer el tiempo previsto para finalizar el procesamiento. |
Success | Amazon ha procesado correctamente la transacción de la API. |
Failure | Se ha generado un error en la transacción de la API durante el procesamiento. Los detalles del error se proporcionarán en el cuerpo de respuesta getTransactionStatus . |
El estado de la transacción es compatible con las siguientes API de gestión logística directa:
Descripción | Sección de la API | Operación |
---|---|---|
Confirmación del pedido | Pedidos de gestión logística directa | submitAcknowledgement |
Enviar confirmaciones de envío | Envíos de gestión logística directa | submitShipmentConfirmations |
Solicitud de etiqueta de envío | Envíos de gestión logística directa | submitShippingLabelRequest |
Actualizaciones sobre el estado del envío | Envíos de gestión logística directa | submitShipmentStatusUpdates |
Actualización del inventario | Inventario de gestión logística directa | submitInventoryUpdate |
Factura | Pagos de gestión logística directa | submitInvoice |
El estado de la transacción solo admite los códigos de estado Processing
y Failure
por el momento. Si el estado de la transacción es Processing
y no se ha actualizado a Failure
transcurridos 30 minutos, esto indica que la transacción se ha procesado correctamente en nuestros sistemas. El estado Success
se admitirá en el futuro.
Solicitud getTransactionStatus
Para obtener el estado de la transacción, llama a la operación getTransactionStatus
y utiliza el siguiente parámetro:
Parámetro de ruta:
Nombre | Descripción | Obligatorio |
---|---|---|
transactionId |
Devuelto anteriormente en la respuesta a la solicitud POST para una transacción específica. Tipo: cadena |
Sí |
Ejemplo de solicitud:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/transactions/v1/transactions/20190904190535-eef8cad8-418e-4ed3-ac72-789e2ee6214a
Respuesta de getTransactionStatus
Una respuesta correcta incluye lo siguiente:
Nombre | Descripción | Obligatorio |
---|---|---|
transactionId |
El identificador único enviado en el campo transactionId en respuesta a la solicitud POST para una transacción específica. Tipo: cadena |
Sí |
status |
Estado de procesamiento actual de la transacción. enum ( Status ) |
Sí |
errors |
Mensaje y código de error de la transacción fallida. Solo disponible cuando el estado de la transacción es "Fallido". Tipo: |
No |
Ejemplo de respuesta:
{
"transactionId": "20190918190535-eef8cad8-418e-456f-ac72-789e2ee6813c",
"status": "Failure",
"errors": [
{
"code": "INVALID_ORDER_ID",
"message": "Invalid order ID."
}
]
}
Updated 5 months ago