Especificações da API
O Selling Partner API para itens de catálogo fornece acesso programático a informações sobre itens no catálogo da Amazon.
Casos de uso
Usando a API de parceiros de vendas para itens do catálogo (API de itens do catálogo), você pode recuperar informações sobre os itens no catálogo da Amazon. Consulte a Referência da API de itens do catálogo para obter detalhes sobre as operações da API e os tipos de dados e esquemas associados.
Error
Resposta de erro retornada quando a solicitação não é bem-sucedida.
| Valor | Descrição |
|---|---|
| code Obrigatório Tipo: String | Um código de erro que identifica o tipo de erro ocorrido. |
| message Obrigatório Tipo: String | Uma mensagem que descreve a condição de erro. |
| details Obrigatório Tipo: String | Detalhes adicionais que podem ajudar o integrador a entender ou corrigir o problema. |
ErrorList
Uma lista de respostas de erro retornadas quando uma solicitação é malsucedida.
| Valor | Descrição |
|---|---|
| errors Obrigatório Tipo: < Error > array | Lista de erros |
Item
Um item no catálogo da Amazon.
| Valor | Descrição |
|---|---|
| asin Obrigatório Tipo: ItemAsin | O número de identificação padrão da Amazon (ASIN) é o identificador exclusivo de um item no catálogo da Amazon. |
| attributes Opcional Tipo: ItemAttributes | Um objeto JSON que contém dados de atributo de item estruturado codificados por nome de atributo. Os atributos do item do catálogo estão disponíveis apenas para proprietários de marcas e estão em conformidade com as definições de tipo de produto relacionadas disponíveis na API do parceiro de vendas para definições de tipo de produto. |
| identifiers Opcional Tipo: ItemIdentifiers | Identificadores associados ao item no catálogo da Amazon, como identificadores UPC e EAN. |
| images Opcional Tipo: ItemImages | Imagens de um item do catálogo da Amazon. Todas as variantes de imagem são fornecidas aos proprietários das marcas. Caso contrário, uma miniatura da variante da imagem "PRINCIPAL" é fornecida. |
| productTypes Opcional Tipo: ItemProductTypes | Tipos de produtos associados ao item do catálogo Amazon. |
| salesRanks Opcional Tipo: ItemSalesRanks | Classificações de vendas de um item do catálogo da Amazon. |
| summaries Opcional Tipo: ItemSummaries | Detalhes resumidos de um item do catálogo da Amazon. |
| variations Opcional Tipo: ItemVariations | Detalhes de variação por mercado para um item de catálogo da Amazon (relacionamentos de variação). |
| vendorDetails Opcional Tipo: ItemVendorDetails | Detalhes do fornecedor associados a um item do catálogo da Amazon. Os detalhes do fornecedor estão disponíveis apenas para fornecedores. |
ItemAsin
O número de identificação padrão da Amazon (ASIN) é o identificador exclusivo de um item no catálogo da Amazon.
Tipo: String
ItemAttributes
Um objeto JSON que contém dados de atributo de item estruturado codificados por nome de atributo. Os atributos do item do catálogo estão disponíveis apenas para proprietários de marcas e estão em conformidade com as definições de tipo de produto relacionadas disponíveis na API do parceiro de vendas para definições de tipo de produto.
Tipo: Objeto
ItemIdentifiers
Identificadores associados ao item no catálogo da Amazon, como identificadores UPC e EAN.
Tipo: < ItemIdentifiersByMarketplace > array
ItemIdentifiersByMarketplace
Identificadores associados ao item no catálogo da Amazon para o mercado da Amazon indicado.
| Valor | Descrição |
|---|---|
| marketplaceId Obrigatório Tipo: String | Identificador de mercado da Amazon. |
| identifiers Obrigatório Tipo: < ItemIdentifier > array | Identificadores associados ao item no catálogo da Amazon para o mercado da Amazon indicado. |
ItemIdentifier
Identificador associado ao item no catálogo da Amazon, como um identificador UPC ou EAN.
| Valor | Descrição |
|---|---|
| identifierType Obrigatório Tipo: String | Tipo de identificador, como UPC, EAN ou ISBN. |
| identifier Obrigatório Tipo: String | Identificador. |
ItemImages
Imagens de um item do catálogo da Amazon. Todas as variantes de imagem são fornecidas aos proprietários das marcas. Caso contrário, uma miniatura da variante da imagem "PRINCIPAL" é fornecida.
Tipo: < ItemImagesByMarketplace > array
ItemImagesByMarketplace
Imagens de um item no catálogo da Amazon para o mercado da Amazon indicado.
| Valor | Descrição |
|---|---|
| marketplaceId Obrigatório Tipo: String | Identificador de mercado da Amazon. |
| images Obrigatório Tipo: < ItemImage > array | Imagens de um item no catálogo da Amazon para o mercado da Amazon indicado. |
ItemImage
Imagem de um item do catálogo da Amazon.
| Valor | Descrição |
|---|---|
| variant Obrigatório Tipo: enum (Variant) | Variante da imagem, como MAIN ou PT01. Exemplo: "MAIN" |
| link Obrigatório Tipo: String | Link, ou URL, para a imagem. |
| height Obrigatório Tipo: Integer | Altura da imagem em pixels. |
| width Obrigatório Tipo: Integer | Largura da imagem em pixels. |
ItemProductTypes
Tipos de produtos associados ao item do catálogo Amazon.
Tipo: < ItemProductTypeByMarketplace > array
ItemProductTypeByMarketplace
Tipo de produto associado ao item do catálogo da Amazon para o mercado da Amazon indicado.
| Valor | Descrição |
|---|---|
| marketplaceId Obrigatório Tipo: Integer | Identificador de mercado da Amazon. |
| ranks Obrigatório Tipo: < ItemSalesRank > array | Classificações de vendas de um item do catálogo da Amazon para um mercado da Amazon. |
ItemSalesRank
Classificação de vendas de um item do catálogo da Amazon.
| Valor | Descrição |
|---|---|
| title Obrigatório Tipo: String | Título ou nome da classificação de vendas. |
| link Obrigatório Tipo: String | Link do site de varejo da Amazon correspondente, ou URL, para a classificação de vendas. |
| rank Obrigatório Tipo: Integer | Valor da classificação de vendas. |
ItemSummaries
Detalhes resumidos de um item do catálogo da Amazon.
Tipo: < ItemSummaryByMarketplace > array
ItemSummaryByMarketplace
Detalhes resumidos de um item do catálogo da Amazon para o mercado da Amazon indicado.
| Nome | Descrição |
|---|---|
| marketplaceId Obrigatório Tipo: String | Identificador de mercado da Amazon. |
| brandName Opcional Tipo: String | Nome da marca associada a um item do catálogo da Amazon. |
| browseNode Opcional Tipo: String | Identificador do nó de navegação associado a um item do catálogo Amazon. |
| colorName Opcional Tipo: String | Nome da cor associada a um item do catálogo Amazon. |
| itemName Opcional Tipo: String | Nome, ou título, associado a um item do catálogo da Amazon. |
| manufacturer Opcional Tipo: String | Nome do fabricante associado a um item do catálogo da Amazon. |
| modelNumber Opcional Tipo: String | Número do modelo associado a um item do catálogo da Amazon. |
| sizeName Opcional Tipo: String | Nome do tamanho associado a um item do catálogo da Amazon. |
| styleName Opcional Tipo: String | Nome do estilo associado a um item do catálogo Amazon. |
ItemVariations
Detalhes de variação por mercado para um item de catálogo da Amazon (relacionamentos de variação).
Tipo: < ItemVariationsByMarketplace > array
ItemVariationsByMarketplace
Detalhes de variação para o item do catálogo Amazon para o mercado Amazon indicado.
| Valor | Descrição |
|---|---|
| marketplaceId Obrigatório Tipo: String | Identificador de mercado da Amazon. |
| asins Obrigatório Tipo: < String > array | Identificadores (ASINs) dos itens relacionados. |
| variationType Obrigatório Tipo: enum (VariationType) | Tipo de relação de variação do item do catálogo Amazon na solicitação para o (s) item (ns) relacionado (s): "PARENT" ou "CHILD". Exemplo: "PARENT" |
ItemVendorDetails
Detalhes do fornecedor associados a um item do catálogo da Amazon. Os detalhes do fornecedor estão disponíveis apenas para fornecedores.
Tipo: < ItemVendorDetailsByMarketplace > array
ItemVendorDetailsByMarketplace
Detalhes do fornecedor associados a um item do catálogo da Amazon para o mercado da Amazon indicado.
| marketplaceId Obrigatório Tipo: String | Identificador de mercado da Amazon. |
| brandCode Opcional Tipo: String | Código da marca associado a um item do catálogo da Amazon. |
| categoryCode Opcional Tipo: String | Categoria de produto associada a um item do catálogo da Amazon. |
| manufacturerCode Opcional Tipo: String | Código do fabricante associado a um item do catálogo da Amazon. |
| manufacturerCodeParent Opcional Tipo: String | Código do fornecedor pai do código do fabricante |
| productGroup Opcional Tipo: String | Grupo de produtos associado a um item do catálogo da Amazon. |
| replenishmentCategory Opcional Tipo: enum (ReplenishmentCategory) | Categoria de reabastecimento associada a um item do catálogo da Amazon. |
| subcategoryCode Opcional Tipo: String | Subcategoria de produto associada a um item de catálogo da Amazon. |
ItemSearchResults
Itens no catálogo da Amazon e meta dados relacionados à pesquisa.
| Valor | Descrição |
|---|---|
| numberOfResults Obrigatório Tipo: Integer | O número total estimado de produtos correspondidos pela consulta de pesquisa (apenas os resultados até o limite de contagem de páginas serão retornados por solicitação, independentemente do número encontrado). Nota: O número máximo de itens (ASINs) que podem ser retornados e paginados é 1000. |
| pagination Obrigatório Tipo: Pagination | Se disponíveis, os valores nextToken e / ou previousToken necessários para retornar resultados paginados. |
| refinements Obrigatório Tipo: Refinements | Refinamentos de pesquisa. |
| items Obrigatório Tipo: < Item > array | Uma lista de itens do catálogo da Amazon. |
Pagination
Quando uma solicitação produz uma resposta que excede o pageSize, ocorre a paginação. Isso significa que a resposta é dividida em páginas individuais. Para recuperar a próxima página ou a página anterior, você deve passar o valor nextToken ou o valor previousToken como o parâmetro pageToken na próxima solicitação. Quando você receber a última página, não haverá a chave nextToken no objeto de paginação.
| Valor | Descrição |
|---|---|
| nextToken Opcional Tipo: String | Um token que pode ser usado para buscar a próxima página. |
| previousToken Opcional Tipo: String | Um token que pode ser usado para buscar a página anterior. |
Refinements
Refinamentos de pesquisa.
| Valor | Descrição |
|---|---|
| brands Obrigatório Tipo: < BrandRefinement > array | Refinamentos de pesquisa de marca. |
| classifications Obrigatório Tipo: < ClassificationRefinement > array | Refinamentos da pesquisa de classificação. |
BrandRefinement
Descrição de uma marca que pode ser usada para obter resultados de pesquisa mais refinados.
| Valor | Descrição |
|---|---|
| numberOfResults Obrigatório Tipo: Integer | O número estimado de resultados que ainda seriam retornados se a chave de refinamento fosse aplicada. |
| brandName Obrigatório Tipo: String | Marca. Para exibição e pode ser usado como um refinamento de pesquisa. |
ClassificationRefinement
Descrição de uma classificação que pode ser usada para obter resultados de pesquisa mais refinados.
| Valor | Descrição |
|---|---|
| numberOfResults Obrigatório Tipo: Integer | O número estimado de resultados que ainda seriam retornados se a chave de refinamento fosse aplicada. |
| displayName Obrigatório Tipo: String | Nome de exibição para a classificação. |
| classificationId Obrigatório Tipo: String | Identificador da classificação que pode ser usado para fins de refinamento de pesquisa. |
Variant
Variante da imagem, como MAIN ou PT01.
Tipo: enum
| Valor | Descrição |
|---|---|
| MAIN | Imagem principal do item. |
| PT01 | Outra imagem #1 para o item. |
| PT02 | Outra imagem #2 para o item. |
| PT03 | Outra imagem #3 para o item. |
| PT04 | Outra imagem #4 para o item. |
| PT05 | Outra imagem #5 para o item. |
| PT06 | Outra imagem #6 para o item. |
| PT07 | Outra imagem #7 para o item. |
| PT08 | Outra imagem #8 para o item. |
| SWCH | Imagem de amostra para o item. |
VariationType
Tipo de relação de variação do item do catálogo Amazon na solicitação para o (s) item (ns) relacionado (s): "PARENT" ou "CHILD".
Tipo: enum
| Valor | Descrição |
|---|---|
| PARENT | O item do catálogo Amazon na solicitação é um pai de variação do (s) item (ns) relacionado (s) indicado (s) por ASIN. |
| CHILD | O item do catálogo Amazon na solicitação é um filho de variação do item relacionado identificado por ASIN. |
ReplenishmentCategory
Categoria de reabastecimento associada a um item do catálogo da Amazon.
Tipo: enum
| Valor | Descrição |
|---|---|
| ALLOCATED | Indica a compra não automatizada de estoque que foi alocado para a Amazon pelo fornecedor. |
| BASIC_REPLENISHMENT | Indica a compra não automatizada de estoque. |
| IN_SEASON | Indica a compra não automatizada de estoque para itens sazonais. |
| LIMITED_REPLENISHMENT | Retendo o status de reabastecimento da fila antes que um item seja NEW_PRODUCT. |
| MANUFACTURER_OUT_OF_STOCK | Indica que o fornecedor está fora de estoque por um longo período e não pode fazer pedidos em espera. |
| NEW_PRODUCT | Indica um novo item que a Amazon ainda não possui em estoque. |
| NON_REPLENISHABLE | Indica o pai do sortimento usado para exibição da página de detalhes, não itens reais. |
| NON_STOCKUPABLE | Indica estoque de envio direto que a Amazon não armazena em seus centros de distribuição. |
| OBSOLETE | Indica que o item está obsoleto e não deve ser pedido. |
| PLANNED_REPLENISHMENT | Indica itens ativos que devem ser pedidos automaticamente. |
IncludedData
Tipo: enum
- Para uso com a (s) operação (ões): searchCatalogItems
| Valor | Descrição |
|---|---|
| identifiers | Identificadores associados ao item no catálogo da Amazon, como identificadores UPC e EAN. |
| images | Imagens de um item do catálogo da Amazon. Todas as variantes de imagem são fornecidas aos proprietários das marcas; caso contrário, uma miniatura da variante da imagem "MAIN" é fornecida. |
| productTypes | Tipos de produtos associados ao item do catálogo Amazon. |
| salesRanks | Classificações de vendas de um item do catálogo da Amazon. |
| summaries | Detalhes resumidos de um item do catálogo da Amazon. |
| variations | Detalhes de variação de um item de catálogo da Amazon (relacionamentos de variação). |
| vendorDetails | Detalhes do fornecedor associados a um item do catálogo da Amazon. Os detalhes do fornecedor estão disponíveis apenas para fornecedores. |
- Para uso com a (s) operação (ões): getCatalogItem
| Valor | Descrição |
|---|---|
| attributes | Um objeto JSON contendo dados de atributo de item estruturado codificados por nome de atributo. Os atributos de item do catálogo estão disponíveis apenas para proprietários de marcas e estão em conformidade com as definições de tipo de produto da Amazon disponíveis na API de parceiro de venda para definições de tipo de produto. |
| identifiers | Identificadores associados ao item no catálogo da Amazon, como identificadores UPC e EAN. |
| images | Imagens de um item do catálogo da Amazon. Todas as variantes de imagem são fornecidas aos proprietários das marcas; caso contrário, uma miniatura da variante da imagem "MAIN" é fornecida. |
| productTypes | Tipos de produtos associados ao item do catálogo Amazon. |
| salesRanks | Classificações de vendas de um item do catálogo da Amazon. |
| summaries | Detalhes resumidos de um item do catálogo da Amazon. |
| variations | Detalhes de variação de um item de catálogo da Amazon (relacionamentos de variação). |
| vendorDetails | Detalhes do fornecedor associados a um item do catálogo da Amazon. Os detalhes do fornecedor estão disponíveis apenas para fornecedores. |