listShippingMethods

get

/ccadmin/v1/shippingMethods

List Shipping Methods. Get a list of shipping methods based on request parameters. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listShippingMethods_response
Type: object
Show Source
  • items
    The array of shipping method details, includes the associated order and profile details if the request contains the same
Example:
{
    "items":[
        {
            "shippingGroupId":"sg1006",
            "shippingAddress":{
                "lastName":"Anderson",
                "country":"US",
                "city":"Syracuse",
                "prefix":"",
                "postalCode":"13202",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "isDefaultAddress":false,
                "suffix":"",
                "selectedCountry":"US",
                "stateName":"New York",
                "populateShippingMethods":true,
                "alias":"Home",
                "state":"NY",
                "isDefaultShippingAddress":false,
                "email":"kim@example.com",
                "selectedState":"NY",
                "state_ISOCode":"US-NY",
                "isDefaultBillingAddress":false,
                "address3":"",
                "address2":"",
                "address1":"21 Cedar Ave",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "faxNumber":"",
                "middleName":""
            },
            "items":[
                {
                    "commerceItemId":"ci17000462",
                    "quantity":2,
                    "productId":"Product_23Cxyi",
                    "catRefId":"Sku_23Dxyi"
                },
                {
                    "commerceItemId":"ci13000659",
                    "quantity":2,
                    "productId":"Product_27Fxyzi",
                    "childItems":[
                        {
                            "addOnItem":false,
                            "quantity":1,
                            "productId":"prod10037",
                            "rawTotalPrice":0,
                            "detailedItemPriceInfo":[
                                {
                                    "discounted":false,
                                    "secondaryCurrencyTaxAmount":0,
                                    "amount":0,
                                    "quantity":1,
                                    "tax":0,
                                    "orderDiscountShare":0,
                                    "detailedUnitPrice":0,
                                    "currencyCode":null
                                }
                            ],
                            "displayName":"Wii Sports",
                            "availabilityDate":null,
                            "selectedSkuProperties":[
                            ],
                            "externalData":[
                            ],
                            "catRefId":"sku10043",
                            "commerceItemId":"ci13000660",
                            "commerceItemQuantity":1,
                            "expanded":false,
                            "stockState":"",
                            "priceListGroupId":"defaultPriceGroup",
                            "repositoryId":"ci18000436",
                            "selectedOptions":[
                            ],
                            "invalid":false,
                            "stockStatus":true,
                            "shopperInput":{
                            }
                        }
                    ],
                    "catRefId":"Sku_27Gxyzi"
                }
            ],
            "shippingMethods":[
                {
                    "shippingCalculator":"priceRange",
                    "eligibleForProductWithSurcharges":null,
                    "isExternallyPriced":false,
                    "ranges":[
                        {
                            "amount":25,
                            "high":99.99,
                            "low":0,
                            "repositoryId":"standardRange_01"
                        },
                        {
                            "amount":35,
                            "high":null,
                            "low":100,
                            "repositoryId":"standardRange_02"
                        }
                    ],
                    "associatedPriceListGroups":[
                    ],
                    "displayName":"Standard",
                    "description":null,
                    "allSites":true,
                    "sites":[
                    ],
                    "taxCode":null,
                    "type":0,
                    "shippingGroupType":"hardgoodShippingGroup",
                    "enabled":true,
                    "displaySequence":0,
                    "repositoryId":"standardShippingMethod",
                    "excludedCategoriesShippingCharge":[
                    ],
                    "isFallback":false,
                    "id":"standardShippingMethod",
                    "shipToLocations":[
                        {
                            "repositoryId":"100001"
                        }
                    ],
                    "excludedCategories":[
                    ]
                },
                {
                    "shippingCalculator":"priceRange",
                    "eligibleForProductWithSurcharges":null,
                    "isExternallyPriced":false,
                    "ranges":[
                        {
                            "amount":25,
                            "high":99.99,
                            "low":0,
                            "repositoryId":"priorityRange_01"
                        },
                        {
                            "amount":35,
                            "high":null,
                            "low":100,
                            "repositoryId":"priorityRange_02"
                        }
                    ],
                    "associatedPriceListGroups":[
                    ],
                    "displayName":"Priority",
                    "description":null,
                    "allSites":true,
                    "sites":[
                    ],
                    "taxCode":null,
                    "type":0,
                    "shippingGroupType":"hardgoodShippingGroup",
                    "enabled":true,
                    "displaySequence":4,
                    "repositoryId":"priorityShippingMethod",
                    "excludedCategoriesShippingCharge":[
                    ],
                    "isFallback":false,
                    "id":"priorityShippingMethod",
                    "shipToLocations":[
                        {
                            "repositoryId":"100001"
                        }
                    ],
                    "excludedCategories":[
                    ]
                },
                {
                    "shippingCalculator":"priceRange",
                    "eligibleForProductWithSurcharges":null,
                    "isExternallyPriced":false,
                    "ranges":[
                        {
                            "amount":0,
                            "high":null,
                            "low":0,
                            "repositoryId":"freeRange_01"
                        }
                    ],
                    "associatedPriceListGroups":[
                    ],
                    "displayName":"Free Shipping",
                    "description":null,
                    "allSites":true,
                    "sites":[
                    ],
                    "taxCode":null,
                    "type":0,
                    "shippingGroupType":"hardgoodShippingGroup",
                    "enabled":true,
                    "displaySequence":5,
                    "repositoryId":"freeShippingMethod",
                    "excludedCategoriesShippingCharge":[
                    ],
                    "isFallback":false,
                    "id":"freeShippingMethod",
                    "shipToLocations":[
                        {
                            "repositoryId":"100001"
                        }
                    ],
                    "excludedCategories":[
                    ]
                },
                {
                    "shippingCalculator":"priceRange",
                    "eligibleForProductWithSurcharges":null,
                    "isExternallyPriced":false,
                    "ranges":[
                        {
                            "amount":25,
                            "high":99.99,
                            "low":0,
                            "repositoryId":"twoDayRange_01"
                        },
                        {
                            "amount":35,
                            "high":null,
                            "low":100,
                            "repositoryId":"twoDayRange_02"
                        }
                    ],
                    "associatedPriceListGroups":[
                    ],
                    "displayName":"Two Day",
                    "description":null,
                    "allSites":true,
                    "sites":[
                    ],
                    "taxCode":null,
                    "type":0,
                    "shippingGroupType":"hardgoodShippingGroup",
                    "enabled":true,
                    "displaySequence":6,
                    "repositoryId":"twoDayShippingMethod",
                    "excludedCategoriesShippingCharge":[
                    ],
                    "isFallback":false,
                    "id":"twoDayShippingMethod",
                    "shipToLocations":[
                        {
                            "repositoryId":"100001"
                        }
                    ],
                    "excludedCategories":[
                    ]
                },
                {
                    "shippingCalculator":"priceRange",
                    "eligibleForProductWithSurcharges":null,
                    "isExternallyPriced":false,
                    "ranges":[
                        {
                            "amount":4.5,
                            "high":49.99,
                            "low":0,
                            "repositoryId":"groundRange_01"
                        },
                        {
                            "amount":8.5,
                            "high":99.99,
                            "low":50,
                            "repositoryId":"groundRange_02"
                        },
                        {
                            "amount":11,
                            "high":null,
                            "low":100,
                            "repositoryId":"groundRange_03"
                        }
                    ],
                    "associatedPriceListGroups":[
                    ],
                    "displayName":"Ground",
                    "description":null,
                    "allSites":true,
                    "sites":[
                    ],
                    "taxCode":null,
                    "type":0,
                    "shippingGroupType":"hardgoodShippingGroup",
                    "enabled":true,
                    "displaySequence":7,
                    "repositoryId":"groundShippingMethod",
                    "excludedCategoriesShippingCharge":[
                    ],
                    "isFallback":false,
                    "id":"groundShippingMethod",
                    "shipToLocations":[
                        {
                            "repositoryId":"100001"
                        }
                    ],
                    "excludedCategories":[
                    ]
                },
                {
                    "shippingCalculator":"priceRange",
                    "eligibleForProductWithSurcharges":null,
                    "isExternallyPriced":false,
                    "ranges":[
                        {
                            "amount":35,
                            "high":99.99,
                            "low":0,
                            "repositoryId":"overNightRange_01"
                        },
                        {
                            "amount":45,
                            "high":null,
                            "low":100,
                            "repositoryId":"overNightRange_02"
                        }
                    ],
                    "associatedPriceListGroups":[
                    ],
                    "displayName":"Overnight",
                    "description":null,
                    "allSites":true,
                    "sites":[
                    ],
                    "taxCode":"FR020400",
                    "type":0,
                    "shippingGroupType":"hardgoodShippingGroup",
                    "enabled":true,
                    "displaySequence":9,
                    "repositoryId":"overNightShippingMethod",
                    "excludedCategoriesShippingCharge":[
                    ],
                    "isFallback":false,
                    "id":"overNightShippingMethod",
                    "shipToLocations":[
                        {
                            "repositoryId":"100001"
                        }
                    ],
                    "excludedCategories":[
                    ]
                }
            ]
        }
    ]
}
Nested Schema : items
Type: array
The array of shipping method details, includes the associated order and profile details if the request contains the same
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
The item details in the cart
Show Source
Nested Schema : shippingAddress
Type: object
shipping address of the profile
Show Source
Nested Schema : shippingMethods
Type: array
The shipping method details
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : associatedPriceListGroups
Type: array
The associated Price list groups for this Shipping Method.
Show Source
Nested Schema : excludedCategories
Type: array
The excluded categories
Show Source
Nested Schema : ranges
Type: array
the price ranges for this shipping method
Show Source
Nested Schema : shipToLocations
Type: array
The array of repository IDs of shipping locations.
Show Source
Nested Schema : sites
Type: array
List of sites.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
The currency of the price list group.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
[
    {
        "eligibleForProductWithSurcharges":false,
        "shippingCalculator":"priceRange",
        "isExternallyPriced":false,
        "ranges":[
            {
                "amount":4.75,
                "high":14.99,
                "low":0,
                "repositoryId":"groundRange1"
            },
            {
                "amount":5.95,
                "high":49.99,
                "low":15,
                "repositoryId":"groundRange2"
            },
            {
                "amount":6.5,
                "high":null,
                "low":50,
                "repositoryId":"groundRange3"
            }
        ],
        "associatedPriceListGroups":[
            {
                "displayName":"UsDollar",
                "listPriceList":{
                    "repositoryId":"listPrices"
                },
                "repositoryId":"UsDollar",
                "active":true,
                "salePriceList":{
                    "repositoryId":"salePrices"
                },
                "currency":{
                    "symbol":"$",
                    "displayName":"US Dollar",
                    "repositoryId":"en_US",
                    "fractionalDigits":2,
                    "currencyCode":"USD",
                    "numericCode":"840"
                },
                "id":"UsDollar",
                "locale":"en_US",
                "shippingSurchargePriceList":{
                    "repositoryId":"shippingSurchargePrices"
                }
            }
        ],
        "displayName":"Ground",
        "description":null,
        "type":0,
        "taxCode":"FR020400",
        "shippingGroupType":"hardgoodShippingGroup",
        "enabled":true,
        "displaySequence":0,
        "repositoryId":"ground",
        "isFallback":false,
        "shipToLocations":[
            {
                "repositoryId":"SouthUS"
            },
            {
                "repositoryId":"NorthUS"
            }
        ]
    },
    {
        "eligibleForProductWithSurcharges":true,
        "shippingCalculator":"priceRange",
        "isExternallyPriced":false,
        "ranges":[
            {
                "amount":8.75,
                "high":14.99,
                "low":0,
                "repositoryId":"twoDayRange1"
            },
            {
                "amount":9.95,
                "high":49.99,
                "low":15,
                "repositoryId":"twoDayRange2"
            },
            {
                "amount":10.5,
                "high":null,
                "low":50,
                "repositoryId":"twoDayRange3"
            }
        ],
        "associatedPriceListGroups":[
            {
                "displayName":"UsDollar",
                "listPriceList":{
                    "repositoryId":"listPrices"
                },
                "repositoryId":"UsDollar",
                "active":true,
                "salePriceList":{
                    "repositoryId":"salePrices"
                },
                "currency":{
                    "symbol":"$",
                    "displayName":"US Dollar",
                    "repositoryId":"en_US",
                    "fractionalDigits":2,
                    "currencyCode":"USD",
                    "numericCode":"840"
                },
                "id":"UsDollar",
                "locale":"en_US",
                "shippingSurchargePriceList":{
                    "repositoryId":"shippingSurchargePrices"
                }
            }
        ],
        "displayName":"Two Day",
        "description":null,
        "type":0,
        "taxCode":"FR020400",
        "shippingGroupType":"hardgoodShippingGroup",
        "enabled":true,
        "displaySequence":1,
        "repositoryId":"twoDay",
        "isFallback":false,
        "shipToLocations":[
            {
                "repositoryId":"SouthUS"
            },
            {
                "repositoryId":"EastUS"
            }
        ]
    },
    {
        "eligibleForProductWithSurcharges":false,
        "shippingCalculator":"priceRange",
        "isExternallyPriced":false,
        "ranges":[
            {
                "amount":16.4,
                "high":null,
                "low":0,
                "repositoryId":"overnightRange1"
            }
        ],
        "associatedPriceListGroups":[
            {
                "displayName":"UsDollar",
                "listPriceList":{
                    "repositoryId":"listPrices"
                },
                "repositoryId":"UsDollar",
                "active":true,
                "salePriceList":{
                    "repositoryId":"salePrices"
                },
                "currency":{
                    "symbol":"$",
                    "displayName":"US Dollar",
                    "repositoryId":"en_US",
                    "fractionalDigits":2,
                    "currencyCode":"USD",
                    "numericCode":"840"
                },
                "id":"UsDollar",
                "locale":"en_US",
                "shippingSurchargePriceList":{
                    "repositoryId":"shippingSurchargePrices"
                }
            }
        ],
        "displayName":"Overnight",
        "description":null,
        "type":0,
        "taxCode":"FR020400",
        "shippingGroupType":"hardgoodShippingGroup",
        "enabled":true,
        "displaySequence":2,
        "repositoryId":"overnight",
        "isFallback":false,
        "shipToLocations":[
            {
                "repositoryId":"WestUS"
            },
            {
                "repositoryId":"NorthUS"
            }
        ]
    },
    {
        "eligibleForProductWithSurcharges":false,
        "shippingCalculator":"priceRange",
        "isExternallyPriced":false,
        "ranges":[
            {
                "amount":66,
                "high":59.99,
                "low":0,
                "repositoryId":"100001"
            },
            {
                "amount":76,
                "high":null,
                "low":60,
                "repositoryId":"100002"
            }
        ],
        "associatedPriceListGroups":[
        ],
        "displayName":"asdfsdaf",
        "description":null,
        "type":0,
        "taxCode":null,
        "shippingGroupType":"hardgoodShippingGroup",
        "enabled":true,
        "displaySequence":3,
        "repositoryId":"100001",
        "isFallback":false,
        "shipToLocations":[
        ]
    }
]

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top