Changes for page Sellables

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

From version < 4.1 >

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

To version < 6.1 >

edited by Shop Team
on 2019/07/18 09:34

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -42,7 +42,7 @@
  == 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.
++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 ==
@@ -59,52 +59,52 @@
  {{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
--]
++   "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}}
@@ -195,86 +195,86 @@
  {{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"
++   "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"
  }
--],
--"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}}
  \\
@@ -308,11 +308,11 @@
  {{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"/>
++   <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}}
@@ -334,13 +334,17 @@
  {{code language="js" title="Response Payload"}}
  {
--"ideaId": "5d0a19935fd3e41d7dd6900f",
--"productTypeId": "725",
--"sellableId": "R43XoE5rBATzxQnRNykG-725-9"
++    "ideaId": "5d0a19935fd3e41d7dd6900f",
++    "productTypeId": "725",
++    "sellableId": "R43XoE5rBATzxQnRNykG-725-9"
  }
  {{/code}}
--== Code example ==
++= Implementation Support =
--There is an example integration of this API available [[here>>url:https://github.com/spreadshirt/shop-api-example-integration||shape="rect"]].
++If you do not own a Partner Area based shop yet, but need something "in hand" to develop your implementation, you can rely on the **example shop 100488332** provided by us. The shop is available on the European platform (.net) only. You can use articleId=(% style="color: rgb(80,80,80);" %)999999999 to test the **legacy article mapping resource **in this shop.
++
++Also, 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 @@
--28278802
++28278806

url

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

Changes for page Sellables

Summary

Details

Navigation