Changes for page Design Details

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

<
From version < 2.1 >
edited by Shop Team
on 2019/08/01 11:55
To version < 9.1 >
edited by Shop Team
on 2019/08/01 14:44
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,8 @@
1 +In our terminology, a design represents a pixel (png, jpg, gif) or vector image (svg) that you uploaded in the Partner Area.
2 +
1 1  = List of all designs in the shop =
2 2  
5 +(% class="wrapped" %)
3 3  |=(((
4 4  Method
5 5  )))|=(((
... ... @@ -15,12 +15,31 @@
15 15  [[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"]]
16 16  )))
17 17  
21 +(% class="auto-cursor-target" %)
18 18  \\
19 19  
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 +
20 20  {{code language="js" title="Example Payload"}}
21 21  {
22 - "sortField":"default",
23 - "sortOrder":"default",
24 24   "offset":0,
25 25   "limit":10,
26 26   "count":2,
... ... @@ -29,15 +29,6 @@
29 29   "id":"163261757",
30 30   "href":"https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261757",
31 31   "name":"I love you",
32 - "price":{
33 - "vatIncluded":0.0,
34 - "vatExcluded":0.0,
35 - "vat":0.0,
36 - "currency":{
37 - "id":"1",
38 - "href":"https://api.spreadshirt.net/api/v1/currencies/1"
39 - }
40 - },
41 41   "backgroundColor":"#666666",
42 42   "resources":[
43 43   {
... ... @@ -46,21 +46,11 @@
46 46   "type":"preview"
47 47   }
48 48   ],
49 - "version":1562573036
50 50   },
51 51   {
52 52   "id":"163261722",
53 53   "href":"https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261722",
54 54   "name":"pinguine",
55 - "price":{
56 - "vatIncluded":0.0,
57 - "vatExcluded":0.0,
58 - "vat":0.0,
59 - "currency":{
60 - "id":"1",
61 - "href":"https://api.spreadshirt.net/api/v1/currencies/1"
62 - }
63 - },
64 64   "resources":[
65 65   {
66 66   "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261722",
... ... @@ -68,13 +68,90 @@
68 68   "type":"preview"
69 69   }
70 70   ],
71 - "version":1562573036
72 72   },
73 73   ]
74 74  }
75 75  {{/code}}
76 76  
77 -(% class="auto-cursor-target" %)
78 78  \\
79 79  
81 += Details about a design =
82 +
83 +(% class="wrapped" %)
84 +|=(((
85 +Method
86 +)))|=(((
87 +URL
88 +)))|=(((
89 +Example
90 +)))
91 +|(((
92 +GET
93 +)))|(((
94 +/api/v1/shops/<shopId>/designs/<designId>
95 +)))|(((
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"]]
97 +)))
98 +
80 80  \\
100 +
101 +A design has the following characteristics:
102 +
103 +* Each design has a name, a description, a size.
104 +* **Images:** To retrieve a design image, you can use a URL similar to the following one: [[https:~~/~~/image.spreadshirtmedia.net/image-server/v1/designs/2484607>>url:https://image.spreadshirtmedia.net/image-server/v1/designs/2484607||shape="rect"]]. These URLs are provided within the resources part of the design payload.
105 +* **Color Layers:** Vector designs consist of one or more color layers. We provide for each color layer, the original color of the uploaded design as well as the color set by the owner as actual default color. Example:
106 +[[image:attach:design-layer2.png]]
107 +\\
108 +* **Allowed Print Types:** For each design, we provide a list of print types, e.g. flock, flex or digital direct print, that can be used to print that design. Vector and pixel images are printed using different print types!
109 +
110 +\\
111 +
112 +{{code language="js" title="Example Payload"}}
113 +{
114 + "href":"https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261757",
115 + "id":"163261757",
116 + "created":"2019-07-08T08:03:56.000+0000",
117 + "modified":"2019-07-22T10:17:39.000+0000",
118 + "name":"I love you",
119 + "description":"A lovely design for you",
120 + "tags":"Love,Love hurts,Love me,Love parade,Love with heart,Loved,Lovestruck,You,Young money,Young wild and free,Your,Youtube,migration,shop api,test",
121 + "user":{
122 + "href":"https://api.spreadshirt.net/api/v1/users/117878306",
123 + "id":"117878306"
124 + },
125 + "size":{
126 + "width":3938.0,
127 + "height":1149.0,
128 + "unit":"px"
129 + },
130 + "colors":[
131 +
132 + ],
133 + "backgroundColor":"#666666",
134 + "printTypes":[
135 + {
136 + "href":"https://api.spreadshirt.net/api/v1/shops/100488332/printTypes/17",
137 + "id":"17"
138 + },
139 + {
140 + "href":"https://api.spreadshirt.net/api/v1/shops/100488332/printTypes/1",
141 + "id":"1"
142 + },
143 + ],
144 + "resources":[
145 + {
146 + "mediaType":"png",
147 + "type":"preview",
148 + "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261757,backgroundColor=666666"
149 + },
150 + {
151 + "mediaType":"png",
152 + "type":"montage",
153 + "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261757"
154 + }
155 + ],
156 +}
157 +{{/code}}
158 +
159 +(% class="auto-cursor-target" %)
160 +\\
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -28278859
1 +28278911
url
... ... @@ -1,1 +1,1 @@
1 -https://developer.spreadshirt.net/wiki/spaces/API/pages/28278859/Design
1 +https://developer.spreadshirt.net/wiki/spaces/API/pages/28278911/Design