Permalink
Fetching contributors…
Cannot retrieve contributors at this time
101 lines (66 sloc) 2.16 KB
---
parent: apiv3
title: shop
---
# Shop <%= edit_link %>
<%= partial 'partials/toc' %>
## Retrieve a single shop
<pre class="terminal">
GET /shops/:id
</pre>
<%= render_recording :shops_show %>
## Retrieve a shop's reviews
### Linked resources
* <%= link_to 'Linked Resources', '/api/v3#linked-resources' %>
* <%= link_to 'User', '/api/v3/user' %>
<pre class="terminal">
GET /shops/:id/reviews
</pre>
<%= render_recording :shop_reviews %>
### Meta
You may choose to include extra meta information using the following parameter:
`shop_rating_breakdown`
: Review stats. Contains the impression (positive or negative), the total count
for that impression and a percentage to help the client draw a rating bar.
<%= render_recording :shop_reviews_with_rating_breakdown %>
## List shop locations
#### Linked resources
<pre class="terminal">
GET /shops/:shop_id/locations
</pre>
<%= render_recording :shop_locations_index %>
Addresses can be included / embedded using the `address` value. Addresses are
expanded versions of the `full_address` field. If the `format` of the Location
is `structured` then the address fields will be populated. If the `format` is
`unstructured` then the fields will be `null`.
<pre class="terminal">
GET /shops/:shop_id/locations?embed=address
</pre>
<%= render_recording :shop_locations_index_embed_address %>
## Retrieve a single shop location
#### Linked resources
<pre class="terminal">
GET /shops/:shop_id/locations/:id
</pre>
<%= render_recording :shop_locations_show %>
Addresses can be included / embedded using the `address` value. Addresses are
expanded versions of the `full_address` field.
<pre class="terminal">
GET /shops/:shop_id/locations/:id?embed=address
</pre>
<%= render_recording :shop_locations_show_embed_address %>
<% if flavor == 'skroutz' %>
## Find shop locations with geolocation
<pre class="terminal">
GET /locations/find
</pre>
<%= render_recording :shop_locations_find %>
<% end %>
## Search for shops
<pre class="terminal">
GET /shops/search?q=value
</pre>
Name | Type | Description
---- | ------ | -----------
`q` | String | Search with the value of this parameter
<%= render_recording :shop_search %>