REST API for Oracle Commerce Cloud December 2017

getCurrency

get

/ccadmin/v1/currencies/{id}

Get Currency. Get a single currency item.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the requested currency.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getCurrency_response

Properties

currencyCode: Type: string

currency code of Currency
currencyType: Type: string

Type of Currency
deleted: Type: string

deleted flag of currency. Applicable to loylatyPoints currencyType.
displayName: Type: string

Readable name of the currency
fractionalDigits: Type: integer

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

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


{
    "currencyType":null,
    "symbol":"$",
    "deleted":false,
    "displayName":"US Dollar",
    "repositoryId":"en_US",
    "fractionalDigits":2,
    "currencyCode":"USD",
    "numericCode":"840"
}

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.| |80010|The request for currency was not valid.|

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

{
  "currencyType": null,
  "symbol": "$",
  "deleted": false,
  "displayName": "US Dollar",
  "repositoryId": "en_US",
  "fractionalDigits": 2,
  "currencyCode": "USD",
  "numericCode": "840"
}