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 array of shipping method details, includes the associated order and profile details if the request contains the same
Example:
{
"items":[
{
"shippingGroupId":"sg1003",
"shippingAddress":{
"lastName":"Anderson",
"country":"US",
"city":"Syracuse",
"prefix":"",
"postalCode":"13202",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":true,
"suffix":"",
"selectedCountry":"US",
"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",
"repositoryId":"se-980031",
"faxNumber":"",
"middleName":""
},
"items":[
{
"commerceItemId":"ci8000422",
"quantity":3,
"productId":"Product_23Cxyi",
"catRefId":"Sku_23Dxyi"
}
],
"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:
arrayThe array of shipping method details, includes the associated order and profile details if the request contains the same
Show Source
Nested Schema : items
Type:
Show Source
object-
items(optional):
array items
The item details in the cart
-
shippingAddress(optional):
object shippingAddress
shipping address of the profile
-
shippingGroupId(optional):
string
The shipping group ID.
-
shippingMethods(optional):
array shippingMethods
The shipping method details
Nested Schema : shippingAddress
Type:
objectshipping address of the profile
Show Source
-
address1(optional):
string
the address1 of the shipping address
-
address2(optional):
string
the address2 of the shipping address
-
address3(optional):
string
the address3 of the shipping address
-
city(optional):
string
the city of the shipping address
-
country(optional):
string
the country of the shipping address
-
county(optional):
string
the county of the shipping address
-
email(optional):
string
the email address
-
faxNumber(optional):
string
The faxNumber of the shipping address.
-
firstName(optional):
string
the first name of the shipping address
-
lastName(optional):
string
the last name of the shipping address
-
middleName(optional):
string
The middle name of the shipping address.
-
phoneNumber(optional):
string
the phone Number of the shipping address
-
postalCode(optional):
string
the postal Code of the shipping address
-
selectedCountry(optional):
string
the country code of the shipping address
-
selectedState(optional):
string
the state ISO alpha-2 code of the shipping address
-
state(optional):
string
the state of the shipping address
-
state_ISOCode(optional):
string
the state ISO alpha-4 code of the shipping address
Nested Schema : items
Type:
Show Source
object-
catRefId(optional):
string
The id of the category to which the product belongs.
-
commerceItemId(optional):
string
The unique line item id distinguisher.
-
productId(optional):
string
The id of the product in the cart.
-
quantity(optional):
number
The quantity of the product in the cart.
Nested Schema : items
Type:
Show Source
object-
allSites(optional):
boolean
Whether or not it includes all sites in the response.
-
associatedPriceListGroups(optional):
array associatedPriceListGroups
The associated Price list groups for this Shipping Method.
-
description(optional):
string
The description of shipping group.
-
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 null.
-
enabled(optional):
boolean
whether this shipping method is enabled or not.
-
excludedCategories(optional):
array excludedCategories
The excluded categories
-
id(optional):
string
the shipping method id.
-
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.
-
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 shipping group type.
-
shipToLocations(optional):
array shipToLocations
The array of repository IDs of shipping locations.
-
sites(optional):
array sites
List of sites.
-
taxCode(optional):
string
a valid tax code for calculating tax on shipping.
-
type(optional):
integer
The type property of the shipping method.
Nested Schema : associatedPriceListGroups
Type:
arrayThe associated Price list groups for this Shipping Method.
Show Source
Nested Schema : shipToLocations
Type:
arrayThe array of repository IDs of shipping locations.
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
-
secondaryCurrencyShippingAmount(optional):
string
In case of mix currency, if secondaryCurrencyCode is sent in request, shipping amount will be calculated according to given secondaryCurrencyCode. Else if payShippingInSecondaryCurrency flag is enabled in site repository, shipping amount will be calculated according to site level secondaryCurrencyCode
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