Jump to

• Request
• Response

Get Shopping Cart Layout

get

/rest/v19/shoppingCarts/{processVarName}/layouts/{layoutVarName}

This endpoint returns the layout definition for a specific shopping cart.

Request

Path Parameters

• layoutVarName(required): string
  The unique variable name to identify the layout.
• processVarName(required): string
  The unique variable name to identify the process.

Back to Top

Response

Default Response

The response for getting the shopping cart layout

Body ()

Root Schema : shopping-cart-layout-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Layout identifier.",
            "title":"Layout ID"
        },
        "VarName":{
            "type":"string",
            "description":"Layout variable name.",
            "title":"Layout Variable Name"
        },
        "processName":{
            "type":"string",
            "description":"Process name.",
            "title":"Process Name"
        },
        "enabled":{
            "type":"boolean",
            "description":"Enabled indicator.",
            "title":"Enabled"
        },
        "checkoutButtonLabel":{
            "type":"string",
            "description":"Checkout button label.",
            "title":"Checkout Button Label"
        },
        "hideButtonLabel":{
            "type":"string",
            "description":"Hide button label.",
            "title":"Hide Button Label"
        },
        "clearButtonLabel":{
            "type":"string",
            "description":"Clear button label.",
            "title":"Clear Button Label"
        },
        "showClearButton":{
            "type":"boolean",
            "description":"Show clear button indicator.",
            "title":"Show Clear Button"
        },
        "itemsSelectedByDefault":{
            "type":"boolean",
            "description":"Item selected by default indicator.",
            "title":"Item Selected By Default"
        },
        "showTranslationsButton":{
            "type":"boolean",
            "description":"Show translations button indicator.",
            "title":"Show Translations Button"
        },
        "removeItemsOnCheckout":{
            "type":"boolean",
            "description":"Remove items on checkout indicator.",
            "title":"Remove Items On Checkout"
        },
        "displayTotalType":{
            "type":"string",
            "description":"Display total type.",
            "title":"Display Total Type",
            "enum":[
                "TOP",
                "BOTTOM",
                "NONE"
            ]
        },
        "columns":{
            "$ref":"#/definitions/shopping-cart-layout-columns"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : shopping-cart-layout-columns

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/shopping-cart-layout-column"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object shopping-cart-layout-column

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/shopping-cart-layout-column"
    }
}

Nested Schema : shopping-cart-layout-column

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Unique identifier for a layout column.",
            "title":"ID"
        },
        "columnLabel":{
            "type":"string",
            "description":"Colulmn label.",
            "title":"Column Label"
        },
        "columnDesc":{
            "type":"string",
            "description":"Column description.",
            "title":"Column Description"
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order number.",
            "title":"Order Number"
        },
        "valueAlignment":{
            "type":"string",
            "description":"Value alignment.",
            "title":"Value Alignment"
        },
        "editable":{
            "type":"boolean",
            "description":"Editable indicator.",
            "title":"Editable"
        },
        "editableApplicable":{
            "type":"boolean",
            "description":"Editable applicable indicator.",
            "title":"Editable Applicable"
        },
        "visible":{
            "type":"boolean",
            "description":"Visible indicator.",
            "title":"Visible"
        },
        "columnType":{
            "type":"string",
            "description":"Column type.",
            "title":"Column Type",
            "enum":[
                "ITEM",
                "PRICE",
                "QUANTITY",
                "SUBTOTAL",
                "PRICEBOOK",
                "DESCRIPTION"
            ]
        }
    }
}

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

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object",
            "default":"self"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top