Jump to

• Request
• Response

getBillingCountries

get

/ccstore/v1/countries/billingCountries

Get Billing Countries. Lists all the billing countries.

Request

Supported Media Types

• application/json

Query Parameters

• pSortOrder(optional): string
  Specify the sort order of how the billing countries should be returned. Valid values are asc and desc. The default value it asc

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getBillingCountries_response

Type: object

Show Source

• items(optional): array items
  The list of all billing countries.

{
    "properties":{
        "items":{
            "description":"The list of all billing countries.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "country":{
                        "description":"The country repository id, display name and country code.",
                        "type":"object",
                        "properties":{
                            "displayName":{
                                "description":"Localized country name.",
                                "type":"string"
                            },
                            "countryCode":{
                                "description":"ISO 3166-1 two letter country code.",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"The ID of the country item.",
                                "type":"string"
                            }
                        }
                    },
                    "regions":{
                        "description":"The list of regions for particular country.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "regionCode":{
                                    "description":"The region code (4 character ISO code).",
                                    "type":"string"
                                },
                                "displayName":{
                                    "description":"Localized region name.",
                                    "type":"string"
                                },
                                "repositoryId":{
                                    "description":"The ID of the region item.",
                                    "type":"string"
                                },
                                "abbreviation":{
                                    "description":"The region code in abbreviated form. Usually a 2 character ISO code",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "repositoryId":{
                        "description":"The ID of the country item.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of all billing countries.

Show Source

• Array of: object items

{
    "description":"The list of all billing countries.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "country":{
                "description":"The country repository id, display name and country code.",
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"Localized country name.",
                        "type":"string"
                    },
                    "countryCode":{
                        "description":"ISO 3166-1 two letter country code.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The ID of the country item.",
                        "type":"string"
                    }
                }
            },
            "regions":{
                "description":"The list of regions for particular country.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "regionCode":{
                            "description":"The region code (4 character ISO code).",
                            "type":"string"
                        },
                        "displayName":{
                            "description":"Localized region name.",
                            "type":"string"
                        },
                        "repositoryId":{
                            "description":"The ID of the region item.",
                            "type":"string"
                        },
                        "abbreviation":{
                            "description":"The region code in abbreviated form. Usually a 2 character ISO code",
                            "type":"string"
                        }
                    }
                }
            },
            "repositoryId":{
                "description":"The ID of the country item.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• country(optional): object country
  The country repository id, display name and country code.
• regions(optional): array regions
  The list of regions for particular country.
• repositoryId(optional): string
  The ID of the country item.

{
    "type":"object",
    "properties":{
        "country":{
            "description":"The country repository id, display name and country code.",
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"Localized country name.",
                    "type":"string"
                },
                "countryCode":{
                    "description":"ISO 3166-1 two letter country code.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The ID of the country item.",
                    "type":"string"
                }
            }
        },
        "regions":{
            "description":"The list of regions for particular country.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "regionCode":{
                        "description":"The region code (4 character ISO code).",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Localized region name.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The ID of the region item.",
                        "type":"string"
                    },
                    "abbreviation":{
                        "description":"The region code in abbreviated form. Usually a 2 character ISO code",
                        "type":"string"
                    }
                }
            }
        },
        "repositoryId":{
            "description":"The ID of the country item.",
            "type":"string"
        }
    }
}

Nested Schema : country

Type: object

The country repository id, display name and country code.

Show Source

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

{
    "description":"The country repository id, display name and country code.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Localized country name.",
            "type":"string"
        },
        "countryCode":{
            "description":"ISO 3166-1 two letter country code.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The ID of the country item.",
            "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 (4 character ISO code).",
                "type":"string"
            },
            "displayName":{
                "description":"Localized region name.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The ID of the region item.",
                "type":"string"
            },
            "abbreviation":{
                "description":"The region code in abbreviated form. Usually a 2 character ISO code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• abbreviation(optional): string
  The region code in abbreviated form. Usually a 2 character ISO code
• displayName(optional): string
  Localized region name.
• regionCode(optional): string
  The region code (4 character ISO code).
• repositoryId(optional): string
  The ID of the region item.

{
    "type":"object",
    "properties":{
        "regionCode":{
            "description":"The region code (4 character ISO code).",
            "type":"string"
        },
        "displayName":{
            "description":"Localized region name.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The ID of the region item.",
            "type":"string"
        },
        "abbreviation":{
            "description":"The region code in abbreviated form. Usually a 2 character ISO code",
            "type":"string"
        }
    }
}

Example Response (application/json)

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

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| |------------------|------------------| |80032|If error occurs when retrieving billing countries.|

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