/
manufacturer.html.md.erb
58 lines (38 loc) · 1.56 KB
/
manufacturer.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
---
parent: apiv3
title: manufacturer
---
# Manufacturer <%= edit_link %>
<%= partial 'partials/toc' %>
## List manufacturers
<pre class="terminal">
GET /manufacturers
</pre>
<%= render_recording :manufacturers_index %>
## Retrieve a single manufacturer
<pre class="terminal">
GET /manufacturers/:id
</pre>
<%= render_recording :manufacturers_show %>
## Retrieve a manufacturer's categories
<pre class="terminal">
GET /manufacturers/:id/categories
</pre>
<%= render_recording :manufacturer_categories %>
### Ordering
Valid parameters to perform ordering
Name | Type | Value | Description
----------- | ------ | -------------------------------------------------------- | ------------
`order_by` | String | `name`, `popularity` <small class="mark">default</small> | Order by name or popularity
`order_dir` | String | `asc`, `desc` <small class="mark">default</small> | Order ascending or descending
## Retrieve a manufacturer's SKUs
<pre class="terminal">
GET /manufacturers/:id/skus
</pre>
<%= render_recording :manufacturer_skus %>
### Ordering
Valid parameters to perform ordering
Name | Type | Value | Description
----------- | ------ | --------------------------------------------------------- | ------------
`order_by` | String | `price`, `popularity` <small class="mark">default</small> | Order by price or popularity
`order_dir` | String | `asc`, `desc` <small class="mark">default</small> | Order ascending or descending