Guía de casos de uso de la FBA Small y Light API
Recupere mediante programación información sobre el inventario en la Amazon's fulfillment network
Versión API: v1
¿Qué es la FBA Inventory API?
La FBA Inventory API le permite realizar un seguimiento de la disponibilidad en tiempo real de su inventario en la Amazon's fulfillment network a nivel de marketplace. Puede obtener detalles como la condición de publicación y las cantidades de inventario, como fulfillable , inbound , reserved , unfulfillable y researching . Esta API está disponible a nivel mundial.
Cómo usar la FBA Inventory API
nextToken
expirará en 30 segundos.Para evitar errores, utiliza
nextToken
para obtener la siguiente página en un plazo de 30 segundos.
La FBA Inventory API requiere el rol de listado de productos .
ElgetInventorySummaries
La operación devuelve una lista de inventory summaries. Los resúmenes devueltos dependen de la presencia o ausencia del startDateTime
y sellerSkus
parámetros de consulta:
-
Se devuelven todos los inventory summaries con todos los detalles disponibles cuando
startDateTime
ysellerSkus
se omiten los parámetros. -
Cuando
startDateTime
se proporciona, la operación devuelve inventory summaries que han cambiado después de la fecha y hora especificadas. ElsellerSkus
se ignora el parámetro.Evitar errores de paginación
Para evitar errores, utilice ambos
startDateTime
ynextToken
para obtener la siguiente página de inventory summaries que han cambiado después de la fecha y hora especificadas. -
Cuando el
sellerSkus
se proporciona el parámetro, la operación devuelve inventory summaries solo para elsellerSkus
especificado.
Tutorial: obtenga todos los inventory summaries disponibles con todos los detalles disponibles
Este tutorial le muestra cómo usar la FBA Inventory API para devolver todos los inventory summaries disponibles con detalles completos. Esto corresponde al número 1 en Cómo usar la FBA Inventory API .
requisitos previos
Para completar este tutorial necesitarás:
- El ID de marketplace para el marketplace para el que se devolverán inventory summaries.
Obtenga todos los inventory summaries disponibles con detalles completos.
Para devolver todos los inventory summaries disponibles con detalles completos, llame a la operación getInventorySummaries de la FBA Inventory API y pase los siguientes parámetros de consulta:
Parámetro | Descripción | Requerido |
---|---|---|
details | Ajustado a true para devolver inventory summaries con detalles y cantidades de inventory summaries adicionales. De lo contrario, devuelve solo inventory summaries (valor predeterminado). | Sí. Debe estar configurado para true . |
granularityType | El tipo de granularidad para el nivel de agregación de inventario. Valores posibles: Marketplace . | Sí. |
granularityId | El ID de granularidad para el tipo de granularidad especificado. Cuando granularityType es Marketplace , debe especificar el marketplaceId . | Sí. |
marketplaceIds | El ID de marketplace para el marketplace para el que se devolverán inventory summaries. Solo se permite una ID de marketplace. | Sí. |
nextToken | Token de string devuelto en la respuesta de su solicitud anterior. El token caduca después de 30 segundos. | No. |
Ejemplo de solicitud:
GET https://sellingpartnerapi-na.amazon.com/fba/inventory/v1/summaries?details=true&granularityType=Marketplace&granularityId=ATVPDKIKX0DER&marketplaceIds=ATVPDKIKX0DER
Una respuesta exitosa incluye lo siguiente en la payload para cada sellerSku
:
Nombre | Descripción |
---|---|
sellerSku | La unidad de mantenimiento de existencias (SKU) del seller del artículo. |
fnSku | Identificador de SKU de la red logística de Amazon. Las unidades de mantenimiento de existencias de la red logística (FNSKU) son identificadores únicos que Amazon asigna a los productos almacenados y gestionados desde los centros logísticos de Amazon. |
asin | El número de identificación estándar de Amazon (ASIN) de un artículo. Puedes encontrar el ASIN en la página de detalles del producto. |
productName | El título del producto en el idioma localizado del artículo dentro del marketplace especificado. |
lastUpdatedTime | La fecha y hora en que se actualizó por última vez cualquier cantidad. |
totalQuantity | El número total de unidades en un envío entrante o en los centros logísticos de Amazon. |
fulfillableQuantity | La cantidad de artículos que se pueden recoger, embalar y enviar. |
inboundWorkingQuantity | El número de unidades en un envío entrante para el que ha notificado a Amazon. |
inboundShippedQuantity | El número de unidades en un envío entrante sobre el que ha notificado a Amazon y ha proporcionado un número de seguimiento. |
inboundReceivingQuantity | El número de unidades que aún no se han recibido en un centro logístico de Amazon para su procesamiento, pero que forman parte de un envío entrante con algunas unidades que ya se han recibido y procesado. |
totalReservedQuantity | El número total de unidades en la red logística de Amazon que actualmente se están recolectando, empaquetando y enviando; o se dejan de lado para la medición, el muestreo u otros procesos internos. |
pendingCustomerOrderQuantity | El número de unidades reservadas para pedidos de clientes. |
pendingTransshipmentQuantity | El número de unidades que se transfieren de un centro logístico a otro. |
fcProcessingQuantity | El número de unidades que se han dejado de lado en el centro logístico para procesamiento adicional. |
totalUnfulfillableQuantity | El número total de unidades en la red logística de Amazon en condiciones no vendibles. |
customerDamagedQuantity | El número de unidades en disposición dañada del cliente. |
warehouseDamagedQuantity | El número de unidades en disposición dañada del almacén. |
distributorDamagedQuantity | El número de unidades en disposición dañada del distribuidor. |
carrierDamagedQuantity | El número de unidades en disposición dañada del transportista. |
defectiveQuantity | El número de unidades en disposición defectuosa. |
expiredQuantity | El número de unidades en disposición vencida. |
totalResearchingQuantity | El número total de unidades que se están investigando actualmente en la red de cumplimiento de Amazon. |
researchingQuantityBreakdown | Una lista de detalles de cantidad para artículos que se están investigando actualmente que incluyeresearchingQuantityInShortTerm (1-10 días)researchingQuantityInMidTerm (11-20 días)* researchingQuantityInLongTerm (21 días o más). |
Ejemplo de respuesta:
{
"pagination": {
"nextToken": "seed"
},
"payload": {
"granularity": {
"granularityType": "Marketplace",
"granularityId": "ATVPDKIKX0DER"
},
"inventorySummaries": [
{
"asin": "B00T9QONN1",
"fnSku": "B00T9QONN1",
"sellerSku": "msku314best",
"condition": "NewItem",
"inventoryDetails": {
"fulfillableQuantity": 66,
"inboundWorkingQuantity": 21,
"inboundShippedQuantity": 0,
"inboundReceivingQuantity": 0,
"reservedQuantity": {
"totalReservedQuantity": 0,
"pendingCustomerOrderQuantity": 0,
"pendingTransshipmentQuantity": 0,
"fcProcessingQuantity": 0
},
"researchingQuantity": {
"totalResearchingQuantity": 0,
"researchingQuantityBreakdown": [
{
"name": "researchingQuantityInShortTerm",
"quantity": 0
},
{
"name": "researchingQuantityInMidTerm",
"quantity": 0
},
{
"name": "researchingQuantityInLongTerm",
"quantity": 0
}
]
},
"unfulfillableQuantity": {
"totalUnfulfillableQuantity": 0,
"customerDamagedQuantity": 0,
"warehouseDamagedQuantity": 0,
"distributorDamagedQuantity": 0,
"carrierDamagedQuantity": 0,
"defectiveQuantity": 0,
"expiredQuantity": 0
}
},
"lastUpdatedTime": "2018-03-31T23: 40: 39Z",
"productName": "CalciumPowder",
"totalQuantity": 87
}
]
}
}
Tutorial: obtenga todos los inventory summaries disponibles que han cambiado
Este instructivo le muestra cómo usar la FBA Inventory API para devolver todos los inventory summaries disponibles que han cambiado desde la fecha y hora de inicio especificadas. Esto corresponde al número 2 en Cómo usar la FBA Inventory API .
requisitos previos
Para completar este tutorial necesitarás:
- El ID de marketplace para el marketplace para el que se devolverán inventory summaries.
- La fecha y hora de inicio para usar como base para devolver inventory summaries que han cambiado.
Obtenga todos los inventory summaries disponibles que han cambiado
startDateTime
requerido
startDateTime
es necesario para obtener la siguiente página de inventory summaries que han cambiado después de la fecha y hora especificadas.
Para devolver todos los inventory summaries disponibles que han cambiado, llame algetInventorySummaries
funcionamiento de la FBA Inventory API, pasando los siguientes parámetros de consulta:
Parámetro | Descripción | Requerido |
---|---|---|
details | Ajustado a true para devolver inventory summaries con detalles y cantidades de inventory summaries adicionales. De lo contrario, devuelve solo inventory summaries (valor predeterminado). | No. |
granularityType | El tipo de granularidad para el nivel de agregación de inventario. Valores posibles: Marketplace . | Sí. |
granularityId | El ID de granularidad para el tipo de granularidad especificado. Cuando granularityType es Marketplace , debe especificar el marketplaceId . | Sí. |
startDateTime | Una fecha y hora de inicio en formato ISO 8601. Si se especifica, se devuelven todos los inventory summaries que han cambiado desde entonces. Debe especificar una fecha y hora que no sea anterior a 18 meses antes de la fecha y hora de la solicitud. Nota: No se detectan cambios en lo siguiente: inboundWorkingQuantity inboundShippedQuantity * inboundReceivingQuantity | Sí. |
marketplaceIds | El ID de marketplace para el marketplace para el que se devolverán inventory summaries. Solo se permite una ID de marketplace. | Sí. |
nextToken | Token de string devuelto en la respuesta de su solicitud anterior. El token caduca después de 30 segundos. | No. |
Ejemplo de solicitud:
GET https://sellingpartnerapi-na.amazon.com/fba/inventory/v1/summaries?granularityType=Marketplace&granularityId=ATVPDKIKX0DER&startDateTime=2018-03-27T23:40:39Z&marketplaceIds=ATVPDKIKX0DER
Una respuesta exitosa incluye lo siguiente en la payload para cada sellerSku
. Observa que, porque el parámetro detail
no se especificó en el ejemplo de solicitud y el valor predeterminado es false
, no se devuelven cantidades y detalles de inventory summaries adicionales.
Nombre | Descripción |
---|---|
sellerSku | La unidad de mantenimiento de existencias (SKU) del seller del artículo. |
fnSku | Identificador de SKU de la red logística de Amazon. Las unidades de mantenimiento de existencias de la red logística (FNSKU) son identificadores únicos que Amazon asigna a los productos almacenados y gestionados desde los centros logísticos de Amazon. |
asin | El número de identificación estándar de Amazon (ASIN) de un artículo. Puedes encontrar el ASIN en la página de detalles del producto. |
productName | El título del producto en el idioma localizado del artículo dentro del marketplace especificado. |
lastUpdatedTime | La fecha y hora en que se actualizó por última vez cualquier cantidad. |
totalQuantity | El número total de unidades en un envío entrante o en los centros logísticos de Amazon. |
Ejemplo de respuesta:
{
"pagination": {
"nextToken": "seed"
},
"payload": {
"granularity": {
"granularityType": "Marketplace",
"granularityId": "ATVPDKIKX0DER"
},
"inventorySummaries": [
{
"asin": "B00T9QONN1",
"fnSku": "B00T9QONN1",
"sellerSku": "msku314best",
"condition": "NewItem",
"lastUpdatedTime": "2018-03-31T23: 40: 39Z",
"productName": "CalciumPowder",
"totalQuantity": 87
}
]
}
}
Tutorial: obtenga inventory summaries para los SKU de seller especificados
Este tutorial le muestra cómo usar la FBA Inventory API para devolver inventory summaries para uno o más (hasta 50) especificados sellerSku
s. Esto corresponde al número 3 en Cómo usar la FBA Inventory API .
requisitos previos
Para completar este tutorial necesitarás:
- El ID de marketplace para el marketplace para el que se devolverán inventory summaries.
- Una lista de hasta cincuenta
sellerSku
s para los que devolver inventory summaries.
Obtenga inventory summaries con detalles adicionales para los SKU de seller especificados.
Para devolver inventory summaries con todos los detalles de los SKU especificados, llame a la operación getInventorySummaries de la FBA Inventory API y pase los siguientes parámetros de consulta:
Parámetro | Descripción | Requerido |
---|---|---|
details | Ajustado a true para devolver inventory summaries con detalles y cantidades de inventory summaries adicionales. De lo contrario, devuelve solo inventory summaries (valor predeterminado). | Sí. Debe estar configurado para true . |
granularityType | El tipo de granularidad para el nivel de agregación de inventario. Valores posibles: Marketplace . | Sí. |
granularityId | El ID de granularidad para el tipo de granularidad especificado. Cuando granularityType es Marketplace , debe especificar el marketplaceId . | Sí. |
sellerSkus | Una lista de SKU de seller para los que devolver inventory summaries. Puede especificar hasta 50 SKU. | Sí. |
marketplaceIds | El ID de marketplace para el marketplace para el que se devolverán inventory summaries. Solo se permite una ID de marketplace. | Sí. |
Ejemplo de solicitud:
GET https://sellingpartnerapi-na.amazon.com/fba/inventory/v1/summaries?details=true&granularityType=Marketplace&granularityId=ATVPDKIKX0DER&sellerSkus=msku314best%2Cmsku271good&marketplaceIds=ATVPDKIKX0DER
Una respuesta exitosa incluye lo siguiente en la payload para cada uno de los sellerSkus especificados:
Nombre | Descripción |
---|---|
sellerSku | La unidad de mantenimiento de existencias (SKU) del seller del artículo. |
fnSku | Identificador de SKU de la red logística de Amazon. Las unidades de mantenimiento de existencias de la red logística (FNSKU) son identificadores únicos que Amazon asigna a los productos almacenados y gestionados desde los centros logísticos de Amazon. |
asin | El número de identificación estándar de Amazon (ASIN) de un artículo. Puedes encontrar el ASIN en la página de detalles del producto. |
productName | El título del producto en el idioma localizado del artículo dentro del marketplace especificado. |
lastUpdatedTime | La fecha y hora en que se actualizó por última vez cualquier cantidad. |
totalQuantity | El número total de unidades en un envío entrante o en los centros logísticos de Amazon. |
fulfillableQuantity | La cantidad de artículos que se pueden recoger, embalar y enviar. |
inboundWorkingQuantity | El número de unidades en un envío entrante para el que ha notificado a Amazon. |
inboundShippedQuantity | El número de unidades en un envío entrante sobre el que ha notificado a Amazon y ha proporcionado un número de seguimiento. |
inboundReceivingQuantity | El número de unidades que aún no se han recibido en un centro logístico de Amazon para su procesamiento, pero que forman parte de un envío entrante con algunas unidades que ya se han recibido y procesado. |
totalReservedQuantity | El número total de unidades en la red logística de Amazon que actualmente se están recolectando, empaquetando y enviando; o se dejan de lado para la medición, el muestreo u otros procesos internos. |
pendingCustomerOrderQuantity | El número de unidades reservadas para pedidos de clientes. |
pendingTransshipmentQuantity | El número de unidades que se transfieren de un centro logístico a otro. |
fcProcessingQuantity | El número de unidades que se han dejado de lado en el centro logístico para procesamiento adicional. |
totalUnfulfillableQuantity | El número total de unidades en la red logística de Amazon en condiciones no vendibles. |
customerDamagedQuantity | El número de unidades en disposición dañada del cliente. |
warehouseDamagedQuantity | El número de unidades en disposición dañada del almacén. |
distributorDamagedQuantity | El número de unidades en disposición dañada del distribuidor. |
carrierDamagedQuantity | El número de unidades en disposición dañada del transportista. |
defectiveQuantity | El número de unidades en disposición defectuosa. |
expiredQuantity | El número de unidades en disposición vencida. |
totalResearchingQuantity | El número total de unidades que se están investigando actualmente en la red de cumplimiento de Amazon. |
researchingQuantityBreakdown | Una lista de detalles de cantidad para artículos que se están investigando actualmente que incluyeresearchingQuantityInShortTerm (1-10 días)researchingQuantityInMidTerm (11-20 días)* researchingQuantityInLongTerm (21 días o más). |
Ejemplo de respuesta:
{
"pagination": {
"nextToken": "seed"
},
"payload": {
"granularity": {
"granularityType": "Marketplace",
"granularityId": "ATVPDKIKX0DER"
},
"inventorySummaries": [
{
"asin": "B00T9QONN1",
"fnSku": "B00T9QONN1",
"sellerSku": " msku314best",
"condition": "NewItem",
"inventoryDetails": {
"fulfillableQuantity": 66,
"inboundWorkingQuantity": 21,
"inboundShippedQuantity": 0,
"inboundReceivingQuantity": 0,
"reservedQuantity": {
"totalReservedQuantity": 0,
"pendingCustomerOrderQuantity": 0,
"pendingTransshipmentQuantity": 0,
"fcProcessingQuantity": 0
},
"researchingQuantity": {
"totalResearchingQuantity": 0,
"researchingQuantityBreakdown": [
{
"name": "researchingQuantityInShortTerm",
"quantity": 0
},
{
"name": "researchingQuantityInMidTerm",
"quantity": 0
},
{
"name": "researchingQuantityInLongTerm",
"quantity": 0
}
]
},
"unfulfillableQuantity": {
"totalUnfulfillableQuantity": 0,
"customerDamagedQuantity": 0,
"warehouseDamagedQuantity": 0,
"distributorDamagedQuantity": 0,
"carrierDamagedQuantity": 0,
"defectiveQuantity": 0,
"expiredQuantity": 0
}
},
"lastUpdatedTime": "2018-03-31T23: 40: 39Z",
"productName": "CalciumPowder",
"totalQuantity": 87
},
{
"asin": "B00T9QONN2",
"fnSku": "B00T9QONN2",
"sellerSku": " msku271good",
"condition": "NewItem",
"inventoryDetails": {
"fulfillableQuantity": 6,
"inboundWorkingQuantity": 2,
"inboundShippedQuantity": 0,
"inboundReceivingQuantity": 0,
"reservedQuantity": {
"totalReservedQuantity": 0,
"pendingCustomerOrderQuantity": 0,
"pendingTransshipmentQuantity": 0,
"fcProcessingQuantity": 0
},
"researchingQuantity": {
"totalResearchingQuantity": 0,
"researchingQuantityBreakdown": [
{
"name": "researchingQuantityInShortTerm",
"quantity": 0
},
{
"name": "researchingQuantityInMidTerm",
"quantity": 0
},
{
"name": "researchingQuantityInLongTerm",
"quantity": 0
}
]
},
"unfulfillableQuantity": {
"totalUnfulfillableQuantity": 0,
"customerDamagedQuantity": 0,
"warehouseDamagedQuantity": 0,
"distributorDamagedQuantity": 0,
"carrierDamagedQuantity": 0,
"defectiveQuantity": 0,
"expiredQuantity": 0
}
},
"lastUpdatedTime": "2018-04-01T23: 40: 39Z",
"productName": "CalciumPowder",
"totalQuantity": 8
}
]
}
}
Recomendación general
Siguiente Token en GetInventorySummariesResponse
Para evitar errores, utilice nextToken
para pasar a la página siguiente en 30 segundos.
Paginación en GetInventorySummariesResponse
Cuando una llamada a la operación getInventorySummaries produce un nextToken
, luego hay inventarios que aún no se han encontrado y puede obtenerlos en las llamadas posteriores. Usted itera a través de los Inventarios usando el nextToken
token proporcionado en respuestas sucesivas. Todo el inventario ha sido atravesado, sólo después de que el pagination
se devuelve como respuesta. esto significa que inventorySummaries
la lista puede estar vacía pero aún produciendo un nextToken
.
Ejemplos:
Incluso si no hay inventarios en el inventorySummaries
lista, hay una nextToken
:
{
"response": {
"pagination": {
"nextToken": "XXXXXXXXX"
},
"payload": {
"granularity": {
},
"inventorySummaries": []
}
}
}
El getInventorySummaries
a operação é considerada concluída somente quando a pagination
não é retornada na resposta:
{
"response": {
"payload": {
"granularity": {
},
"inventorySummaries": []
}
}
}
Updated over 1 year ago