Changes for page Sellables

Last modified by Shop Team on 2023/02/13 22:56
<
From version < 12.1 >
edited by Shop Team
on 2019/08/06 08:23
To version < 18.1
edited by Shop Team
on 2023/02/13 22:56
Change comment: Renamed back-links.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +API.Spreadshirt Public Shop API Documentation.API REST Resources.WebHome
Content
... ... @@ -11,6 +11,7 @@
11 11  
12 12  = List Resource =
13 13  
14 +(% class="wrapped" %)
14 14  |=(((
15 15  Method
16 16  )))|=(((
... ... @@ -26,7 +26,6 @@
26 26  (% style="color: rgb(80,80,80);" %)[[https:~~/~~/api.spreadshirt.net/api/v1/shops/100488332/sellables?page=0>>url:https://api.spreadshirt.net/api/v1/shops/100488332/sellables?page=0||shape="rect"]]
27 27  )))
28 28  
29 -
30 30  Returns a paginated list of the shop's sellables in a format like this:
31 31  
32 32  {{code language="js" title="Response Payload"}}
... ... @@ -39,6 +39,7 @@
39 39   {
40 40   "sellableId" : "praawgg73zU5gzZN0gaM-812-7",
41 41   "ideaId" : "5d22f8ebb264a16f6b87fb6f",
42 + "mainDesignId": "142648902",
42 42   "productTypeId" : "812",
43 43   "price" :
44 44   {
... ... @@ -100,7 +100,7 @@
100 100  
101 101  (% class="wrapped" %)
102 102  |=(((
103 -Fiel
104 +Field
104 104  )))|=(((
105 105  Description
106 106  )))
... ... @@ -114,15 +114,22 @@
114 114  )))|(((
115 115  Identifies the uploaded design. Necessary to query the detail resource but also useful to group content by design if desired.
116 116  )))
118 +|(% colspan="1" %)(% colspan="1" %)
119 +(((
120 +(% class="objectBox objectBox-string" %)mainDesignId
121 +)))|(% colspan="1" %)(% colspan="1" %)
122 +(((
123 +Identifies the main image/design which is used for this Idea (usually the first design you add in the Partner Area). Can be used if you want to use  the [[Designs Resource>>doc:API.Spreadshirt Public Shop API Documentation.API REST Resources.Design Details.WebHome]] in combination with this resource.
124 +)))
117 117  |(((
118 118  productTypeId
119 119  )))|(((
120 -Identifies the 'type of garment' used. Can be used to lookup additional meta data from the product type resources described [[here>>doc:ProductType]].
128 +Identifies the 'type of garment' used. Can be used to lookup additional meta data from the product type resources described [[here>>doc:API.Spreadshirt Public Shop API Documentation.API REST Resources.ProductType.WebHome]].
121 121  )))
122 122  |(((
123 123  price
124 124  )))|(((
125 -Always in the currency of the shop. Check [[this>>doc:Price Formatting Guide]] for hints on how to format the price in a user-friendly way.
133 +Always in the currency of the shop. Check [[this>>doc:API.Spreadshirt Public Shop API Documentation.API Tutorials.Build your own shop system.Price Formatting Guide.WebHome]] for hints on how to format the price in a user-friendly way.
126 126  )))
127 127  |(((
128 128  name
... ... @@ -159,7 +159,7 @@
159 159  appearanceIds
160 160  )))|(% colspan="1" %)(% colspan="1" %)
161 161  (((
162 -The 'colors' a sellable currently has available for purchase. If you need more information on the colors, the product type resource [[here>>doc:ProductType]] is useful.
170 +The 'colors' a sellable currently has available for purchase. If you need more information on the colors, the product type resource [[here>>doc:API.Spreadshirt Public Shop API Documentation.API REST Resources.ProductType.WebHome]] is useful.
163 163  )))
164 164  |(% colspan="1" %)(% colspan="1" %)
165 165  (((
... ... @@ -169,6 +169,7 @@
169 169  The default 'color' you can set in the Partner Area. This is the color the previewImage is in. It also provides a good starting point when linking to a detail page.
170 170  )))
171 171  
180 +Please note that this resource returns a maximum of 9504 sellables or 198 full pages. The page parameter must thus always be between 0 and 197 (inclusively).
172 172  
173 173  Implementation remarks: For advanced implementations, it is usually best to import the content of the sellable list into your own data base in regular intervals (for example once every 24h).
174 174  This allows you to implement a custom navigation structure, filters, etc. according to your needs.
... ... @@ -175,6 +175,7 @@
175 175  
176 176  = Detail Resource =
177 177  
187 +(% class="wrapped" %)
178 178  |=(((
179 179  Method
180 180  )))|=(((
... ... @@ -236,6 +236,7 @@
236 236   ],
237 237   "sellableId" : "praawgg73zU5gzZN0gaM-812-7",
238 238   "ideaId" : "5d22f8ebb264a16f6b87fb6f",
249 + "mainDesignId": "142648902",
239 239   "productTypeId" : "812",
240 240   "price" :
241 241   {
... ... @@ -297,7 +297,7 @@
297 297  
298 298  (% class="wrapped" %)
299 299  |=(((
300 -Field name
311 +Field
301 301  )))|=(((
302 302  Meaning
303 303  )))
... ... @@ -304,7 +304,7 @@
304 304  |(((
305 305  sizeIds
306 306  )))|(((
307 -Describes the sizes available for purchase for the sellable in this appearance. For more information on sizes, check the product type resource [[here>>doc:ProductType]].
318 +Describes the sizes available for purchase for the sellable in this appearance. For more information on sizes, check the product type resource [[here>>doc:API.Spreadshirt Public Shop API Documentation.API REST Resources.ProductType.WebHome]].
308 308  )))
309 309  |(((
310 310  images
... ... @@ -312,7 +312,6 @@
312 312  A number of images giving an adequate overview over the sellable and it's properties in this appearance when displayed (ordered from most important to least important image). The exact number and shape of the images depend on your shop settings and the specifications you set when uploading the design. This object has the same structure as **previewImage** (mentioned in the list resource section).
313 313  )))
314 314  
315 -
316 316  Implementation remarks: It is not feasible to import these detail resources into your own data base (because the number of entries can skyrocket quickly).
317 317  Instead, it is recommended to request the API dynamically in an ad-hoc manner once a customer visits a detail page.
318 318  
venn.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +81.8 KB
Content
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -28278934
1 +28278792
url
... ... @@ -1,1 +1,1 @@
1 -https://developer.spreadshirt.net/wiki/spaces/API/pages/28278934/Sellables
1 +https://developer.spreadshirt.net/wiki/spaces/API/pages/28278792/Sellables

Navigation