Wiki source code of Design

Version 5.1 by Shop Team on 2019/08/01 12:21
Hide last authors
Shop Team 5.1 1 In our terminology, a design represents a pixel (png, jpg, gif) or vector image (svg) that a customer or partner can use to put it on a product type.
2
Shop Team 1.1 3 = List of all designs in the shop =
4
Shop Team 3.1 5 (% class="wrapped" %)
Shop Team 1.1 6 |=(((
7 Method
8 )))|=(((
9 URL
10 )))|=(((
11 Example
12 )))
13 |(((
14 GET
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 \\
22
23 {{code language="js" title="Example Payload"}}
24 {
25 "offset":0,
26 "limit":10,
27 "count":2,
28 "designs":[
29 {
30 "id":"163261757",
31 "href":"https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261757",
32 "name":"I love you",
33 "backgroundColor":"#666666",
34 "resources":[
35 {
36 "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261757",
37 "mediaType":"png",
38 "type":"preview"
39 }
40 ],
41 },
42 {
43 "id":"163261722",
44 "href":"https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261722",
45 "name":"pinguine",
46 "resources":[
47 {
48 "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261722",
49 "mediaType":"png",
50 "type":"preview"
51 }
52 ],
53 },
54 ]
55 }
56 {{/code}}
57
58 \\
59
Shop Team 3.1 60 = Details about a design =
61
Shop Team 4.1 62 (% class="wrapped" %)
Shop Team 3.1 63 |=(((
64 Method
65 )))|=(((
66 URL
67 )))|=(((
68 Example
69 )))
70 |(((
71 GET
72 )))|(((
73 /api/v1/shops/<shopId>/designs/<designId>
74 )))|(((
75 [[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"]]
76 )))
77
Shop Team 1.1 78 \\
Shop Team 3.1 79
Shop Team 5.1 80 A design has the following characteristics:
Shop Team 4.1 81
82 * Each design has a name, a description, a size and a price. The price is in this case the commission that the owner of the design earns for each usage.
83 * **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.
84 * **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:
85 [[image:attach:design-layer2.png]]
86 \\
87 * **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!
88
89 \\
90
Shop Team 3.1 91 {{code language="js" title="Example Payload"}}
92 {
93 "href":"https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261757",
94 "id":"163261757",
95 "created":"2019-07-08T08:03:56.000+0000",
96 "modified":"2019-07-22T10:17:39.000+0000",
97 "name":"I love you",
98 "description":"A lovely design for you",
99 "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",
100 "user":{
101 "href":"https://api.spreadshirt.net/api/v1/users/117878306",
102 "id":"117878306"
103 },
104 "size":{
105 "width":3938.0,
106 "height":1149.0,
107 "unit":"px"
108 },
109 "colors":[
110
111 ],
112 "backgroundColor":"#666666",
113 "printTypes":[
114 {
115 "href":"https://api.spreadshirt.net/api/v1/shops/100488332/printTypes/17",
116 "id":"17"
117 },
118 {
119 "href":"https://api.spreadshirt.net/api/v1/shops/100488332/printTypes/1",
120 "id":"1"
121 },
122 ],
123 "designCategories":[
124
125 ],
126 "price":{
127 "vatExcluded":0.00,
128 "vatIncluded":0.00,
129 "vat":19.00,
130 "currency":{
131 "href":"https://api.spreadshirt.net/api/v1/currencies/1",
132 "id":"1"
133 }
134 },
135 "resources":[
136 {
137 "mediaType":"png",
138 "type":"preview",
139 "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261757,backgroundColor=666666"
140 },
141 {
142 "mediaType":"png",
143 "type":"montage",
144 "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261757"
145 }
146 ],
147 }
148 {{/code}}
149
150 (% class="auto-cursor-target" %)
151 \\

Navigation