Changes for page Baskets

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

From version < 3.1 >

edited by Shop Team
on 2019/08/01 12:05

To version < 2.1 >

edited by Shop Team
on 2019/08/01 11:21

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

@@ -66,26 +66,19 @@
  )))|(((
  The quantity of the specific basket item that the customer selected.
  )))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--basketItems/element/id
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--SellableId of the sellable you want to put into the basket.
--)))
  |(((
--basketItems/element/type
++basketItems/type
  )))|(((
  A constant for all Partner Area based shops. Always use "sprd:sellable".
  )))
  |(((
--basketItems/element/properties
++basketItems/properties
  )))|(((
  This array of key-value-pairs must always contain values for "size" and "appearance".
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
--basketItems/element/shop/id
++basketItems/shop/id
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
  The id of your shop.
@@ -104,274 +104,3 @@
  (% class="auto-cursor-target" %)
  \\
--
--(% class="auto-cursor-target" %)
--= Read a basket =
--
--|=(((
--Method
--)))|=(((
--URL
--)))|=(((
--Example
--)))
--|(((
--GET
--)))|(((
--/api/v1/baskets/<basketId>
--)))|(((
--[[https:~~/~~/api.spreadshirt.net/api/v1/baskets/5ad33740-30ad-41b0-846f-9e1f0c6824b5?mediaType=json>>url:https://api.spreadshirt.net/api/v1/currencies/1?mediaType=json||shape="rect"]]
--)))
--
--(% class="auto-cursor-target" %)
--Given an id obtained from creating a basket, this resource allows to read the basket data and it contains additional information that can be useful to show to the customer.
--
--{{code language="js" title="Example Response Payload"}}
--
--{
--   "href" : "https://api.spreadshirt.net/api/v1/baskets/5ad33740-30ad-41b0-846f-9e1f0c6824b5",
--   "id" : "5ad33740-30ad-41b0-846f-9e1f0c6824b5",
--   "shop" :
--      {
--         "href" : "https://api.spreadshirt.net/api/v1/shops/100488332",
--         "id" : "100488332"
--      },
--   "currency" :
--      {
--         "href" : "https://api.spreadshirt.net/api/v1/currencies/1",
--         "id" : "1"
--      },
--   "language" :
--      {
--         "href" : "https://api.spreadshirt.net/api/v1/languages/2",
--         "id" : "2"
--      },
--   "country" :
--      {
--         "href" : "https://api.spreadshirt.net/api/v1/countries/1",
--         "id" : "1"
--      },
--   "shipping" :
--      {
--         "price" :
--            {
--               "vatExcluded" : 4.16,
--               "vatIncluded" : 4.99,
--               "display" : 4.99,
--               "vat" : 20,
--               "currency" :
--                  {
--                     "href" : "https://api.spreadshirt.net/api/v1/currencies/1",
--                     "id" : "1"
--                  }
--            },
--         "priceItem" :
--            {
--               "vatExcluded" : 4.16,
--               "vatIncluded" : 4.99,
--               "display" : 4.99,
--               "vat" : 20,
--               "currency" :
--                  {
--                     "href" : "https://api.spreadshirt.net/api/v1/currencies/1",
--                     "id" : "1"
--                  }
--            }
--      },
--   "priceItems" :
--      {
--         "vatExcluded" : 14.58,
--         "vatIncluded" : 17.49,
--         "display" : 17.49,
--         "currency" :
--            {
--               "href" : "https://api.spreadshirt.net/api/v1/currencies/1",
--               "id" : "1"
--            }
--      },
--   "priceTotal" :
--      {
--         "vatExcluded" : 18.74,
--         "vatIncluded" : 22.48,
--         "display" : 22.48,
--         "currency" :
--            {
--               "href" : "https://api.spreadshirt.net/api/v1/currencies/1",
--               "id" : "1"
--            }
--      },
--   "basketItems" :
--      [
--         {
--            "href" : "https://api.spreadshirt.net/api/v1/baskets/5ad33740-30ad-41b0-846f-9e1f0c6824b5/items/672b26f1-e9e5-479b-973a-cfba1d1c8139",
--            "id" : "672b26f1-e9e5-479b-973a-cfba1d1c8139",
--            "description" : "Men’s Premium T-Shirt",
--            "quantity" : 1,
--            "element" :
--               {
--                  "id" : "praawgg73zU5gzZN0gaM-812-7",
--                  "type" : "sprd:sellable",
--                  "shop" :
--                     {
--                        "href" : "https://api.spreadshirt.net/api/v1/shops/100488332",
--                        "id" : "100488332"
--                     },
--                  "properties" :
--                     [
--                        {
--                           "key" : "size",
--                           "value" : "3"
--                        },
--                        {
--                           "key" : "sizeLabel",
--                           "value" : "M"
--                        },
--                        {
--                           "key" : "appearance",
--                           "value" : "2"
--                        },
--                        {
--                           "key" : "appearanceLabel",
--                           "value" : "black"
--                        },
--                        {
--                           "key" : "sellable",
--                           "value" : "praawgg73zU5gzZN0gaM-812-7"
--                        },
--                        {
--                           "key" : "idea",
--                           "value" : "5d22f8ebb264a16f6b87fb6f"
--                        },
--                        {
--                           "key" : "product",
--                           "value" : "524053687"
--                        },
--                        {
--                           "key" : "productType",
--                           "value" : "812"
--                        },
--                        {
--                           "key" : "appearanceLink",
--                           "value" : "http://image.spreadshirtmedia.net/image-server/v1/appearances/2"
--                        }
--                     ]
--               },
--            "shop" :
--               {
--                  "href" : "https://api.spreadshirt.net/api/v1/shops/100488332",
--                  "id" : "100488332"
--               },
--            "priceItem" :
--               {
--                  "vatExcluded" : 14.58,
--                  "vatIncluded" : 17.49,
--                  "display" : 17.49,
--                  "vat" : 20,
--                  "currency" :
--                     {
--                        "href" : "https://api.spreadshirt.net/api/v1/currencies/1",
--                        "id" : "1"
--                     }
--               },
--            "price" :
--               {
--                  "vatExcluded" : 14.58,
--                  "vatIncluded" : 17.49,
--                  "display" : 17.49,
--                  "vat" : 20,
--                  "currency" :
--                     {
--                        "href" : "https://api.spreadshirt.net/api/v1/currencies/1",
--                        "id" : "1"
--                     }
--               }
--         }
--      ],
--   "links" :
--      [
--         {
--            "type" : "defaultCheckout",
--            "href" : "https://checkout.spreadshirt.de/en?basketId=5ad33740-30ad-41b0-846f-9e1f0c6824b5"
--         },
--         {
--            "type" : "shopCheckout",
--            "href" : "https://checkout.spreadshirt.de/en?basketId=5ad33740-30ad-41b0-846f-9e1f0c6824b5&shopId=100488332"
--         },
--         {
--            "type" : "platformCheckout",
--            "href" : "https://checkout.spreadshirt.de/en?basketId=5ad33740-30ad-41b0-846f-9e1f0c6824b5"
--         }
--      ]
--}
--{{/code}}
--
--The most important fields are summarized as follows:
--
--|=(((
--Field
--)))|=(((
--Description
--)))
--|(((
--shipping/priceItem/display
--)))|(((
--Assumed shipping price for standard shipping without shipping discounts. (The exact price depends on the customer's location.)
--)))
--|(((
--shipping/price/display
--)))|(((
--Assumed shipping price for standard shipping with shipping discounts subtracted. (The exact price depends on the customer's location.)
--)))
--|(((
--priceItems/display
--)))|(((
--Total price of all basket items with discounts already subtracted.
--)))
--|(((
--priceTotal/display
--)))|(((
--Total price of all basket items (with discounts already subtracted) plus shipping/price/display. This is what you usually want to dispay as **total**.
--)))
--|(((
--basketItems/description
--)))|(((
--Human-readable product type description.
--)))
--|(((
--basketItems/quantity
--)))|(((
--This is what you sent when creating the basket.
--)))
--|(((
--basketItems/element/id
--)))|(((
--This is what you sent when creating the basket.
--)))
--|(((
--basketItems/element/properties
--)))|(((
--Aside from the properties that you sent yourself when creating the basket, this also includes the useful human-readable fields "sizeLabel" and "appearanceLabel".
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--basketItems/priceItem/display
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--The price for an item with quantity=1 without taking discounts into account.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--basketItems/price/display
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--The price for an item with quantity=1 with discounts subtracted.
--)))
--|(% colspan="1" %)(% colspan="1" %)
--(((
--links
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--Use the link with type "shopCheckout" to redirect your customer to Spreadshirt's checkout.
--)))
--
--\\

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--28278863
++28278858

url

@@ -1,1 +1,1 @@
--https://developer.spreadshirt.net/wiki/spaces/API/pages/28278863/Baskets
++https://developer.spreadshirt.net/wiki/spaces/API/pages/28278858/Baskets

Changes for page Baskets

Summary

Details

Navigation