Changes for page Sellables

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

From version < 2.1 >

edited by jns
on 2019/07/15 12:17

To version < 10.1 >

edited by Shop Team
on 2019/08/01 13:52

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Public Shop API
++Sellables

Author

@@ -1,1 +1,1 @@
--XWiki.jns
++XWiki.shop

Content

@@ -1,8 +1,319 @@
--(% class="auto-cursor-target" %)
++= General Remarks =
++
++The **Public Shop API** only works for shops that are based on the (new) Partner Area, not for legacy User Area-based shops. Terminology:
++
++* an **idea** represents an image you uploaded in the Partner Area that you gave a name and added other meta data to. In the Partner Area this is loosely referred to as a **design**.
++* a **sellable** is a representation of an **idea** printed on a **product type**. Depending on the product range selected in the Partner Area, one **idea** might have 100+ **sellables** associated with it.
++
++A **sellable** is thus something concrete that a customer can buy, while an **idea** represents a grouping of content mainly intended to make administration easier.
++
++All requests to the **Public Shop API** should be made from your server and not from the browser. This allows you to leverage caching, avoids [[CORS>>url:https://en.wikipedia.org/wiki/Cross-origin_resource_sharing||shape="rect"]] policy interference and keeps your API key secure.
++
++= List Resource =
++
++|=(((
++Method
++)))|=(((
++URL
++)))|=(((
++Example
++)))
++|(((
++GET
++)))|(((
++{{{/api/v1/shops/&#x3c;shopId&#x3e;/sellables?page=&#x3c;page&#x3e;}}}
++)))|(((
++(% style="color: rgb(80,80,80);" %)[[https:~~/~~/api.spreadshirt.net/api/v1/shops/100488332/sellables?page=0>>url:https://api.spreadshirt.net/api/v1/shops/100488332/sellables?page=0||shape="rect"]]
++)))
++
++
++Returns a paginated list of the shop's sellables in a format like this:
++
++{{code language="js" title="Response Payload"}}
++{
++   "count" : 4760,
++   "limit" : 48,
++   "offset" : 0,
++   "sellables" :
++      [
++         {
++            "sellableId" : "praawgg73zU5gzZN0gaM-812-7",
++            "ideaId" : "5d22f8ebb264a16f6b87fb6f",
++            "productTypeId" : "812",
++            "price" :
++               {
++                  "amount" : 17.49,
++                  "currencyId" : "1"
++               },
++            "name" : "I love you",
++            "tags" :
++               [
++                  "Young wild and free",
++                  "shop api",
++                  "test",
++                  "Young money",
++                  "Loved",
++                  "Lovestruck",
++                  "Love with heart",
++                  "Love hurts",
++                  "Love",
++                  "Love me",
++                  "Youtube",
++                  "migration",
++                  "Your",
++                  "You",
++                  "Love parade"
++               ],
++            "previewImage" :
++               {
++                  "url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A2PA3811PT17X50Y96D163261757FS2991/views/1,width=500,height=500,appearanceId=2,crop=list,modelId=1111,version=1564481428.jpg",
++                  "type" : "MODEL"
++               },
++            "appearanceIds" :
++               [
++                  "411",
++                  "645",
++                  "648",
++                  "649",
++                  "719",
++                  "1",
++                  "2",
++                  "366",
++                  "348",
++                  "387",
++                  "92",
++                  "39",
++                  "231",
++                  "317",
++                  "3",
++                  "29",
++                  "328",
++                  "339"
++               ],
++            "defaultAppearanceId" : "2"
++         }
++      ]
++}
++{{/code}}
++
++The fields are to be interpreted as follows:
++
++(% class="wrapped" %)
++|=(((
++Fiel
++)))|=(((
++Description
++)))
++|(((
++sellableId
++)))|(((
++Unique identifier for the sellable. Necessary to query the detail resource mentioned below as well as for the add-to-basket request.
++)))
++|(((
++ideaId
++)))|(((
++Identifies the uploaded design. Necessary to query the detail resource but also useful to group content by design if desired.
++)))
++|(((
++productTypeId
++)))|(((
++Identifies the 'type of garment' used. Can be used to lookup additional meta data from the product type resources described [[here>>doc:Inventory Resources]].
++)))
++|(((
++price
++)))|(((
++Always in the currency of the shop. Check [[this>>doc:Price Formatting Guide]] for hints on how to format the price in a user-friendly way.
++)))
++|(((
++name
++)))|(((
++The text you entered in the Partner Area.
++)))
++|(((
++description
++)))|(((
++The text you entered in the Partner Area (optional).
++)))
++|(((
++tags
++)))|(((
++The text you entered in the Partner Area (optional).
++)))
++|(((
++previewImage
++)))|(((
++An image we deem best suited to represent the sellable on a list page.
++)))
++|(((
++previewImage/url
++)))|(((
++The image url you can embed directly into your page.
++)))
++|(((
++previewImage/type
++)))|(((
++Describes the type of image available from the url using one of the following values: PRODUCT, DESIGN, MODEL, ALTERNATIVE_MODEL.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++appearanceIds
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The 'colors' a sellable currently has available for purchase. If you need more information on the colors, the product type resource [[here>>doc:Inventory Resources]] is useful.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++defaultAppearanceId
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++The default 'color' you can set in the Partner Area. This is the color the previewImage is in. It also provides a good starting point when linking to a detail page.
++)))
++
++
++Implementation remarks: For advanced implementations, it is usually best to import the content of the sellable list into your own data base in regular intervals (for example once every 24h).
++This allows you to implement a custom navigation structure, filters, etc. according to your needs.
++
++= Detail Resource =
++
++|=(((
++Method
++)))|=(((
++URL
++)))|=(((
++Example
++)))
++|(((
++GET
++)))|(((
++{{{/api/v1/shops/&#x3c;shopId&#x3e;/sellables/&#x3c;sellableId&#x3e;?appearanceId=&#x3c;appearanceId&#x3e;&#x26;ideaId=&#x3c;ideaId&#x3e;}}}
++)))|(((
++(% style="color: rgb(80,80,80);" %)[[https:~~/~~/api.spreadshirt.net/api/v1/shops/100488332/sellables/praawgg73zU5gzZN0gaM-812-7?appearanceId=411&ideaId=5d22f8ebb264a16f6b87fb6f>>url:https://api.spreadshirt.net/api/v1/shops/100488332/sellables/praawgg73zU5gzZN0gaM-812-7?appearanceId=411&ideaId=5d22f8ebb264a16f6b87fb6f||shape="rect"]]
++)))
++
  \\
--{{info title="Coming soon"}}
--<p>As announced at <span class="wikiexternallink"><a shape="rect" href="https://www.spreadshirt.net/forum/t/what-to-do-if-im-still-in-the-legacy-user-area-and-using-spreadshirts-api-or-a-third-party-plugin/6124">https://www.spreadshirt.net/forum/t/what-to-do-if-im-still-in-the-legacy-user-area-and-using-spreadshirts-api-or-a-third-party-plugin/6124</a></span> our new Shop API documentation will be available soon!</p>
--{{/info}}
++Returns detailed information on a specific sellable in a specific appearance in a format like this:
++{{code language="js" title="Response Payload"}}
++{
++   "sizeIds" :
++      [
++         "2",
++         "3",
++         "4",
++         "5",
++         "6",
++         "38",
++         "94",
++         "102"
++      ],
++   "images" :
++      [
++         {
++            "url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A2PA3811PT17X50Y96D163261757FS2991/views/1,width=650,height=650,appearanceId=411,crop=detail,modelId=1111,version=1564481428.jpg",
++            "type" : "MODEL"
++         },
++         {
++            "url" : "https://image.spreadshirtmedia.net/image-server/v1/compositions/T812A2PA3811PT17X50Y96D163261757FS2991/views/1,width=650,height=650,appearanceId=411.jpg",
++            "type" : "DESIGN"
++         },
++         {
++            "url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A2PA3811PT17X50Y96D163261757FS2991/views/2,width=650,height=650,appearanceId=411,crop=detail,modelId=1117,version=1564481457.jpg",
++            "type" : "MODEL"
++         },
++         {
++            "url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A2PA3811PT17X50Y96D163261757FS2991/views/3,width=650,height=650,appearanceId=411.jpg",
++            "type" : "PRODUCT"
++         },
++         {
++            "url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A2PA3811PT17X50Y96D163261757FS2991/views/4,width=650,height=650,appearanceId=411.jpg",
++            "type" : "PRODUCT"
++         },
++         {
++            "url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A2PA3811PT17X50Y96D163261757FS2991/views/1,width=650,height=650,appearanceId=411,crop=detail,modelId=85,version=1564482744.jpg",
++            "type" : "ALTERNATIVE_MODEL"
++         }
++      ],
++   "sellableId" : "praawgg73zU5gzZN0gaM-812-7",
++   "ideaId" : "5d22f8ebb264a16f6b87fb6f",
++   "productTypeId" : "812",
++   "price" :
++      {
++         "amount" : 17.49,
++         "currencyId" : "1"
++      },
++   "name" : "112016603 143175205 I love you",
++   "tags" :
++      [
++         "Young wild and free",
++         "shop api",
++         "test",
++         "Young money",
++         "Loved",
++         "Lovestruck",
++         "Love with heart",
++         "Love hurts",
++         "Love",
++         "Love me",
++         "Youtube",
++         "migration",
++         "Your",
++         "You",
++         "Love parade"
++      ],
++   "previewImage" :
++      {
++         "url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A2PA3811PT17X50Y96D163261757FS2991/views/1,width=500,height=500,appearanceId=2,crop=list,modelId=1111,version=1564481428.jpg",
++         "type" : "MODEL"
++      },
++   "appearanceIds" :
++      [
++         "411",
++         "645",
++         "648",
++         "649",
++         "719",
++         "1",
++         "2",
++         "366",
++         "348",
++         "387",
++         "92",
++         "39",
++         "231",
++         "317",
++         "3",
++         "29",
++         "328",
++         "339"
++      ],
++   "defaultAppearanceId" : "2"
++}
++{{/code}}
++
  \\
++
++Most of the fields are exactly the same as in the list resource and have the same semantics. Two additional fields are included:
++
++(% class="wrapped" %)
++|=(((
++Field name
++)))|=(((
++Meaning
++)))
++|(((
++sizeIds
++)))|(((
++Describes the sizes available for purchase for the sellable in this appearance. For more information on sizes, check the product type resource [[here>>doc:Inventory Resources]].
++)))
++|(((
++images
++)))|(((
++A number of images giving an adequate overview over the sellable and it's properties in this appearance when displayed (ordered from most important to least important image). The exact number and shape of the images depend on your shop settings and the specifications you set when uploading the design. This object has the same structure as **previewImage** (mentioned in the list resource section).
++)))
++
++
++Implementation remarks: It is not feasible to import these detail resources into your own data base (because the number of entries can skyrocket quickly).
++Instead, it is recommended to request the API dynamically in an ad-hoc manner once a customer visits a detail page.
++
++\\

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--28278794
++28278874

url

@@ -1,1 +1,1 @@
--https://developer.spreadshirt.net/wiki/spaces/API/pages/28278794/Public Shop API
++https://developer.spreadshirt.net/wiki/spaces/API/pages/28278874/Sellables

Changes for page Sellables

Summary

Details

Navigation