/momo/products/search

POST /api/momo/products/search

Price: 20 credits

Search momo products by keyword, with sort, price range and brand filters: product cards with price, list price, rating, review count, stock, sales band, shop, labels and images

How to use it

Prices are in TWD. Sponsored placements carry is_sponsored. Brand numbers come from brand_id on momo/products.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• price_min integer nullable — Minimum price in TWD (min: 0)
• price_max integer nullable — Maximum price in TWD (min: 0)
• keyword string required — Search keyword (examples: "耳機"; minLength: 1)
• count integer required — Max number of products to return (min: 1; max: 3000)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "monthly_sales", "newest", "price_asc", "price_desc", "rating")
• brand_ids array nullable — momo brand numbers to keep (examples: ["20160808155934745"])

Response

• @type string (default: "MomoListedProduct")
• id string required
• name string nullable
• subtitle string nullable
• url string nullable
• price number nullable
• price_max number nullable
• list_price number nullable
• price_note string nullable
• image string nullable
• images array (default: [])
• rating number nullable
• review_count integer nullable
• stock_quantity integer nullable
• total_sales_text string nullable
• shop_name string nullable
• vendor_code string nullable
• category_ids array (default: [])
• category_names array (default: [])
• labels array (default: [])
• video_url string nullable
• sale_start_text string nullable
• installment_months integer nullable
• is_sponsored boolean nullable
• is_discounted boolean nullable
• has_gift boolean nullable
• has_coupon boolean nullable
• is_adult boolean 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.