REST API for Oracle Commerce Cloud December 2017

createExchangeRate

post

/ccadmin/v1/exchangerates

Create Exchange rate. Endpoint for creating Exchange rate

Request

Supported Media Types

application/json

Body Parameter

Root Schema : createExchangeRate_request

Example


{
    "targetCurrency":"POINTS",
    "exchangeRate":5,
    "sourceCurrency":"USD"
}

Properties

exchangeRate: Type: number

Required: true

Multiplying factor to convert source currency value to target currency value
sourceCurrency: Type: string

Required: true

The source currency code
targetCurrency: Type: string

Required: true

The target currency code

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createExchangeRate_response

Properties

exchangeRate: Type: number

Multiplying factor to convert source currency value to target currency value
id: Type: string

THe id of exchange rate.
sourceCurrency: Type: string

The source currency code
targetCurrency: Type: string

The target currency code

Example application/json


{
    "targetCurrency":"POINTS",
    "exchangeRate":"5",
    "sourceCurrency":"USD",
    "id":"10001"
}

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| |------------------|------------------| |80205|The required attribute {0} is missing| |180003|The request to create the currency exchange rate could not be performed.| |180006|Currency exchange rate with source currency {0} and target currency {1} already exists.| |80206|Format for {0} is incorrect. Please check the API documentation for more details.|

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:

{
  "targetCurrency": "POINTS",
  "exchangeRate": 5,
  "sourceCurrency": "USD"
}

Sample Response Payload returned by endpoint:

{
  "targetCurrency": "POINTS",
  "exchangeRate": "5",
  "sourceCurrency": "USD",
  "id": "10001"
}