Changes for page Design Details

Last modified by Shop Team on 2023/02/13 22:56
<
From version < 9.1 >
edited by Shop Team
on 2019/08/01 14:44
To version < 11.3 >
edited by Shop Team
on 2023/02/13 22:56
>
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Design
1 +Design Details
Parent
... ... @@ -1,0 +1,1 @@
1 +API.Spreadshirt Public Shop API Documentation.API REST Resources.WebHome
Content
... ... @@ -1,7 +1,5 @@
1 -In our terminology, a design represents a pixel (png, jpg, gif) or vector image (svg) that you uploaded in the Partner Area.
1 +In our terminology, a design represents a pixel (png, jpg, gif) or vector image (svg) that you uploaded in the Partner Area. Every entry from the [[Sellables endpoint>>doc:API.Sellables]] contains a field "mainDesignId". This id can be used to access the resource below in order to retrieve additional information about the upload. In the vast majority of implementations, this information is not necessary and it suffices to use the "Sellables" resource.
2 2  
3 -= List of all designs in the shop =
4 -
5 5  (% class="wrapped" %)
6 6  |=(((
7 7  Method
... ... @@ -13,84 +13,6 @@
13 13  |(((
14 14  GET
15 15  )))|(((
16 -/api/v1/shops/<shopId>/designs
17 -)))|(((
18 -[[https:~~/~~/api.spreadshirt.net/api/v1/shops/100488332/designs?mediaType=json>>url:https://api.spreadshirt.net/api/v1/shops/100488332/designs?mediaType=json||shape="rect"]]
19 -)))
20 -
21 -(% class="auto-cursor-target" %)
22 -\\
23 -
24 -|=(((
25 -Query Paramete
26 -)))|=(((
27 -Description
28 -)))
29 -|(((
30 -limit
31 -)))|(((
32 -Between 1 and 1000. Determines the maximum number of results per request.
33 -)))
34 -|(((
35 -offset
36 -)))|(((
37 -Allows pagination.
38 -)))
39 -
40 -\\
41 -
42 -\\
43 -
44 -{{code language="js" title="Example Payload"}}
45 -{
46 - "offset":0,
47 - "limit":10,
48 - "count":2,
49 - "designs":[
50 - {
51 - "id":"163261757",
52 - "href":"https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261757",
53 - "name":"I love you",
54 - "backgroundColor":"#666666",
55 - "resources":[
56 - {
57 - "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261757",
58 - "mediaType":"png",
59 - "type":"preview"
60 - }
61 - ],
62 - },
63 - {
64 - "id":"163261722",
65 - "href":"https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261722",
66 - "name":"pinguine",
67 - "resources":[
68 - {
69 - "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261722",
70 - "mediaType":"png",
71 - "type":"preview"
72 - }
73 - ],
74 - },
75 - ]
76 -}
77 -{{/code}}
78 -
79 -\\
80 -
81 -= Details about a design =
82 -
83 -(% class="wrapped" %)
84 -|=(((
85 -Method
86 -)))|=(((
87 -URL
88 -)))|=(((
89 -Example
90 -)))
91 -|(((
92 -GET
93 -)))|(((
94 94  /api/v1/shops/<shopId>/designs/<designId>
95 95  )))|(((
96 96  [[https:~~/~~/api.spreadshirt.net/api/v1/shops/100488332/designs/163261757?mediaType=json>>url:https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261757?mediaType=json||shape="rect"]]
design-layer2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +31.8 KB
Content
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -28278911
1 +28278856
url
... ... @@ -1,1 +1,1 @@
1 -https://developer.spreadshirt.net/wiki/spaces/API/pages/28278911/Design
1 +https://developer.spreadshirt.net/wiki/spaces/API/pages/28278856/Design Details

Navigation