Skip to main content

Get a Cart Shipping Group by ID

GET Get a Cart Shipping Group by ID​

https://useast.api.elasticpath.com/v2/carts/:cartID/shipping-groups/:shippingGroupID

Parameters​

Path parameters​

NameRequiredTypeDescription
cartIDRequiredstringThe unique identifier of the cart to retrieve a shipping group for a cart.
shippingGroupIDRequiredstringThe unique identifier of the shipping group related to a cart.

Headers​

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.

Request Example​

curl -X GET https://useast.api.elasticpath.com/v2/carts/:cartID/shipping-groups/:shippingGroupID
    -H "Authorization: Bearer XXXX" \
    -H "content-type: application/json" \

Response Example​

200 OK

{
    "data": {
        "type": "shipping_group",
        "id": "eb063818-939a-458f-97a4-2601c0c2b445",
        "relation": "cart",
        "order_id": "",
        "cart_id": "2b5cb684-7fdf-4a50-9e6a-9e880f7150ba",
        "shipping_type": "UPS Ground",
        "tracking_reference": "ground_1234",
        "address": {
            "first_name": "Ron",
            "last_name": "Swanson",
            "company_name": "Ron Swanson Enterprises",
            "phone_number": "",
            "line_1": "1 Sunny Street",
            "line_2": "",
            "postcode": "92802",
            "county": "Orange",
            "country": "US",
            "region": "CA",
            "instructions": ""
        },
        "delivery_estimate": {
            "start": "2023-04-25T00:00:00Z",
            "end": "2023-04-29T00:00:00Z"
        },
        "created_at": "2023-06-23T16:36:10.717Z",
        "updated_at": "2023-06-23T16:36:10.717Z",
        "relationships": {
            "cart": {
                "data": {
                    "type": "cart",
                    "id": "2b5cb684-7fdf-4a50-9e6a-9e880f7150ba"
                }
            }
        },
        "meta": {
            "shipping_display_price": {
                "total": {
                    "amount": 700,
                    "currency": "USD",
                    "formatted": "$7.00"
                },
                "base": {
                    "amount": 500,
                    "currency": "USD",
                    "formatted": "$5.00"
                },
                "tax": {
                    "amount": 100,
                    "currency": "USD",
                    "formatted": "$1.00"
                },
                "fees": {
                    "amount": 100,
                    "currency": "USD",
                    "formatted": "$1.00"
                }
            }
        }
    }
}

Errors​

When the shipping group is part of another cart, checked out, or doesn't exist, an error response similar to the one below is returned:

{
    "errors": [
        {
            "status": 404,
            "title": "Shipping groups not found",
            "detail": "Shipping groups not found for this cart. Please verify the shipping groups exists for this cart and are not already associated with orders.",
            "meta": {
                "cart_id": "123",
                "shipping_group_ids": [
                    "4658e5e5-bbf3-4da2-92ef-a832dfcfe677"
                ]
            }
        }
    ]
}