REST API - Return basket options (until 7.8)

URI

/baskets/<basket-id>

Http Method

OPTIONS

Short Description

Returns all available options for the given basket

Query Parameters

 

Example Requests

/baskets/uhQKAB17AEcAAAFFvhQ4Cf_V

HTTP Status Codes

200 OK

Description

Returns the following available options for the given basket:

  • Common shipping methods

Depending on the flag isMultipleShippmentSupported the option request returns all available shipping methods for the whole basket or the option request returns nothing:

  • isMultipleShippmentSupported = true: there are no shipping methods for the whole basket available because the shipping methods are only available at the line item level
  • isMultipleShippmentSupported = false: The option request returns all available shipping methods for the whole baskets (shipping methods on basket level).

Cartridge

app_sf_rest
Application

B2C Web Shop, SMB Web Shop

Product Version

7.5

Product To Version

7.8

Status

final

JSON

Request data format

application/json

Request related java object

n/a

Request data example

n/a

Response data format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketOptionsRO
com.intershop.sellside.rest.common.capi.resourceobject.ShippingMethodRO
isMultipleShippmentSupportedtrue (= multiple shipment => no options on basket level available)

Response data example

{
    "type": "BasketOptionsRO"
}    

Request data format

application/json

Request related java object

n/a

Request data example

n/a

Response data format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketOptionsRO
com.intershop.sellside.rest.common.capi.resourceobject.ShippingMethodRO
isMultipleShippmentSupportedfalse (= single shipment => options on basket level available)

Response data example

{
    "type": "BasketOptionsRO",
    "availableShippingMethods":
    {
        "name": "availableShippingMethods",
        "type": "AvailableShippingMethodsRO",
        "description": "Available shipping methods",
        "shippingMethods":
        [
            {
                "name": "E-mail Delivery",
                "type": "ShippingMethodRO",
                "description": "E-mail, normally within 24 hours.",
                "shippingTimeMax": 0,
                "shippingTimeMin": 0,
                "id": "EMAIL"
            },
            {
                "name": "Hazardous Materials",
                "type": "ShippingMethodRO",
                "description": "Shipping according to all applicable hazardous materials rules and regulations.",
                "shippingTimeMax": 10,
                "shippingTimeMin": 7,
                "id": "HAZMAT"
            },
            {
                "name": "International Express Delivery",
                "type": "ShippingMethodRO",
                "description": "International Express Delivery",
                "shippingTimeMax": 5,
                "shippingTimeMin": 3,
                "id": "INT"
            },
            {
                "name": "Media Mail",
                "type": "ShippingMethodRO",
                "description": "Ship books, CDs, DVDs, and other media.",
                "shippingTimeMax": 5,
                "shippingTimeMin": 2,
                "id": "MM"
            },
            {
                "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.",
                "shippingTimeMax": 6,
                "shippingTimeMin": 0,
                "id": "SATURDAY"
            },
            {
                "name": "2-Business Day",
                "type": "ShippingMethodRO",
                "description": "1-2 Day Ground - Delivered to you 1-2 business days after we process your order.",
                "shippingTimeMax": 2,
                "shippingTimeMin": 1,
                "id": "STD_2DAY"
            },
            {
                "name": "5-Business Day",
                "type": "ShippingMethodRO",
                "description": "2-5 Day Ground - Delivered to you 2-5 business days after we process your order.",
                "shippingTimeMax": 5,
                "shippingTimeMin": 2,
                "id": "STD_5DAY"
            },
            {
                "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"
            },
            {
                "name": "Standard Freight Delivery",
                "type": "ShippingMethodRO",
                "description": "Standard freight delivery for large items.",
                "shippingTimeMax": 7,
                "shippingTimeMin": 5,
                "id": "TRUCK"
            }
        ]
    }
}

XML

Request data format

text/xml

Request related java object

n/a

Request data example

n/a

Response data format

text/xml

Response related java object

com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketOptionsRO
com.intershop.sellside.rest.common.capi.resourceobject.ShippingMethodRO
isMultipleShippmentSupportedtrue (= multiple shipment => no options on basket level available)

Response data example

<BasketOptions type="BasketOptionsRO"/>    

Request data format

text/xml

Request related java object

n/a

Request data example

n/a

Response data format

text/xml

Response related java object

com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketOptionsRO
com.intershop.sellside.rest.common.capi.resourceobject.ShippingMethodRO
isMultipleShippmentSupportedfalse (= single shipment => options on basket level available)

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BasketOptions type="BasketOptionsRO">
  <availableShippingMethods name="availableShippingMethods" type="AvailableShippingMethodsRO">
    <description>Available shipping methods</description>
    <shippingMethods>
      <shippingMethod name="E-mail Delivery" type="ShippingMethodRO">
        <description>E-mail, normally within 24 hours.</description>
        <id>EMAIL</id>
        <name>E-mail Delivery</name>
        <shippingTimeMax>0</shippingTimeMax>
        <shippingTimeMin>0</shippingTimeMin>
      </shippingMethod>
      <shippingMethod name="Hazardous Materials" type="ShippingMethodRO">
        <description>Shipping according to all applicable hazardous materials rules and regulations.</description>
        <id>HAZMAT</id>
        <name>Hazardous Materials</name>
        <shippingTimeMax>10</shippingTimeMax>
        <shippingTimeMin>7</shippingTimeMin>
      </shippingMethod>
      <shippingMethod name="International Express Delivery" type="ShippingMethodRO">
        <description>International Express Delivery</description>
        <id>INT</id>
        <name>International Express Delivery</name>
        <shippingTimeMax>5</shippingTimeMax>
        <shippingTimeMin>3</shippingTimeMin>
      </shippingMethod>
      <shippingMethod name="Media Mail" type="ShippingMethodRO">
        <description>Ship books, CDs, DVDs, and other media.</description>
        <id>MM</id>
        <name>Media Mail</name>
        <shippingTimeMax>5</shippingTimeMax>
        <shippingTimeMin>2</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="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="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>
      <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="Standard Freight Delivery" type="ShippingMethodRO">
        <description>Standard freight delivery for large items.</description>
        <id>TRUCK</id>
        <name>Standard Freight Delivery</name>
        <shippingTimeMax>7</shippingTimeMax>
        <shippingTimeMin>5</shippingTimeMin>
      </shippingMethod>
    </shippingMethods>
  </availableShippingMethods>
</BasketOptions>

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