Jump to

• Request
• Response

addRegions

post

/ccadmin/v1/countries/{id}/addRegions

Add all the specified regions for the country

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the country which is ISO 3166-1 two letter country code.

Body ()

Root Schema : addRegions_request

Type: object

Show Source

• regions(optional): array regions
  The list of regions for particular country.

{
    "properties":{
        "regions":{
            "description":"The list of regions for particular country.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "regionCode":{
                        "description":"The region code (normally its ISO 3166-2 code).",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Localized region name.",
                        "type":"string"
                    },
                    "abbreviation":{
                        "description":"The region code in abbreviated form. Usually a 2 letter country code",
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "regions":[
            {
                "regionCode":"LK-GA",
                "displayName":"Galle",
                "abbreviation":"GA"
            },
            {
                "regionCode":"LK-CO",
                "displayName":"Colombo",
                "abbreviation":"CO"
            }
        ]
    }
}

Example:

{
    "regions":[
        {
            "regionCode":"LK-GA",
            "displayName":"Galle",
            "abbreviation":"GA"
        },
        {
            "regionCode":"LK-CO",
            "displayName":"Colombo",
            "abbreviation":"CO"
        }
    ]
}

Nested Schema : regions

Type: array

The list of regions for particular country.

Show Source

• Array of: object items

{
    "description":"The list of regions for particular country.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "regionCode":{
                "description":"The region code (normally its ISO 3166-2 code).",
                "type":"string"
            },
            "displayName":{
                "description":"Localized region name.",
                "type":"string"
            },
            "abbreviation":{
                "description":"The region code in abbreviated form. Usually a 2 letter country code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• abbreviation(optional): string
  The region code in abbreviated form. Usually a 2 letter country code
• displayName(optional): string
  Localized region name.
• regionCode(optional): string
  The region code (normally its ISO 3166-2 code).

{
    "type":"object",
    "properties":{
        "regionCode":{
            "description":"The region code (normally its ISO 3166-2 code).",
            "type":"string"
        },
        "displayName":{
            "description":"Localized region name.",
            "type":"string"
        },
        "abbreviation":{
            "description":"The region code in abbreviated form. Usually a 2 letter country code",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : addRegions_response

Type: object

Show Source

• regions(optional): array regions
  The list of regions for particular country.

{
    "properties":{
        "regions":{
            "description":"The list of regions for particular country.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "regionCode":{
                        "description":"The region code (normally its ISO 3166-2 code).",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Localized region name.",
                        "type":"string"
                    },
                    "abbreviation":{
                        "description":"The region code in abbreviated form. Usually a 2 letter country code",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : regions

Type: array

The list of regions for particular country.

Show Source

• Array of: object items

{
    "description":"The list of regions for particular country.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "regionCode":{
                "description":"The region code (normally its ISO 3166-2 code).",
                "type":"string"
            },
            "displayName":{
                "description":"Localized region name.",
                "type":"string"
            },
            "abbreviation":{
                "description":"The region code in abbreviated form. Usually a 2 letter country code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• abbreviation(optional): string
  The region code in abbreviated form. Usually a 2 letter country code
• displayName(optional): string
  Localized region name.
• regionCode(optional): string
  The region code (normally its ISO 3166-2 code).

{
    "type":"object",
    "properties":{
        "regionCode":{
            "description":"The region code (normally its ISO 3166-2 code).",
            "type":"string"
        },
        "displayName":{
            "description":"Localized region name.",
            "type":"string"
        },
        "abbreviation":{
            "description":"The region code in abbreviated form. Usually a 2 letter country code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "regions":[
        {
            "regionCode":"LK-GA",
            "displayName":"Galle",
            "abbreviation":"GA"
        },
        {
            "regionCode":"LK-CO",
            "displayName":"Colombo",
            "abbreviation":"CO"
        }
    ]
}

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| |------------------|------------------| |19000|The country code is either invalid or not configured : {countryId}| |80067|Region {id} already exists| |80062|Invalid input. {key} key must be specified with valid value| |80068|Invalid abbreviation : {abbreviation}. Abbreviation must match the region abbreviation value specified in region code : {regionId}| |80069|Invalid region code : {regionId}. Region code must start with country code : {countryId}-|

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