Keyword search
Each page consulted costs 1 credit and returns up to 12 products.
{
"target": "samsung.com.br",
"type": "plp",
"keyword": "geladeira",
"page": 1
} // docs
Search for Samsung products by keyword or URL, with prices, availability and pagination. Each PLP query costs 1 credit.
samsung.com.br:plp · 1 credit per request
Standard credit cost. Your account pricing is shown in the sandbox.
Try this operation in the sandboxSearch queries the catalog and may include parts and accessories related to the term. The example shows two items from a page of up to 12. Sorting and stock may change between requests. The catalog limits the result window to at most 208 accessible pages. Monetary values use BRL: price is the current price; regularPrice is the reference price; cashPrice is the lowest published one-installment offer, including Pix when specified. installmentPrice and installmentCount describe the largest interest-free credit card installment plan. Prices of unavailable offers are null. Coupons, device trade-ins and club discounts are not calculated.
curl -X POST https://api.geckoapi.com.br/v1/extract \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"target": "samsung.com.br",
"type": "plp",
"keyword": "geladeira",
"page": 1
}' Keep your API key on your server. See the quickstart for authentication and response handling.
The hosted MCP tool fixes target and type for this operation. Its remaining arguments use the same input rules as Extract.
POST /v1/mcp · Bearer or X-API-Key authentication
{
"jsonrpc": "2.0",
"id": 3,
"method": "tools/call",
"params": {
"name": "samsung_com_br_plp",
"arguments": {
"keyword": "geladeira",
"page": 1,
"executionId": "exec_example_123"
}
}
} Conditional fields depend on the alternatives and constraints in the rule column. Fields marked unsupported are omitted.
| Field | Type | Requirement | Rule | Default | Example |
|---|---|---|---|---|---|
| url URL extraction target. For some PLPs it can be omitted when API assembles URL from other fields. | string (URL) | Conditional | URL search shop.samsung.com/br/term?_q=term&map=ft. Mandatory when keyword is not sent. Categories and category filters are not supported. Tracking parameters are removed. | - | https://shop.samsung.com/br/geladeira?_q=geladeira&map=ft |
| keyword Keyword for PLP searches. In Google Search it represents the query sent to Google; in Booking PLP is mandatory; in other PLPs it can replace URL. | string | Conditional | Mandatory without URL; from 1 to 200 characters, without control characters or backslash. If shipped with URL, must match the term of URL. | - | geladeira |
| sort Ordering for VivaReal, Chaves na Mão, OLX and Webmotors PLP, Booking Review and Hotels Review. VivaReal: relevance/date/price/biggest_price/biggest_area. Webmotors: relevance/price/biggest_price/year_desc/mileage_asc. OLX: relevance/date/price/biggest_price/price_relevance. Booking/Hotels Review: most_relevant/newest_first/oldest_first/score_desc/score_asc. | "relevance" | "date" | "price" | "biggest_price" | "biggest_area" | "price_relevance" | "most_relevant" | "newest_first" | "oldest_first" | "score_desc" | "score_asc" | "year_desc" | "mileage_asc" | Optional | relevance, price, biggest_price, date or biggest_discount. In URL, accept order=OrderByScoreDESC, OrderByPriceASC, OrderByPriceDESC, OrderByReleaseDateDESC or OrderByBestDiscountDESC. | relevance | price |
| target Target source for extraction. | enum | Required | Use samsung.com.br. | samsung.com.br | samsung.com.br |
| type Extraction type: pdp, idp, plp, ilp, quote, review or places. | enum | Required | Use plp. | plp | plp |
| page Pagination. In PLP, including Trivago, and in Reclame AQUI ILP starts in 1; in review (MercadoLivre, Booking and Hotels) starts in 0. The Reclame AQUI ILP even accepts the page 100. | integer | Optional | Integer from 1 to 208. Up to 12 products per page; omit to use the page in URL, or 1. Use nextPageUrl to continue. | 1 | 1 |
Each page consulted costs 1 credit and returns up to 12 products.
{
"target": "samsung.com.br",
"type": "plp",
"keyword": "geladeira",
"page": 1
} page and sort sent in the payload have priority over the values of URL.
{
"target": "samsung.com.br",
"type": "plp",
"url": "https://shop.samsung.com/br/geladeira?_q=geladeira&map=ft",
"page": 2,
"sort": "price"
} Leaf paths and expected types. Field names and enum values are part of the API contract.
{
"requestId": "string",
"executionId": "string",
"data.source": "string",
"data.type": "string",
"data.url": "string",
"data.requestUrl": "string",
"data.extractedAt": "string",
"data.query": "string",
"data.sort": "string",
"data.totalResults": "number",
"data.totalPages": "number",
"data.page": "number",
"data.resultsPerPage": "number",
"data.offset": "number",
"data.nextPage": "number | null",
"data.nextPageUrl": "string | null",
"data.items[].url": "string",
"data.items[].productId": "string",
"data.items[].sku": "string",
"data.items[].name": "string",
"data.items[].available": "boolean | null",
"data.items[].price": "number | null",
"data.items[].regularPrice": "number | null",
"data.items[].cashPrice": "number | null",
"data.items[].installmentPrice": "number | null",
"data.items[].installmentCount": "number | null",
"data.items[].sellerId": "string | null",
"data.items[].sellerName": "string | null",
"data.items[].currency": "string",
"data.items[].currencyRaw": "string",
"data.items[].brand": "string | null",
"data.items[].thumbnail": "string | null",
"data.items[].aggregateRating": "null",
"data.items[].sponsored": "boolean"
} Illustrative response. Product names, reviews and other source content retain their original language. Missing and null values do not imply zero stock, free shipping or zero reviews.
{
"requestId": "d68564d2-34bc-47e6-a1a6-796794f8463b",
"executionId": "f7b0f7f6-3363-4958-9f7e-6c0e0d189874",
"data": {
"source": "samsung.com.br",
"type": "plp",
"url": "https://shop.samsung.com/br/geladeira?_q=geladeira&map=ft&page=1",
"requestUrl": "https://shop.samsung.com/br/geladeira?_q=geladeira&map=ft&page=1",
"extractedAt": "2026-10-01T12:17:13.588Z",
"query": "geladeira",
"sort": "relevance",
"totalResults": 100,
"totalPages": 9,
"page": 1,
"resultsPerPage": 12,
"offset": 0,
"nextPage": 2,
"nextPageUrl": "https://shop.samsung.com/br/geladeira?_q=geladeira&map=ft&page=2",
"items": [
{
"url": "https://shop.samsung.com/br/geladeira-samsung-duplex-rt42-inox-bivolt-415l/p?skuId=16004",
"productId": "13208",
"sku": "16004",
"name": "Geladeira Samsung Duplex RT42 Inox Bivolt 415L",
"available": true,
"price": 4525.27,
"regularPrice": 4525.27,
"cashPrice": 4299.01,
"installmentPrice": 251.4,
"installmentCount": 18,
"sellerId": "1",
"sellerName": "SAMSUNG ELETRÔNICA DA AMAZÔNIA LTDA.",
"currency": "BRL",
"currencyRaw": "R$",
"brand": "Samsung",
"thumbnail": "https://samsungbrshop.vteximg.com.br/arquivos/ids/296134/SA365_SMG_RT42C_Galeria_1000x1000_01_20260721.jpg?v=639220673517100000",
"aggregateRating": null,
"sponsored": false
},
{
"url": "https://shop.samsung.com/br/geladeira-samsung-duplex-rt47-inox-bivolt-465l/p?skuId=16005",
"productId": "13209",
"sku": "16005",
"name": "Geladeira Samsung Duplex RT47 Inox Bivolt 465L",
"available": true,
"price": 4899,
"regularPrice": 4899,
"cashPrice": 4899,
"installmentPrice": 272.16,
"installmentCount": 18,
"sellerId": "1",
"sellerName": "SAMSUNG ELETRÔNICA DA AMAZÔNIA LTDA.",
"currency": "BRL",
"currencyRaw": "R$",
"brand": "Samsung",
"thumbnail": "https://samsungbrshop.vteximg.com.br/arquivos/ids/296144/SA365_SMG_RT47C_Galeria_1000x1000_01_20260721.jpg?v=639220673657000000",
"aggregateRating": null,
"sponsored": false
}
]
}
} | Path | Type | Description | Example |
|---|---|---|---|
| data.extractedAt | string | Date and time of extraction in ISO 8601. | 2026-10-01T12:17:13.588Z |
| data.items[].aggregateRating | null | Aggregate evaluation; null because the catalog consulted does not provide evaluations. | null |
| data.items[].available | boolean | null | Availability of the selected SKU; null when the origin does not inform. | true |
| data.items[].brand | string | null | Product brand. | Samsung |
| data.items[].cashPrice | number | null | Lowest value in one installment published in the offer; does not imply discount on Pix. | 4299.01 |
| data.items[].currency | string | Offer currency: BRL. | BRL |
| data.items[].currencyRaw | string | Currency symbol: R$. | R$ |
| data.items[].installmentCount | number | null | Number of interest-free installments on credit cards for this option. | 18 |
| data.items[].installmentPrice | number | null | Value of the option installment with more interest-free installments on credit cards, when available. | 251.4 |
| data.items[].name | string | Name published by source. | Geladeira Samsung Duplex RT42 Inox Bivolt 415L |
| data.items[].price | number | null | Current price in reais; null when the offer is unavailable or unpriced. | 4525.27 |
| data.items[].productId | string | Product identifier in the Samsung catalog. | 13208 |
| data.items[].regularPrice | number | null | Reference price in reais, when informed. | 4525.27 |
| data.items[].sellerId | string | null | Offer seller identifier. | 1 |
| data.items[].sellerName | string | null | Name of the seller of the offer. | SAMSUNG ELETRÔNICA DA AMAZÔNIA LTDA. |
| data.items[].sku | string | Variation identifier (SKU); Different voltages may have different SKUs. | 16004 |
| data.items[].sponsored | boolean | false: Catalog search does not mark these results as sponsored. | false |
| data.items[].thumbnail | string | null | URL from SKU main image. | https://samsungbrshop.vteximg.com.br/arquivos/ids/296134/SA365_SMG_RT42C_Galeria_1000x1000_01_20260721.jpg?v=639220673517100000 |
| data.items[].url | string | URL; in the product, skuId identifies the selected variation. | https://shop.samsung.com/br/geladeira-samsung-duplex-rt42-inox-bivolt-415l/p?skuId=16004 |
| data.nextPage | number | null | Next page, or null at the end of pagination. | 2 |
| data.nextPageUrl | string | null | URL public next page, preserving search and sorting; null at the end. | https://shop.samsung.com/br/geladeira?_q=geladeira&map=ft&page=2 |
| data.offset | number | Starting position of the page in the catalog. | 0 |
| data.page | number | Page consulted, starting at 1. | 1 |
| data.query | string | Search keyword. | geladeira |
| data.requestUrl | string | URL public normalized search, same as url. | https://shop.samsung.com/br/geladeira?_q=geladeira&map=ft&page=1 |
| data.resultsPerPage | number | Page size: up to 12 products. | 12 |
| data.sort | string | Standard ordering: relevance, price, biggest_price, date or biggest_discount. | relevance |
| data.source | string | Source domain. | samsung.com.br |
| data.totalPages | number | Number of accessible pages, limited to 208. | 9 |
| data.totalResults | number | Total informed by the catalog for the search. | 100 |
| data.type | string | Extraction type. | plp |
| data.url | string | URL; in the product, skuId identifies the selected variation. | https://shop.samsung.com/br/geladeira?_q=geladeira&map=ft&page=1 |
| executionId | string | Identifier of the worker execution. | f7b0f7f6-3363-4958-9f7e-6c0e0d189874 |
| requestId | string | Request identifier HTTP in GeckoAPI. | d68564d2-34bc-47e6-a1a6-796794f8463b |
When supported by this operation, an entity not found upstream can return HTTP 200 with data: null and notFound: true. Check the documented response fields before interpreting an empty result. Source-specific behavior and exceptions are described above.
| HTTP status | Error code | Meaning |
|---|---|---|
| 400 | INVALID_PAYLOAD | Invalid JSON or a request that violates the documented validation rules. |
| 401 | UNAUTHORIZED | Missing authorization or an invalid API key or token. |
| 402 | INSUFFICIENT_CREDITS | The account has insufficient credits for this operation. |
| 403 | FORBIDDEN | The account does not have access, or the API is temporarily disabled. |
| 409 | EXECUTION_CONFLICT | The execution identifier conflicts with an incompatible execution state. |
| 429 | RATE_LIMIT_EXCEEDED / TOO_MANY_INFLIGHT_REQUESTS | A rate limit or simultaneous request limit was exceeded. |
| 5xx | UPSTREAM_TIMEOUT / UPSTREAM_HTTP_ERROR / WORKER_FUNCTION_ERROR | An upstream, worker or gateway failure. Failed requests follow the platform refund policy. |