Referencia de FBA Inventory API v1
Descripción general
La Selling Partner API para el FBA Inventory le permite recuperar información sobre el inventario en la red de cumplimiento de Amazon mediante programación.
Información de versión
Versión : v1
Información del contacto
Contacto : Soporte para desarrolladores Selling Partner API
URL de contacto : https://sellercentral.amazon.com/gp/mws/contactus.html
Información de licencia
Licencia : Licencia Apache 2.0
URL de la licencia : http://www.apache.org/licenses/LICENSE-2.0
esquema URI
Anfitrión : Sellingpartnerapi-na.amazon.com
Esquemas : HTTPS
consume
application/json
produce
application/json
Operaciones
Rutas
GET /fba/inventory/v1/summaries
Operación: getInventorySummaries
Descripción
Devuelve una lista de inventory summaries. Los summaries devueltos dependen de la presencia o ausencia del startDateTime , sellerSkus y Parámetros del sellerSku :
- Todos los inventory summaries con detalles disponibles se devuelven cuando el
startDateTime,sellerSkusy Se omiten los parámetrosde sellerSku. . - Cuando se proporciona
startDateTime, la operación devuelve inventory summaries que han tenido cambios después de la fecha y hora especificadas. El , la operación devuelve inventory summaries que han tenido cambios después de la fecha y hora especificadas. ElsellerSkusy Los parámetrosde sellerSkuse ignoran. Importante: Para evitar errores, utilice ambos Para evitar errores, utilice ambos fecha ystartDateTimeynextTokenpara obtener la siguiente página de inventory summaries que han cambiado después de la fecha y la hora especificadas. - Cuando el se proporciona el parámetro
sellerSkus, la operación devuelve inventory summaries solo para el especificado , la operación devuelve inventory summaries solo para el especificadosellerSkus. El parámetrosellerSkuse ignora. se ignora. - Cuando el se proporciona el parámetro
sellerSku, la operación devuelve inventory summaries solo para el especificado , la operación devuelve inventory summaries solo para el especificadosellerSku.
Nota: Los parámetros asociados con esta operación pueden contener caracteres especiales que deben codificarse para llamar correctamente a la API. Para evitar errores con SKU al codificar URL, consulte Codificación de URL .
Plan de uso:
| Tasa (solicitudes por segundo) | Burst |
|---|---|
| 2 | 2 |
El solicitud de respuesta x-amzn-RateLimit-Limit devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de burst para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y burst más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema | Por defecto |
|---|---|---|---|---|
| Query | details opcional | true para devolver inventory summaries con cantidades y detalles de inventory summaries adicionales. De lo contrario, devuelve solo inventory summaries (valor predeterminado). | booleano | "false" |
| Query | granularityType requerido | El tipo de granularity para el nivel de agregación de inventario. | enum ( granularityType ) | - |
| Query | granularityId requerido | El ID de granularidad para el nivel de agregación de inventario. | string | - |
| Query | startDateTime opcional | Una fecha y startDateTime en formato ISO8601. 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 en que llama a la API. Nota: No se detectan cambios en inboundWorkingQuantity, inboundShippedQuantity y inboundReceivingQuantity. | string (date-time) | - |
| Query | sellerSkus opcional | Una lista de seller SKUs para los que devolver inventory summaries. Puede especificar hasta 50 SKU. Recuento máximo : 50 : 50 | < string > array | - |
| Query | sellerSku opcional | Un solo seller SKU utilizado para consultar los inventory summaries de seller SKU especificado. | string | - |
| Query | nextToken opcional | Token de string devuelto en la respuesta de su solicitud anterior. El token de string caducará 30 segundos después de su creación. | string | - |
| Query | marketplaceIds requerido | El ID de marketplace para el marketplace para el que se devolverán inventory summaries. Número máximo : 1 : 1 | < string > array | - |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | OK Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | GetInventorySummariesResponse |
Para códigos de estado de error, descripciones y esquemas, consulte Respuestas y esquemas de error .
produce
application/json
Respuestas de error y esquemas
Esta tabla contiene códigos de estado HTTP e información asociada para respuestas de error.
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | GetInventorySummariesResponse |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado, firma no válida o recurso no encontrado. Headers: x-amzn-RequestId (string): ID de referencia de solicitud única. | GetInventorySummariesResponse |
| 404 | El recurso especificado no existe. Headers: x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | GetInventorySummariesResponse |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el solicitud de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | GetInventorySummariesResponse |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers: x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el solicitud de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | GetInventorySummariesResponse |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el solicitud de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | GetInventorySummariesResponse |
Definiciones
Granularity
Describe una granularidad en la que se pueden agregar datos de inventario. Por ejemplo, si utiliza la granularidad de Marketplace, la cantidad completa reflejará el inventario que podría completarse en el marketplace determinado.
| Nombre | Descripción | Esquema |
|---|---|---|
| granularityType opcional | El tipo de granularity para el nivel de agregación de inventario. | string |
| granularityId opcional | El ID de granularidad para el granularityType especificado. Cuando granularityType es Marketplace, especifique marketplaceId. | string |
ReservedQuantity
La cantidad de inventario reservado.
| Nombre | Descripción | Esquema |
|---|---|---|
| totalReservedQuantity opcional | 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. | integer |
| pendingCustomerOrderQuantity opcional | El número de unidades reservadas para pedidos de clientes. | integer |
| pendingTransshipmentQuantity opcional | El número de unidades que se transfieren de un centro logístico a otro. | integer |
| fcProcessingQuantity opcional | El número de unidades que se han dejado de lado en el centro logístico para procesamiento adicional. | integer |
ResearchingQuantityEntry
El inventario extraviado o dañado en el almacén que se está confirmando activamente en nuestros centros logísticos.
| Nombre | Descripción | Esquema |
|---|---|---|
| name requerido | La duración de la investigación. | enum ( Name ) |
| quantity requerido | El número de unidades. | integer |
ResearchingQuantity
El número de unidades extraviadas o dañadas en el almacén que se están confirmando activamente en nuestros centros logísticos.
| Nombre | Descripción | Esquema |
|---|---|---|
| totalResearchingQuantity opcional | El número total de unidades que se están investigando actualmente en la red de cumplimiento de Amazon. | integer |
| researchingQuantityBreakdown opcional | Una lista de detalles de la cantidad de artículos que se están investigando actualmente. | < ResearchingQuantityEntry > array |
UnfulfillableQuantity
La cantidad de inventario no cumplible.
| Nombre | Descripción | Esquema |
|---|---|---|
| totalUnfulfillableQuantity opcional | El número total de unidades en la red logística de Amazon en condiciones no vendibles. | integer |
| customerDamagedQuantity opcional | El número de unidades en disposición dañada del cliente. | integer |
| warehouseDamagedQuantity opcional | El número de unidades en disposición dañada del almacén. | integer |
| distributorDamagedQuantity opcional | El número de unidades en disposición dañada del distribuidor. | integer |
| carrierDamagedQuantity opcional | El número de unidades en disposición dañada del transportista. | integer |
| defectiveQuantity opcional | El número de unidades en disposición defectuosa. | integer |
| expiredQuantity opcional | El número de unidades en disposición vencida. | integer |
InventoryDetails
Detalles resumidos del inventario. Este objeto no aparecerá si el parámetro de detalles en la solicitud es falso.
| Nombre | Descripción | Esquema |
|---|---|---|
| fulfillableQuantity opcional | La cantidad de artículos que se pueden recoger, embalar y enviar. | integer |
| inboundWorkingQuantity optional | El número de unidades en un envío entrante para el que ha notificado a Amazon. | integer |
| inboundShippedQuantity optional | 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. | integer |
| inboundReceivingQuantity optional | 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. | integer |
| reservedQuantity optional | La cantidad de inventario reservado. | ReservedQuantity |
| researchingQuantity optional | El número de unidades extraviadas o dañadas en el almacén que se están confirmando activamente en nuestros centros logísticos. | ResearchingQuantity |
| unfulfillableQuantity optional | La cantidad de inventario no cumplible. | UnfulfillableQuantity |
InventorySummary
Inventory summary para un artículo específico.
| Nombre | Descripción | Esquema |
|---|---|---|
| asin optional | El número de identificación estándar de Amazon (ASIN) de un artículo.. | string |
| fnSku optional | Identificador de SKU de la red Amazon's fulfillment. | string |
| sellerSku opcional | El seller SKU del artículo. | string |
| condition optional | El estado del artículo descrito por el seller (por ejemplo, Artículo nuevo). | string |
| inventoryDetails optional | Summarized inventory details. Este objeto no aparecerá si el parámetro de detalles en la solicitud es falso. | InventoryDetails |
| lastUpdatedTime optional | La fecha y hora en que se actualizó por última vez cualquier cantidad. | string (date-time) |
| productName optional | El título del producto en el idioma localizado del artículo dentro del marketplace específico. | string |
| totalQuantity optional | El número total de unidades en un envío entrante o en los centros logísticos de Amazon (Amazon fulfillment centers). | integer |
InventorySummaries
Una lista de inventory summaries.
Tipo : < InventorySummary > array
Pagination
El proceso de devolver los resultados a una solicitud en lotes de un tamaño definido denominado páginas. Esto se hace para ejercer cierto control sobre el tamaño del resultado y el rendimiento general. Es una forma de gestión del tráfico.
| Nombre | Descripción | Esquema |
|---|---|---|
| nextToken opcional | Una string generada que se usa para recuperar la página siguiente del resultado. Si se devuelve nextToken, pase el valor de nextToken a la siguiente solicitud. Si no se devuelve nextToken, no hay más elementos para devolver. | string |
GetInventorySummariesResult
El esquema de payload para la operación getInventorySummaries.
| Nombre | Descripción | Esquema |
|---|---|---|
| granularity required | Describe una granularidad en la que se pueden agregar datos de inventario. Por ejemplo, si utiliza la granularidad de Marketplace, la cantidad completa reflejará el inventario que podría completarse en el marketplace determinado. | Granularity |
| inventorySummaries required | Una lista de inventory summaries. | InventorySummaries |
GetInventorySummariesResponse
The Response schema.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | La payload para la operación getInventorySummaries. | GetInventorySummariesResult |
| paginación opcional | El proceso de devolver los resultados a una solicitud en lotes de un tamaño definido denominado páginas. Esto se hace para ejercer cierto control sobre el tamaño del resultado y el rendimiento general. Es una forma de gestión del tráfico. | Pagination |
| errores opcional | Se produjeron uno o más errores inesperados durante la operación getInventorySummaries. | ErrorList |
Error
Se devolvió una respuesta de error cuando la solicitud no tuvo éxito.
| Nombre | Descripción | Esquema |
|---|---|---|
| código requerido | Un código de error que identifica el tipo de error que ocurrió. | string |
| mensaje opcional | Un mensaje que describe la condición de error en un formato legible por humanos. | string |
| detalles opcional | Información adicional que puede ayudar a la persona que llama a comprender o solucionar el problema. | string |
ErrorList
Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.
GranularityType
El granularityType para el nivel de agregación de inventario.
Tipo : enum
| Valor | Descripción |
|---|---|
| Marketplace | Marketplace |
Name
La duración de la investigación.
Tipo : enum
| Valor | Descripción |
|---|---|
| researchingQuantityInShortTerm | A corto plazo de 1 a 10 días. |
| researchingQuantityInMidTerm | Plazo medio de 11 a 20 días. |
| researchingQuantityInLongTerm | Largo Plazo por 21 días o más. |
Updated over 1 year ago