Get Dependent v2.0Beta

The Get Item endpoint retrieves the details for an item in a cart. The request will return a single item with any options selected by the customer.

Request

GET /v2.0/customers/{profileKey}/carts/{cartId}/items/{itemId}

Authorization

An OAuth 2.0 Bearer token with the Cart.Read scope is required. For more information, see Authentication.

Path Parameters

A list of the supported path parameters is described below.

Name	Required	Type	Description
profileKey	true	guid	The profile key for the customer.
cartId	true	guid	The cart id for the cart.
itemId	true	guid	The cart item id.

Response

200

OK

Returns a Dependent resource wrapped in an ApiResponse envelope.

Response Body

The endpoint returns our ApiResponse envelope. The data property of the response will contain a CartItem resource.

Sample

{
    "message": "The operation succeeded!",
    "notifications": [],
    "data": {
        "id": "c0b7c57d-7da4-400f-b67a-7b85fd709c0c",
        "menuKey": "ROCO-ZA-3",
        "menuVersion": 202107,
        "menuItemKey": 811000176,
        "displayName": "Classic Cheese Burger",
        "currency": "ZAR",
        "price": 69.00,
        "quantity": 1,
        "value": 88.00,
        "options": [
            {
                "optionSetKey": 861000001,
                "optionSetItemKey": 811000011,
                "displayName": "Beef",
                "currency": "ZAR",
                "price": 0.00
            },
            {
                "optionSetKey": 861000035,
                "optionSetItemKey": 811000205,
                "displayName": "Bacon",
                "currency": "ZAR",
                "price": 19.00
            }
        ],
        "specialInstructions": null
    }
}

Errors

The standard error responses apply.

401

Unauthorized

When authentication fails.

403

Forbidden

When authorisation fails.

404

Not Found

When the cart cannot be found.

404

Not Found

When the item cannot be found.