Changes for page Sellables

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

From version < 3.1 >

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

To version < 4.1 >

edited by Shop Team
on 2019/07/18 07:55

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Author

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

Content

@@ -1,9 +1,346 @@
--(% class="auto-cursor-target" %)
++= Preface =
++
++Spreadshirt provides several ways to offer an online shop experience to your customers:
++
++1. The standalone Spreadshop ([[this>>url:https://shop.spreadshirt.com/SpreadShop||shape="rect"]], for example). This application is officially developed, hosted and maintained by Spreadshirt. Running a Spreadshop requires zero technical skills and is always the recommended approach.
++1. JavaScript integration (described [[here>>url:https://help.spreadshirt.com/hc/en-us/articles/207487815-Website-Integration-with-JavaScript||shape="rect"]]). If you have an existing website, you can embed a piece of JavaScript into it that manipulates your website in order to embed the Spreadshop into your site. This requires a decent understanding of HTML and CSS in order to resolve any conflicts between your site and the Spreadshop that may arise.
++1. CMS plugins for [[WordPress>>url:https://wordpress.org/plugins/spreadshop/#developers||shape="rect"]] and others (currently just [[Joomla>>url:https://extensions.joomla.org/extension/spreadshop/||shape="rect"]]) that embed the JavaScript snippet mentioned in (2.) for you. If you run a website based on such CMS, these plugins can make your life a bit easier. An understanding of HTML and CSS is nonetheless important.
++1. An independent, custom built web application based on the **Public Shop API** described in this document. This interface is for web developers only (or people who can afford to hire one). Going for this approach is only feasible for people who have a solid understanding of server side & client side programming, HTTP, HTML and CSS.
++
++= Prerequisites =
++
++The **Public Shop API** only works for shops that are based on the (new) Partner Area, not for legacy User Area-based shops. On top of that, an API key is required.
++Note that not only the content you upload in the Partner Area, but also the shop settings affect the output of the **Public Shop API**. For example, enabling model images affects the image URLs returned by the API.
++
++= Terminology =
++
++Partner Area shops are not based on the old domain entities **articles** and **products** anymore. Instead, they are based on **ideas** and **sellables** (sic!).
++
++* 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.
++
++= Changelog =
++
++* 22 July 2019: 1.0
++** The field **previewImage** as well as the content of the **images** array have been changed from strings to objects. These objects now contain information about the image type.
++** Introduced a **legacy article mapping resource**.
++* 27 June 2019: Beta
++** Beta release with request for feedback
++
++= REST Resources =
++
++== Base URLs ==
++
++As always, use [[https:~~/~~/api.spreadshirt.com>>url:https://api.spreadshirt.com||shape="rect"]] if your shop is based on the North American Spreadshirt platform or use [[https:~~/~~/api.spreadshirt.net>>url:https://api.spreadshirt.net||shape="rect"]] if your shop runs on the European platform.
++
++== Authentication ==
++
++Please provide your API key as described [[here>>doc:Security]]. A signature or sessionId is not required.
++Remember to set a user agent header naming your application and including its version. Example: "MyApp-1.0"
++
++== Client / Server ==
++
++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 policy interference and keeps your API key secure.
++
++== List Resource ==
++
  \\
--{{info title="Coming soon - new Public Shop API"}}
--<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 <strong>Public Shop API</strong> documentation will be available soon!</p>
--{{/info}}
++{{code title="Request"}}
++GET {baseUrl}/api/v1/shops/{shopId}/sellables?page=0
--(% class="auto-cursor-target" %)
++{{/code}}
++
  \\
++
++Returns a paginated list of the shop's sellables in a format like this:
++
++{{code language="js" title="Response Payload"}}
++{
++"count" : 473,
++"limit" : 48,
++"offset" : 0,
++"sellables" :
++[
++{
++"sellableId" : "74bYwmw5a3tXgyZpnw7j-812-7",
++"ideaId" : "5c7e78f95fd3e45786249fb0",
++"productTypeId" : "812",
++"price" :
++{
++"amount" : 21.99,
++"currencyId" : "1"
++},
++"name" : "Boss in black",
++"description" : "Be your own boss in black and printed by real people in black!",
++"tags" :
++[
++"Fanwear",
++"SpreadShop",
++"Awesome"
++],
++"previewImage" :
++{
++"url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A1PA3811PT17X49Y84D142648902FS2951PA3813PT17X60Y17D142648934FS2706/views/1,width=500,height=500,appearanceId=1,crop=list,modelId=85,version=1554885779/be-your-own-boss-in-black-and-printed-by-real-people-in-black.jpg",
++"type" : "MODEL"
++},
++"appearanceIds" :
++[
++"411",
++"645",
++"649",
++"1",
++"366",
++"92",
++"39",
++"231",
++"317",
++"3",
++"29",
++"328"
++],
++"defaultAppearanceId" : "1"
++},
++// more sellables
++]
++}
++{{/code}}
++
++The fields are to be interpreted as follows:
++
++|=(((
++Field name
++)))|=(((
++Meaning
++)))
++|(((
++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 ==
++
++{{code title="Request"}}
++GET {baseUrl}/api/v1/shops/{shopId}/sellables/{sellableId}?appearanceId={appearanceId}&ideaId={ideaId}
++
++{{/code}}
++
++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/T812A1PA3811PT17X49Y84D142648902FS2951PA3813PT17X60Y17D142648934FS2706/views/1,width=650,height=650,appearanceId=411,crop=detail,modelId=85,version=1554885779/be-your-own-boss-in-black-and-printed-by-real-people-in-black.jpg",
++"type" : "MODEL"
++},
++{
++"url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A1PA3811PT17X49Y84D142648902FS2951PA3813PT17X60Y17D142648934FS2706/views/2,width=650,height=650,appearanceId=411,crop=detail,modelId=91,version=1554885805/be-your-own-boss-in-black-and-printed-by-real-people-in-black.jpg",
++"type" : "MODEL"
++},
++{
++"url" : "https://image.spreadshirtmedia.net/image-server/v1/compositions/T812A1PA3811PT17X49Y84D142648902FS2951PA3813PT17X60Y17D142648934FS2706/views/1,width=650,height=650,appearanceId=411/be-your-own-boss-in-black-and-printed-by-real-people-in-black.jpg",
++"type" : "DESIGN"
++},
++{
++"url" : "https://image.spreadshirtmedia.net/image-server/v1/compositions/T812A1PA3811PT17X49Y84D142648902FS2951PA3813PT17X60Y17D142648934FS2706/views/2,width=650,height=650,appearanceId=411/be-your-own-boss-in-black-and-printed-by-real-people-in-black.jpg",
++"type" : "DESIGN"
++},
++{
++"url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A1PA3811PT17X49Y84D142648902FS2951PA3813PT17X60Y17D142648934FS2706/views/3,width=650,height=650,appearanceId=411/be-your-own-boss-in-black-and-printed-by-real-people-in-black.jpg",
++"type" : "PRODUCT"
++},
++{
++"url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A1PA3811PT17X49Y84D142648902FS2951PA3813PT17X60Y17D142648934FS2706/views/4,width=650,height=650,appearanceId=411/be-your-own-boss-in-black-and-printed-by-real-people-in-black.jpg",
++"type" : "PRODUCT"
++},
++{
++"url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A1PA3811PT17X49Y84D142648902FS2951PA3813PT17X60Y17D142648934FS2706/views/1,width=650,height=650,appearanceId=411,crop=detail,modelId=1111,version=1554884899/be-your-own-boss-in-black-and-printed-by-real-people-in-black.jpg",
++"type" : "ALTERNATIVE_MODEL"
++}
++],
++"sellableId" : "74bYwmw5a3tXgyZpnw7j-812-7",
++"ideaId" : "5c7e78f95fd3e45786249fb0",
++"productTypeId" : "812",
++"price" :
++{
++"amount" : 21.99,
++"currencyId" : "1"
++},
++"name" : "Boss in black",
++"description" : "Be your own boss in black and printed by real people in black!",
++"tags" :
++[
++"Fanwear",
++"SpreadShop",
++"Awesome"
++],
++"previewImage" :
++{
++"url" : "https://image.spreadshirtmedia.net/image-server/v1/products/T812A1PA3811PT17X49Y84D142648902FS2951PA3813PT17X60Y17D142648934FS2706/views/1,width=500,height=500,appearanceId=1,crop=list,modelId=85,version=1554885779/be-your-own-boss-in-black-and-printed-by-real-people-in-black.jpg",
++"type" : "MODEL"
++},
++"appearanceIds" :
++[
++"411",
++"645",
++"649",
++"1",
++"366",
++"92",
++"39",
++"231",
++"317",
++"3",
++"29",
++"328"
++],
++"defaultAppearanceId" : "1"
++}
++{{/code}}
++
++\\
++
++Most of the fields are exactly the same as in the list resource and have the same semantics. Two additional fields are included:
++
++|=(((
++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.
++
++== Basket resources ==
++
++The [[basket resources>>doc:Basket Resources]] generally still work as they used to. However, keep in mind that a sellable is a new domain entity and hence different from products and articles.
++To put a sellable into a basket, use this payload fragment instead:
++
++{{code language="xml" title="Payload Fragment"}}
++<element id="MLorqlGGrLhljORQ7old-1007-22" type="sprd:sellable">
++<properties>
++<property key="appearance">539</property>
++<property key="size">3</property>
++</properties>
++<shop id="100229382" href="https://api.spreadshirt.net/api/v1/shops/100229382"/>
++</element>
++{{/code}}
++
++
++Note that the **type** property needs a different constant now and a **shop** tag needs to be sent as well.
++
++== Legacy article mapping resource ==
++
++If your shop was subject to a migration from the old model (that was based on articles and was accessible through the User Area), you may still have deeplinks or internal data structures referencing these now-gone articles.
++To ease the transition phase, we provide the following resource that allows you to find the corresponding sellable your article was migrated to:
++
++{{code title="Request"}}
++GET {baseUrl}/api/v1/shops/{shopId}/sellables/findForArticle?articleId={articleId}
++
++{{/code}}
++
++
++The response contains the identifiers necessary to make the connection between old and new domain entities.
++
++{{code language="js" title="Response Payload"}}
++{
++"ideaId": "5d0a19935fd3e41d7dd6900f",
++"productTypeId": "725",
++"sellableId": "R43XoE5rBATzxQnRNykG-725-9"
++}
++{{/code}}
++
++== Code example ==
++
++There is an example integration of this API available [[here>>url:https://github.com/spreadshirt/shop-api-example-integration||shape="rect"]].
++It shows a draft of a shop system written in php that might be helpful to understand the (list-page -> detail-page -> add-to-basket) workflow.

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--28278801
++28278802

url

@@ -1,1 +1,1 @@
--https://developer.spreadshirt.net/wiki/spaces/API/pages/28278801/Public Shop API
++https://developer.spreadshirt.net/wiki/spaces/API/pages/28278802/Public Shop API

Changes for page Sellables

Summary

Details

Navigation