Jump to

• Request
• Response

listCountries

get

/ccadmin/v1/countries

List Countries. List all the configured countries

Request

Supported Media Types

• application/json

Query Parameters

• regions: string
  to fetch regions, this property can be set to true
• sortByCode: string
  to get country list sorted by country code or descrption.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listCountries_response

Type: object

Show Source

• items: array items
  The list of all countries.

{
    "properties":{
        "items":{
            "description":"The list of all countries.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"Localized country name.",
                        "type":"string"
                    },
                    "countryCode":{
                        "description":"ISO 3166-1 two letter country code.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The repository ID of the country item.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of all countries.

Show Source

• Array of: object items

{
    "description":"The list of all countries.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"Localized country name.",
                "type":"string"
            },
            "countryCode":{
                "description":"ISO 3166-1 two letter country code.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The repository ID of the country item.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• countryCode: string
  ISO 3166-1 two letter country code.
• displayName: string
  Localized country name.
• repositoryId: string
  The repository ID of the country item.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Localized country name.",
            "type":"string"
        },
        "countryCode":{
            "description":"ISO 3166-1 two letter country code.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository ID of the country item.",
            "type":"string"
        }
    }
}

Example Response (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. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |80004|Exception Occurred|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top