REST API for Oracle Commerce Cloud December 2017

updateSelectedBillingCountries

put

/ccadmin/v1/merchant/billingCountries

Update Selected Billing Countries. Updates the available billing countries

Request

Supported Media Types

application/json

Body Parameter

Root Schema : updateSelectedBillingCountries_request

Example


{
    "billingCountryRepositoryId":[
        "CA",
        "US"
    ],
    "siteId":"siteUS"
}

Properties

billingCountryRepositoryId: Type: array billingCountryRepositoryId

Required: true

Additional Properties Allowed:

Repository ID of the Billing Country
siteId: Type: string

Site ID of the site

Nested Schema : billingCountryRepositoryId

Type: array

Repository ID of the Billing Country

Items

Type: string

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateSelectedBillingCountries_response

Properties

items: Type: array items

Additional Properties Allowed:

The updated list of all Billing Countries

Nested Schema : items

Type: array

The updated list of all Billing Countries

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

countryCode: Type: string

Country Code of the Billing Country
displayName: Type: string

Display Name of the Billing Country
repositoryId: Type: string

Repository ID of the Billing Country

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.| |34071|There is an error in updating the Billing Countries.|

Body

Root Schema : errorModel

Type: object

Properties

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 errors

Additional 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

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

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 Request:

{
  "billingCountryRepositoryId": [
    "CA",
    "US"
  ],
  "siteId": "siteUS"
}

Sample Response Payload returned by endpoint:

[
  {
    "countryCode": "CA",
    "displayName": "Canada",
    "repositoryId": "CA"
  },
  {
    "countryCode": "US",
    "displayName": "United States",
    "repositoryId": "US"
  }
]