/magazineluiza/products/search

POST /api/magazineluiza/products/search

Price: 5 credits

Search Magazine Luiza (Magalu) products by keyword with optional facet filters and sorting. Returns products with price, installments, rating, seller and category.

How to use it

Search Magalu products by keyword (term). Returns a list of products with name, brand, image, price, list_price, discount, installments, rating, seller and category. Sort with sort (relevance, price_asc, price_desc, best_selling, rating, release_date, shipping_time). Narrow with filters (each a filter_type + value, e.g. brand=apple, seller=magazineluiza, price, delivery_magalu, or attribute slugs like modelo/cor); available filter values per query appear in the response. Optionally pass a zipcode (CEP).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• zipcode string nullable — Brazilian ZIP code (CEP) for locality-aware pricing and availability (examples: "01310100")
• term string required — Search keyword (examples: "iphone"; minLength: 1)
• count integer required — Max number of results (min: 1)
• sort string nullable — Result ordering (one of: "relevance", "shipping_time", "price_asc", "price_desc", "best_selling", "rating", "release_date")
• filters array — Facet filters to narrow the search (default: [])
  • filter_type string required — Filter dimension: brand, seller, category, price, delivery_magalu, review, origin, entity, or an attribute slug (e.g. modelo, cor, armazenamento-interno, memoria-ram, tamanho-da-tela) (examples: "brand"; minLength: 1)
  • value string required — Filter value slug (available values per query are returned in the response filters) (examples: "apple"; minLength: 1)

Response

• @type string (default: "MagazineluizaSearchProduct")
• id string required
• name string nullable
• brand object nullable
  • @type string (default: "MagazineluizaBrand")
  • name string nullable
  • alias string nullable
• reference string nullable
• image string nullable
• is_available boolean nullable
• is_buy_box boolean nullable
• price number nullable
• list_price number nullable
• discount_percent number nullable
• currency string nullable
• installment_count integer nullable
• installment_amount number nullable
• rating object nullable
  • @type string (default: "MagazineluizaRating")
  • count integer nullable
  • score number nullable
• seller_id string nullable
• seller_score number nullable
• category object nullable
  • @type string (default: "MagazineluizaCategory")
  • id string nullable
  • name string nullable
• subcategory object nullable
  • @type string (default: "MagazineluizaCategory")
  • id string nullable
  • name string nullable
• offer_id string nullable
• tags array (default: [])
• path string nullable
• url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.