Get All Shopping Cart Layouts
get
/rest/v16/shoppingCarts/{processVarName}/layouts
This endpoint returns the layout definition for all shopping carts.
Request
Path Parameters
-
processVarName(required): string
The unique variable name to identify the process.
Response
Default Response
The response for getting the shopping cart layout
Nested Schema : links
Type:
Show Source
array
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : shopping-cart-layout-response
Type:
Show Source
object
-
checkoutButtonLabel:
string
Title:
Checkout Button Label
Checkout button label. -
clearButtonLabel:
string
Title:
Clear Button Label
Clear button label. -
columns:
object shopping-cart-layout-columns
-
displayTotalType:
string
Title:
Display Total Type
Allowed Values:[ "TOP", "BOTTOM", "NONE" ]
Display total type. -
enabled:
boolean
Title:
Enabled
Enabled indicator. -
hideButtonLabel:
string
Title:
Hide Button Label
Hide button label. -
id:
integer
Title:
Layout ID
Layout identifier. -
itemsSelectedByDefault:
boolean
Title:
Item Selected By Default
Item selected by default indicator. -
links:
array links
-
processName:
string
Title:
Process Name
Process name. -
removeItemsOnCheckout:
boolean
Title:
Remove Items On Checkout
Remove items on checkout indicator. -
showClearButton:
boolean
Title:
Show Clear Button
Show clear button indicator. -
showTranslationsButton:
boolean
Title:
Show Translations Button
Show translations button indicator. -
VarName:
string
Title:
Layout Variable Name
Layout variable name.
Nested Schema : links
Type:
Show Source
array
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : shopping-cart-layout-column
Type:
Show Source
object
-
columnDesc:
string
Title:
Column Description
Column description. -
columnLabel:
string
Title:
Column Label
Colulmn label. -
columnType:
string
Title:
Column Type
Allowed Values:[ "ITEM", "PRICE", "QUANTITY", "SUBTOTAL", "PRICEBOOK", "DESCRIPTION" ]
Column type. -
editable:
boolean
Title:
Editable
Editable indicator. -
editableApplicable:
boolean
Title:
Editable Applicable
Editable applicable indicator. -
id:
integer
Title:
ID
Unique identifier for a layout column. -
orderNumber:
integer
Title:
Order Number
Order number. -
valueAlignment:
string
Title:
Value Alignment
Value alignment. -
visible:
boolean
Title:
Visible
Visible indicator.
Nested Schema : reference links
Type:
object
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related object
URL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current object
Default Value:self
Link Relationship to the current object
Examples
The following example returns the layout definition for all shopping carts by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/shoppingCarts/transaction/layouts
Response Body Sample
{ "items": [{ "id": 6966063, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/shoppingCarts/transaction/layouts/desktopLayout" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/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/v16/shoppingCarts/transaction/layouts" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/shoppingCarts/transaction" } ] }