Referencia de la Catalog Items API v2020-12-01
Cómo utilizar la API de items del catálogo.
Descripción general
La Selling Partner API para items del catálogo proporciona acceso programático a información sobre items en el catálogo de Amazon.
Para obtener más información, consulte la Guía de casos de uso de la API de elementos del catálogo .
Información de versión
Versión : 2020-12-01
Información del contacto
Contacto : Soporte para desarrolladores de la 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
Schema URI
Anfitrión : sellingpartnerapi-na.amazon.com
Schemas : HTTPS
consume
application/json
produce
application/json
Operaciones
searchCatalogItems
getCatalogItem
Rutas
GET /catalog/2020-12-01/items
Operación: searchCatalogItems
Descripción
Busque y devuelva una lista de items del catálogo de Amazon e información asociada.
Planes de uso:
| Tasa (solicitudes por segundo) | Burst |
|---|---|
| 2 | 2 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tasa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica los valores por defecto de tasa y ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden observar valores de tasa y ráfaga más altos que los mostrados aquí. Para obtener más información, consulta la documentación correspondiente. Planes de uso y límites de tasa en la SP-API.
Parámetros
| Tipo | Nombre | Descripción | Schema | Default |
|---|---|---|---|---|
| Query | keywords opcional | Una lista de palabras delimitadas por comas para buscar en el catálogo de Amazon. | array (csv) | - |
| Query | marketplaceIds requerido | Una lista delimitada por comas de identificadores de marketplace de Amazon para la solicitud. Número máximo : 1 | array (csv) | - |
| Query | includedData opcional | Una lista delimitada por comas de conjuntos de datos para incluir en la respuesta. Default: summaries | < enum ( IncludedData ) > array(csv) | "[\"summaries\"]" |
| Query | brandNames opcional | Una lista delimitada por comas de marcas para limitar la búsqueda de Querys basadas en keywords . | array (csv) | - |
| Query | classificationIds opcional | Una lista delimitada por comas de identificadores de clasificación para limitar la búsqueda. | array (csv) | - |
| Query | pageSize opcional | Número de resultados a devolver por página. Máximo : 20 | integer | 10 |
| Query | pageToken opcional | Un token para buscar una página determinada cuando hay varias páginas de resultados. | string | - |
| Query | keywordsLocale opcional | El idioma de las palabras clave proporcionadas para Querys basadas en keywords . El valor predeterminado es la configuración regional principal del marketplace. | string | - |
| Query | locale opcional | Configuración regional para recuperar summaries localizados. El valor predeterminado es la configuración regional principal del marketplace. | string | - |
Respuestas
| Código HTTP | Descripción | Schema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): identificador de referencia de solicitud único. | ItemSearchResults |
Para códigos de estado de error, descripciones y Schemas, consulte Respuestas y Schemas de error .
consume
application/json
produce
application/json
GET /catalog/2020-12-01/items/{asin}
Operación: getCatalogItem
Descripción
Recupera detalles de un item en el catálogo de Amazon.
Plan de uso:
| Tasa (solicitudes por segundo) | Burst |
|---|---|
| 2 | 2 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tasa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica los valores de tasa y ráfaga predeterminados para esta operación. Los Selling partners cuyas necesidades comerciales requieran un mayor rendimiento pueden observar valores de tasa y ráfaga más altos que los mostrados aquí. Para obtener más información, consulta la documentación sobre limitación de tasa en la Guía del desarrollador de AWS.Planes de uso y límites de tasa en la SP-API.
Parámetros
| Tipo | Nombre | Descripción | Schema |
|---|---|---|---|
| Path | asin requerido | El Standard Identification Number (ASIN) del item. | string |
| Query | marketplaceIds requerido | Una lista delimitada por comas de identificadores de marketplace de Amazon. Los conjuntos de datos en la respuesta contienen datos solo para los marketplaces especificados. | array (csv) |
| Query | includedData opcional | Una lista delimitada por comas de conjuntos de datos para incluir en la respuesta. Default: summaries | < enum ( IncludedData ) > array(csv) |
| Query | locale opcional | Configuración regional para recuperar summaries localizados. El valor predeterminado es la configuración regional principal del marketplace. | string |
Respuestas
| Código HTTP | Descripción | Schema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string): su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): identificador de referencia de solicitud único. | Item |
Para códigos de estado de error, descripciones y Schemas, consulte Respuestas y Schemas de error .
consume
application/json
produce
application/json
Respuestas de error y Schemas
Esta tabla contiene códigos de estado HTTP e información asociada para respuestas de error.
| Código HTTP | Descripción | Schema |
|---|---|---|
| 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): identificador de referencia de solicitud único. | Lista de errores |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string): identificador de referencia de solicitud único. | Lista de errores |
| 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): identificador de referencia de solicitud único. | Lista de errores |
| 413 | El tamaño de la solicitud excedió el tamaño máximo aceptado. Headers : x-amzn-RequestId (string): identificador de referencia de solicitud único. | Lista de errores |
| 415 | La carga útil de la solicitud está en un formato no admitido. Headers : x-amzn-RequestId (string): identificador de referencia de solicitud único. | Lista de errores |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RequestId (string): identificador de referencia de solicitud único. | Lista de errores |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : x-amzn-RequestId (string): identificador de referencia de solicitud único. | Lista de errores |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RequestId (string): identificador de referencia de solicitud único. | Lista de errores |
Definiciones
Error
Respuesta de error devuelta cuando la solicitud no tiene éxito.
| Nombre | Descripción | Schema |
|---|---|---|
| código requerido | Un código de error que identifica el tipo de error que ocurrió. | string |
| mensaje requerido | Un mensaje que describe la condición de error. | string |
| detalles opcional | Detalles adicionales que pueden ayudar a la persona que llama a comprender o solucionar el problema. | string |
Lista de errores
Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.
Item
Un Item en el catálogo de Amazon.
| Nombre | Descripción | Schema |
|---|---|---|
| asin requerido | El Standard Identification Number (ASIN) es el identificador único de un item en el catálogo de Amazon. | ItemAsin |
| attributes opcional | Un objeto JSON que contiene datos de atributos de elementos estructurados con clave por nombre de atributo. Los atributos de los items del catálogo se ajustan a las definiciones de tipos de productos relacionados disponibles en la Selling Partner API para definiciones de tipos de productos. | ItemAttributes |
| identifiers opcional | Identificadores asociados con el item en el catálogo de Amazon, como los identificadores UPC y EAN. | ItemIdentifiers |
| images opcional | Imágenes de un item en el catálogo de Amazon. | ItemImages |
| productTypes opcional | Tipos de productos asociados con el item del catálogo de Amazon. | ItemProductTypes |
| salesRanks opcional | Clasificación de ventas de un item del catálogo de Amazon. | ItemSalesRanks |
| summaries opcional | Resumen de detalles de un item del catálogo de Amazon. | ItemSummaries |
| vendorDetails opcional | Detalles del Vendor asociado con un item del catálogo de Amazon. Los detalles del Vendor están disponibles solo para los Vendors. | ItemVendorDetails |
ItemAsin
El Standard Identification Number (ASIN) es el identificador único de un item en el catálogo de Amazon.
Tipo : string
ItemAttributes
Un objeto JSON que contiene datos de atributos de elementos estructurados con clave por nombre de atributo. Los atributos de los items del catálogo se ajustan a las definiciones de tipos de productos relacionados disponibles en la Selling Partner API para definiciones de tipos de productos.
Tipo : objeto
ItemIdentifiers
Identificadores asociados con el item en el catálogo de Amazon, como los identificadores UPC y EAN.
Tipo : < ItemIdentifiersByMarketplace > array
ItemIdentifiersByMarketplace
Identificadores asociados con el item en el catálogo de Amazon para el marketplace de Amazon indicado.
| Nombre | Descripción | Schema |
|---|---|---|
| marketplaceId requerido | Identificador del marketplace de Amazon. | string |
| identifiers requerido | Identificadores asociados con el item en el catálogo de Amazon para el marketplace de Amazon indicado. | < ItemIdentifier > array |
ItemIdentifier
Identificador asociado al item en el catálogo de Amazon, como un identificador UPC o EAN.
| Nombre | Descripción | Schema |
|---|---|---|
| identifierType requerido | Tipo de identificador, como UPC, EAN o ISBN. | string |
| identifier requerido | Identificador. | string |
ItemImages
Imágenes de un item en el catálogo de Amazon.
ItemImagesByMarketplace
Imágenes de un item en el catálogo de Amazon para el marketplace de Amazon indicado.
| Nombre | Descripción | Schema |
|---|---|---|
| marketplaceId requerido | Identificador del marketplace de Amazon. | string |
| images requerido | Imágenes de un item en el catálogo de Amazon para el marketplace de Amazon indicado. | < ItemImage > array |
ItemImage
Imagen de un item en el catálogo de Amazon.
| Nombre | Descripción | Schema |
|---|---|---|
| variant requerido | Variante de la imagen, como MAIN o PT01 . Ejemplo : "MAIN" | enum ( Variant ) |
| link requerido | link, o URL, para la imagen. | string |
| height requerido | Altura de la imagen en píxeles. | integer |
| width requerido | Ancho de la imagen en píxeles. | integer |
ItemProductTypes
Tipos de productos asociados con el item del catálogo de Amazon.
Tipo : < ItemProductTypeByMarketplace > array
ItemProductTypeByMarketplace
Tipo de producto asociado con el item del catálogo de Amazon para el marketplace de Amazon indicado.
| Nombre | Descripción | Schema |
|---|---|---|
| marketplaceId opcional | Identificador del marketplace de Amazon. | string |
| productType opcional | Nombre del tipo de producto asociado al item del catálogo de Amazon. Ejemplo : "LUGGAGE" | string |
ItemSalesRanks
Clasificación de ventas de un item del catálogo de Amazon.
Tipo : < ItemSalesRanksByMarketplace > array
ItemSalesRanksByMarketplace
Rangos de ventas de un item del catálogo de Amazon para el marketplace de Amazon indicado.
| Nombre | Descripción | Schema |
|---|---|---|
| marketplaceId requerido | Identificador del marketplace de Amazon. | string |
| ranks requerido | Rangos de ventas de un item del catálogo de Amazon para un marketplace de Amazon. | < ItemSalesRank > array |
ItemSalesRank
Rango de ventas de un item del catálogo de Amazon.
| Nombre | Descripción | Schema |
|---|---|---|
| title requerido | Título, o nombre, del rango de ventas. | string |
| link opcional | link o URL del website minorista de Amazon correspondiente para el rango de ventas. | string |
| rank requerido | Valor de rango de ventas. | integer |
ItemSummaries
Resumen de detalles de un item del catálogo de Amazon.
Tipo : < ItemSummaryByMarketplace > array
ItemSummaryByMarketplace
Detalles resumidos de un item del catálogo de Amazon para el marketplace de Amazon indicado.
| Nombre | Descripción | Schema |
|---|---|---|
| marketplaceId requerido | Identificador del marketplace de Amazon. | string |
| brandName opcional | Nombre de la marca asociada a un item del catálogo de Amazon. | string |
| colorName opcional | Nombre del color asociado a un item del catálogo de Amazon. | string |
| itemName opcional | Nombre, o título, asociado con un item del catálogo de Amazon. | string |
| manufacturer opcional | Nombre del fabricante asociado a un item del catálogo de Amazon. | string |
| modelNumber opcional | Número de modelo asociado con un item del catálogo de Amazon. | string |
| sizeName opcional | Nombre de la talla asociada a un item del catálogo de Amazon. | string |
| styleName opcional | Nombre del estilo asociado a un item del catálogo de Amazon. | string |
ItemVariations
Detalles de variación por marketeplace para un item del catálogo de Amazon (relaciones de variación).
Tipo: < ItemVariationsByMarketplace > array
ItemVariationsByMarketplace
Detalles de la variación del item del catálogo de Amazon para el marketeplace de Amazon indicado.
| Nombre | Descripción | Schema |
|---|---|---|
| marketplaceId requerido | Identificador del marketeplace de Amazon. | array |
| asins requerido | Identificadores (ASIN) de los items relacionados. | < string > array |
| variationType requerido | Tipo de relación de variación del artículo del catálogo de Amazon en la solicitud con el(los) artículo(s) relacionado(s): "PARENT" o "CHILD". Ejemplo : "PARENT" | enum (VariationType) |
ItemVendorDetails
Detalles del Vendor asociado con un item del catálogo de Amazon. Los detalles del Vendor están disponibles solo para los Vendors.
Tipo : < ItemVendorDetailsByMarketplace > array
ItemVendorDetailsByMarketplace
Detalles del Vendor asociados con un item del catálogo de Amazon para el marketplace de Amazon indicado.
| Nombre | Descripción | Schema |
|---|---|---|
| marketplaceId requerido | Identificador del marketplace de Amazon. | string |
| brandCode opcional | Código de marca asociado a un item del catálogo de Amazon. | string |
| categoryCode opcional | Categoría de producto asociada a un item del catálogo de Amazon. | string |
| manufacturerCode opcional | Código de fabricante asociado a un item del catálogo de Amazon. | string |
| manufacturerCodeParent opcional | Código de Vendor principal del código de fabricante. | string |
| productGroup opcional | Grupo de productos asociado a un item del catálogo de Amazon. | string |
| replenishmentCategory opcional | Categoría de reposición asociada con un item del catálogo de Amazon. | enum ( ReplenishmentCategory ) |
| subcategoryCode opcional | Subcategoría de producto asociada a un item del catálogo de Amazon. | string |
ItemSearchResults
items en el catálogo de Amazon y metadatos relacionados con la búsqueda.
| Nombre | Descripción | Schema |
|---|---|---|
| numberOfResults requerido | Para búsquedas basadas en identifiers , el número total de items del catálogo de Amazon encontrados. Para búsquedas basadas en keywords , el número total estimado de elementos del catálogo de Amazon que coincidieron con la Query de búsqueda (solo se devolverán resultados por solicitud hasta el límite de recuento de páginas, independientemente del número encontrado). Nota: La cantidad máxima de items (ASIN) que se pueden devolver y paginar es 1000. | integer |
| pagination requerido | Si está disponible, el nextToken y/o Se requieren valores previousToken para devolver resultados paginados. | Pagination |
| refinements requerido | Buscar refinamientos para Búsquedas basadas en keywords . | Refinements |
| items requerido | Una lista de items del catálogo de Amazon. | < Item > array |
Pagination
Cuando una solicitud produce una respuesta que excede el pageSize , se produce la paginación. Esto significa que la respuesta se divide en páginas individuales. Para recuperar la página siguiente o la página anterior, debe pasar el valor nextToken o el valor previousToken como el parámetro pageToken en la siguiente solicitud. Cuando reciba la última página, no habrá tecla nextToken en el objeto de paginación.
| Nombre | Descripción | Schema |
|---|---|---|
| nextToken opcional | Un token que se puede usar para obtener la página siguiente. | string |
| previousToken opcional | Un token que se puede usar para recuperar la página anterior. | string |
Refinements
Refinamientos de búsqueda.
| Nombre | Descripción | Schema |
|---|---|---|
| brands requerido | Refinamientos de búsqueda de marca. | < BrandRefinement > array |
| classifications requerido | Refinamientos de búsqueda de clasificación. | < ClassificationRefinement > array |
BrandRefinement
Descripción de una marca que se puede utilizar para obtener resultados de búsqueda más detallados.
| Nombre | Descripción | Schema |
|---|---|---|
| numberOfResults requerido | El número estimado de resultados que aún se devolverían si se aplicara la clave de refinamiento. | integer |
| brandName requerido | Nombre de la marca. Para mostrar y se puede utilizar como un refinamiento de búsqueda. | string |
ClassificationRefinement
Descripción de una clasificación que se puede utilizar para obtener resultados de búsqueda más detallados.
| Nombre | Descripción | Schema |
|---|---|---|
| numberOfResults requerido | El número estimado de resultados que aún se devolverían si se aplicara la clave de refinamiento. | integer |
| displayName requerido | Nombre para mostrar de la clasificación. | string |
| classificationId requerido | Identificador de la clasificación que se puede utilizar para fines de refinamiento de búsqueda. | string |
Variant
Variante de la imagen, como MAIN o PT01 .
Tipo : enum
| Valor | Descripción |
|---|---|
| MAIN | Imagen principal del item. |
| PT01 | Otra imagen #1 para el item. |
| PT02 | Otra imagen #2 para el item. |
| PT03 | Otra imagen #3 para el item. |
| PT04 | Otra imagen #4 para el item. |
| PT05 | Otra imagen #5 para el item. |
| PT06 | Otra imagen #6 para el item. |
| PT07 | Otra imagen #7 para el item. |
| PT08 | Otra imagen #8 para el item. |
| SWCH | Imagen de muestra del item. |
VariationType
Tipo de relación de variación del item del catálogo de Amazon en la solicitud con el(los) item(s) relacionado(s): "PARENT" o "PARENT".
Tipo : enum
| Valor | Descripción |
|---|---|
| PARENT | El item del catálogo de Amazon en la solicitud es una variación principal de los items relacionados indicados por el ASIN. |
| CHILD | El item del catálogo de Amazon en la solicitud es una variación secundaria del items relacionados indicados por el ASIN. |
ReplenishmentCategory
Categoría de reposición asociada con un item del catálogo de Amazon.
Tipo : enum
| Valor | Descripción |
|---|---|
| ALLOCATED | Indica la compra no automatizada de inventario que el Vendor ha asignado a Amazon. |
| BASIC_REPLENISHMENT | Indica compras no automatizadas de inventario. |
| IN_SEASON | Indica la compra no automatizada de inventario para items de temporada. |
| LIMITED_REPLENISHMENT | Mantener el estado de reposición de la cola antes de que se envíe un item NEW_PRODUCT . |
| MANUFACTURER_OUT_OF_STOCK | Indica que el Vendor está agotado por un período de tiempo más largo y no puede hacer un pedido pendiente. |
| NEW_PRODUCT | Indica un item nuevo que Amazon aún no tiene en inventario. |
| NON_REPLENISHABLE | Indica el surtido principal utilizado para mostrar la página de detalles, no los items reales. |
| NON_STOCKUPABLE | Indica inventario de envío directo que Amazon no almacena en sus centros logísticos. |
| OBSOLETE | Indica que el item está obsoleto y no se debe pedir. |
| PLANNED_REPLENISHMENT | Indica items activos que deben ordenarse automáticamente. |
IncludedData
Tipo : enum
Para usar con las operaciones: searchCatalogItems
| Valor | Descripción |
|---|---|
| attributes | Un objeto JSON que contiene datos de atributos de elementos estructurados con clave por nombre de atributo. Los atributos de los items del catálogo se ajustan a las definiciones de tipos de productos de Amazon relacionados disponibles en la Selling Partner API para definiciones de tipos de productos. |
| dimensions | Dimensions de un item en el catálogo de Amazon. |
| identifiers | Identificadores asociados con el item en el catálogo de Amazon, como los identificadores UPC y EAN. |
| images | Imágenes de un item en el catálogo de Amazon. |
| productTypes | Tipos de productos asociados con el item del catálogo de Amazon. |
| relationships | Detalles de la relación de un item del catálogo de Amazon (por ejemplo, variaciones). |
| salesRanks | Clasificación de ventas de un item del catálogo de Amazon. |
| summaries | Resumen de detalles de un item del catálogo de Amazon. Referirse a atributos de un item del catálogo de Amazon para obtener más detalles. |
| vendorDetails | Detalles del Vendor asociado con un item del catálogo de Amazon. Los detalles del Vendor están disponibles solo para los Vendors. |
Para usar con la(s) operación(es): getCatalogItem
| Valor | Descripción |
|---|---|
| attributes | Un objeto JSON que contiene datos de atributos de elementos estructurados con clave por nombre de atributo. Los atributos de los items del catálogo se ajustan a las definiciones de tipos de productos de Amazon relacionados disponibles en la Selling Partner API para definiciones de tipos de productos. |
| dimensions | Dimensions de un item en el catálogo de Amazon. |
| identifiers | Identificadores asociados con el item en el catálogo de Amazon, como los identificadores UPC y EAN. |
| images | Imágenes de un item en el catálogo de Amazon. |
| productTypes | Tipos de productos asociados con el item del catálogo de Amazon. |
| relationships | Detalles de la relación de un item del catálogo de Amazon (por ejemplo, variaciones). |
| salesRanks | Clasificación de ventas de un item del catálogo de Amazon. |
| summaries | Resumen de detalles de un item del catálogo de Amazon. Consulte los "atributos" de un item del catálogo de Amazon para obtener más detalles. |
| vendorDetails | Detalles del Vendor asociado con un item del catálogo de Amazon. Los detalles del Vendor están disponibles solo para los Vendors. |
Updated over 1 year ago