COMMERCE_SERP com site rakuten para receber os produtos que uma busca mostra, na ordem da loja, ou COMMERCE_PRODUCT com a url de um produto para ler esse produto. Cada busca ou página de produto concluída custa 0.5 crédito.
Busca
GET /v1/async/task/{id} ou receba o webhook. Veja Tarefas assíncronas.
Parâmetros
site: Obrigatório.rakuten.query: Obrigatório. Termo de busca, de 1 a 500 caracteres.limit: Inteiro opcional de 1 a 40, com padrão 20.country: Opcional. O padrão éJP, o país da loja. Qualquer outro país é recusado com422 REGION_UNSUPPORTED.
include: até include: {} retorna 422 VALIDATION_ERROR em payload.include antes da reserva de créditos.
Exemplo de resposta
Campos do resultado
site,queryecountryrepetem a requisição.returnedCounté o número de itens emproducts.- Cada produto inclui
rank,productId,titleeurl.productIdéshop:item, os IDs da loja e do item da página de produto.ranksegue a ordem padrão da loja, e os anúncios que a loja marca como patrocinados ficam de fora. price,rating,reviewCounteimageUrlaparecem quando a página de resultados os mostra.priceé um número nacurrencydo produto (ISO 4217); quando os tamanhos têm preços diferentes, é o menor.ratingusa uma escala de cinco pontos. Números de avaliações abreviados, como 999+, ficam de fora.- Cada busca retorna produtos da primeira página de resultados da loja.
Página de produto
Parâmetros
url: Obrigatório. Uma página de produto da loja Rakuten, com até 2.048 caracteres:item.rakuten.co.jp/{shop}/{item}/. Asurlde produto que uma busca retorna funcionam como estão. Os parâmetros que não afetam o resultado, como códigos de rastreamento, são removidos antes da leitura.country: Opcional. O padrão éJP, o país da página. Qualquer outro país é recusado com422 REGION_UNSUPPORTED.
include: até include: {} retorna 422 VALIDATION_ERROR em payload.include antes da reserva de créditos.
Exemplo de resposta
Campos do resultado
site,country,urleproductIdidentificam a página.urlé a página lida, eproductIdé o mesmo que uma busca retorna.titlesempre aparece.price,currency,inStock,seller,rating,reviewCount,images,description,descriptionImages,options,categoriesegtinaparecem quando a página os mostra.priceé o que um comprador paga conforme a página mostra ao abrir, antes de cupons e frete, emcurrency(ISO 4217).inStocké a disponibilidade do produto.selleré o lojista que o vende.ratingusa uma escala de cinco pontos com duas casas decimais.reviewCounté o número de avaliações.imageslista até 30 fotos da galeria do produto, na ordem da página. Banners ou avisos que o vendedor coloca nessa galeria vêm junto.descriptioné texto simples com uma linha por parágrafo, com até 10.000 caracteres; o texto que só aparece dentro de imagens não é incluído.descriptionImageslista até 300 imagens da descrição do produto, na ordem da página. Banners e avisos que os vendedores colocam na descrição vêm junto, e o texto dentro das imagens não é lido.optionslista até 20 escolhas, como tamanho ou cor, cada uma com até 100values; os demais campos descrevem a escolha com que a página abre.categoriesvai da categoria mais ampla à mais específica, com até 10 níveis.gtiné o UPC, EAN ou JAN que a página informa.
Erros e cobrança
- Uma busca que não retorna produtos termina como tarefa com falha.
- Uma página de produto que a loja responde com 404 ou 410, como um produto removido, encerra a tarefa com
PAGE_UNAVAILABLE, e a mensagem traz a resposta da loja. Se a loja recusar a leitura com 403, 412, 429 ou 435, a tarefa espera e tenta de novo por até 6 minutos. As demais leituras com falha, e uma recusa que dure mais, terminam comENGINE_NO_RESULT. - Só as tarefas concluídas são cobradas: 0.5 crédito por busca ou página de produto.