listShippingMethods

post

/ccstore/v1/shippingMethods

List Shipping Methods. Get a list of shipping methods that are valid for a given address. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : listShippingMethods_request
Type: object
Show Source
Example:
{
    "priceInfo":{
        "amount":22.98,
        "total":22.98,
        "shipping":0,
        "shippingSurchargeValue":0,
        "tax":0,
        "subTotal":22.98,
        "currencyCode":"USD",
        "totalWithoutTax":22.98
    },
    "shippingGroups":[
        {
            "shippingGroupId":"sg10001",
            "shippingAddress":{
                "lastName":"sample",
                "country":"United States",
                "address3":"",
                "address2":"Address2",
                "city":"redwood city",
                "prefix":"",
                "address1":"Address1",
                "defaultCountryCode":null,
                "postalCode":"94085",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "isDefaultAddress":true,
                "suffix":"",
                "selectedCountry":"US",
                "firstName":"sample",
                "phoneNumber":"5345345",
                "alias":"Address",
                "faxNumber":"",
                "middleName":"",
                "state":"California",
                "selectedState":"CA",
                "email":"sample@test.com",
                "state_ISOCode":"US-CA"
            },
            "items":[
                {
                    "commerceItemId":"ci7000501",
                    "quantity":2,
                    "productId":"prod10004",
                    "childItems":[
                        {
                            "addOnItem":true,
                            "quantity":1,
                            "productId":"Product_18Cxi",
                            "displayName":"Dr. Dolittle",
                            "catRefId":"Sku_18Dxi"
                        }
                    ],
                    "catRefId":"sku10028"
                },
                {
                    "quantity":2,
                    "productId":"Product_36Exy",
                    "catRefId":"Sku_36Fxy"
                }
            ],
            "productIdForShippingSurcharge":[
                "Product_36Exy"
            ]
        },
        {
            "shippingGroupId":"sg10002",
            "shippingAddress":{
                "lastName":"test",
                "country":"United States",
                "address3":"",
                "address2":"Address2",
                "city":"jhg",
                "prefix":"",
                "address1":"Address1",
                "defaultCountryCode":null,
                "postalCode":"03031",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "isDefaultAddress":false,
                "suffix":"",
                "selectedCountry":"US",
                "firstName":"sample no tax",
                "phoneNumber":"675675675",
                "alias":"Address##3",
                "faxNumber":"",
                "middleName":"",
                "state":"New Hampshire",
                "selectedState":"NH",
                "email":"sample@test.com",
                "state_ISOCode":"US-NH"
            },
            "items":[
                {
                    "commerceItemId":"ci7000501",
                    "quantity":2,
                    "productId":"prod10004",
                    "childItems":[
                        {
                            "addOnItem":true,
                            "quantity":1,
                            "productId":"Product_18Cxi",
                            "displayName":"Dr. Dolittle",
                            "catRefId":"Sku_18Dxi"
                        }
                    ],
                    "catRefId":"sku10028"
                },
                {
                    "quantity":2,
                    "productId":"Product_36Exy",
                    "catRefId":"Sku_36Fxy"
                }
            ],
            "productIdForShippingSurcharge":[
                "Product_36Exy"
            ]
        }
    ],
    "profileId":"se-570031",
    "shoppingCart":{
        "coupons":[
        ],
        "items":[
            {
                "commerceItemId":"ci7000501",
                "quantity":4,
                "productId":"prod10004",
                "childItems":[
                    {
                        "addOnItem":true,
                        "quantity":2,
                        "productId":"Product_18Cxi",
                        "displayName":"Dr. Dolittle",
                        "catRefId":"Sku_18Dxi"
                    }
                ],
                "catRefId":"sku10028"
            },
            {
                "quantity":4,
                "productId":"Product_36Exy",
                "catRefId":"Sku_36Fxy"
            }
        ]
    }
}
Nested Schema : productIdForShippingSurcharge
Type: array
array of product ids present in the cart.
Show Source
Nested Schema : shippingAddress
Type: object
shipping address of the profile
Show Source
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
Nested Schema : items
Type: array
The list of shipping methods.
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 : ranges
Type: array
The price ranges for this shipping method.
Show Source
Nested Schema : shipToLocations
Type: array
The Shipping Regions for a Shipping Method
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
Nested Schema : shippingCountryRegion
Type: array
The shipping country region
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : country
Type: object
The shipping country.
Show Source
Nested Schema : regions
Type: array
The regions in the shipping country
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
[
    {
        "items":[
            {
                "shippingGroupId":"sg10001",
                "shippingAddress":{
                    "lastName":"sample",
                    "country":"US",
                    "city":"City",
                    "prefix":"",
                    "postalCode":"94085",
                    "jobTitle":"",
                    "companyName":"",
                    "county":"",
                    "isDefaultAddress":true,
                    "suffix":"",
                    "selectedCountry":"US",
                    "populateShippingMethods":false,
                    "alias":"Address",
                    "state":"CA",
                    "selectedState":"CA",
                    "email":"sample@test.com",
                    "state_ISOCode":"US-CA",
                    "address3":"",
                    "address2":"Address 2",
                    "address1":"22 Address line ",
                    "defaultCountryCode":null,
                    "firstName":"sample",
                    "phoneNumber":"5345345",
                    "faxNumber":"",
                    "middleName":""
                },
                "items":[
                    {
                        "commerceItemId":"ci7000501",
                        "quantity":2,
                        "productId":"prod10004",
                        "childItems":[
                            {
                                "addOnItem":true,
                                "quantity":1,
                                "productId":"Product_18Cxi",
                                "displayName":"Dr. Dolittle",
                                "catRefId":"Sku_18Dxi"
                            }
                        ],
                        "catRefId":"sku10028"
                    },
                    {
                        "quantity":2,
                        "productId":"Product_36Exy",
                        "catRefId":"Sku_36Fxy"
                    }
                ],
                "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":[
                        ]
                    },
                    {
                        "shippingCalculator":"external",
                        "eligibleForProductWithSurcharges":true,
                        "estimatedDeliveryDateGuaranteed":false,
                        "internationalDutiesTaxesFees":0,
                        "ranges":[
                            {
                                "amount":14.95,
                                "high":1.7976931348623157E308,
                                "low":0
                            }
                        ],
                        "displayName":"canadapost-overnight",
                        "taxCode":"GT987",
                        "shippingGroupType":"hardgoodShippingGroup",
                        "estimatedDeliveryDate":"2013-04-12 14:48:45 -0400",
                        "enabled":true,
                        "deliveryDays":2,
                        "repositoryId":"canadapost-overnight",
                        "carrierId":"ON"
                    },
                    {
                        "shippingCalculator":"external",
                        "estimatedDeliveryDateGuaranteed":false,
                        "internationalDutiesTaxesFees":0,
                        "ranges":[
                            {
                                "amount":33,
                                "high":1.7976931348623157E308,
                                "low":0
                            }
                        ],
                        "deliveryDays":2,
                        "displayName":"fedex-2dayground",
                        "repositoryId":"fedex-2dayground",
                        "carrierId":"1D",
                        "taxCode":"TD543",
                        "shippingGroupType":"hardgoodShippingGroup",
                        "estimatedDeliveryDate":"2013-04-12 14:48:45 -0400",
                        "enabled":true
                    }
                ]
            },
            {
                "shippingGroupId":"sg10002",
                "shippingAddress":{
                    "lastName":"sample",
                    "country":"US",
                    "city":"jhg",
                    "prefix":"",
                    "postalCode":"03031",
                    "jobTitle":"",
                    "companyName":"",
                    "county":"",
                    "isDefaultAddress":false,
                    "suffix":"",
                    "selectedCountry":"US",
                    "populateShippingMethods":false,
                    "alias":"Address##3",
                    "state":"NH",
                    "selectedState":"NH",
                    "email":"sample@test.com",
                    "state_ISOCode":"US-NH",
                    "address3":"",
                    "address2":"Address line 2",
                    "address1":"22 Address Line ",
                    "defaultCountryCode":null,
                    "firstName":"sample no tax",
                    "phoneNumber":"675675675",
                    "faxNumber":"",
                    "middleName":""
                },
                "items":[
                    {
                        "commerceItemId":"ci7000501",
                        "quantity":2,
                        "productId":"prod10004",
                        "childItems":[
                            {
                                "addOnItem":true,
                                "quantity":1,
                                "productId":"Product_18Cxi",
                                "displayName":"Dr. Dolittle",
                                "catRefId":"Sku_18Dxi"
                            }
                        ],
                        "catRefId":"sku10028"
                    },
                    {
                        "quantity":2,
                        "productId":"Product_36Exy",
                        "catRefId":"Sku_36Fxy"
                    }
                ],
                "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":[
                        ]
                    },
                    {
                        "shippingCalculator":"external",
                        "eligibleForProductWithSurcharges":true,
                        "estimatedDeliveryDateGuaranteed":false,
                        "isExternallyPriced":false,
                        "internationalDutiesTaxesFees":0,
                        "ranges":[
                            {
                                "amount":14.95,
                                "high":1.7976931348623157E308,
                                "low":0
                            }
                        ],
                        "displayName":"canadapost-overnight",
                        "taxCode":"GT987",
                        "shippingGroupType":"hardgoodShippingGroup",
                        "estimatedDeliveryDate":"2013-04-12 14:48:45 -0400",
                        "enabled":true,
                        "deliveryDays":2,
                        "repositoryId":"canadapost-overnight",
                        "isFallback":false,
                        "carrierId":"ON"
                    },
                    {
                        "shippingCalculator":"external",
                        "estimatedDeliveryDateGuaranteed":false,
                        "isExternallyPriced":false,
                        "internationalDutiesTaxesFees":0,
                        "ranges":[
                            {
                                "amount":33,
                                "high":1.7976931348623157E308,
                                "low":0
                            }
                        ],
                        "displayName":"fedex-2dayground",
                        "taxCode":"TD543",
                        "shippingGroupType":"hardgoodShippingGroup",
                        "estimatedDeliveryDate":"2013-04-12 14:48:45 -0400",
                        "enabled":true,
                        "deliveryDays":2,
                        "repositoryId":"fedex-2dayground",
                        "isFallback":false,
                        "carrierId":"1D"
                    }
                ]
            }
        ]
    }
]

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