Changes for page Sellables

Last modified by Shop Team on 2023/02/13 22:56

<
From version < 15.1 >
edited by Shop Team
on 2023/02/13 22:56
To version < 12.1 >
edited by Shop Team
on 2019/08/06 08:23
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -API REST Resources
Content
... ... @@ -11,7 +11,6 @@
11 11  
12 12  = List Resource =
13 13  
14 -(% class="wrapped" %)
15 15  |=(((
16 16  Method
17 17  )))|=(((
... ... @@ -27,6 +27,7 @@
27 27  (% 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"]]
28 28  )))
29 29  
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,7 +39,6 @@
39 39   {
40 40   "sellableId" : "praawgg73zU5gzZN0gaM-812-7",
41 41   "ideaId" : "5d22f8ebb264a16f6b87fb6f",
42 - "mainDesignId": "142648902",
43 43   "productTypeId" : "812",
44 44   "price" :
45 45   {
... ... @@ -101,7 +101,7 @@
101 101  
102 102  (% class="wrapped" %)
103 103  |=(((
104 -Field
103 +Fiel
105 105  )))|=(((
106 106  Description
107 107  )))
... ... @@ -115,13 +115,6 @@
115 115  )))|(((
116 116  Identifies the uploaded design. Necessary to query the detail resource but also useful to group content by design if desired.
117 117  )))
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 -)))
125 125  |(((
126 126  productTypeId
127 127  )))|(((
... ... @@ -177,7 +177,6 @@
177 177  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.
178 178  )))
179 179  
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).
181 181  
182 182  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).
183 183  This allows you to implement a custom navigation structure, filters, etc. according to your needs.
... ... @@ -184,7 +184,6 @@
184 184  
185 185  = Detail Resource =
186 186  
187 -(% class="wrapped" %)
188 188  |=(((
189 189  Method
190 190  )))|=(((
... ... @@ -246,7 +246,6 @@
246 246   ],
247 247   "sellableId" : "praawgg73zU5gzZN0gaM-812-7",
248 248   "ideaId" : "5d22f8ebb264a16f6b87fb6f",
249 - "mainDesignId": "142648902",
250 250   "productTypeId" : "812",
251 251   "price" :
252 252   {
... ... @@ -308,7 +308,7 @@
308 308  
309 309  (% class="wrapped" %)
310 310  |=(((
311 -Field
300 +Field name
312 312  )))|=(((
313 313  Meaning
314 314  )))
... ... @@ -323,6 +323,7 @@
323 323  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).
324 324  )))
325 325  
315 +
326 326  Implementation remarks: It is not feasible to import these detail resources into your own data base (because the number of entries can skyrocket quickly).
327 327  Instead, it is recommended to request the API dynamically in an ad-hoc manner once a customer visits a detail page.
328 328  
venn.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -81.8 KB
Content
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -28278792
1 +28278934
url
... ... @@ -1,1 +1,1 @@
1 -https://developer.spreadshirt.net/wiki/spaces/API/pages/28278792/Sellables
1 +https://developer.spreadshirt.net/wiki/spaces/API/pages/28278934/Sellables