1. REST API for Oracle Commerce Cloud 21A
  2. Tasks
  3. Admin
  4. Shipping Regions

updateShippingRegion

put

/ccadmin/v1/shippingRegions/{id}

Update Shipping Region. Updates a Shipping Region based on request parameters.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : updateShippingRegion_request
Type: object
Show Source
Example:
{
    "shippingRegionName":"NorthUS",
    "shippingCountryRegion":{
        "regions":[
            {
                "repositoryId":"US-AL"
            }
        ],
        "repositoryId":"US"
    }
}
Nested Schema : shippingCountryRegion
Type: array
Repository Id of the region.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : regions
Type: array
The list of all Shipping Regions.
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateShippingRegion_response
Type: object
Show Source
Nested Schema : shippingCountryRegion
Type: array
The list of all regions of a country in the Shipping region.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : country
Type: array
The details of the country present in the Shipping Region.
Show Source
Nested Schema : regions
Type: array
The list of all Shipping Regions.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
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"
                        }
                    ],
                    "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 updating shipping region| |31018|Please enter a valid shipping region name.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top