/demaecan/shops/reviews

POST /api/demaecan/shops/reviews

Price: 5 credits

Get Demae-can (出前館) shop reviews by shop id (or shop URL), optionally sorted by date or rating. Each review has the rating, comment text, delivery and review timestamps, the reviewed menu items with quality tags, and the shop's reply if any. A non-existent or review-less shop returns an empty list.

How to use it

Fetch Demae-can (demae-can.com) reviews for a shop by id (e.g. '1003691') or shop URL. Optional sort (newest/rating_desc/rating_asc). Returns id, rating, text, delivered_at, reviewed_at, menu_items (each with name, is_good, quality tags, image) and the shop reply when present. Returns an empty list when the shop has no reviews or does not exist.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• shop string required — Demae-can shop id or a full shop URL (examples: "1003691", "https://demae-can.com/shop/menu/1003691"; minLength: 1)
• count integer required — Max number of reviews to return (min: 1)
• sort string nullable — Review ordering (one of: "newest", "rating_desc", "rating_asc")

Response

• @type string (default: "DemaecanShopReview")
• id string required
• rating integer nullable
• text string nullable
• delivered_at string nullable
• reviewed_at string nullable
• menu_items array (default: [])
  • @type string (default: "DemaecanReviewMenuItem")
  • item_code string nullable
  • name string nullable
  • is_good boolean (default: false)
  • tags array (default: [])
  • image string nullable
  • user_image string nullable
• reply object nullable
  • @type string (default: "DemaecanReviewReply")
  • text string nullable
  • verified_at 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.