Jump to

• Request
• Response
• Examples

Get Shopping Cart

get

/rest/v16/shoppingCarts/{processVarName}

This endpoint returns a shopping cart for a process.

Request

Path Parameters

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

Back to Top

Response

Default Response

The response for getting the shopping cart.

Body ()

Root Schema : shopping-cart-response

Type: object

Show Source

• links: array links
• 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.
• shoppingCartItems: object shoppingCartItems
• 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.

{
    "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"
        },
        "shoppingCartItems":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/link"
                    }
                }
            }
        },
        "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 : shoppingCartItems

Type: object

Show Source

• links: array links

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

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

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

Back to Top

Examples

The following example shows how to retrieve a shopping cart for a process 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

Response Body Sample

{
  "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",
  "shoppingCartItems": {
    "links": [{
        "rel": "self",
        "href": "https://sitename.oracle.com/rest/v16/shoppingCarts/transaction/shoppingCartItems"
      }, {
        "rel": "parent",
        "href": "https://sitename.oracle.com/rest/v16/shoppingCarts/transaction"
      }
    ]
  }
}

Back to Top