Jump to

• Request
• Response
• Examples

Get List of All Shopping Carts

get

/rest/v16/shoppingCarts

This endpoint returns a list of all shopping carts visible to the user.

Request

There are no request parameters for this operation.

Back to Top

Response

Default Response

The response for getting the shopping carts.

Body ()

Root Schema : shopping-cart-list-response

Type: object

Show Source

• items: array items
• links: array links

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

Nested Schema : items

Type: array

Show Source

• Array of: object shopping-cart-response

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

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-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 list of 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

Response Body Sample

{
    "links": [{
            "rel": "self",
            "href": "https://sitename.oracle.com/rest/v16/shoppingCarts"
        }
    ],
    "items": [{
            "links": [{
                    "rel": "self",
                    "href": "https://sitename.oracle.com/rest/v16/shoppingCarts/transaction"
                }
            ],
            "priceBookApplicable": true,
            "showAddToQuoteButton": false,
            "showCheckoutButton": true,
            "processVarName": "transaction",
            "processName": "Quotes"
        }, {
            "links": [{
                    "rel": "self",
                    "href": "https://sitename.oracle.com/rest/v16/shoppingCarts/oraclecpqo"
                }
            ],
            "priceBookApplicable": true,
            "showAddToQuoteButton": false,
            "showCheckoutButton": true,
            "processVarName": "oraclecpqo",
            "processName": "Oracle Quote to Order",
        }
    ]

Back to Top