j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Add an item to a basket.
Operation ID: addItemToBasketAdds new items to a basket. The added items are associated with the specified shipment. If no shipment id is specified, the added items are associated with the default shipment. Considered values from the request body, for each item are:
- productId: a valid product ID. This is the ID of the product to be added to the basket. If the product is already in the basket, the API either increments the quantity of the existing product line item or creates a new product line item, based on the site preference 'Add Product Behavior'. For option products and product bundles containing variation masters, the API creates a new product line item regardless of the site preference.
- shipmentId: a valid shipment ID (optional). This is the ID of the shipment in which the product item is created.
- quantity: a number between 0.01 and 999. This is the quantity of the product to order.
- inventoryId: a valid inventory ID (optional). This is the ID of the inventory from which the item is allocated.
- bonusDiscountLineItemId: a valid bonus discount line item ID (optional). This is the ID of the bonus discount line item for which the added product is a selected bonus product.
- optionItems/optionValueId: a valid option value ID. This is an option value for an option item of an option product. This is only possible if the product item is an option product. To set option values, you must specify a collection of option items in the optionItems property. These option items must contain optionId and optionValueId. Also, the values you specify must be valid for the option product that this product item represents. Otherwise, the server throws an InvalidProductOptionItemException or an InvalidProductOptionValueItemException.
- custom properties in the form c_: the custom property must correspond to a custom attribute () defined for ProductLineItem. The value of this property must be valid for the type of custom attribute defined for ProductLineItem.
curl "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-baskets/v2/organizations/{organizationId}/baskets/{basketId}/items?siteId=RefArch" \
-X POST \
-H "content-type: application/json" \
-d '[
{
"\"productId\"": "green-bag",
"\"quantity\"": 1
}
]'An identifier for the organization the request is being made by
f_ecom_zzxy_prd
The ID of the basket to be modified.
The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites
RefArch
A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter Accept-Language following RFC 2616 & RFC 1766. This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
en-US
[
{
"\"productId\"": "green-bag",
"\"quantity\"": 1
}
]
The tax on the line item, including any adjustments. It is read only.
19
The base price of the line item, which is the unit price not including adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
130
The ID of the bonus discount line item this bonus product relates to. It is read only.
A flag indicating whether the product item is a bonus.
true
The bundled product items.
Returns true if the item is a gift. It is read only.
true
The gift message.
Happy Birthday
The inventory list ID associated with this item.
inventory
The product item ID. Use it to identify this item when updating its quantity or creating a custom price adjustment for it. It is read only.
The text describing the item.
The option items.
The price of the line item before applying any adjustments. If the line item is based on net pricing then the net price is returned. If the line item is based on gross pricing then the gross price is returned. It is read only.
The price adjustments.
[{
"appliedDiscount": {
"amount": 15,
"type": "amount"
},
"itemText": "AgentOrderAdjustment",
"reasonCode": "override manual promo"
}]
The price of the product line item including item-level adjustments, but not including order-level adjustments or shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
20.99
The price of the product line item including item-level adjustments and prorated order-level adjustments, but not including shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
15.5
The ID of the product.
nintendo-ds-console
If this product line item was added from a product list, this value is a reference to the corresponding product list item.
The name of the product.
Nintendo DS Game Console
The quantity of the products represented by this item.
1
The ID of the shipment this item belongs to.
me
If the product line item has a related shipping item, this value is its ID. A related shipping item represents a surcharge applied to individual products using a particular shipping method. It is read only.
006490dcc338feeafc71c964bf
The tax for the product item, not including price adjustments. It is read only.
0.3
The price used to calculate the tax for this product item. It is read only.
30
The tax class ID for the product item, or null if no tax class ID is associated with the product item. It is read only.
The tax rate, which is the decimal tax rate to be applied to the product represented by this item. It is read only.
0.9
Success, the response body contains the basket with the added items.
{
"adjustedMerchandizeTotalTax": 30,
"adjustedShippingTotalTax": 0.8,
"agentBasket": false,
"basketId": "a10ff320829cb0eef93ca5310a",
"billingAddress": {
"address1": "104 Presidential Way",
"city": "Woburn",
"countryCode": "US",
"firstName": "Stephanie",
"fullName": "Stephanie Miller",
"id": "bfea663fd3de75d5be3ec02702",
"lastName": "Miller",
"postalCode": "01801",
"stateCode": "MA"
},
"channelType": "storefront",
"couponItems": [
{
"code": "5ties",
"couponItemId": "cc6ef43f207bf64099288aec36",
"statusCode": "no_applicable_promotion",
"valid": true
}
],
"creationDate": "2019-10-17T08:29:55.340Z",
"currency": "USD",
"customerInfo": {
"customerId": "beQeANXJNsd0xcINsB6cSrobQa",
"email": "shopper@salesforce-test.com"
},
"lastModified": "2019-10-17T08:29:55.698Z",
"merchandizeTotalTax": 30,
"orderTotal": 646.76,
"paymentInstruments": [
{
"amount": 0,
"paymentCard": {
"cardType": "Visa",
"creditCardExpired": false
},
"paymentInstrumentId": "b7679bea661819b2de78b9de7d",
"paymentMethodId": "CREDIT_CARD"
}
],
"productItems": [
{
"adjustedTax": 30,
"basePrice": 199.99,
"bonusProductLineItem": false,
"gift": false,
"itemId": "3d4e28425ce0b3a65b0ac4e163",
"itemText": "Green Umbrella - Sustained Edition",
"optionItems": [
{
"adjustedTax": 0,
"basePrice": 0,
"bonusProductLineItem": false,
"gift": false,
"itemId": "ff9452ed11fcf5c80f9143a8f1",
"itemText": "We will plant a tree for your order.",
"optionId": "plantATree",
"optionValueId": "000",
"price": 0,
"priceAfterItemDiscount": 0,
"priceAfterOrderDiscount": 0,
"productId": "000",
"productName": "Plant a tree.",
"quantity": 3,
"shipmentId": "me",
"tax": 0,
"taxBasis": 0,
"taxClassId": "standard",
"taxRate": 0.05
}
],
"price": 599.97,
"priceAfterItemDiscount": 599.97,
"priceAfterOrderDiscount": 599.97,
"productId": "green-umbrella",
"productName": "Green Umbrella - Sustained Edition",
"quantity": 3,
"shipmentId": "me",
"tax": 30,
"taxBasis": 599.97,
"taxClassId": "standard",
"taxRate": 0.05
}
],
"productSubTotal": 599.97,
"productTotal": 599.97,
"shipments": [
{
"adjustedMerchandizeTotalTax": 30,
"adjustedShippingTotalTax": 0.8,
"gift": false,
"merchandizeTotalTax": 30,
"productSubTotal": 599.97,
"productTotal": 599.97,
"shipmentId": "me",
"shipmentTotal": 646.76,
"shippingAddress": {
"address1": "4162 Turkey Pen Road",
"city": "New York",
"countryCode": "US",
"firstName": "Agustin",
"fullName": "Agustin Estes",
"id": "4432af77112f7c2433248a48e8",
"lastName": "Estes",
"postalCode": "10016",
"stateCode": "NY"
},
"shippingMethod": {
"description": "Order received within 7-10 business days",
"id": "001",
"name": "Ground",
"price": 15.99
},
"shippingStatus": "not_shipped",
"shippingTotal": 15.99,
"shippingTotalTax": 0.8,
"taxTotal": 30.8
}
],
"shippingItems": [
{
"adjustedTax": 0.8,
"basePrice": 15.99,
"itemId": "d5ed0e58b8f8b5efe8d617a630",
"itemText": "Shipping",
"price": 15.99,
"priceAfterItemDiscount": 15.99,
"shipmentId": "me",
"tax": 0.8,
"taxBasis": 15.99,
"taxClassId": "standard",
"taxRate": 0.05
}
],
"shippingTotal": 15.99,
"shippingTotalTax": 0.8,
"taxation": "net",
"taxTotal": 30.8
}
The total tax on products in the shipment, including item-level price adjustments but not including service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. It is read only.
4.95
The total tax on shipping charges in the shipment, including shipping price adjustments. It is read only.
0.3
Is the basket created by an agent? It is read only.
true
The unique identifier for the basket. It is read only.
e78aa5646a8efebdd9cdd38be7
The billing address.
The bonus discount line items.
The sales channel. It is read only.
- storefront
- callcenter
- marketplace
- dss
- store
- facebookads
- subscriptions
- onlinereservation
- customerservicecenter
- instagramcommerce
- tiktok
- snapchat
- youtube
storefront
The coupon items.
[{
"code": "10_percent_off"
}]
The timestamp when the basket was created. It is read only.
2015-05-19T15:23:18.000Z
A three letter uppercase currency code conforming to the ISO 4217 standard, or the string N/A indicating that a currency is not applicable.
USD
The customer information, if the customer is logged in.
The gift certificate line items.
[{
"amount": 1,
"recipientEmail": "miller@salesforce-test.com",
"shipmentId": "me"
}]
Tax values that are grouped and summed based on the tax rate. The tax totals of the line items with the same tax rate are grouped together and summed up. This does not affect the calculation in any way. It is read only.
The expiration datetime of the inventory reservation. It is read only.
2015-05-19T15:30:18.000Z
The timestamp when the basket was last modified. It is read only.
2015-05-19T15:25:18.000Z
The total products tax in the purchase currency. Merchandise total price represents the sum of the product prices before services (such as shipping) or adjustments from promotions have been added. It is read only.
4.95
The order-level price adjustments.
[{
"appliedDiscount": {
"amount": 15,
"type": "amount"
},
"itemText": "AgentOrderAdjustment",
"reasonCode": "override manual promo"
}]
The total price, including products, shipping and tax. It is read only.
110.24
The payment instruments list.
[{
"amount": 0,
"paymentCard": {
"holder": "Miller",
"cardType": "Visa"
},
"paymentMethodId": "CREDIT_CARD"
}]
The product items.
[{
"quantity": 1
}]
The total price of all products including item-level adjustments, but not including order-level adjustments or shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
99
The total price of all products including adjustments, but not including shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
88
The shipments.
[{
"shipmentId": "me2",
"shippingMethod": {
"id": "001"
},
"shippingAddress": {
"firstName": "Stephanie",
"lastName": "Miller",
"address1": "385 Prospect Valley Road",
"city": "Woburn",
"postalCode": "01801",
"stateCode": "MA",
"countryCode": "US"
}
}]
The shipping items.
The total price of all shipping charges, including shipping adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
5.99
The total tax on all shipping charges, not including shipping adjustments. It is read only.
0.3
The source code assigned to the basket. It is read only.
OUTDOOR1
The total tax amount. It is read only.
5.25
The taxation policy (gross or net). It is read only.
- gross
- net
net
If the tax is rounded at the group level, this is set to true. If the tax is rounded at the item or unit level, it is set to false.
true
If the created basket is a temporary basket, this is set to true. Otherwise, it is set to false.
true
This type supports additional properties passed along with the defined properties of this API.
To indicate that the properties were defined and expected to be handled as additional properties, they are expected to be prefixed with a c_.
The type will reject any property that does not fit this pattern, only allowing additional properties beginning with the known prefix.