listSelectedBillingCountries
get
/ccadmin/v1/merchant/billingCountries
List Selected Billing Countries. Lists the available billing countries
Request
Supported Media Types
- application/json
Query Parameters
- siteId
-
Type:
string
Site ID of the site- sortByCode
Type:boolean
Sort by Code: true or false- sortByOrder
Type:string
Sort Order: asc or desc
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : listSelectedBillingCountries_response
- countriesList
-
Type:
array
countriesListAdditional Properties Allowed:Regions List for all countries.
Nested Schema : countriesList
Nested Schema : items
Type:
object
- countryCode
-
Type:
string
Country Code of the Billing Country - displayName
-
Type:
string
Display Name of the Billing Country - regions
-
Type:
array
regionsAdditional Properties Allowed:Regions list. - repositoryId
-
Type:
string
Repository ID of the Billing Country
Nested Schema : regions
Nested Schema : items
Type:
object
- abbreviation
-
Type:
string
Abbreviation of the Billing region - displayName
-
Type:
string
Display Name of the Billing region - regionCode
-
Type:
string
Country Code of the Billing region - repositoryId
-
Type:
string
Repository ID of the Billing region
Example application/json
[
{
"countryCode":"CA",
"displayName":"Canada",
"repositoryId":"CA"
},
{
"countryCode":"US",
"displayName":"United States",
"repositoryId":"US"
}
]
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|
|------------------|------------------|
|30011|Site id {0} does not exist.|
Body
Root Schema : errorModel
Type:
object
- 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
errorsAdditional 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
Nested Schema : items
Type:
object
- 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:
[ { "countryCode": "CA", "displayName": "Canada", "repositoryId": "CA" }, { "countryCode": "US", "displayName": "United States", "repositoryId": "US" } ]