schema_toc_link_after.md

The table of contents

• Shop
  • GET /api/shops
  • GET /api/shops/{shop_id}

Shop

Stability: prototype

ShopInformationAPI

Attributes

Name	Type	Description	Example
address	string	Shop Address	"Ginza Tokyo"
id	integer	Shop ID	42
latitude	string	Shop latitude	"35.695192"
longitude	string	Shop longitude	"139.758681"
name	string	Shop Name	"Ultimate Sushi Shop"

Shop Shop Search API

Shop search by geocode

GET /api/shops

Required Parameters

Name	Type	Description	Example
latitude	string	target latitude	"35.695192"
longitude	string	target longitude	"139.758681"

Optional Parameters

Name	Type	Description	Example
name	string	match word	"hot"

Curl Example

$ curl -n https://api.yasu.com/api/shops
 -G \
  -d name=hot \
  -d latitude=35.695192 \
  -d longitude=139.758681

Response Example

HTTP/1.1 200 OK

[
  {
    "id": 42,
    "name": "Ultimate Sushi Shop",
    "address": "Ginza Tokyo",
    "latitude": "35.695192",
    "longitude": "139.758681",
    "distance": 312
  }
]

Shop Shop Detail API

Provide shop detail information

GET /api/shops/{shop_id}

Optional Parameters

Name	Type	Description	Example
latitude	string	search area latitude	"35.695192"
longitude	string	search area longitude	"139.758681"

Curl Example

$ curl -n https://api.yasu.com/api/shops/$SHOP_ID
 -G \
  -d latitude=35.695192 \
  -d longitude=139.758681

Response Example

HTTP/1.1 200 OK

{
  "id": 42,
  "name": "Ultimate Sushi Shop",
  "address": "Ginza Tokyo",
  "latitude": "35.695192",
  "longitude": "139.758681",
  "holiday": "Sunday",
  "business_hours": "11:00-26:30(LO 26:00)",
  "distance": 312
}