REST API Services for Oracle CPQ

Get All Shopping Cart Items

get

/rest/v19/shoppingCarts/{processVarName}/shoppingCartItems

This endpoint returns all items for a shopping cart.

Request

Path Parameters

processVarName(required): string

The unique variable name to identify the process.

Response

Default Response

The response for getting the shopping cart.

Root Schema : shopping-cart-item-list-response

Type: object

Show Source

items: array items
links: array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/shopping-cart-item"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object shopping-cart-item

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

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 : shopping-cart-item

Type: object

Show Source

description: string

Title: Description

Description of the shopping cart item.
enabled: boolean

Title: Enabled

Enabled indicator.
id: integer

Title: ID

Unique identifier for a shopping cart item.
links: array links
mandatory: boolean

Title: Mandatory

Mandatory indicator.
name: string

Title: Name

Name of the shopping cart item.
parentId: integer

Title: Parent ID

Unique identifier for a shopping cart item parent.
price: object price

Price of the shopping cart item.
priceBookName: string

Title: Price Book Name

Price book name.
quantity: integer

Title: Quantity

Quantity of the shopping cart item.
subTotal: object subTotal

Sub total of the shopping cart item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Unique identifier for a shopping cart item.",
            "title":"ID"
        },
        "parentId":{
            "type":"integer",
            "description":"Unique identifier for a shopping cart item parent.",
            "title":"Parent ID"
        },
        "name":{
            "type":"string",
            "description":"Name of the shopping cart item.",
            "title":"Name"
        },
        "quantity":{
            "type":"integer",
            "description":"Quantity of the shopping cart item.",
            "title":"Quantity"
        },
        "mandatory":{
            "type":"boolean",
            "description":"Mandatory indicator.",
            "title":"Mandatory"
        },
        "enabled":{
            "type":"boolean",
            "description":"Enabled indicator.",
            "title":"Enabled"
        },
        "priceBookName":{
            "type":"string",
            "description":"Price book name.",
            "title":"Price Book Name"
        },
        "description":{
            "type":"string",
            "description":"Description of the shopping cart item.",
            "title":"Description"
        },
        "price":{
            "type":"object",
            "description":"Price of the shopping cart item.",
            "properties":{
                "priceComment":{
                    "type":"string",
                    "description":"Comment of the shopping cart item price.",
                    "title":"Price Comment"
                },
                "value":{
                    "type":"number",
                    "description":"Price of the shopping cart item.",
                    "title":"Price"
                },
                "currency":{
                    "type":"string",
                    "description":"Currency of the shopping cart item.",
                    "title":"Currency"
                }
            }
        },
        "subTotal":{
            "type":"object",
            "description":"Sub total of the shopping cart item.",
            "properties":{
                "priceComment":{
                    "type":"string",
                    "description":"Comment of the shopping cart item sub total.",
                    "title":"Sub total Comment"
                },
                "value":{
                    "type":"number",
                    "description":"Sub total of the shopping cart item.",
                    "title":"Sub total"
                },
                "currency":{
                    "type":"string",
                    "description":"Sub total currency of the shopping cart item.",
                    "title":"Sub total currency"
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

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 : price

Type: object

Price of the shopping cart item.

Show Source

currency: string

Title: Currency

Currency of the shopping cart item.
priceComment: string

Title: Price Comment

Comment of the shopping cart item price.
value: number

Title: Price

Price of the shopping cart item.

{
    "type":"object",
    "description":"Price of the shopping cart item.",
    "properties":{
        "priceComment":{
            "type":"string",
            "description":"Comment of the shopping cart item price.",
            "title":"Price Comment"
        },
        "value":{
            "type":"number",
            "description":"Price of the shopping cart item.",
            "title":"Price"
        },
        "currency":{
            "type":"string",
            "description":"Currency of the shopping cart item.",
            "title":"Currency"
        }
    }
}

Nested Schema : subTotal

Type: object

Sub total of the shopping cart item.

Show Source

currency: string

Title: Sub total currency

Sub total currency of the shopping cart item.
priceComment: string

Title: Sub total Comment

Comment of the shopping cart item sub total.
value: number

Title: Sub total

Sub total of the shopping cart item.

{
    "type":"object",
    "description":"Sub total of the shopping cart item.",
    "properties":{
        "priceComment":{
            "type":"string",
            "description":"Comment of the shopping cart item sub total.",
            "title":"Sub total Comment"
        },
        "value":{
            "type":"number",
            "description":"Sub total of the shopping cart item.",
            "title":"Sub total"
        },
        "currency":{
            "type":"string",
            "description":"Sub total currency of the shopping cart item.",
            "title":"Sub total currency"
        }
    }
}

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"
}

Examples

The following example shows how to retrieve all items for a shopping cart by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/shoppingCarts/transaction/shoppingCartItems

Response Body Sample

{
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/shoppingCarts/transaction/shoppingCartItems"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/shoppingCarts/transaction"
    }
  ],
  "items": [{
      "id": 3022707088,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/shoppingCarts/transaction/shoppingCartItems/3022707088"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/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/v19/shoppingCarts/transaction/shoppingCartItems/3022707090"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/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/v19/shoppingCarts/transaction/shoppingCartItems/3022707091"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/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/v19/shoppingCarts/transaction/shoppingCartItems/3022707092"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/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
    }
  ]
}