Changes for page Design Details

Last modified by Shop Team on 2023/02/13 22:56
<
From version < 3.1 >
edited by Shop Team
on 2019/08/01 12:13
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,4 +1,4 @@
1 -= List of all designs in the shop =
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 3  (% class="wrapped" %)
4 4  |=(((
... ... @@ -11,89 +11,22 @@
11 11  |(((
12 12  GET
13 13  )))|(((
14 -/api/v1/shops/<shopId>/designs
14 +/api/v1/shops/<shopId>/designs/<designId>
15 15  )))|(((
16 -[[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 +[[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"]]
17 17  )))
18 18  
19 19  \\
20 20  
21 -{{code language="js" title="Example Payload"}}
22 -{
23 - "sortField":"default",
24 - "sortOrder":"default",
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 - "price":{
34 - "vatIncluded":0.0,
35 - "vatExcluded":0.0,
36 - "vat":0.0,
37 - "currency":{
38 - "id":"1",
39 - "href":"https://api.spreadshirt.net/api/v1/currencies/1"
40 - }
41 - },
42 - "backgroundColor":"#666666",
43 - "resources":[
44 - {
45 - "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261757",
46 - "mediaType":"png",
47 - "type":"preview"
48 - }
49 - ],
50 - "version":1562573036
51 - },
52 - {
53 - "id":"163261722",
54 - "href":"https://api.spreadshirt.net/api/v1/shops/100488332/designs/163261722",
55 - "name":"pinguine",
56 - "price":{
57 - "vatIncluded":0.0,
58 - "vatExcluded":0.0,
59 - "vat":0.0,
60 - "currency":{
61 - "id":"1",
62 - "href":"https://api.spreadshirt.net/api/v1/currencies/1"
63 - }
64 - },
65 - "resources":[
66 - {
67 - "href":"https://image.spreadshirtmedia.net/image-server/v1/designs/163261722",
68 - "mediaType":"png",
69 - "type":"preview"
70 - }
71 - ],
72 - "version":1562573036
73 - },
74 - ]
75 -}
76 -{{/code}}
21 +A design has the following characteristics:
77 77  
23 +* Each design has a name, a description, a size.
24 +* **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.
25 +* **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:
26 +[[image:attach:design-layer2.png]]
78 78  \\
28 +* **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!
79 79  
80 -= Details about a design =
81 -
82 -|=(((
83 -Method
84 -)))|=(((
85 -URL
86 -)))|=(((
87 -Example
88 -)))
89 -|(((
90 -GET
91 -)))|(((
92 -/api/v1/shops/<shopId>/designs/<designId>
93 -)))|(((
94 -[[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"]]
95 -)))
96 -
97 97  \\
98 98  
99 99  {{code language="js" title="Example Payload"}}
... ... @@ -128,18 +128,6 @@
128 128   "id":"1"
129 129   },
130 130   ],
131 - "designCategories":[
132 -
133 - ],
134 - "price":{
135 - "vatExcluded":0.00,
136 - "vatIncluded":0.00,
137 - "vat":19.00,
138 - "currency":{
139 - "href":"https://api.spreadshirt.net/api/v1/currencies/1",
140 - "id":"1"
141 - }
142 - },
143 143   "resources":[
144 144   {
145 145   "mediaType":"png",
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 -28278861
1 +28278856
url
... ... @@ -1,1 +1,1 @@
1 -https://developer.spreadshirt.net/wiki/spaces/API/pages/28278861/Design
1 +https://developer.spreadshirt.net/wiki/spaces/API/pages/28278856/Design Details

Navigation