Wiki source code of Design

Version 9.1 by Shop Team on 2019/08/01 14:44
Hide last authors
Shop Team 9.1 1 In our terminology, a design represents a pixel (png, jpg, gif) or vector image (svg) that you uploaded in the Partner Area.
Shop Team 5.1 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
Shop Team 9.1 21 (% class="auto-cursor-target" %)
Shop Team 1.1 22 \\
23
Shop Team 9.1 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
Shop Team 8.1 44 {{code language="js" title="Example Payload"}}
Shop Team 1.1 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
Shop Team 3.1 81 = Details about a design =
82
Shop Team 4.1 83 (% class="wrapped" %)
Shop Team 3.1 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
Shop Team 1.1 99 \\
Shop Team 3.1 100
Shop Team 5.1 101 A design has the following characteristics:
Shop Team 4.1 102
Shop Team 9.1 103 * Each design has a name, a description, a size.
Shop Team 4.1 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
Shop Team 8.1 112 {{code language="js" title="Example Payload"}}
Shop Team 3.1 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 \\

Navigation