Jump to

• Request
• Response
• Examples

Get Shopping Cart Item

get

/rest/v16/shoppingCarts/{processVarName}/shoppingCartItems/{id}

This endpoint returns an item from a shopping cart.

Request

Path Parameters

• id(required): integer
  The unique identifier to identify the shopping cart item to retrieve.
• processVarName(required): string
  The unique variable name to identify the process.

Back to Top

Response

Default Response

The response for getting the shopping cart item.

Body ()

Root 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 an item from 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 - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/shoppingCarts/transaction/shoppingCartItems/302270788

Response Body Sample

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

Back to Top