---
title: "Shopping"
method: GET
path: "/v1/shopping"
---

# Shopping

`GET /v1/shopping`

## Request

- Base URL: `https://api.logimu.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.logimu.com/v1/shopping`
- Auth: none declared

Curated product search across Amazon US, UK, Germany, Canada, Australia and
Walmart US: keyword -> ranked, grouped product recommendations in under 100ms, in the
marketplace's local currency. A bare ASIN (or numeric Walmart item ID) returns exactly
that product (mode: "asin"). Metered against the caller's credits (2 credits
per successful query, or 5 with `detail=true`; empty results are never billed).
Walmart opened 2026-07-29 (Nick) — the engine always supported it and the free demo +
MCP already served it; the REST guard was the only blocker (demo-to-paid hole).

## Query parameters

- `q` string, required
- `country` string: Marketplace: us, uk, de, ca, au, fr, it, es, jp, mx, br, walmart.
- `category` string, nullable: Optional keyword filter on the product-category PATH (matched against the full path including all parent categories, singular/plural folded). E.g. q=coffee maker & category=machine keeps only categories whose path mentions Machine(s).
- `group` string, nullable: Force grouping: category | price | none (default auto).
- `min_price` number, nullable: Minimum price filter (alias: price_min).
- `max_price` number, nullable: Maximum price filter (alias: price_max).
- `brand` string, nullable: Restrict to an exact brand.
- `in_stock` boolean, nullable: Only in-stock products when true.
- `include_unavailable` boolean, nullable: false (default): only products with a current offer (a price observed in the activity window). true: also return listings that currently have no offer on the marketplace (Amazon 'Currently unavailable' items: no price, in_stock false). A bare ASIN lookup always returns the product regardless of this flag. Added 2026-09-26.
- `sort` string, nullable: relevance (default) | price | rating.
- `limit` integer, nullable: Max products (default 20).
- `per_group` integer, nullable: Products per category/tier group.
- `accessories` boolean, nullable: Include accessory products (default false).
- `intent` string, nullable: Category-intent inference on (default) | off.
- `format` string, nullable: Books/media: only this format - kindle, paperback, hardcover, mass_market, audiobook, audio_cd, board_book, spiral, library_binding, other; comma-separate several (format=paperback,hardcover). Added 2026-09-30.
- `collapse` boolean, nullable: true (default): one row per book - its other formats (each its own ASIN, with price) are listed in the row's `formats`. false: every format as its own row. Added 2026-09-30.
- `detail` boolean: Attach to EVERY product everything the basic /v1/product answer carries (2026-09-28): current sellers with fulfillment and delivery, 30-day price/stock change events, stock history and state, brand_stats, dimensions, list-price/coupon/badge/rating history, variation coverage, page content (images, bullets, breadcrumbs, variations) and up to 50 featured reviews, plus a response-wide seller_ratings array. Only bsr_history and offer_history stay product-only. 5 credits per query instead of 2. Note: bought_past_month (Amazon's 'N+ bought in past month' badge) is included on every product in EVERY response — no detail flag needed.

## Headers

- `x-api-key` string, nullable
- `authorization` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/logimu/apis/logimu-api.md) · [All operations](https://skmtc.dev/logimu/apis/logimu-api/llms.txt) · [OpenAPI document](https://skmtc.dev/logimu/apis/logimu-api/revisions/3d3f90ad2335?raw)
