/demaecan/shops/search

POST /api/demaecan/shops/search

Price: 5 credits

Search Demae-can (出前館) shops deliverable to a given area (block code), optionally filtered by keyword, cuisine genre, sort order, max delivery time and accepted payment methods. Returns shop cards with name, rating, review count, delivery fee, delivery time, status, tags and top menu items.

How to use it

Search Demae-can (demae-can.com) shops that deliver to an area block code (resolve a postal code to a block code via demaecan/areas/search first). Optional filters: keyword (free text), genre (cuisine), sort (recommend/wait_time/rating), max_wait_time (30/60/90 minutes), payment_methods. Returns id, name, catchphrase, image, rating, review_count, delivery_fee, wait_time, status, has_coupon, tags and top items.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• area string required — Delivery area block code (from areas/search by postal code) (examples: "13113012001"; minLength: 1)
• count integer required — Max number of shops to return (min: 1)
• keyword string nullable — Free-text keyword to search shops/dishes
• genre string nullable — Filter by cuisine genre (one of: "pizza", "fast_food", "sushi_seafood", "chinese", "ramen", "bento", "curry_rice", "donburi", "western", "sweets", "burger_sandwich", "family_restaurant", "fried_chicken", "indian_curry", "japanese", "hamburg_steak", "soba_udon", "tonkatsu_tempura", "cafe_drink", "korean", "takoyaki_okonomiyaki", "pasta_italian", "yakiniku", "healthy", "ethnic", "convenience_store", "alcohol", "party_catering", "in_store_price")
• sort string nullable — Result ordering (one of: "recommend", "wait_time", "rating")
• max_wait_time string nullable — Only shops deliverable within this many minutes (one of: "30", "60", "90")
• payment_methods array — Only shops accepting all of these payment methods (default: []; one of: "credit_card", "amazon_pay", "paypay", "docomo_carrier_pay", "carrier_pay", "madonna_pay", "cash")

Response

• @type string (default: "DemaecanShopCard")
• id string required
• name string required
• catchphrase string nullable
• image string nullable
• rating number nullable
• review_count integer nullable
• delivery_fee number nullable
• wait_time integer nullable
• status string nullable
• status_text string nullable
• chain_id string nullable
• shop_type string nullable
• is_share_deli boolean (default: false)
• is_instore_price boolean (default: false)
• is_half_price_sale boolean (default: false)
• is_ultra_half_price_fes boolean (default: false)
• is_delivery_meiten boolean (default: false)
• has_de_award boolean (default: false)
• has_coupon boolean (default: false)
• has_free_delivery_coupon boolean (default: false)
• tags array (default: [])
• items array (default: [])
  • @type string (default: "DemaecanShopCardItem")
  • item_code string required
  • name string required
  • price number nullable
  • image string nullable
  • item_type 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.