Jump to

• Request
• Response

createExchangeRate

post

/ccadmin/v1/exchangerates

Create Exchange rate. Endpoint for creating Exchange rate

Request

Supported Media Types

• application/json

Body ()

Root Schema : createExchangeRate_request

Type: object

Show Source

• exchangeRate: number
  Multiplying factor to convert source currency value to target currency value
• sourceCurrency: string
  The source currency code
• targetCurrency: string
  The target currency code

{
    "properties":{
        "targetCurrency":{
            "description":"The target currency code",
            "type":"string"
        },
        "exchangeRate":{
            "description":"Multiplying factor to convert source currency value to target currency value",
            "type":"number"
        },
        "sourceCurrency":{
            "description":"The source currency code",
            "type":"string"
        }
    },
    "required":[
        "sourceCurrency",
        "targetCurrency",
        "exchangeRate"
    ],
    "example":{
        "targetCurrency":"POINTS",
        "exchangeRate":5,
        "sourceCurrency":"USD"
    }
}

Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createExchangeRate_response

Type: object

Show Source

• exchangeRate(optional): number
  Multiplying factor to convert source currency value to target currency value
• id(optional): string
  THe id of exchange rate.
• sourceCurrency(optional): string
  The source currency code
• targetCurrency(optional): string
  The target currency code

{
    "properties":{
        "targetCurrency":{
            "description":"The target currency code",
            "type":"string"
        },
        "exchangeRate":{
            "description":"Multiplying factor to convert source currency value to target currency value",
            "type":"number"
        },
        "sourceCurrency":{
            "description":"The source currency code",
            "type":"string"
        },
        "id":{
            "description":"THe id of exchange rate.",
            "type":"string"
        }
    }
}

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

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