createShippingRegion
post
/ccadmin/v1/shippingRegions
Create Shipping Region. Creates a Shipping Region based on request parameters.
Request
Supported Media Types
- application/json
Root Schema : createShippingRegion_request
Type:
Show Source
object
-
repositoryId:
string
Repository Id of country.
-
shippingCountryRegion:
array shippingCountryRegion
Repository Id of the region.
-
shippingRegionName:
string
Name of the Shipping Region.
Example:
{
"shippingRegionName":"NorthUS",
"shippingCountryRegion":{
"regions":[
{
"repositoryId":"US-AK"
},
{
"repositoryId":"US-AL"
}
],
"repositoryId":"US"
}
}
Nested Schema : items
Type:
Show Source
object
-
regions(optional):
array regions
The list of all Shipping Regions.
-
repositoryId:
string
Repository Id of shipping Country Region.
Nested Schema : items
Type:
Show Source
object
-
repositoryId:
string
The Repository Id of the specific region.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createShippingRegion_response
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)
{
"shippingRegions":[
{
"repositoryId":"NorthUS",
"shippingRegionName":"NorthUS",
"shippingCountryRegion":[
{
"country":{
"countryCode":"US",
"displayName":"United States",
"repositoryId":"US"
},
"regions":[
{
"regionCode":"US-AL",
"displayName":"Alabama",
"repositoryId":"US-AL",
"abbreviation":"AL"
},
{
"regionCode":"US-AK",
"displayName":"Alaska",
"repositoryId":"US-AK",
"abbreviation":"AK"
}
],
"repositoryId":"100001"
}
]
}
]
}
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|
|------------------|------------------|
|31014|One or more region is invalid for country: {0}.|
|80012|Invalid shipping region details.|
|80018|Invalid or unsupported country name: {0}.|
|81014|Error creating shipping region.|
|31018|Please enter a valid shipping region name.|
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