Permalink
Fetching contributors…
Cannot retrieve contributors at this time
87 lines (56 sloc) 2.07 KB
---
parent: apiv3
title: product
---
# Product <%= edit_link %>
<%= partial 'partials/toc' %>
## Retrieve a single product
<pre class="terminal">
GET /products/:id
</pre>
<%= render_recording :products_show %>
## Retrieve an SKU's products
<pre class="terminal">
GET /skus/:id/products
</pre>
<%= render_recording :skus_products %>
## Retrieve an SKU's products grouped in cards
<pre class="terminal">
GET /skus/:id/product_cards
</pre>
<%= render_recording :skus_product_cards %>
### Ordering
Name | Type | Description
---------- | ----- | -----------
`order_by` | String | `net_price` (default) or `final_price` (includes shipping & payment_method cost).
### Filtering
You may supply the optional parameter `include_meta[]=filters`
to get meta information about the filters that can be applied.
<%= render_code_from_file "api/product_filters" %>
### Applying filters
Name | Type | Description
---------- | ----- | -----------
`size` | String | ex: `40` Sizes of 40 up to (but not including) 41 will be returned
`distance` | String | ex: `2` Only products within 2km's will be returned
`availability` | String | ex: `0` Only products with immediate availability will be returned
`zero_installments` | Boolean | ex: `true` Only products with zero commission installments will be returned
## Show Personalization info
<pre class="terminal">
GET /personalization
</pre>
<%= render_recording :personalization_show %>
Show the address that is used to calculate shipping & payment_method costs.
## Update Personalization info
<pre class="terminal">
PUT /personalization
</pre>
<%= render_recording :personalization_update %>
Select a different <%= link_to 'User Address', '/api/v3/user', anchor: 'retrieve-user-addresses' %>.
## Search for products
<pre class="terminal">
GET /shops/:shop_id/products/search?shop_uid=value
</pre>
Name | Type | Description
----------- | ------- | -----------
`shop_uid` | Integer | Search with the product identifier as assigned by the shop
<%= render_recording :products_search %>