listShippingCountries
get
/ccagent/v1/validShippingCountries
List Shipping Countries. List all the shipping countries and their regions that have been configured in Admin settings (associated with some Shipping method).
Request
Supported Media Types
- application/json
Query Parameters
-
priceListGroupId(optional): string
Obtains the country/region where the priceListGroupId is applicable. If priceListGroupId is not specified, all the country/regions will be obtained.
-
regions(optional): boolean
For getting regions corresponding to countries.
-
sortByCode(optional): boolean
For returning sorted country/regions.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listShippingCountries_response
Type:
Show Source
object-
countriesList(optional):
array countriesList
The list of all countries with regions.
Nested Schema : items
Type:
Show Source
object-
countryCode(optional):
string
Two letter country code.
-
displayName(optional):
string
Localized country name
-
regions(optional):
array regions
The list of regions for particular country.
-
repositoryId(optional):
string
The repository ID of the country item.
Nested Schema : items
Type:
Show Source
object-
abbreviation(optional):
string
The abbreviation of the region item.
-
displayName(optional):
string
Localized region name.
-
regionCode(optional):
string
The region code (normally its ISO 3166-2 code).
-
repositoryId(optional):
string
The ID of the region item.
Example Response (application/json)
{
"countriesList":[
{
"regions":[
{
"regionCode":"AU-ACT",
"displayName":"Australian Capital Territory",
"repositoryId":"AU-ACT",
"abbreviation":"ACT"
},
{
"regionCode":"AU-NT",
"displayName":"Northern Territory",
"repositoryId":"AU-NT",
"abbreviation":"NT"
},
{
"regionCode":"AU-QLD",
"displayName":"Queensland",
"repositoryId":"AU-QLD",
"abbreviation":"QLD"
},
{
"regionCode":"AU-SA",
"displayName":"South Australia",
"repositoryId":"AU-SA",
"abbreviation":"SA"
},
{
"regionCode":"AU-WA",
"displayName":"Western Australia",
"repositoryId":"AU-WA",
"abbreviation":"WA"
}
],
"displayName":"Australia",
"countryCode":"AU",
"repositoryId":"AU"
},
{
"regions":[
{
"regionCode":"BD-A",
"displayName":"Barisal",
"repositoryId":"BD-A",
"abbreviation":"A"
},
{
"regionCode":"BD-B",
"displayName":"Chittagong",
"repositoryId":"BD-B",
"abbreviation":"B"
},
{
"regionCode":"BD-C",
"displayName":"Dhaka",
"repositoryId":"BD-C",
"abbreviation":"C"
},
{
"regionCode":"BD-D",
"displayName":"Khulna",
"repositoryId":"BD-D",
"abbreviation":"D"
},
{
"regionCode":"BD-E",
"displayName":"Rajshahi",
"repositoryId":"BD-E",
"abbreviation":"E"
},
{
"regionCode":"BD-G",
"displayName":"Sylhet",
"repositoryId":"BD-G",
"abbreviation":"G"
}
],
"displayName":"Bangladesh",
"countryCode":"BD",
"repositoryId":"BD"
},
{
"regions":[
{
"regionCode":"CA-AB",
"displayName":"Alberta",
"repositoryId":"CA-AB",
"abbreviation":"AB"
},
{
"regionCode":"CA-BC",
"displayName":"British Columbia",
"repositoryId":"CA-BC",
"abbreviation":"BC"
},
{
"regionCode":"CA-MB",
"displayName":"Manitoba",
"repositoryId":"CA-MB",
"abbreviation":"MB"
},
{
"regionCode":"CA-NB",
"displayName":"New Brunswick",
"repositoryId":"CA-NB",
"abbreviation":"NB"
},
{
"regionCode":"CA-NL",
"displayName":"Newfoundland and Labrador",
"repositoryId":"CA-NL",
"abbreviation":"NL"
},
{
"regionCode":"CA-NS",
"displayName":"Nova Scotia",
"repositoryId":"CA-NS",
"abbreviation":"NS"
},
{
"regionCode":"CA-NT",
"displayName":"Northwest Territories",
"repositoryId":"CA-NT",
"abbreviation":"NT"
},
{
"regionCode":"CA-NU",
"displayName":"Nunavut",
"repositoryId":"CA-NU",
"abbreviation":"NU"
},
{
"regionCode":"CA-ON",
"displayName":"Ontario",
"repositoryId":"CA-ON",
"abbreviation":"ON"
},
{
"regionCode":"CA-PE",
"displayName":"Prince Edward Island",
"repositoryId":"CA-PE",
"abbreviation":"PE"
},
{
"regionCode":"CA-QC",
"displayName":"Quebec",
"repositoryId":"CA-QC",
"abbreviation":"QC"
},
{
"regionCode":"CA-SK",
"displayName":"Saskatchewan",
"repositoryId":"CA-SK",
"abbreviation":"SK"
},
{
"regionCode":"CA-YT",
"displayName":"Yukon",
"repositoryId":"CA-YT",
"abbreviation":"YT"
}
],
"displayName":"Canada",
"countryCode":"CA",
"repositoryId":"CA"
},
{
"regions":[
{
"regionCode":"DE-BB",
"displayName":"Brandenburg",
"repositoryId":"DE-BB",
"abbreviation":"BB"
},
{
"regionCode":"DE-BE",
"displayName":"Berlin",
"repositoryId":"DE-BE",
"abbreviation":"BE"
},
{
"regionCode":"DE-BW",
"displayName":"Baden-W??rttemberg",
"repositoryId":"DE-BW",
"abbreviation":"BW"
},
{
"regionCode":"DE-BY",
"displayName":"Bavaria",
"repositoryId":"DE-BY",
"abbreviation":"BY"
},
{
"regionCode":"DE-HB",
"displayName":"Bremen",
"repositoryId":"DE-HB",
"abbreviation":"HB"
},
{
"regionCode":"DE-HH",
"displayName":"Hamburg",
"repositoryId":"DE-HH",
"abbreviation":"HH"
},
{
"regionCode":"DE-MV",
"displayName":"Mecklenburg West Pomerania",
"repositoryId":"DE-MV",
"abbreviation":"MV"
},
{
"regionCode":"DE-TH",
"displayName":"Thuringia",
"repositoryId":"DE-TH",
"abbreviation":"TH"
}
],
"displayName":"Germany",
"countryCode":"DE",
"repositoryId":"DE"
},
{
"regions":[
],
"displayName":"Faroe Islands",
"countryCode":"FO",
"repositoryId":"FO"
},
{
"regions":[
{
"regionCode":"IN-AP",
"displayName":"Andhra Pradesh",
"repositoryId":"IN-AP",
"abbreviation":"AP"
},
{
"regionCode":"IN-AR",
"displayName":"Arunachal Pradesh",
"repositoryId":"IN-AR",
"abbreviation":"AR"
},
{
"regionCode":"IN-MN",
"displayName":"Manipur",
"repositoryId":"IN-MN",
"abbreviation":"MN"
},
{
"regionCode":"IN-PB",
"displayName":"Punjab",
"repositoryId":"IN-PB",
"abbreviation":"PB"
},
{
"regionCode":"IN-SK",
"displayName":"Sikkim",
"repositoryId":"IN-SK",
"abbreviation":"SK"
},
{
"regionCode":"IN-TN",
"displayName":"Tamil Nadu",
"repositoryId":"IN-TN",
"abbreviation":"TN"
}
],
"displayName":"India",
"countryCode":"IN",
"repositoryId":"IN"
},
{
"regions":[
{
"regionCode":"LK-1",
"displayName":"Western Province",
"repositoryId":"LK-1",
"abbreviation":"1"
},
{
"regionCode":"LK-2",
"displayName":"Central Province",
"repositoryId":"LK-2",
"abbreviation":"2"
},
{
"regionCode":"LK-3",
"displayName":"Southern Province",
"repositoryId":"LK-3",
"abbreviation":"3"
},
{
"regionCode":"LK-5",
"displayName":"Eastern Province",
"repositoryId":"LK-5",
"abbreviation":"5"
},
{
"regionCode":"LK-9",
"displayName":"Sabaragamuwa Province",
"repositoryId":"LK-9",
"abbreviation":"9"
}
],
"displayName":"Sri Lanka",
"countryCode":"LK",
"repositoryId":"LK"
},
{
"regions":[
{
"regionCode":"US-AK",
"displayName":"Alaska",
"repositoryId":"US-AK",
"abbreviation":"AK"
},
{
"regionCode":"US-AL",
"displayName":"Alabama",
"repositoryId":"US-AL",
"abbreviation":"AL"
},
{
"regionCode":"US-AR",
"displayName":"Arkansas",
"repositoryId":"US-AR",
"abbreviation":"AR"
},
{
"regionCode":"US-AZ",
"displayName":"Arizona",
"repositoryId":"US-AZ",
"abbreviation":"AZ"
},
{
"regionCode":"US-CA",
"displayName":"California",
"repositoryId":"US-CA",
"abbreviation":"CA"
},
{
"regionCode":"US-CO",
"displayName":"Colorado",
"repositoryId":"US-CO",
"abbreviation":"CO"
},
{
"regionCode":"US-CT",
"displayName":"Connecticut",
"repositoryId":"US-CT",
"abbreviation":"CT"
},
{
"regionCode":"US-DC",
"displayName":"District of Columbia",
"repositoryId":"US-DC",
"abbreviation":"DC"
},
{
"regionCode":"US-DE",
"displayName":"Delaware",
"repositoryId":"US-DE",
"abbreviation":"DE"
},
{
"regionCode":"US-FL",
"displayName":"Florida",
"repositoryId":"US-FL",
"abbreviation":"FL"
},
{
"regionCode":"US-GA",
"displayName":"Georgia",
"repositoryId":"US-GA",
"abbreviation":"GA"
},
{
"regionCode":"US-GU",
"displayName":"Guam",
"repositoryId":"US-GU",
"abbreviation":"GU"
},
{
"regionCode":"US-HI",
"displayName":"Hawaii",
"repositoryId":"US-HI",
"abbreviation":"HI"
},
{
"regionCode":"US-IA",
"displayName":"Iowa",
"repositoryId":"US-IA",
"abbreviation":"IA"
},
{
"regionCode":"US-ID",
"displayName":"Idaho",
"repositoryId":"US-ID",
"abbreviation":"ID"
},
{
"regionCode":"US-IL",
"displayName":"Illinois",
"repositoryId":"US-IL",
"abbreviation":"IL"
},
{
"regionCode":"US-IN",
"displayName":"Indiana",
"repositoryId":"US-IN",
"abbreviation":"IN"
},
{
"regionCode":"US-KS",
"displayName":"Kansas",
"repositoryId":"US-KS",
"abbreviation":"KS"
},
{
"regionCode":"US-KY",
"displayName":"Kentucky",
"repositoryId":"US-KY",
"abbreviation":"KY"
},
{
"regionCode":"US-LA",
"displayName":"Louisiana",
"repositoryId":"US-LA",
"abbreviation":"LA"
},
{
"regionCode":"US-MA",
"displayName":"Massachusetts",
"repositoryId":"US-MA",
"abbreviation":"MA"
},
{
"regionCode":"US-MD",
"displayName":"Maryland",
"repositoryId":"US-MD",
"abbreviation":"MD"
},
{
"regionCode":"US-ME",
"displayName":"Maine",
"repositoryId":"US-ME",
"abbreviation":"ME"
},
{
"regionCode":"US-MI",
"displayName":"Michigan",
"repositoryId":"US-MI",
"abbreviation":"MI"
},
{
"regionCode":"US-MN",
"displayName":"Minnesota",
"repositoryId":"US-MN",
"abbreviation":"MN"
},
{
"regionCode":"US-MO",
"displayName":"Missouri",
"repositoryId":"US-MO",
"abbreviation":"MO"
},
{
"regionCode":"US-MP",
"displayName":"Northern Mariana Islands",
"repositoryId":"US-MP",
"abbreviation":"MP"
},
{
"regionCode":"US-MS",
"displayName":"Mississippi",
"repositoryId":"US-MS",
"abbreviation":"MS"
},
{
"regionCode":"US-MT",
"displayName":"Montana",
"repositoryId":"US-MT",
"abbreviation":"MT"
},
{
"regionCode":"US-NC",
"displayName":"North Carolina",
"repositoryId":"US-NC",
"abbreviation":"NC"
},
{
"regionCode":"US-ND",
"displayName":"North Dakota",
"repositoryId":"US-ND",
"abbreviation":"ND"
},
{
"regionCode":"US-NE",
"displayName":"Nebraska",
"repositoryId":"US-NE",
"abbreviation":"NE"
},
{
"regionCode":"US-NH",
"displayName":"New Hampshire",
"repositoryId":"US-NH",
"abbreviation":"NH"
},
{
"regionCode":"US-NJ",
"displayName":"New Jersey",
"repositoryId":"US-NJ",
"abbreviation":"NJ"
},
{
"regionCode":"US-NM",
"displayName":"New Mexico",
"repositoryId":"US-NM",
"abbreviation":"NM"
},
{
"regionCode":"US-NV",
"displayName":"Nevada",
"repositoryId":"US-NV",
"abbreviation":"NV"
},
{
"regionCode":"US-NY",
"displayName":"New York",
"repositoryId":"US-NY",
"abbreviation":"NY"
},
{
"regionCode":"US-OH",
"displayName":"Ohio",
"repositoryId":"US-OH",
"abbreviation":"OH"
},
{
"regionCode":"US-OK",
"displayName":"Oklahoma",
"repositoryId":"US-OK",
"abbreviation":"OK"
},
{
"regionCode":"US-OR",
"displayName":"Oregon",
"repositoryId":"US-OR",
"abbreviation":"OR"
},
{
"regionCode":"US-PA",
"displayName":"Pennsylvania",
"repositoryId":"US-PA",
"abbreviation":"PA"
},
{
"regionCode":"US-PR",
"displayName":"Puerto Rico",
"repositoryId":"US-PR",
"abbreviation":"PR"
},
{
"regionCode":"US-RI",
"displayName":"Rhode Island",
"repositoryId":"US-RI",
"abbreviation":"RI"
},
{
"regionCode":"US-SC",
"displayName":"South Carolina",
"repositoryId":"US-SC",
"abbreviation":"SC"
},
{
"regionCode":"US-SD",
"displayName":"South Dakota",
"repositoryId":"US-SD",
"abbreviation":"SD"
},
{
"regionCode":"US-TN",
"displayName":"Tennessee",
"repositoryId":"US-TN",
"abbreviation":"TN"
},
{
"regionCode":"US-TX",
"displayName":"Texas",
"repositoryId":"US-TX",
"abbreviation":"TX"
},
{
"regionCode":"US-UM",
"displayName":"US Minor Outlying Islands",
"repositoryId":"US-UM",
"abbreviation":"UM"
},
{
"regionCode":"US-UT",
"displayName":"Utah",
"repositoryId":"US-UT",
"abbreviation":"UT"
},
{
"regionCode":"US-VA",
"displayName":"Virginia",
"repositoryId":"US-VA",
"abbreviation":"VA"
},
{
"regionCode":"US-VI",
"displayName":"Virgin Islands",
"repositoryId":"US-VI",
"abbreviation":"VI"
},
{
"regionCode":"US-VT",
"displayName":"Vermont",
"repositoryId":"US-VT",
"abbreviation":"VT"
},
{
"regionCode":"US-WA",
"displayName":"Washington",
"repositoryId":"US-WA",
"abbreviation":"WA"
},
{
"regionCode":"US-WI",
"displayName":"Wisconsin",
"repositoryId":"US-WI",
"abbreviation":"WI"
},
{
"regionCode":"US-WV",
"displayName":"West Virginia",
"repositoryId":"US-WV",
"abbreviation":"WV"
},
{
"regionCode":"US-WY",
"displayName":"Wyoming",
"repositoryId":"US-WY",
"abbreviation":"WY"
}
],
"displayName":"United States",
"countryCode":"US",
"repositoryId":"US"
}
]
}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