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
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)
[
    {
        "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