1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Shipping Regions

createShippingRegion

post

/ccadmin/v1/shippingRegions

Create Shipping Region. Creates a Shipping Region based on request parameters.

Request

Supported Media Types
  • application/json
Body Parameter
Root Schema : createShippingRegion_request
Nested Schema : shippingCountryRegion
Type: array
Repository Id of the region.
Nested Schema : items
Type: object
Nested Schema : regions
Type: array
The list of all Shipping Regions.
Nested Schema : items
Type: object

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : createShippingRegion_response
Nested Schema : shippingCountryRegion
Type: array
The list of all regions of a country in the Shipping region.
Nested Schema : items
Type: object
Nested Schema : country
Type: object
The details of the country present in the Shipping Region.
Nested Schema : regions
Type: array
The list of all Shipping Regions.
Nested Schema : items
Type: object
Example 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.|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Request:

{
  "shippingRegionName": "NorthUS",
  "shippingCountryRegion": {
    "regions": [
      {"repositoryId": "US-AK"},
      {"repositoryId": "US-AL"}
    ],
    "repositoryId": "US"
  }
}

Sample Response Payload returned by endpoint:

{"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"
  }]
}]}