> ## Documentation Index
> Fetch the complete documentation index at: https://docs.querying.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Rakuten API

> Busque produtos na loja Rakuten e leia as páginas de produto dela em JSON: posições com preços, notas e número de avaliações na busca, e preço, estoque, vendedor, imagens e opções em cada página de produto.

Busque produtos na loja Rakuten (rakuten.co.jp) e leia as páginas de produto dela pela API de tarefas assíncronas. Envie `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

```bash theme={"theme":"css-variables"}
curl -X POST https://api.querying.ai/v1/async/task \
  -H "Authorization: Bearer $QUERYING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskType": "COMMERCE_SERP", "payload": { "site": "rakuten", "query": "airpods", "limit": 3 } }'
```

Envie a tarefa e depois consulte `GET /v1/async/task/{id}` ou receba o webhook. Veja [Tarefas assíncronas](https://docs.querying.ai/pt/concepts/async-tasks.md).

### 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 com `422 REGION_UNSUPPORTED`.

Só os campos de payload listados acima são aceitos. Omita `include`: até `include: {}` retorna `422 VALIDATION_ERROR` em `payload.include` antes da reserva de créditos.

### Exemplo de resposta

```json theme={"theme":"css-variables"}
{
  "site": "rakuten",
  "query": "airpods",
  "country": "JP",
  "returnedCount": 3,
  "products": [
    {
      "rank": 1,
      "productId": "rakutenmobile-store:apple-rm2609008",
      "title": "【新登場】 Apple AirPods 5",
      "url": "https://item.rakuten.co.jp/rakutenmobile-store/apple-rm2609008/?variantId=apple-rm2609008",
      "price": 23800,
      "currency": "JPY",
      "rating": 5,
      "reviewCount": 10,
      "imageUrl": "https://thumbnail.image.rakuten.co.jp/@0_mall/rakutenmobile-store/cabinet/item/apple-rm2609008/main.jpg"
    },
    {
      "rank": 2,
      "productId": "rakutenmobile-store:apple-rm2609007",
      "title": "【新登場】 Apple ワイヤレス充電ケース付きAirPods 5",
      "url": "https://item.rakuten.co.jp/rakutenmobile-store/apple-rm2609007/?variantId=apple-rm2609007",
      "price": 27800,
      "currency": "JPY",
      "rating": 5,
      "reviewCount": 16,
      "imageUrl": "https://thumbnail.image.rakuten.co.jp/@0_mall/rakutenmobile-store/cabinet/item/apple-rm2609007/main.jpg"
    },
    {
      "rank": 3,
      "productId": "rakutenmobile-store:apple-rm2509012",
      "title": "Apple AirPods Pro 3",
      "url": "https://item.rakuten.co.jp/rakutenmobile-store/apple-rm2509012/?variantId=apple-rm2509012",
      "price": 42799,
      "currency": "JPY",
      "rating": 4.57,
      "reviewCount": 185,
      "imageUrl": "https://thumbnail.image.rakuten.co.jp/@0_mall/rakutenmobile-store/cabinet/item/apple-rm2509012/main_2606.jpg"
    }
  ]
}
```

### Campos do resultado

* `site`, `query` e `country` repetem a requisição. `returnedCount` é o número de itens em `products`.
* Cada produto inclui `rank`, `productId`, `title` e `url`. `productId` é `shop:item`, os IDs da loja e do item da página de produto. `rank` segue a ordem padrão da loja, e os anúncios que a loja marca como patrocinados ficam de fora.
* `price`, `rating`, `reviewCount` e `imageUrl` aparecem quando a página de resultados os mostra. `price` é um número na `currency` do produto (ISO 4217); quando os tamanhos têm preços diferentes, é o menor.
* `rating` usa 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

```bash theme={"theme":"css-variables"}
curl -X POST https://api.querying.ai/v1/async/task \
  -H "Authorization: Bearer $QUERYING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskType": "COMMERCE_PRODUCT", "payload": { "url": "https://item.rakuten.co.jp/rakutenmobile-store/apple-rm2609008/" } }'
```

### Parâmetros

* `url`: Obrigatório. Uma página de produto da loja Rakuten, com até 2.048 caracteres: `item.rakuten.co.jp/{shop}/{item}/`. As `url` de 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 com `422 REGION_UNSUPPORTED`.

Só os campos de payload listados acima são aceitos. Omita `include`: até `include: {}` retorna `422 VALIDATION_ERROR` em `payload.include` antes da reserva de créditos.

### Exemplo de resposta

```json theme={"theme":"css-variables"}
{
  "site": "rakuten",
  "country": "JP",
  "url": "https://item.rakuten.co.jp/rakutenmobile-store/apple-rm2609008/",
  "productId": "rakutenmobile-store:apple-rm2609008",
  "title": "【新登場】 Apple AirPods 5",
  "price": 23800,
  "currency": "JPY",
  "inStock": true,
  "seller": "楽天モバイル公式 楽天市場店",
  "rating": 5,
  "reviewCount": 10,
  "images": [
    "https://tshop.r10s.jp/rakutenmobile-store/cabinet/item/apple-rm2609008/main.jpg",
    "https://tshop.r10s.jp/rakutenmobile-store/cabinet/item/apple-rm2609008/pht-accessory-01.jpg"
  ],
  "descriptionImages": [
    "https://image.rakuten.co.jp/rakutenmobile-store/cabinet/product/common/pc/faq_pc.jpg",
    "https://image.rakuten.co.jp/rakutenmobile-store/cabinet/item/apple-rm2609008/pc-section01_1.jpg"
  ],
  "categories": ["TV・オーディオ・カメラ", "オーディオ", "ヘッドホン・イヤホン"]
}
```

### Campos do resultado

* `site`, `country`, `url` e `productId` identificam a página. `url` é a página lida, e `productId` é o mesmo que uma busca retorna.
* `title` sempre aparece. `price`, `currency`, `inStock`, `seller`, `rating`, `reviewCount`, `images`, `description`, `descriptionImages`, `options`, `categories` e `gtin` aparecem quando a página os mostra.
* `price` é o que um comprador paga conforme a página mostra ao abrir, antes de cupons e frete, em `currency` (ISO 4217). `inStock` é a disponibilidade do produto. `seller` é o lojista que o vende.
* `rating` usa uma escala de cinco pontos com duas casas decimais. `reviewCount` é o número de avaliações.
* `images` lista 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.
* `descriptionImages` lista 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.
* `options` lista até 20 escolhas, como tamanho ou cor, cada uma com até 100 `values`; os demais campos descrevem a escolha com que a página abre. `categories` vai 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 com `ENGINE_NO_RESULT`.
* Só as tarefas concluídas são cobradas: 0.5 crédito por busca ou página de produto.

## Relacionado

* [Yahoo! Shopping](https://docs.querying.ai/pt/engines/yahoo-shopping.md)
* [Qoo10](https://docs.querying.ai/pt/engines/qoo10.md)
* [Todas as lojas do Commerce](https://docs.querying.ai/pt/engines/overview.md#commerce)
* [Créditos e limites](https://docs.querying.ai/pt/concepts/credits-and-limits.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.