listShippingRegions
get
/ccadmin/v1/shippingRegions
List Shipping Regions. Lists all the Shipping Regions that are available.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listShippingRegions_response
Type:
Show Source
object
-
items(optional):
array items
The list of all Shipping regions.
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The Repository Id of the Shipping Region.
-
shippingCountryRegion(optional):
array shippingCountryRegion
The list of all regions of a country in the Shipping region.
-
shippingRegionName(optional):
string
Name of the Shipping Region.
Nested Schema : shippingCountryRegion
Type:
array
The list of all regions of a country in the Shipping region.
Show Source
Nested Schema : items
Type:
Show Source
object
-
country(optional):
object country
The details of the country present in the Shipping Region.
-
regions(optional):
array regions
The list of all Shipping Regions.
-
repositoryId(optional):
string
Repository Id of shipping Country Region.
Nested Schema : country
Type:
object
The details of the country present in the Shipping Region.
Show Source
-
countryCode(optional):
string
The code of the country in the Shipping Region.
-
displayName(optional):
string
The name of the country.
-
repositoryId(optional):
string
The repository Id of country.
Nested Schema : items
Type:
Show Source
object
-
abbreviation(optional):
string
The region code in abbreviated form. Usually a 2 letter country code
-
displayName(optional):
string
The name of the specific region.
-
regionCode(optional):
string
The code of the specific Region.
-
repositoryId(optional):
string
The Repository Id of the specific region.
Example Response (application/json)
[
{
"repositoryId":"100002",
"shippingRegionName":"Canada",
"shippingCountryRegion":[
{
"country":{
"countryCode":"CA",
"displayName":"Canada",
"repositoryId":"CA"
},
"regions":[
{
"regionCode":"CA-NB",
"displayName":"New Brunswick",
"repositoryId":"CA-NB",
"abbreviation":"NB"
},
{
"regionCode":"CA-PE",
"displayName":"Prince Edward Island",
"repositoryId":"CA-PE",
"abbreviation":"PE"
},
{
"regionCode":"CA-QC",
"displayName":"Quebec",
"repositoryId":"CA-QC",
"abbreviation":"QC"
},
{
"regionCode":"CA-BC",
"displayName":"British Columbia",
"repositoryId":"CA-BC",
"abbreviation":"BC"
},
{
"regionCode":"CA-MB",
"displayName":"Manitoba",
"repositoryId":"CA-MB",
"abbreviation":"MB"
},
{
"regionCode":"CA-YT",
"displayName":"Yukon",
"repositoryId":"CA-YT",
"abbreviation":"YT"
},
{
"regionCode":"CA-NT",
"displayName":"Northwest Territories",
"repositoryId":"CA-NT",
"abbreviation":"NT"
},
{
"regionCode":"CA-NS",
"displayName":"Nova Scotia",
"repositoryId":"CA-NS",
"abbreviation":"NS"
},
{
"regionCode":"CA-NU",
"displayName":"Nunavut",
"repositoryId":"CA-NU",
"abbreviation":"NU"
},
{
"regionCode":"CA-AB",
"displayName":"Alberta",
"repositoryId":"CA-AB",
"abbreviation":"AB"
},
{
"regionCode":"CA-SK",
"displayName":"Saskatchewan",
"repositoryId":"CA-SK",
"abbreviation":"SK"
},
{
"regionCode":"CA-NL",
"displayName":"Newfoundland and Labrador",
"repositoryId":"CA-NL",
"abbreviation":"NL"
},
{
"regionCode":"CA-ON",
"displayName":"Ontario",
"repositoryId":"CA-ON",
"abbreviation":"ON"
}
],
"repositoryId":"100002"
}
]
}
]
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|80017|Error in getting shipping regions.|
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:
array
An 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