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

getShippingRegion

get

/ccadmin/v1/shippingRegions/{id}

Get Shipping Region. Returns a Shipping Region against the ID passed.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the shipping region to be fetched.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getShippingRegion_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

{
    "repositoryId":"100001",
    "shippingRegionName":"United States",
    "shippingCountryRegion":[
        {
            "country":{
                "countryCode":"US",
                "displayName":"United States",
                "repositoryId":"US"
            },
            "regions":[
                {
                    "regionCode":"US-AR",
                    "displayName":"Arkansas",
                    "repositoryId":"US-AR",
                    "abbreviation":"AR"
                },
                {
                    "regionCode":"US-ME",
                    "displayName":"Maine",
                    "repositoryId":"US-ME",
                    "abbreviation":"ME"
                },
                {
                    "regionCode":"US-WV",
                    "displayName":"West Virginia",
                    "repositoryId":"US-WV",
                    "abbreviation":"WV"
                },
                {
                    "regionCode":"US-GA",
                    "displayName":"Georgia",
                    "repositoryId":"US-GA",
                    "abbreviation":"GA"
                },
                {
                    "regionCode":"US-OR",
                    "displayName":"Oregon",
                    "repositoryId":"US-OR",
                    "abbreviation":"OR"
                }
            ],
            "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| |------------------|------------------| |80012|Invalid shipping region details.| |80016|Error getting a shipping region.| |80020|Shipping region does not exist for id: {0}.|
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 Response Payload returned by endpoint:

{
  "repositoryId": "100001",
  "shippingRegionName": "United States",
  "shippingCountryRegion": [{
    "country": {
      "countryCode": "US",
      "displayName": "United States",
      "repositoryId": "US"
    },
    "regions": [
      {
        "regionCode": "US-AR",
        "displayName": "Arkansas",
        "repositoryId": "US-AR",
        "abbreviation": "AR"
      },
      {
        "regionCode": "US-ME",
        "displayName": "Maine",
        "repositoryId": "US-ME",
        "abbreviation": "ME"
      },
      {
        "regionCode": "US-WV",
        "displayName": "West Virginia",
        "repositoryId": "US-WV",
        "abbreviation": "WV"
      },
      {
        "regionCode": "US-GA",
        "displayName": "Georgia",
        "repositoryId": "US-GA",
        "abbreviation": "GA"
      },
      {
        "regionCode": "US-OR",
        "displayName": "Oregon",
        "repositoryId": "US-OR",
        "abbreviation": "OR"
      }
    ],
    "repositoryId": "100001"
  }]
}