Oracle Commerce Cloud October 2017

getReportingCurrency

get

/ccadmin/v1/merchant/reportingCurrency

Get Reporting Currency. Retrieves the merchant's preferred currency for reports

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getReportingCurrency_response

Properties

currencyCode: Type: string

ISO 4127 three-letter currency code
displayName: Type: string

Readable name of the currency
fractionalDigits: Type: string

Number of digits to the right of the decimal point
numericCode: Type: string

ISO 4127 three-digit numeric currency code
repositoryId: Type: string

The ID of the currency item, which is a locale string.
symbol: Type: string

The currency symbol

Example application/json


{
    "symbol":"£",
    "displayName":"British Pound Sterling",
    "repositoryId":"en_GB",
    "fractionalDigits":2,
    "currencyCode":"GBP",
    "numericCode":"826"
}

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| |------------------|------------------| |80011|The requested currency could not be found.|

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

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

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 Response Payload returned by endpoint:

{
  "symbol": "£",
  "displayName": "British Pound Sterling",
  "repositoryId": "en_GB",
  "fractionalDigits": 2,
  "currencyCode": "GBP",
  "numericCode": "826"
}