updateCurrency
put
/ccadmin/v1/currencies/{id}
Update Currency. Endpoint for updating Currency which doesn't has a PriceListGroup.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
Currency ID corresponding to the currency to be updated.
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request. E.g., en,de,fr_CA.
Root Schema : updateCurrency_request
Type:
Show Source
object
-
currencyCode:
string
Non ISO 4217 Standard currency code and must be unique. Space is not allowed.
-
displayName:
string
Readable name of the Currency.
-
fractionalDigits:
integer
Number of digits to the right of the decimal point. Must greater than or equal to zero.
-
symbol:
string
The currency symbol. Space is not allowed.
Example:
{
"symbol":"POINTS"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateCurrency_response
Type:
Show Source
object
-
currencyCode:
string
currency code of Currency
-
currencyType:
string
Type of Currency.
-
deleted:
boolean
Indicates whether Currency is deleted
-
displayName:
string
Readable name of the Currency
-
fractionalDigits:
integer
fractionalDigits of Currency
-
numericCode:
string
Numeric currency code of Currency
-
repositoryId:
string
repositoryId of Currency
-
symbol:
string
The currency symbol of Currency
Example Response (application/json)
{
"currencyType":"loyaltyPoints",
"symbol":"POINTS",
"deleted":false,
"displayName":"PTS",
"repositoryId":"points",
"fractionalDigits":2,
"currencyCode":"PTS",
"numericCode":null
}
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|
|------------------|------------------|
|80210|You can not update the currency {0} as Price List Group exists for it.|
|80011|The requested currency could not be found.|
|80203|The request to update the currency could not be performed.|
|80206|Format for {0} is incorrect. Please check the API documentation for more details.|
|80010|The request for currency was not valid.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
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
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code