Jump to

• Request
• Response

updateSelectedBillingCountries

put

/ccadmin/v1/merchant/billingCountries

Update Selected Billing Countries. Updates the available billing countries

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateSelectedBillingCountries_request

Type: object

Show Source

• billingCountryRepositoryId: array billingCountryRepositoryId
  Repository ID of the Billing Country
• siteId(optional): string
  Site ID of the site

{
    "properties":{
        "billingCountryRepositoryId":{
            "description":"Repository ID of the Billing Country",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "siteId":{
            "description":"Site ID of the site",
            "type":"string"
        }
    },
    "required":[
        "billingCountryRepositoryId"
    ],
    "example":{
        "billingCountryRepositoryId":[
            "CA",
            "US"
        ],
        "siteId":"siteUS"
    }
}

Example:

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

Nested Schema : billingCountryRepositoryId

Type: array

Repository ID of the Billing Country

Show Source

• Array of: string

{
    "description":"Repository ID of the Billing Country",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateSelectedBillingCountries_response

Type: object

Show Source

• items(optional): array items
  The updated list of all Billing Countries

{
    "properties":{
        "items":{
            "description":"The updated list of all Billing Countries",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "countryCode":{
                        "description":"Country Code of the Billing Country",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Display Name of the Billing Country",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository ID of the Billing Country",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The updated list of all Billing Countries

Show Source

• Array of: object items

{
    "description":"The updated list of all Billing Countries",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "countryCode":{
                "description":"Country Code of the Billing Country",
                "type":"string"
            },
            "displayName":{
                "description":"Display Name of the Billing Country",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository ID of the Billing Country",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• countryCode(optional): string
  Country Code of the Billing Country
• displayName(optional): string
  Display Name of the Billing Country
• repositoryId(optional): string
  Repository ID of the Billing Country

{
    "type":"object",
    "properties":{
        "countryCode":{
            "description":"Country Code of the Billing Country",
            "type":"string"
        },
        "displayName":{
            "description":"Display Name of the Billing Country",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the Billing Country",
            "type":"string"
        }
    }
}

Example Response (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

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