REST API - Adds line items to basket / add quote items to basket

Personal Library

https://support.intershop.com/kb/2Y8309

Note

Starting with Intershop 7.10 our REST API is provided in the Open API 3.0 format, see Reference - Intershop Commerce Management 7.10 REST API.

URI	/baskets/<basket-id>/items
Http Method	POST
Short Description	Adds a list of items or line items of a quote to an existing basket
Query Parameters	none
Example Requests	/baskets/XkoKDACqjEkAAAFCHClCMC0h/items/
HTTP Status Codes	201 Created 400 Bad Request Possible values for header 'error-key': basket.basket_id_required.error basket.gift.message.to_required.error basket.gift.message.from_required.error basket.gift.message.message_required.error basket.product.add_to_basket_unsuccessful.error basket.product.not_found.error basket.product.sku_required.error basket.product.quantity_invalid.error quote.no_valid_items.error 403 Forbidden Possible values for header 'error-key': quote.expired.error quote.rejected.error 404 Not Found Possible values for header 'error-key': basket.basket_not_found.error basket.product.not_found.error
Description	Adds a list of items to the basket.The items are either specified in the request body, or come from quote that will be specified with the quote ID. If a quote contains invalid products (delete, offline etc.) then all available products from the quote are added to the basket. If the quote contains no valid products at all an error occurs (400 - quote.no_valid_items.error). For every item sku and quantity has to be specified. For gift certificates additional information are required. That is recipient email, recipient name, sender email, sender name and greeting message. If basket is not found, a status code 404 is returned as a response. If any error occurs when adding products to the basket, then a status code 400 is returned.
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	New Labels

JSON

Request Data Format	application/json
Request related java object	com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource com.intershop.sellside.rest.common.capi.resourceobject.basket.ExtendedLineItemCollectionRO com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemRO
Request Example	Either specify the line items to add: { "elements": [ { "sku":"3934150", "quantity": { "value": 1 } }, { "sku":"859910", "quantity": { "value": 2 } }, { "sku":"4776790", "quantity": { "value": 3 } }, { "sku":"GiftCertificate10", "senderName":"Patricia", "senderEmail":"patricia@test.intershop.de", "recipientName":"Charles", "recipientEmail":"charles@test.intershop.de", "greetingMessage":"Greeting message !!!", "quantity": { "value": 1 } } ] } or specify the quote id to add all items from the quote to the cart: { "quoteID" : "rJ0KDgAhwTUAAAFTEZJOzFK7" }
Response Data Format	application/json
Response related java object	com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource com.intershop.component.rest.capi.resourceobject.LinkRO
Response Example	{ "type": "Link", "uri": "PrimeTech-PrimeTechSpecials-Site/-/baskets/XkoKDACqjEkAAAFCHClCMC0h/items" }

XML

XML Request Data Format	text/xml
XML Request Java Objects	com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource com.intershop.sellside.rest.common.capi.resourceobject.basket.ExtendedLineItemCollectionRO com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemRO
XML Request Example	Either specify the line items to add: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <LineItems> <elements> <BasketLineItem> <sku>3934150</sku> <quantity type="Quantity"> <value>1</value> </quantity> </BasketLineItem> <BasketLineItem> <sku>859910</sku> <quantity type="Quantity"> <value>2</value> </quantity> </BasketLineItem> <BasketLineItem> <sku>4776790</sku> <quantity type="Quantity"> <value>3</value> </quantity> </BasketLineItem> <BasketLineItem> <sku>GiftCertificate10</sku> <quantity type="Quantity"> <value>1</value> </quantity> <recipientEmail>charles@test.intershop.de</recipientEmail> <recipientName>Charles</recipientName> <senderEmail>patricia@test.intershop.de</senderEmail> <senderName>Patricia</senderName> <greetingMessage>Greeting message !!!</greetingMessage> </BasketLineItem> </elements> </LineItems> or specify the quote id to add all items from the quote to the cart: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <LineItems> <quoteID>rJ0KDgAhwTUAAAFTEZJOzFK7</quoteID> </LineItems>
XML Response Data Format	text/xml
XML Response Java Objects	com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource com.intershop.component.rest.capi.resourceobject.LinkRO
XML Response Example	<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Link type="Link"> <uri>PrimeTech-PrimeTechSpecials-Site/-/baskets/XkoKDACqjEkAAAFCHClCMC0h/items</uri> </Link>

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.