Jump to

• Request
• Response
• Examples

Get Shopping Cart (POST)

post

/rest/v16/shoppingCarts/{processVarName}/actions/_getShoppingCart

This endpoint returns the shopping cart associated with the specified process.

Request

Path Parameters

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

Body ()

Root Schema : shopping-cart-pagination-request

Type: object

Show Source

• expandNodes: boolean
  If true, the children rows of nodesExceptionList will be excluded from the response.
• limit: integer
  The maximum number of items in the response.
• nodesExceptionList: array nodesExceptionList
  List of ids.
• offset: integer
  The starting position of the response rows.
• totalPrice: boolean
  If true, totalPrice will be included in the response.
• totalResults: boolean
  If true, totalResults and hasMore properties will be included in the response.

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"integer",
            "description":"The maximum number of items in the response."
        },
        "offset":{
            "type":"integer",
            "description":"The starting position of the response rows."
        },
        "totalResults":{
            "type":"boolean",
            "description":"If true, totalResults and hasMore properties will be included in the response."
        },
        "expandNodes":{
            "type":"boolean",
            "description":"If true, the children rows of nodesExceptionList will be excluded from the response."
        },
        "totalPrice":{
            "type":"boolean",
            "description":"If true, totalPrice will be included in the response."
        },
        "nodesExceptionList":{
            "type":"array",
            "description":"List of ids.",
            "items":{
                "type":"integer"
            }
        }
    }
}

Nested Schema : nodesExceptionList

Type: array

List of ids.

Show Source

• Array of: integer

{
    "type":"array",
    "description":"List of ids.",
    "items":{
        "type":"integer"
    }
}

Back to Top

Response

Default Response

The response for getting the shopping cart

Body ()

Root Schema : shopping-cart-pagination-response

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• links: array links
• offset: integer
  The offset used in the current page.
• priceBookApplicable: boolean
  Title: Price Book Applicable

  Price book applicable indicator.
• processName: string
  Title: Process Name

  Name for the process.
• processVarName: string
  Title: Process Variable Name

  Unique variable name to identify the process.
• showAddToQuoteButton: boolean
  Title: Show Add To Quote Button

  Show add to quote button indicator.
• showCheckoutButton: boolean
  Title: Show Check Out Button

  Show check out button indicator.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "priceBookApplicable":{
            "type":"boolean",
            "description":"Price book applicable indicator.",
            "title":"Price Book Applicable"
        },
        "showAddToQuoteButton":{
            "type":"boolean",
            "description":"Show add to quote button indicator.",
            "title":"Show Add To Quote Button"
        },
        "showCheckoutButton":{
            "type":"boolean",
            "description":"Show check out button indicator.",
            "title":"Show Check Out Button"
        },
        "processVarName":{
            "type":"string",
            "description":"Unique variable name to identify the process.",
            "title":"Process Variable Name"
        },
        "processName":{
            "type":"string",
            "description":"Name for the process.",
            "title":"Process Name"
        },
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "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"
}

Back to Top

Examples

The following example shows how to retrieve the shopping cart associated with the specified process by submitting a POST 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/actions/_getShoppingCart

Request Body Sample

This sample includes optional pagination parameters.

{
  "offset": 0,
  "limit": 2,
  "expandNodes": true,
  "totalResults": true
}

Response Body Sample

This sample includes optional pagination parameters.

{
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/shoppingCarts/transaction"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v16/shoppingCarts"
    }
  ],
  "priceBookApplicable": true,
  "showAddToQuoteButton": false,
  "showCheckoutButton": true,
  "processVarName": "transaction",
  "processName": "Quotes",
  "limit": 2,
  "offset": 0,
  "count": 2,
  "totalResults": 4,
  "hasMore": true,
  "items": [{
      "id": 3022707088,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/shoppingCarts/transaction/shoppingCartItems/3022707088"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/shoppingCarts/transaction/shoppingCartItems/3022707090"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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
    }
  ]
}

Back to Top