REST API for Oracle Commerce Cloud December 2017

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.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listShippingRegions_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of all Shipping regions.

Nested Schema : items

Type: array

The list of all Shipping regions.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

The Repository Id of the Shipping Region.
shippingCountryRegion: Type: array shippingCountryRegion

Additional Properties Allowed:

The list of all regions of a country in the Shipping region.
shippingRegionName: Type: string

Name of the Shipping Region.

Nested Schema : shippingCountryRegion

Type: array

The list of all regions of a country in the Shipping region.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

country: Type: object country

Additional Properties Allowed:

The details of the country present in the Shipping Region.
regions: Type: array regions

Additional Properties Allowed:

The list of all Shipping Regions.
repositoryId: Type: string

Repository Id of shipping Country Region.

Nested Schema : country

Type: object

The details of the country present in the Shipping Region.

Properties

countryCode: Type: string

The code of the country in the Shipping Region.
displayName: Type: string

The name of the country.
repositoryId: Type: string

The repository Id of country.

Nested Schema : regions

Type: array

The list of all Shipping Regions.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

abbreviation: Type: string

The region code in abbreviated form. Usually a 2 letter country code
displayName: Type: string

The name of the specific region.
regionCode: Type: string

The code of the specific Region.
repositoryId: Type: string

The Repository Id of the specific region.

Example 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.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

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