Related Documents
Document Properties
Kbid2831H5
Last Modified23-Jun-2020
Added to KB21-Jun-2017
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.9
  • ICM 7.10

REST API - Delete basket sub line item


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/baskets/<basket-id>/items/<item-id>/sublineitems/<sublinetype>

Http Method

DELETE

Short Description

Delete the sublinetype of a specific basket item

Query Parameters

none

Example Requests

/baskets/XkoKDACqjEkAAAFCHClCMC0h/items/zCYKDACqIpAAAAFCPH9OhDGN/sublineitems/warranty

HTTP Status Codes

303 See other

400 Bad Request
       Possible values for header ‘error-key’:

    • basket.basket_id_required.error
    • basket.lineitem.id_required.error

404 Not Found
       Possible values for header ‘error-key’:

    • basket.basket_not_found.error
    • basket.lineitem.id_required.error
    • basket.lineitem.subline_type_required.error
    • basket.lineitem.id_required.error
    • basket.lineitem.not_found.error

Description

Delete the sublinetype of a specific basket item. Valid types are warranty, giftwrap and giftmessage.

If basket or basket item, or subline type is not found then a status code 404 is returned as a result.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web ShopApplications: B2C Web Shop, SMB Web Shop

Access Restrictions

Requires authentication with user having assigned the following permissions:

  • Purchase (APP_B2B_PURCHASE, only in B2B applications)

Product Version

7.9

Product To Version

 
Status

final

JSON

Request Data Format

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.resource.basket.BasketLineItemResource

Response code is 303. Clients can perform a GET on the address contained in the Location header to get the updated basket item.

Response Example

HTTP-Status: 303
Header:

Location: PrimeTech-PrimeTechSpecials-Site/-/baskets/XkoKDACqjEkAAAFCHClCMC0h/items/zCYKDACqIpAAAAFCPH9OhDGN

Body:

{
   "name": "AVM FRITZ!Box Fon WLAN 7170 Annex A",
   "type": "BasketLineItem",
   "id": "0uEKDgAOROcAAAFCUyhPKFYx",
   "displayName": "AVM FRITZ!Box Fon WLAN 7170 Annex A",
   "total":
   {
       "type": "Money",
       "value": 171.25,
       "currencyMnemonic": "USD"
   },
   "singleBasePrice":
   {
       "type": "Money",
       "value": 171.25,
       "currencyMnemonic": "USD"
   },
   "shippingMethod":
   {
       "type": "Link",
       "title": "Media Mail",
       "uri": "PrimeTech-PrimeTechSpecials-Site/-/shippingmethods/Xp8KABvHoNoAAAFCdg8IREUI"
   },
   "variationProduct": false,
   "longDescription": "FRITZ!Box Fon WLAN Overview
FRITZ!Box Fon WLAN makes telephoning over the Internet easy:
Connect your existing telephones and pick up the handset: that's all there is to it! Now you can talk over the Internet with voice over IP (without even turning on your PC) or over the conventional phone line. And FRITZ!Box Fon WLAN also puts your PCs on the Internet at ADSL speed -- over Ethernet, USB or wireless LAN -- all of this with firewall protection and wireless encryption enabled out of the box.
* FRITZ!Box Fon WLAN combines ADSL router and PBX
* Router with integrated ADSL modem; connects to multiple PCs
* Economical phone calls over Internet with VoIP, or over ISDN or analog phone line
* Internet telephony with existing phones, without PC turned on
* Connect analog terminal equipment, ISDN telephones and PBXs
* Intelligent bandwidth management for perfect voice quality
* Up to 5 answering machines and fax function integrated, with voice-to-mail and fax-to-mail
* USB host for USB printers or USB mass storage media in the network
* WLAN encrypted with unique, factory-set key
* Secure WDS repeater mode for extending WLAN range
* WAN port to connect to an existing cable modem or router
* Integrated firewall protects connected PCs
* Wake on LAN: wake up network devices from standby operation
* Many additional functions like Stick & Surf, Eco Mode, VPN
",
   "product":
   {
       "type": "Link",
       "description": "AVM FRITZ!Box Fon WLAN 7170 Annex A",
       "title": "859910",
       "uri": "PrimeTech-PrimeTechSpecials-Site/-/products/859910"
   },
   "price":
   {
       "type": "Money",
       "value": 171.25,
       "currencyMnemonic": "USD"
   },
   "thumbnail":
   {
       "type": "Link",
       "title": "thumbnail",
       "uri": "/INTERSHOP/static/WFS/PrimeTech-PrimeTechSpecials-Site/-/PrimeTech/en_US/1XS/859910-5489.jpg"
   },
   "shortDescription": "FRITZ!Box Fon WLAN 7170 Annex A",
   "sku": "859910",
   "quantity":
   {
       "type": "Quantity",
       "value": 1,
       "unit": ""
   },
   "inStock": true,
   "availability": true,
   "isHiddenGift": false,
   "isFreeGift": false,
   "bundleProduct": false,
   "salesTaxes":
   [
       {
           "type": "AppliedTax",
           "amount":
           {
               "type": "Money",
               "value": 10.28,
               "currencyMnemonic": "USD"
           },
           "rate": 0.06
       }
   ]
}

XML

XML Request Data Format

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.resource.basket.BasketLineItemResource

Response code is 303. Clients can perform a GET on the address contained in the Location header to get the updated basket item.

XML Response Example

HTTP-Status: 303
Header:

Location: PrimeTech-PrimeTechSpecials-Site/-/baskets/XkoKDACqjEkAAAFCHClCMC0h/items/zCYKDACqIpAAAAFCPH9OhDGN

Body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BasketLineItem name="Acer Predator G3 G3610" type="BasketLineItem">
    <availability>true</availability>
    <giftMessage type="Link">
        <description>Birthday Gift Message</description>
        <title>lIIKDACqMlQAAAFChrpTzDHt</title>
        <uri>PrimeTech-PrimeTechSpecials-Site/-/products/BirthdayGiftMessage</uri>
    </giftMessage>
    <giftwrap type="Link">
        <description>Birthday Gift Wrap</description>
        <title>RX0KDACqKmoAAAFCvIxTzDHs</title>
        <uri>PrimeTech-PrimeTechSpecials-Site/-/products/BirthdayGiftWrap</uri>
    </giftwrap>
    <inStock>true</inStock>
    <isHidden>false</isHidden>
    <product type="Link">
        <description>Acer Predator G3 G3610</description>
        <title>10809311</title>
        <uri>PrimeTech-PrimeTechSpecials-Site/-/products/10809311</uri>
    </product>
    <quantity type="Quantity">
        <value>1</value>
    </quantity>
    <salesTaxes>
        <AppliedTax type="AppliedTax">
            <amount type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>221.92</value>
            </amount>
            <rate>0.19</rate>
        </AppliedTax>
    </salesTaxes>
    <shipToAddress type="Address">
        <addressName>Patricia Miller, Berliner Str. 20, Potsdam</addressName>
        <city>Potsdam</city>
        <country>Germany</country>
        <countryCode>DE</countryCode>
        <email>patricia@test.intershop.de</email>
        <firstName>Patricia</firstName>
        <ID>kS4KABvHkwcAAAFCdL4J6CtB</ID>
        <lastName>Miller</lastName>
        <mobile></mobile>
        <phoneBusiness></phoneBusiness>
        <phoneHome>049364112677</phoneHome>
        <postalCode>14482</postalCode>
        <state></state>
        <street>Berliner Str. 20</street>
        <street2></street2>
        <street3></street3>
        <title>Mrs.</title>
    </shipToAddress>
    <shippingMethod type="Link">
        <title>Standard Freight Delivery</title>
        <uri>PrimeTech-PrimeTechSpecials-Site/-/shippingmethods/MnMKABvH0ykAAAFC00MJ6CtN</uri>
    </shippingMethod>
    <sku>10809311</sku>
    <thumbnail type="Link">
        <title>thumbnail</title>
        <uri>/INTERSHOP/static/WFS/PrimeTech-PrimeTechSpecials-Site/-/PrimeTech/en_US/1XS/10809311-9609.jpg</uri>
    </thumbnail>
</BasketLineItem>

Reference - WebShop REST APIs

Disclaimer

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets