Jump to

• Request
• Response

listLocales

get

/ccadmin/v1/locales

Get the list of all application supported locales including the default locale.

Request

Supported Media Types

• application/json

Query Parameters

• withAliases(optional): boolean
  Defaults to false. Passing as true will return an 'aliases' property for any locales that have aliases.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listLocales_response

Type: object

Show Source

• defaultLocale(optional): object defaultLocale
  The default locale object.
• items(optional): array items
  The list of valid locales from the server.

{
    "properties":{
        "defaultLocale":{
            "description":"The default locale object.",
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"Human-readable name of the loacle (e.g., English (United States)).",
                    "type":"string"
                },
                "name":{
                    "description":"The name of the locale such as 'en' or 'pt_BR'.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"Repository ID of the locale item.",
                    "type":"string"
                },
                "localeId":{
                    "description":"Internal ID of the locale.",
                    "type":"string"
                }
            }
        },
        "items":{
            "description":"The list of valid locales from the server.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"Human-readable name of the loacle (e.g., English (United States)).",
                        "type":"string"
                    },
                    "name":{
                        "description":"The name of the locale such as 'en' or 'pt_BR'.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository ID of the locale item.",
                        "type":"string"
                    },
                    "localeId":{
                        "description":"Internal ID of the locale.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : defaultLocale

Type: object

The default locale object.

Show Source

• displayName(optional): string
  Human-readable name of the loacle (e.g., English (United States)).
• localeId(optional): string
  Internal ID of the locale.
• name(optional): string
  The name of the locale such as 'en' or 'pt_BR'.
• repositoryId(optional): string
  Repository ID of the locale item.

{
    "description":"The default locale object.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Human-readable name of the loacle (e.g., English (United States)).",
            "type":"string"
        },
        "name":{
            "description":"The name of the locale such as 'en' or 'pt_BR'.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the locale item.",
            "type":"string"
        },
        "localeId":{
            "description":"Internal ID of the locale.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

The list of valid locales from the server.

Show Source

• Array of: object items

{
    "description":"The list of valid locales from the server.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"Human-readable name of the loacle (e.g., English (United States)).",
                "type":"string"
            },
            "name":{
                "description":"The name of the locale such as 'en' or 'pt_BR'.",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository ID of the locale item.",
                "type":"string"
            },
            "localeId":{
                "description":"Internal ID of the locale.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional): string
  Human-readable name of the loacle (e.g., English (United States)).
• localeId(optional): string
  Internal ID of the locale.
• name(optional): string
  The name of the locale such as 'en' or 'pt_BR'.
• repositoryId(optional): string
  Repository ID of the locale item.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Human-readable name of the loacle (e.g., English (United States)).",
            "type":"string"
        },
        "name":{
            "description":"The name of the locale such as 'en' or 'pt_BR'.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the locale item.",
            "type":"string"
        },
        "localeId":{
            "description":"Internal ID of the locale.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "defaultLocale":{
        "displayName":"English (United States)",
        "name":"en",
        "repositoryId":"1",
        "localeId":"1"
    },
    "items":[
        {
            "displayName":"Chinese (Simplified)",
            "name":"zh_CN",
            "repositoryId":"24",
            "localeId":"24"
        },
        {
            "displayName":"Chinese (Traditional)",
            "name":"zh_TW",
            "repositoryId":"14",
            "localeId":"14"
        },
        {
            "displayName":"Czech",
            "name":"cs",
            "repositoryId":"16",
            "localeId":"16"
        },
        {
            "displayName":"Turkish",
            "name":"tr",
            "repositoryId":"12",
            "localeId":"12"
        },
        {
            "displayName":"Vietnamese",
            "name":"vi",
            "repositoryId":"27",
            "localeId":"27"
        }
    ]
}

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| |------------------|------------------| |27000|Default locale for site it not set.| |27002|Unable to retrieve the locale list.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): 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(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): 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