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

REST API - Return basket line item options


Note

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

URI

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

Http Method

OPTIONS

Short Description

Returns all available options for the given line item

Query Parameters

none

Example Requests

/baskets/XkoKDACqjEkAAAFCHClCMC0h/items/7XwKDACqvlwAAAFCkrZCMC2X

HTTP Status Codes

200 OK

Description

Returns the following available options for the given basket line item:

  • Eligible shipping methods
  • Warranties
  • Gift wraps
  • Gift messages
  • Product variation options

Cartridge

app_sf_rest

Application

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.resourceobject.basket.BasketLineItemOptionsRO
com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO.AvailableWarrantiesRO
com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO.AvailableProductVariationsRO
com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO.ApplicableGiftWrapsRO
com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO.ApplicableGiftMessagesRO
com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO.EligibleShippingMethodsRO

Response Example

{
   "type": "BasketLineItemOptionsRO",
   "eligibleShippingMethods":
   {
       "name": "eligibleShippingMethodsRO",
       "type": "EligibleShippingMethodsRO",
       "description": "Available shipping methods",
       "shippingMethods":
       [
           {
               "name": "2-Business Day",
               "type": "ShippingMethodRO",
               "id": "STD_2DAY",
               "description": "1-2 Day Ground - Delivered to you 1-2 business days after we process your order.",
               "shippingTimeMin": 1,
               "shippingTimeMax": 2
           },
           {
               "name": "Standard Ground",
               "type": "ShippingMethodRO",
               "id": "STD_GROUND",
               "description": "3-7 Day Ground - Delivered to you 3-7 business days after we process your order.",
               "shippingTimeMin": 3,
               "shippingTimeMax": 7
           },
           {
               "name": "Saturday Delivery",
               "type": "ShippingMethodRO",
               "id": "SATURDAY",
               "description": "You can expect your order to arrive on a Saturday by either 10:30 a.m. EST or 4:30 p.m. EST, depending on the shipping destination. If your order is placed before 3:00 PM EST, your credit is approved, the receiving address is verified, and the item is in stock, then your order will be shipped the same day.",
               "shippingTimeMin": 0,
               "shippingTimeMax": 6
           },
           {
               "name": "5-Business Day",
               "type": "ShippingMethodRO",
               "id": "STD_5DAY",
               "description": "2-5 Day Ground - Delivered to you 2-5 business days after we process your order.",
               "shippingTimeMin": 2,
               "shippingTimeMax": 5
           }
       ]
   },
   "availableWarranties":
   {
       "name": "availableWarrantiesRO",
       "type": "AvailableWarrantiesRO",
       "description": "Avaliable warranties",
       "warranties":
       [
           {
               "type": "Link",
               "description": "1-year Warranty",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/1YEARWARR",
               "title": "1YEARWARR"
           },
           {
               "type": "Link",
               "description": "2-year Warranty",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/2YEARWARR",
               "title": "2YEARWARR"
           }
       ]
   },
    "availableVariations":
   {
       "name": "availableProductVariationsRO",
       "type": "AvailableProductVariationsRO",
       "description": "Available product variations",
       "variations":
       [
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 640GB",
               "title": "3934150",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934150"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 500GB",
               "title": "3934151",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934151"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 500GB",
               "title": "3934154",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934154"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 500GB",
               "title": "3934158",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934158"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 640GB",
               "title": "3934159",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934159"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 640GB",
               "title": "3934160",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934160"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 640GB",
               "title": "3950413",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3950413"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 500GB",
               "title": "3950792",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3950792"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 750GB",
               "title": "6830671",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/6830671"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 750GB",
               "title": "6830672",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/6830672"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 750GB",
               "title": "6830673",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/6830673"
           },
           {
               "type": "Link",
               "description": "A-DATA CH94 Portable 750GB",
               "title": "6830674",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/6830674"
           }
       ]
   },
   "applicableGiftWraps":
   {
       "name": "applicableGiftWrapsRO",
       "type": "ApplicableGiftWrapsRO",
       "description": "Applicable gift wraps",
       "giftWraps":
       [
           {
               "type": "Link",
               "description": "Ordinary Gift Wrap",
               "title": "OrdinaryGiftWrap",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/OrdinaryGiftWrap"
           },
           {
               "type": "Link",
               "description": "Birthday Gift Wrap",
               "title": "BirthdayGiftWrap",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/BirthdayGiftWrap"
           },
           {
               "type": "Link",
               "description": "Christmas Gift Wrap",
               "title": "ChristmasGiftWrap",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/ChristmasGiftWrap"
           },
           {
               "type": "Link",
               "description": "Flower Gift Wrap",
               "title": "FlowerGiftWrap",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/FlowerGiftWrap"
           },
           {
               "type": "Link",
               "description": "Valentine's Day Gift Wrap",
               "title": "ValentinesDayGiftWrap",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/ValentinesDayGiftWrap"
           }
       ]
   },
   "applicableGiftMessages":
   {
       "name": "applicableGiftMessagesRO",
       "type": "ApplicableGiftMessagesRO",
       "description": "Applicable gift messages",
       "giftMessages":
       [
           {
               "type": "Link",
               "description": "Ordinary Gift Message",
               "title": "OrdinaryGiftMessage",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/OrdinaryGiftMessage"
           },
           {
               "type": "Link",
               "description": "Birthday Gift Message",
               "title": "BirthdayGiftMessage",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/BirthdayGiftMessage"
           },
           {
               "type": "Link",
               "description": "Christmas Gift Message",
               "title": "ChristmasGiftMessage",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/ChristmasGiftMessage"
           },
           {
               "type": "Link",
               "description": "Flower Gift Message",
               "title": "FlowerGiftMessage",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/FlowerGiftMessage"
           },
           {
               "type": "Link",
               "description": "Valentine's Day Gift Message",
               "title": "ValentinesDayGiftMessage",
               "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/ValentinesDayGiftMessage"
           }
       ]
   }
}

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.resourceobject.basket.BasketLineItemOptionsRO
com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO.AvailableWarrantiesRO
com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO.AvailableProductVariationsRO
com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO.ApplicableGiftWrapsRO
com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO.ApplicableGiftMessagesRO
com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO.EligibleShippingMethodsRO

XML Response Example

<BasketLineItemOptions type="BasketLineItemOptionsRO">
    <applicableGiftMessages name="applicableGiftMessagesRO" type="ApplicableGiftMessagesRO">
        <description>Applicable gift messages</description>
        <giftMessages>
            <giftMessage type="Link">
                <description>Ordinary Gift Message</description>
                <title>OrdinaryGiftMessage</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/OrdinaryGiftMessage</uri>
            </giftMessage>
            <giftMessage type="Link">
                <description>Birthday Gift Message</description>
                <title>BirthdayGiftMessage</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/BirthdayGiftMessage</uri>
            </giftMessage>
            <giftMessage type="Link">
                <description>Christmas Gift Message</description>
                <title>ChristmasGiftMessage</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/ChristmasGiftMessage</uri>
            </giftMessage>
            <giftMessage type="Link">
                <description>Flower Gift Message</description>
                <title>FlowerGiftMessage</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/FlowerGiftMessage</uri>
            </giftMessage>
            <giftMessage type="Link">
                <description>Valentine's Day Gift Message</description>
                <title>ValentinesDayGiftMessage</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/ValentinesDayGiftMessage</uri>
            </giftMessage>
        </giftMessages>
    </applicableGiftMessages>
    <applicableGiftWraps name="applicableGiftWrapsRO" type="ApplicableGiftWrapsRO">
        <description>Applicable gift wraps</description>
        <giftWraps>
            <giftWrap type="Link">
                <description>Ordinary Gift Wrap</description>
                <title>OrdinaryGiftWrap</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/OrdinaryGiftWrap</uri>
            </giftWrap>
            <giftWrap type="Link">
                <description>Birthday Gift Wrap</description>
                <title>BirthdayGiftWrap</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/BirthdayGiftWrap</uri>
            </giftWrap>
            <giftWrap type="Link">
                <description>Christmas Gift Wrap</description>
                <title>ChristmasGiftWrap</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/ChristmasGiftWrap</uri>
            </giftWrap>
            <giftWrap type="Link">
                <description>Flower Gift Wrap</description>
                <title>FlowerGiftWrap</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/FlowerGiftWrap</uri>
            </giftWrap>
            <giftWrap type="Link">
                <description>Valentine's Day Gift Wrap</description>
                <title>ValentinesDayGiftWrap</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/ValentinesDayGiftWrap</uri>
            </giftWrap>
        </giftWraps>
    </applicableGiftWraps>
    <availableVariations name="availableProductVariationsRO" type="AvailableProductVariationsRO">
        <description>Available product variations</description>
        <variations>
            <variation type="Link">
                <description>A-DATA CH94 Portable 640GB</description>
                <title>3934150</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934150</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 500GB</description>
                <title>3934151</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934151</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 500GB</description>
                <title>3934154</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934154</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 500GB</description>
                <title>3934158</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934158</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 640GB</description>
                <title>3934159</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934159</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 640GB</description>
                <title>3934160</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3934160</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 640GB</description>
                <title>3950413</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3950413</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 500GB</description>
                <title>3950792</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3950792</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 750GB</description>
                <title>6830671</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/6830671</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 750GB</description>
                <title>6830672</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/6830672</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 750GB</description>
                <title>6830673</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/6830673</uri>
            </variation>
            <variation type="Link">
                <description>A-DATA CH94 Portable 750GB</description>
                <title>6830674</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/6830674</uri>
            </variation>
        </variations>
    </availableVariations>
    <availableWarranties name="AvailableWarrantiesRO" type="AvailableWarrantiesRO">
        <description>Available warranties</description>
        <warranties>
            <warranty type="Link">
                <description>1-year Warranty</description>
                <title>1YEARWARR</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/1YEARWARR</uri>
            </warranty>
            <warranty type="Link">
                <description>2-year Warranty</description>
                <title>2YEARWARR</title>
                <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/2YEARWARR</uri>
            </warranty>
        </warranties>
    </availableWarranties>
    <eligibleShippingMethods name="eligibleShippingMethodsRO" type="EligibleShippingMethodsRO">
        <description>Available shipping methods</description>
        <shippingMethods>
            <shippingMethod name="2-Business Day" type="ShippingMethodRO">
                <description>1-2 Day Ground - Delivered to you 1-2 business days after we process your order.</description>
                <id>STD_2DAY</id>
                <name>2-Business Day</name>
                <shippingTimeMax>2</shippingTimeMax>
                <shippingTimeMin>1</shippingTimeMin>
            </shippingMethod>
            <shippingMethod 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>
            </shippingMethod>
            <shippingMethod name="Saturday Delivery" type="ShippingMethodRO">
                <description>You can expect your order to arrive on a Saturday by either 10:30 a.m. EST or 4:30 p.m. EST, depending on the shipping destination. If your order is placed before 3:00 PM EST, your credit is approved, the receiving address is verified, and the item is in stock, then your order will be shipped the same day.</description>
                <id>SATURDAY</id>
                <name>Saturday Delivery</name>
                <shippingTimeMax>6</shippingTimeMax>
                <shippingTimeMin>0</shippingTimeMin>
            </shippingMethod>
            <shippingMethod name="5-Business Day" type="ShippingMethodRO">
                <description>2-5 Day Ground - Delivered to you 2-5 business days after we process your order.</description>
                <id>STD_5DAY</id>
                <name>5-Business Day</name>
                <shippingTimeMax>5</shippingTimeMax>
                <shippingTimeMin>2</shippingTimeMin>
            </shippingMethod>
        </shippingMethods>
    </eligibleShippingMethods>
</BasketLineItemOptions>

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