REST API for Oracle Commerce Cloud December 2017

listCountries

get

/ccadmin/v1/countries

List Countries. List all the configured countries

Request

Supported Media Types

application/json

Query Parameters

regions: Type: string

to fetch regions, this property can be set to true
sortByCode: Type: string

to get country list sorted by country code or descrption.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listCountries_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of all countries.

Nested Schema : items

Type: array

The list of all countries.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

countryCode: Type: string

ISO 3166-1 two letter country code.
displayName: Type: string

Localized country name.
repositoryId: Type: string

The repository ID of the country item.

Example application/json


[
    {
        "displayName":"United Arab Emirates",
        "countryCode":"AE",
        "repositoryId":"AE"
    },
    {
        "displayName":"United Kingdom",
        "countryCode":"GB",
        "repositoryId":"GB"
    },
    {
        "displayName":"United States",
        "countryCode":"US",
        "repositoryId":"US"
    },
    {
        "displayName":"Uruguay",
        "countryCode":"UY",
        "repositoryId":"UY"
    }
]

Default Response

The error response

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:

[
  {
    "displayName": "United Arab Emirates",
    "countryCode": "AE",
    "repositoryId": "AE"
  },
  {
    "displayName": "United Kingdom",
    "countryCode": "GB",
    "repositoryId": "GB"
  },
  {
    "displayName": "United States",
    "countryCode": "US",
    "repositoryId": "US"
  },
  {
    "displayName": "Uruguay",
    "countryCode": "UY",
    "repositoryId": "UY"
  }
]