AddItemToCart (Method)

Description

Adds an Item, by Item_ID, to the current shopping cart in a specified Quantity using the Unit of Measure.

Request (AddItemToCartSoapIn)

The request body is of type AddItemToCart.

Request Body Parameters

Name	Description	Data Type
Item_ID	The Item_ID of the Item to add to the cart.	xml:int
Qty	The quantity of the Item to add to the cart.	xml:int
UOM	The type of the unit of measure. Valid options are as follows: Stocking: "stocking", "STK", "S" or 1 Alternate: "alternate", "ALT", "A" or 2 Other: "other", "OTH", "O" or 3 Preferred: "preferred", "PREF", "P" or 0 or Specify the UOM by the unit label text prefixed with an @ sign. For example "@EA"	xml:anyType
Options	An object with optional parameters. Introduced in v2.21. Available parameters Warehouse - a valid warehouse code, which when sent will request the line be shipped from the specified warehouse. Assumes the item is stocked in the specified warehouse.	xml:string

Example

The following example shows how to perform the web operation in CyberStore.

Javascript

// Example: Add to the Shopping Cart  
//      the Item with Item_ID = 579 
//      with a quantity of 1
//      in the Preferred unit of measure
// then send the response to the browser console

MakeAJAXCall("Cart.AddItemToCart", {
    Item_ID: 579,
    Qty: 1,
    UOM: 'preferred'
}, console.log);

// Example 2: Add item to the Shopping Cart 
//      with a warehouse specified as an optional parameter

MakeAJAXCall("Cart.AddItemToCart", {
    Item_ID: 579,
    Qty: 1,
    UOM: 0,
    Options: {
        Warehouse: 'N'
    }
}, console.log);

200 Response (AddItemToCartSoapOut)

The response body is of type AddItemToCartResponse.

Response Body Parameters

Name	Description	Data Type
AddItemToCartResult	A string value containing a JSON object containing the details of the items in the cart after peforming the add item operation. // Example 1: Successful add to cart response { "Success": true, "CartOrderDetail_ID": 1007, "Message": "There are 2 items in the Shopping Cart.", "Data": { "ItemCount": 2, "SubTotalAmount": 860.3, "Weight": 20.0, "Volume": 0.6, "LastUpdated": "2022-03-29T16:06:49.86", "SubTotal": "$860.30 ", "Detail": [{ "Row": 1, "ID": 1007, "Item_ID": 579, "Parent_ID": -1, "StockCode": "A100", "Description": "15 Speed Mountain Bike Boys", "Quantity": 2, "UOM": "EA", "UnitType": 1, "DefaultPriceAmount": 560.0, "CustomerPriceAmount": 559.0, "DiscountPriceAmount": 477.945, "WebPriceAmount": 430.1505, "TotalPriceAmount": 860.3, "UnitWeight": 10.0, "UnitVolume": 0.3, "IsBackordered": false, "Warehouse": "", "LastUpdated": "2022-03-29T16:40:37.333", "URL": "/ECommerce/product/a100/15-speed-mountain-bike-boys", "Photo": "/Ecommerce/site/images/Photo1/A100.jpg", "DefaultPrice": "$560.00 ", "CustomerPrice": "$559.00 ", "DiscountPrice": "$477.945 ", "WebPrice": "$430.151 ", "TotalPrice": "$860.30 " }] }, "Result": { "Success": true, "Message": "There are 2 items in the Shopping Cart.", "ElapsedTime": "51 ms" } } // Example 2: Error add to cart response { "Success": false, "CartOrderDetail_ID": 0, "Message": "The requested item was not found, and can not be added to the cart at this time.\r\n There are 2 items in the Shopping Cart.", "Data": { "ItemCount": 2, "SubTotalAmount": 860.3, "Weight": 20.0, "Volume": 0.6, "LastUpdated": "2022-03-29T16:06:49.86", "SubTotal": "$860.30 ", "Detail": [{ "Row": 1, "ID": 1007, "Item_ID": 579, "Parent_ID": -1, "StockCode": "A100", "Description": "15 Speed Mountain Bike Boys", "Quantity": 2, "UOM": "EA", "UnitType": 1, "DefaultPriceAmount": 560.0, "CustomerPriceAmount": 559.0, "DiscountPriceAmount": 477.945, "WebPriceAmount": 430.1505, "TotalPriceAmount": 860.3, "UnitWeight": 10.0, "UnitVolume": 0.3, "IsBackordered": false, "Warehouse": "", "LastUpdated": "2022-03-29T16:40:37.333", "URL": "/ECommerce/product/a100/15-speed-mountain-bike-boys", "Photo": "/Ecommerce/site/images/Photo1/A100.jpg", "DefaultPrice": "$560.00 ", "CustomerPrice": "$559.00 ", "DiscountPrice": "$477.945 ", "WebPrice": "$430.151 ", "TotalPrice": "$860.30 " }] }, "Result": { "Success": false, "Message": "The requested item was not found, and can not be added to the cart at this time.\r\n There are 2 items in the Shopping Cart.", "ElapsedTime": "7 ms" } }	xml:string

Name

Description

Data Type

AddItemToCartResult

A string value containing a JSON object containing the details of the items in the cart after peforming the add item operation.

// Example 1: Successful add to cart response

{
    "Success": true,
    "CartOrderDetail_ID": 1007,
    "Message": "There are 2 items in the Shopping Cart.",
    "Data": {
        "ItemCount": 2,
        "SubTotalAmount": 860.3,
        "Weight": 20.0,
        "Volume": 0.6,
        "LastUpdated": "2022-03-29T16:06:49.86",
        "SubTotal": "$860.30 ",
        "Detail": [{
            "Row": 1,
            "ID": 1007,
            "Item_ID": 579,
            "Parent_ID": -1,
            "StockCode": "A100",
            "Description": "15 Speed Mountain Bike Boys",
            "Quantity": 2,
            "UOM": "EA",
            "UnitType": 1,
            "DefaultPriceAmount": 560.0,
            "CustomerPriceAmount": 559.0,
            "DiscountPriceAmount": 477.945,
            "WebPriceAmount": 430.1505,
            "TotalPriceAmount": 860.3,
            "UnitWeight": 10.0,
            "UnitVolume": 0.3,
            "IsBackordered": false,
            "Warehouse": "",
            "LastUpdated": "2022-03-29T16:40:37.333",
            "URL": "/ECommerce/product/a100/15-speed-mountain-bike-boys",
            "Photo": "/Ecommerce/site/images/Photo1/A100.jpg",
            "DefaultPrice": "$560.00 ",
            "CustomerPrice": "$559.00 ",
            "DiscountPrice": "$477.945 ",
            "WebPrice": "$430.151 ",
            "TotalPrice": "$860.30 "
        }]
    },
    "Result": {
        "Success": true,
        "Message": "There are 2 items in the Shopping Cart.",
        "ElapsedTime": "51 ms"
    }
}

// Example 2: Error add to cart response

{
    "Success": false,
    "CartOrderDetail_ID": 0,
    "Message": "The requested item was not found, and can not be added to the cart at this time.\r\n There are 2 items in the Shopping Cart.",
    "Data": {
        "ItemCount": 2,
        "SubTotalAmount": 860.3,
        "Weight": 20.0,
        "Volume": 0.6,
        "LastUpdated": "2022-03-29T16:06:49.86",
        "SubTotal": "$860.30 ",
        "Detail": [{
            "Row": 1,
            "ID": 1007,
            "Item_ID": 579,
            "Parent_ID": -1,
            "StockCode": "A100",
            "Description": "15 Speed Mountain Bike Boys",
            "Quantity": 2,
            "UOM": "EA",
            "UnitType": 1,
            "DefaultPriceAmount": 560.0,
            "CustomerPriceAmount": 559.0,
            "DiscountPriceAmount": 477.945,
            "WebPriceAmount": 430.1505,
            "TotalPriceAmount": 860.3,
            "UnitWeight": 10.0,
            "UnitVolume": 0.3,
            "IsBackordered": false,
            "Warehouse": "",
            "LastUpdated": "2022-03-29T16:40:37.333",
            "URL": "/ECommerce/product/a100/15-speed-mountain-bike-boys",
            "Photo": "/Ecommerce/site/images/Photo1/A100.jpg",
            "DefaultPrice": "$560.00 ",
            "CustomerPrice": "$559.00 ",
            "DiscountPrice": "$477.945 ",
            "WebPrice": "$430.151 ",
            "TotalPrice": "$860.30 "
        }]
    },
    "Result": {
        "Success": false,
        "Message": "The requested item was not found, and can not be added to the cart at this time.\r\n There are 2 items in the Shopping Cart.",
        "ElapsedTime": "7 ms"
    }
}

xml:string