Changes for page Design Details

Last modified by Shop Team on 2023/02/13 22:56
<
From version < 11.3 >
edited by Shop Team
on 2023/02/13 22:56
To version < 4.1 >
edited by Shop Team
on 2019/08/01 12:20
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Design Details
1 +Design
Parent
... ... @@ -1,1 +1,0 @@
1 -API.Spreadshirt Public Shop API Documentation.API REST Resources.WebHome
Content
... ... @@ -1,4 +1,4 @@
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.
1 += List of all designs in the shop =
2 2  
3 3  (% class="wrapped" %)
4 4  |=(((
... ... @@ -11,6 +11,85 @@
11 11  |(((
12 12  GET
13 13  )))|(((
14 +/api/v1/shops/<shopId>/designs
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"]]
17 +)))
18 +
19 +\\
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}}
77 +
78 +\\
79 +
80 += Details about a design =
81 +
82 +(% class="wrapped" %)
83 +|=(((
84 +Method
85 +)))|=(((
86 +URL
87 +)))|=(((
88 +Example
89 +)))
90 +|(((
91 +GET
92 +)))|(((
14 14  /api/v1/shops/<shopId>/designs/<designId>
15 15  )))|(((
16 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"]]
... ... @@ -18,9 +18,9 @@
18 18  
19 19  \\
20 20  
21 -A design has the following characteristics:
100 +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. A typical design, e.g. the "I Heart" design from the Spreadshirt marketplace, is illustrated in the picture above. A design has the following characteristics:
22 22  
23 -* Each design has a name, a description, a size.
102 +* 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.
24 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 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 26  [[image:attach:design-layer2.png]]
... ... @@ -61,6 +61,18 @@
61 61   "id":"1"
62 62   },
63 63   ],
143 + "designCategories":[
144 +
145 + ],
146 + "price":{
147 + "vatExcluded":0.00,
148 + "vatIncluded":0.00,
149 + "vat":19.00,
150 + "currency":{
151 + "href":"https://api.spreadshirt.net/api/v1/currencies/1",
152 + "id":"1"
153 + }
154 + },
64 64   "resources":[
65 65   {
66 66   "mediaType":"png",
design-layer2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -31.8 KB
Content
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -28278856
1 +28278862
url
... ... @@ -1,1 +1,1 @@
1 -https://developer.spreadshirt.net/wiki/spaces/API/pages/28278856/Design Details
1 +https://developer.spreadshirt.net/wiki/spaces/API/pages/28278862/Design

Navigation