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
- application/json
Query Parameters
-
enabledOnly(optional): boolean
Only return shipping methods which are enabled. Defaults to true.
-
production(optional): boolean
If set to true, returns shipping methods from the production database i.e only published data will be retrieved.
-
shippingGroupType(optional): string
If set, only returns shipping methods of the given shipping group type.
-
useSiteHeader(optional): boolean
If set to true, returns shipping methods of the given site else return all the shipping methods. Defaults to false
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listShippingMethods_response
Type:
Show Source
object-
items(optional):
array items
The list of shipping methods.
Nested Schema : items
Type:
Show Source
object-
associatedPriceListGroups(optional):
array associatedPriceListGroups
The associated Price list groups for this Shipping Method.
-
displayName(optional):
string
The display name for the shipping method given the current locale.
-
displaySequence(optional):
integer
Used to determine the ordering of shipping methods in the UI. Lower values should appear first in any ordered list.
-
eligibleForProductWithSurcharges(optional):
boolean
Whether this shipping method is enabled for products with surcharges or not. Defaults to false.
-
enabled(optional):
boolean
Whether this shipping method is enabled or not.
-
externalId(optional):
string
External Id for the shipping method
-
internalName(optional):
string
Internal name for the shipping method.
-
isExternallyPriced(optional):
boolean
Whether this shipping method can be priced externally or not. Defaults to false.
-
isFallback(optional):
boolean
Use this shipping method when Commerce Cloud cannot connect to an external shipping service. Defaults to false.
-
name(optional):
string
The internal name for the shipping method.
-
ranges(optional):
array ranges
The price ranges for this shipping method.
-
repositoryId(optional):
string
The ID of the shipping method item.
-
shippingCalculator(optional):
string
A valid key for the available calculator types.
-
shippingGroupType(optional):
string
The internal name for the shipping method.
-
shipToLocations(optional):
array shipToLocations
The Shipping Regions for a Shipping Method
-
taxCode(optional):
string
A valid tax code for calculating tax on shipping.
Nested Schema : associatedPriceListGroups
Type:
arrayThe associated Price list groups for this Shipping Method.
Show Source
Nested Schema : items
Type:
Show Source
object-
active(optional):
boolean
If the price list group is active.
-
currency(optional):
object currency
The currency of the price list group.
-
deleted(optional):
boolean
If the price list deleted
-
displayName(optional):
string
The display name of the price list group.
-
id(optional):
string
The id of the price list group.
-
locale(optional):
string
The locale associated
-
repositoryId(optional):
string
The repository Id of the price list group.
Nested Schema : currency
Type:
objectThe currency of the price list group.
Show Source
-
repositoryId(optional):
string
The repository ID of the currency.
Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary value for the range.
-
high(optional):
number
The upper boundary of the range.
-
low(optional):
number
The lower boundary of the range.
-
repositoryId(optional):
string
The repository id of this priceRange item.
Nested Schema : items
Type:
Show Source
object-
repositoryId(optional):
string
The repository ID of the shipping region.
-
shippingCountryRegion(optional):
array shippingCountryRegion
The shipping country region
-
shippingRegionName(optional):
string
The name of the Shipping Region
Nested Schema : items
Type:
Show Source
object-
country(optional):
object country
The shipping country.
-
regions(optional):
array regions
The regions in the shipping country
-
repositoryId(optional):
string
The repository ID of the shipping country region.
Nested Schema : country
Type:
objectThe shipping country.
Show Source
-
repositoryId(optional):
string
The repository ID of the country.
Nested Schema : items
Type:
Show Source
object-
repositoryId(optional):
string
The repository ID of the region.
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",
"externalId":"id12345",
"description":null,
"type":0,
"taxCode":"FR020400",
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"internalName":"Internal Name",
"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",
"externalId":"id12345",
"description":null,
"type":0,
"taxCode":"FR020400",
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"internalName":"Internal Name",
"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",
"externalId":"id12345",
"description":null,
"type":0,
"taxCode":"FR020400",
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"internalName":"Internal Name",
"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",
"externalId":"id12345",
"description":null,
"type":0,
"taxCode":null,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"internalName":"Internal Name",
"displaySequence":3,
"repositoryId":"100001",
"isFallback":false,
"shipToLocations":[
]
}
]Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code