Shopping Cart REST APIs

Get List of All Shopping Carts
Description	This endpoint returns a list of all shopping carts visible to the user.
URI Endpoint	/rest/v17/shoppingCarts
End Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	priceBookApplicable	The boolean value for showing the price book indicator
	showAddToQuoteButton	The boolean value for showing the Add to Quote indicator
	showCheckoutButton	The boolean value for showing the Checkout button indicator
	processVarName	The variable name of the process
	processName	The name of the process
	items	Array of links to individual shopping cart items

URI Endpoint Sample

Response Sample

{ "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts" } ], "items": [{ "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction" } ], "priceBookApplicable": true, "showAddToQuoteButton": false, "showCheckoutButton": true, "processVarName": "transaction", "processName": "Quotes" }, { "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/oraclecpqo" } ], "priceBookApplicable": true, "showAddToQuoteButton": false, "showCheckoutButton": true, "processVarName": "oraclecpqo", "processName": "Oracle Quote to Order", } ] }

Get Most Recent Shopping Cart
Description	This endpoint returns the most recently modified shopping cart.
URI Endpoint	/rest/v17/shoppingCarts/actions/_getMostRecentShoppingCart
End Parameters	None
HTTP Method	POST
Request Body Parameters	limit	(Optional) The maximum number of items to show in the response. The default is 1000.
	offset	(Optional) The starting position of the response rows. The default is 0.
	totalResults	(Optional) The boolean value includes all results for the response. The default is false. If true, the totalResults and hasMore properties are included in the response. If false, the totalResults and hasMore properties are excluded in the response.
	expandNodes	(Optional) The boolean value for showing parent and child line items in the response. If true, child line items from the nodesExceptionList are excluded in the response. If false, child line items from the nodesExceptionList are included in the response.
	nodesExceptionList	(Optional) List of shopping cart child line item ids to exclude when the parent item is in the shopping cart
	totalPrice	(Optional) The boolean value for including the total price in the response. The default is false. If true, the total price is included in the response. If false, the total price is excluded from the response.
Response Body Parameters	priceBookApplicable	The boolean value for showing the price book indicator
	showAddToQuoteButton	The boolean value for showing the Add to Quote indicator
	showCheckoutButton	The boolean value for showing the Checkout button indicator
	processVarName	The variable name of the process
	processName	The name of the process
	items	Array of links to individual shopping cart items
	limit	(Optional) The maximum number of items to show in the response
	offset	(Optional) The starting position of the response rows
	count	(Optional) The count of the shopping cart items returned in the response
	totalResults	(Optional) When the totalResults request parameter is set to true, this value indicates the total count of items in the shopping cart
	hasMore	(Optional) When the totalResults request parameter is set to true, this boolean value indicates if there are more shopping cart items available in the database
	totalPrice	(Optional) The string value for the total price of the items in the shopping cart. The value includes the currency symbol.
	hasChildren	(Optional) The boolean value indicates whether the item has child items

URI Endpoint Sample

Request Sample

Response Sample

Get Shopping Cart
Description	This endpoint returns a shopping cart for a process.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}
Endpoint Parameters	processVarName	The variable name of the process
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	priceBookApplicable	The boolean value for showing the price book indicator
	showAddToQuoteButton	The boolean value for showing the Add to Quote indicator
	showCheckoutButton	The boolean value for showing the Checkout button indicator
	processVarName	The variable name of the process
	processName	The name of the process
	shoppingCartItems	Array of links to individual shopping cart items

URI Endpoint Sample

Response Sample

{ "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts" } ], "priceBookApplicable": true, "showAddToQuoteButton": false, "showCheckoutButton": true, "processVarName": "transaction", "processName": "Quotes", "shoppingCartItems": { "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction" } ] } }

Get Shopping Cart
Description	This endpoint returns the shopping cart associated with the specified process.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}/actions/_getShoppingCart
End Parameters	None
HTTP Method	POST
Request Body Parameters	limit	(Optional) The maximum number of items to show in the response. The default is 1000.
	offset	(Optional) The starting position of the response rows. The default is 0.
	totalResults	(Optional) The boolean value includes all results for the response. The default is false. If true, the totalResults and hasMore properties are included in the response. If false, the totalResults and hasMore properties are excluded in the response.
	expandNodes	(Optional) The boolean value for showing parent and child line items in the response. If true, child line items from the nodesExceptionList are excluded in the response. If false, child line items from the nodesExceptionList are included in the response.
	nodesExceptionList	(Optional) List of shopping cart child line item ids to exclude when the parent item is in the shopping cart
	totalPrice	(Optional) The boolean value for including the total price in the response. The default is false. If true, the total price is included in the response. If false, the total price is excluded from the response.
Response Body Parameters	priceBookApplicable	The boolean value for showing the price book indicator
	showAddToQuoteButton	The boolean value for showing the Add to Quote indicator
	showCheckoutButton	The boolean value for showing the Checkout button indicator
	processVarName	The variable name of the process
	processName	The name of the process
	items	Array of links and the shopping cart items
	limit	(Optional) The maximum number of items to show in the response
	offset	(Optional) The starting position of the response rows
	count	(Optional) The count of the shopping cart items returned in the response
	totalResults	(Optional) When the totalResults request parameter is set to true, this value indicates the total count of items in the shopping cart
	hasMore	(Optional) When the totalResults request parameter is set to true, this boolean value indicates if there are more shopping cart items available in the database
	totalPrice	(Optional) The string value for the total price of the items in the shopping cart. The value includes the currency symbol.
	hasChildren	(Optional) The boolean value indicates whether the item has child items

URI Endpoint Sample

Request Sample

Response Sample

Get All Shopping Cart Items
Description	This endpoint returns all items for a shopping cart.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}/shoppingCartItems
Endpoint Parameters	processVarName	The variable name of the process
HTTP Method	GET
Response Body Parameters	None
Response Body Parameters	links	Links to the related object
	id	The unique identifier for the a shopping cart item
	rel	The relationship to the object. The default is self.
	parentId	The unique identifier for the shopping cart item parent
	name	The string value for name of the shopping cart item
	quantity	The quantity of the shopping cart item
	mandatory	The boolean value for the mandatory indicator
	enabled	The boolean value for the enabled indicator
	priceBookName	The name of the price book for the shopping cart item
	description	The description of the shopping cart item
	price	The price of the shopping cart item

URI Endpoint Sample

Response Sample

{ "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction" } ], "items": [{ "id": 3022707088, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems/3022707088" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems" } ], "parentId": -1, "name": "part100", "quantity": 1, "price": { "value": -1.0, "currency": "USD", "priceComment": "US Dollar price not defined." }, "mandatory": false, "enabled": true, "priceBookName": "", "description": "", "hasChildren": true }, { "id": 3022707090, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems/3022707090" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems" } ], "parentId": 3022707088, "name": "part1", "quantity": 1, "price": { "value": 1.33, "currency": "USD" }, "mandatory": false, "enabled": true, "priceBookName": "Base Price", "description": "", "hasChildren": false }, { "id": 3022707091, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems/3022707091" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems" } ], "parentId": 3022707088, "name": "part2", "quantity": 2, "price": { "value": 2.33, "currency": "USD" }, "mandatory": false, "enabled": true, "priceBookName": "Base Price", "description": "", "hasChildren": false }, { "id": 3022707092, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems/3022707092" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems" } ], "parentId": 3022707088, "name": "part3", "quantity": 3, "price": { "value": 3.33, "currency": "USD" }, "mandatory": false, "enabled": true, "priceBookName": "Base Price", "description": "", "hasChildren": false } ] }

Get Shopping Cart Item
Description	This endpoint returns an item from a shopping cart.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}/shoppingCartItems/{id}
Endpoint Parameters	processVarName	The variable name of the process
	id	The unique identifier for the shopping cart item
HTTP Method	GET
Response Body Parameters	links	Links to the related object
	id	The unique identifier for the a shopping cart item
	parentId	The unique identifier for the shopping cart item parent
	name	The string value for name of the shopping cart item
	quantity	The quantity of the shopping cart item
	mandatory	The boolean value for the mandatory indicator
	enabled	The boolean value for the enabled indicator
	priceBookName	The name of the price book for the shopping cart item
	description	The description of the shopping cart item
	price	The price of the shopping cart item
	hasChildren	The boolean value to indicate if the item has child items

URI Endpoint Sample

Response Sample

{ "id": 3022707088, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems/3022707088" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/shoppingCartItems" } ], "parentId": -1, "name": "part100", "quantity": 1, "price": { "value": -1.0, "currency": "USD", "priceComment": "US Dollar price not defined." }, "mandatory": false, "enabled": true, "priceBookName": "", "description": "", "hasChildren": true }

Add Selected Items to Quote
Description	This endpoint adds the selected items from the shopping cart to the current quote.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}/actions/_addToQuote
Endpoint Parameters	processVarName	The variable name of the process
HTTP Method	POST
Response Body Parameters	selections	The items selected in the shopping cart. The item ids for specific items or [] to indicate all items in the cart.
	selectionMode	The mode setting for the selected items
Success Response	The response contains the destinationUrl to launch the Transaction page

URI Endpoint Sample

Request Sample

Response Sample

{ "destinationUrl": "https://sitename.oracle.com/commerce/buyside/document.jsp?id=3022564562&document_id=4356178&bm_cm_process_id=4356122&formaction=openTransaction" }

Check out the Selected Items
Description	This endpoint adds the selected items from the shopping cart to a new quote.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}/actions/_checkout
Endpoint Parameters	processVarName	The variable name of the process
HTTP Method	POST
Response Body Parameters	selections	The items selected in the shopping cart. The item ids for specific items or [] to indicate all items in the cart.
	selectionMode	The mode setting for the selected items
Success Response	The response contains the destinationUrl to launch the Transaction page

URI Endpoint Sample

Request Sample

Response Sample

{ "destinationUrl": "https://sitename.oracle.com/commerce/buyside/document.jsp?id=3022564562&document_id=4356178&bm_cm_process_id=4356122&formaction=openTransaction" }

Clear All Items from a Shopping Cart
Description	This endpoint clears all shopping cart items from the shopping cart.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}/actions/_clearItems
Endpoint Parameters	processVarName	The variable name of the process
HTTP Method	POST
Request Body Parameters	None
Success Response	HTTP Code 204

URI Endpoint Sample

Clear Shopping Cart Item
Description	This endpoint clears a shopping cart item from the shopping cart.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}/shoppingCartItems/{id}
Endpoint Parameters	processVarName	The variable name of the process
HTTP Method	DELETE
Request Body Parameters	None
Success Response	HTTP Code 204

URI Endpoint Sample

Return to Quote
Description	This endpoint returns to the quote URL from the shopping cart.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}/action/_returnToQuote
Endpoint Parameters	processVarName	The variable name of the process
HTTP Method	POST
Request Body Parameters	None
Success Response	The response contains the destinationUrl to launch the Transaction page

URI Endpoint Sample

Response Sample

{ "destinationUrl": "https://sitename.oracle.com/commerce/buyside/document.jsp?id=3022564716&document_id=4356178&bm_cm_process_id=4356122&formaction=openTransaction" }

Get All Shopping Cart Layouts
Description	This endpoint returns the layout definition for all shopping carts.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}/layouts
Endpoint Parameters	processVarName	The variable name of the process
HTTP Method	GET
Request Body Parameters	None
Success Response	The JSON data containing the desktop layout definition for all shopping carts

URI Endpoint Sample

Response Sample

{ "items": [{ "id": 6966063, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/layouts/desktopLayout" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/layouts" } ], "varName": "desktopLayout", "processName": "Quotes", "enabled": true, "displayTotalType": "TOP", "checkoutButtonLabel": "Proceed To Checkout", "hideButtonLabel": "Hide", "clearButtonLabel": "Clear Cart", "showClearButton": true, "itemsSelectedByDefault": true, "showTranslationsButton": false, "removeItemsOnCheckout": false, "columns": { "items": [{ "id": 6966066, "columnLabel": "Item Added", "columnDesc": "", "orderNumber": 0, "columnType": "ITEM", "valueAlignment": "LEFT_ALIGN", "editable": false, "editableApplicable": false, "visible": false }, { "id": 6966065, "columnLabel": "Quantity", "columnDesc": "", "orderNumber": 1, "columnType": "QUANTITY", "valueAlignment": "LEFT_ALIGN", "editable": true, "editableApplicable": true, "visible": false }, { "id": 6966067, "columnLabel": "Unit Price", "columnDesc": "", "orderNumber": 2, "columnType": "PRICE", "valueAlignment": "LEFT_ALIGN", "editable": false, "editableApplicable": false, "visible": false }, { "id": 6966068, "columnLabel": "Subtotal", "columnDesc": "", "orderNumber": 3, "columnType": "SUBTOTAL", "valueAlignment": "LEFT_ALIGN", "editable": false, "editableApplicable": false, "visible": false }, { "id": 6966069, "columnLabel": "Price Book", "columnDesc": "", "orderNumber": 4, "columnType": "PRICEBOOK", "valueAlignment": "LEFT_ALIGN", "editable": false, "editableApplicable": false, "visible": false }, { "id": 7277423, "columnLabel": "Description", "columnDesc": "", "orderNumber": 5, "columnType": "DESCRIPTION", "valueAlignment": "LEFT_ALIGN", "editable": false, "editableApplicable": false, "visible": false } ] } } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/layouts" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction" } ] }

Get Shopping Cart Layout
Description	This endpoint returns the layout definition for a specific shopping cart.
URI Endpoint	/rest/v17/shoppingCarts/{processVarName}/layouts/{layoutVarName}
Endpoint Parameters	processVarName	The variable name of the process
	layoutVarName	The variable name of a shopping cart layout
HTTP Method	GET
Request Body Parameters	None
Success Response	The JSON data containing the desktop layout definition for the specified shopping cart

URI Endpoint Sample

Response Sample

{ "id": 6966063, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/layouts/desktopLayout" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/shoppingCarts/transaction/layouts" } ], "varName": "desktopLayout", "processName": "Quotes", "enabled": true, "displayTotalType": "TOP", "checkoutButtonLabel": "Proceed To Checkout", "hideButtonLabel": "Hide", "clearButtonLabel": "Clear Cart", "showClearButton": true, "itemsSelectedByDefault": true, "showTranslationsButton": false, "removeItemsOnCheckout": false, "columns": { "items": [{ "id": 6966066, "columnLabel": "Item Added", "columnDesc": "", "orderNumber": 0, "columnType": "ITEM", "valueAlignment": "LEFT_ALIGN", "editable": false, "editableApplicable": false, "visible": false }, { "id": 6966065, "columnLabel": "Quantity", "columnDesc": "", "orderNumber": 1, "columnType": "QUANTITY", "valueAlignment": "LEFT_ALIGN", "editable": true, "editableApplicable": true, "visible": false }, { "id": 6966067, "columnLabel": "Unit Price", "columnDesc": "", "orderNumber": 2, "columnType": "PRICE", "valueAlignment": "LEFT_ALIGN", "editable": false, "editableApplicable": false, "visible": false }, { "id": 6966068, "columnLabel": "Subtotal", "columnDesc": "", "orderNumber": 3, "columnType": "SUBTOTAL", "valueAlignment": "LEFT_ALIGN", "editable": false, "editableApplicable": false, "visible": false }, { "id": 6966069, "columnLabel": "Price Book", "columnDesc": "", "orderNumber": 4, "columnType": "PRICEBOOK", "valueAlignment": "LEFT_ALIGN", "editable": false, "editableApplicable": false, "visible": false }, { "id": 7277423, "columnLabel": "Description", "columnDesc": "", "orderNumber": 5, "columnType": "DESCRIPTION", "valueAlignment": "LEFT_ALIGN", "editable": false, "editableApplicable": false, "visible": false } ] } }