Request Data Format | application/json |
---|---|
Request related java object | n/a |
Request Example | n/a |
Response Data Format | application/json |
Response related java object | com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketRO |
isMultipleShippmentSupported | true (= multiple shipment => shipping methods are available at the line item level) |
Response Example | { "name": "basket", "type": "Basket", "purchaseCurrency": "USD", "costCenterID": "511288", "documentNumber": "", "recurringOrderDocumentNo": "0000001", "salesTaxTotalsByTaxRate": [ { "name": "name", "type": "AppliedTax", "rate": 19, "amount": { "type": "Money", "currencyMnemonic": "USD", "value": 121.67 } } ], "totals": { "name": "basketTotals", "type": "BasketTotals", "dutiesAndSurchargesTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 0 }, "shippingTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 3.59 }, "paymentCostsTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 5.95 }, "itemShippingRebatesTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 0 }, "bucketShippingRebatesTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 0 }, "taxTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 122.66 }, "basketTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 768.28 }, "itemTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 773.28 }, "basketValueRebatesTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 20.23 }, "basketShippingRebatesTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 3.59 }, "basketTotalMinusLimitedTender": { "type": "Money", "value": 737.94, "currencyMnemonic": "USD" }, "limitedTenderTotal": { "type": "Money", "value": 30.34, "currencyMnemonic": "USD" } }, "shippingBuckets": [ { "name": "basketShippingBucket", "type": "BasketShippingBucket", "shippingInstructions": "", "lineItems": [ { "type": "Link", "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/baskets/BhkKAB175IwAAAFGG9duYWtl/items/uRUKAB17mBYAAAFGYdhuYWtl", "title": "Canon LEGRIA HF R16", "attributes": [ { "name": "position", "type": "Integer", "value": 1 }, { "name": "sku", "type": "String", "value": "3953312" } ] }, { "type": "Link", "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/baskets/BhkKAB175IwAAAFGG9duYWtl/items/NH8KAB17fkAAAAFG3AVuYWtm", "title": "A-DATA CH94 Portable 640GB", "attributes": [ { "name": "position", "type": "Integer", "value": 3 }, { "name": "sku", "type": "String", "value": "3950413" } ] } ], "shippingMethod": { "name": "Standard Ground", "type": "BasketShippingMethod", "shippingTimeMin": 3, "shippingTimeMax": 7, "id": "STD_GROUND" }, "shipToAddress": { "type": "Address", "city": "Weimar", "countryCode": "DE", "postalCode": "35096", "street": "Philosophenstr. 94", "mobile": "01635587723", "phoneHome": "49334467587", "firstName": "Susanne", "lastName": "Franke", "addressName": "Susanne Franke, Philosophenstr. 94, Weimar", "id": "jNgKAB17LDMAAAFGAuluYWto", "country": "Germany" } } ], "valueRebates": [ { "name": "appliedRebate", "type": "AppliedRebate", "description": "", "rebateType": "OrderValueOffDiscount", "amount": { "type": "Money", "currencyMnemonic": "USD", "value": 8.33 } }, { "name": "appliedRebate", "type": "AppliedRebate", "description": "For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code "INTERSHOP".", "code": "INTERSHOP", "rebateType": "OrderValueOffDiscount", "amount": { "type": "Money", "currencyMnemonic": "USD", "value": 11.9 } } ], "shippingRebates": [ { "name": "appliedRebate", "type": "AppliedRebate", "description": "", "rebateType": "ShippingValueOffDiscount", "amount": { "type": "Money", "currencyMnemonic": "USD", "value": 3.59 } } ], "dynamicMessages": [ "Buy another product which costs more then $ 14.00 and get my promotion!" ], "affiliatePartnerID": "4bcKAB2Ykg4AAAFbjvEYRPJ7", "affiliateProgramID": "uzMKAB2YvKAAAAFb7DUYRPJ8", "multipleShippmentsSupported": true, "invoiceToAddress": { "type": "Address", "city": "Weimar", "countryCode": "DE", "postalCode": "35096", "street": "Philosophenstr. 94", "mobile": "01635587723", "phoneHome": "49334467587", "firstName": "Susanne", "lastName": "Franke", "addressName": "Susanne Franke, Philosophenstr. 94, Weimar", "id": "jNgKAB17LDMAAAFGAuluYWto", "country": "Germany" }, "id": "BhkKAB175IwAAAFGG9duYWtl" } |
Request Data Format | application/json |
---|---|
Request related java object | n/a |
Request Example | n/a |
Response Data Format | application/json |
Response related java object | com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketRO |
isMultipleShippmentSupported | false (= single shipment => shipping methods are available at the basket level) |
Response Example | { "name": "basket", "type": "Basket", "costCenterID": "511288", "documentNumber": "", "recurringOrderDocumentNo": "0000001", "invoiceToAddress": { "type": "Address", "city": "Potsdam", "countryCode": "DE", "postalCode": "14482", "street": "Berliner Str. 20", "phoneHome": "049364112677", "firstName": "Patricia", "lastName": "Miller", "title": "Mrs.", "addressName": "Patricia Miller, Berliner Str. 20, Potsdam", "id": "a28KAB3RrIkAAAFGfwFjRgSD", "country": "Germany" }, "commonShipToAddress": { "type": "Address", "city": "Potsdam", "countryCode": "DE", "postalCode": "14482", "street": "Berliner Str. 20", "phoneHome": "049364112677", "firstName": "Patricia", "lastName": "Miller", "title": "Mrs.", "addressName": "Patricia Miller, Berliner Str. 20, Potsdam", "id": "a28KAB3RrIkAAAFGfwFjRgSD", "country": "Germany" }, "commonShippingMethod": { "name": "Standard Ground", "type": "ShippingMethodRO", "description": "3-7 Day Ground - Delivered to you 3-7 business days after we process your order.", "shippingTimeMax": 7, "shippingTimeMin": 3, "id": "STD_GROUND" }, "purchaseCurrency": "USD", "multipleShippmentsSupported": false, "salesTaxTotalsByTaxRate": [ { "name": "name", "type": "AppliedTax", "amount": { "type": "Money", "currencyMnemonic": "USD", "value": 193.08 }, "rate": 19 } ], "shippingTaxTotalsByTaxRate": [ { "name": "name", "type": "AppliedTax", "amount": { "type": "Money", "currencyMnemonic": "USD", "value": 2.7 }, "rate": 19 } ], "recurrence": { "type": "Recurrence", "startDate": 1472680800000, "endDate": 1504216800000, "interval": "P2M", "repetitions": 42 }, "shippingBuckets": [ { "name": "basketShippingBucket", "type": "BasketShippingBucket", "shippingMethod": { "name": "Standard Ground", "type": "BasketShippingMethod", "shippingTimeMax": 7, "shippingTimeMin": 3, "id": "STD_GROUND" }, "shipToAddress": { "type": "Address", "city": "Potsdam", "countryCode": "DE", "postalCode": "14482", "street": "Berliner Str. 20", "phoneHome": "049364112677", "firstName": "Patricia", "lastName": "Miller", "title": "Mrs.", "addressName": "Patricia Miller, Berliner Str. 20, Potsdam", "id": "a28KAB3RrIkAAAFGfwFjRgSD", "country": "Germany" }, "lineItems": [ { "type": "Link", "title": "HP ProBook 6550b Notebook PC", "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/baskets/L2IKAB3Rr6YAAAFGbuhjRgSB/items/KG4KAB3RjdAAAAFGwuljRgSB", "attributes": [ { "name": "position", "type": "Integer", "value": 1 }, { "name": "sku", "type": "String", "value": "5079807" } ] }, { "type": "Link", "title": "Benq MD300", "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/baskets/L2IKAB3Rr6YAAAFGbuhjRgSB/items/yN4KAB3RUBcAAAFGZw5jRgSC", "attributes": [ { "name": "position", "type": "Integer", "value": 2 }, { "name": "sku", "type": "String", "value": "1612143" } ] } ] } ], "totals": { "name": "basketTotals", "type": "BasketTotals", "basketShippingRebatesTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 0 }, "basketValueRebatesTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 0 }, "itemTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 1209.28 }, "basketTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 1226.22 }, "itemShippingRebatesTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 0 }, "bucketShippingRebatesTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 0 }, "dutiesAndSurchargesTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 0 }, "shippingTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 16.94 }, "taxTotal": { "type": "Money", "currencyMnemonic": "USD", "value": 195.78 }, "basketTotalMinusLimitedTender": { "type": "Money", "value": 1195.88, "currencyMnemonic": "USD" }, "limitedTenderTotal": { "type": "Money", "value": 30.34, "currencyMnemonic": "USD" } }, "affiliatePartnerID": "4bcKAB2Ykg4AAAFbjvEYRPJ7", "affiliateProgramID": "uzMKAB2YvKAAAAFb7DUYRPJ8", "id": "L2IKAB3Rr6YAAAFGbuhjRgSB" } |
XML Request Data Format | text/xml |
---|---|
XML Request Java Objects | n/a |
XML Request Example | n/a |
XML Response Data Format | text/xml |
XML Response Java Objects | com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketRO |
isMultipleShippmentSupported | true (= multiple shipment => shipping methods are available at the line item level) |
XML Response Example | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Basket name="basket" type="Basket"> <affiliatePartnerID>4bcKAB2Ykg4AAAFbjvEYRPJ7</affiliatePartnerID> <affiliateProgramID>uzMKAB2YvKAAAAFb7DUYRPJ8</affiliateProgramID> <costCenterID>511288</costCenterID> <id>BhkKAB175IwAAAFGG9duYWtl</id> <documentNumber></documentNumber> <recurringOrderDocumentNo>0000001</recurringOrderDocumentNo> <invoiceToAddress type="Address"> <addressName>Susanne Franke, Philosophenstr. 94, Weimar</addressName> <city>Weimar</city> <country>Germany</country> <countryCode>DE</countryCode> <firstName>Susanne</firstName> <id>jNgKAB17LDMAAAFGAuluYWto</id> <lastName>Franke</lastName> <mobile>01635587723</mobile> <phoneHome>49334467587</phoneHome> <postalCode>35096</postalCode> <street>Philosophenstr. 94</street> </invoiceToAddress> <multipleShippmentsSupported>true</multipleShippmentsSupported> <purchaseCurrency>USD</purchaseCurrency> <salesTaxTotalsByTaxRate> <AppliedTax name="name" type="AppliedTax"> <amount type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>121.67</value> </amount> <rate>19.0</rate> </AppliedTax> </salesTaxTotalsByTaxRate> <shippingBuckets> <BasketShippingBucket name="basketShippingBucket" type="BasketShippingBucket"> <lineItems> <Link type="Link"> <attributes> <ResourceAttribute name="position" type="Integer"> <value>1</value> </ResourceAttribute> <ResourceAttribute name="sku" type="String"> <value>3953312</value> </ResourceAttribute> </attributes> <title>Canon LEGRIA HF R16</title> <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/baskets/BhkKAB175IwAAAFGG9duYWtl/items/uRUKAB17mBYAAAFGYdhuYWtl</uri> </Link> <Link type="Link"> <attributes> <ResourceAttribute name="position" type="Integer"> <value>3</value> </ResourceAttribute> <ResourceAttribute name="sku" type="String"> <value>3950413</value> </ResourceAttribute> </attributes> <title>A-DATA CH94 Portable 640GB</title> <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/baskets/BhkKAB175IwAAAFGG9duYWtl/items/NH8KAB17fkAAAAFG3AVuYWtm</uri> </Link> </lineItems> <shipToAddress type="Address"> <addressName>Susanne Franke, Philosophenstr. 94, Weimar</addressName> <city>Weimar</city> <country>Germany</country> <countryCode>DE</countryCode> <firstName>Susanne</firstName> <id>jNgKAB17LDMAAAFGAuluYWto</id> <lastName>Franke</lastName> <mobile>01635587723</mobile> <phoneHome>49334467587</phoneHome> <postalCode>35096</postalCode> <street>Philosophenstr. 94</street> </shipToAddress> <shippingInstructions> </shippingInstructions> <shippingMethod name="Standard Ground" type="BasketShippingMethod"> <id>STD_GROUND</id> <shippingTimeMax>7</shippingTimeMax> <shippingTimeMin>3</shippingTimeMin> </shippingMethod> </BasketShippingBucket> </shippingBuckets> <shippingRebates> <AppliedRebate name="appliedRebate" type="AppliedRebate"> <rebateType>ShippingValueOffDiscount</rebateType> </AppliedRebate> </shippingRebates> <totals name="basketTotals" type="BasketTotals"> <basketShippingRebatesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>3.59</value> </basketShippingRebatesTotal> <basketTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>768.28</value> </basketTotal> <basketTotalMinusLimitedTender type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>737.94000</value> </basketTotalMinusLimitedTender> <basketValueRebatesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>20.23</value> </basketValueRebatesTotal> <bucketShippingRebatesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </bucketShippingRebatesTotal> <dutiesAndSurchargesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </dutiesAndSurchargesTotal> <itemShippingRebatesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </itemShippingRebatesTotal> <itemTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>773.28</value> </itemTotal> <limitedTenderTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>30.34000</value> </limitedTenderTotal> <paymentCostsTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>5.95</value> </paymentCostsTotal> <shippingTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>3.59</value> </shippingTotal> <taxTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>122.66</value> </taxTotal> </totals> <valueRebates> <AppliedRebate name="appliedRebate" type="AppliedRebate"> <rebateType>OrderValueOffDiscount</rebateType> </AppliedRebate> <AppliedRebate name="appliedRebate" type="AppliedRebate"> <code>INTERSHOP</code> <rebateType>OrderValueOffDiscount</rebateType> </AppliedRebate> </valueRebates> <dynamicMessages> <span style="color: #ff0000;">Buy another product which costs more then $ 14.00 and get my promotion!</span> </dynamicMessages> </Basket> |
XML Request Data Format | text/xml |
---|---|
XML Request Java Objects | n/a |
XML Request Example | n/a |
XML Response Data Format | text/xml |
XML Response Java Objects | com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketRO |
isMultipleShippmentSupported | false (= single shipment => shipping methods are available at the basket level) |
XML Response Example | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Basket name="basket" type="Basket"> <affiliatePartnerID>4bcKAB2Ykg4AAAFbjvEYRPJ7</affiliatePartnerID> <affiliateProgramID>uzMKAB2YvKAAAAFb7DUYRPJ8</affiliateProgramID> <commonShipToAddress type="Address"> <addressName>Patricia Miller, Berliner Str. 20, Potsdam</addressName> <city>Potsdam</city> <country>Germany</country> <countryCode>DE</countryCode> <firstName>Patricia</firstName> <id>a28KAB3RrIkAAAFGfwFjRgSD</id> <lastName>Miller</lastName> <phoneHome>049364112677</phoneHome> <postalCode>14482</postalCode> <street>Berliner Str. 20</street> <title>Mrs.</title> </commonShipToAddress> <commonShippingMethod name="Standard Ground" type="ShippingMethodRO"> <description>3-7 Day Ground - Delivered to you 3-7 business days after we process your order.</description> <id>STD_GROUND</id> <name>Standard Ground</name> <shippingTimeMax>7</shippingTimeMax> <shippingTimeMin>3</shippingTimeMin> </commonShippingMethod> <id>L2IKAB3Rr6YAAAFGbuhjRgSB</id> <documentNumber></documentNumber> <recurringOrderDocumentNo>0000001</recurringOrderDocumentNo> <invoiceToAddress type="Address"> <addressName>Patricia Miller, Berliner Str. 20, Potsdam</addressName> <city>Potsdam</city> <country>Germany</country> <countryCode>DE</countryCode> <firstName>Patricia</firstName> <id>a28KAB3RrIkAAAFGfwFjRgSD</id> <lastName>Miller</lastName> <phoneHome>049364112677</phoneHome> <postalCode>14482</postalCode> <street>Berliner Str. 20</street> <title>Mrs.</title> </invoiceToAddress> <recurrence startDate="2016-09-01T10:00:00Z" endDate="2017-09-01T10:00:00Z" interval="P2M" repetitions="42" type="Recurrence"/> <multipleShippmentsSupported>false</multipleShippmentsSupported> <purchaseCurrency>USD</purchaseCurrency> <salesTaxTotalsByTaxRate> <AppliedTax name="name" type="AppliedTax"> <amount type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>193.08</value> </amount> <rate>19.0</rate> </AppliedTax> </salesTaxTotalsByTaxRate> <shippingBuckets> <BasketShippingBucket name="basketShippingBucket" type="BasketShippingBucket"> <lineItems> <Link type="Link"> <attributes> <ResourceAttribute name="position" type="Integer"> <value>1</value> </ResourceAttribute> <ResourceAttribute name="sku" type="String"> <value>5079807</value> </ResourceAttribute> </attributes> <title>HP ProBook 6550b Notebook PC</title> <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/baskets/L2IKAB3Rr6YAAAFGbuhjRgSB/items/KG4KAB3RjdAAAAFGwuljRgSB</uri> </Link> <Link type="Link"> <attributes> <ResourceAttribute name="position" type="Integer"> <value>2</value> </ResourceAttribute> <ResourceAttribute name="sku" type="String"> <value>1612143</value> </ResourceAttribute> </attributes> <title>Benq MD300</title> <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/baskets/L2IKAB3Rr6YAAAFGbuhjRgSB/items/yN4KAB3RUBcAAAFGZw5jRgSC</uri> </Link> </lineItems> <shipToAddress type="Address"> <addressName>Patricia Miller, Berliner Str. 20, Potsdam</addressName> <city>Potsdam</city> <country>Germany</country> <countryCode>DE</countryCode> <firstName>Patricia</firstName> <id>a28KAB3RrIkAAAFGfwFjRgSD</id> <lastName>Miller</lastName> <phoneHome>049364112677</phoneHome> <postalCode>14482</postalCode> <street>Berliner Str. 20</street> <title>Mrs.</title> </shipToAddress> <shippingMethod name="Standard Ground" type="BasketShippingMethod"> <id>STD_GROUND</id> <shippingTimeMax>7</shippingTimeMax> <shippingTimeMin>3</shippingTimeMin> </shippingMethod> </BasketShippingBucket> </shippingBuckets> <shippingTaxTotalsByTaxRate> <AppliedTax name="name" type="AppliedTax"> <amount type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>2.70</value> </amount> <rate>19.0</rate> </AppliedTax> </shippingTaxTotalsByTaxRate> <totals name="basketTotals" type="BasketTotals"> <basketShippingRebatesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </basketShippingRebatesTotal> <basketTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>1226.22</value> </basketTotal> <basketTotalMinusLimitedTender type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>1195.88000</value> </basketTotalMinusLimitedTender> <basketValueRebatesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.00</value> </basketValueRebatesTotal> <bucketShippingRebatesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </bucketShippingRebatesTotal> <dutiesAndSurchargesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </dutiesAndSurchargesTotal> <itemShippingRebatesTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>0.0</value> </itemShippingRebatesTotal> <itemTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>1209.28</value> </itemTotal> <limitedTenderTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>30.34000</value> </limitedTenderTotal> <shippingTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>16.94</value> </shippingTotal> <taxTotal type="Money"> <currencyMnemonic>USD</currencyMnemonic> <value>195.78</value> </taxTotal> </totals> </Basket> |
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.