REST API for Oracle Commerce Cloud December 2017

listCurrencies

get

/ccadmin/v1/currencies

List Currencies. Get a list of currencies and the currently selected currency.

Request

Supported Media Types

application/json

Query Parameters

includeDeleted: Type: boolean

If true, include soft deleted items in results. If false or not present, exclude them.
limit: Type: integer

The number of items to return.
offset: Type: integer

Index of the first element to return.
sort: Type: string

Sorting criteria.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listCurrencies_response

Properties

items: Type: array items

Additional Properties Allowed:

List of currencies
limit: Type: integer

The number of items to return.
offset: Type: integer

Index of the first element to return.
selectedCurrency: Type: object selectedCurrency

Additional Properties Allowed:

Selected currency
sort: Type: array sort

Additional Properties Allowed:

Sorting criteria.
total: Type: integer

The total number of items. Deprecated.
totalResults: Type: integer

The total number of items.
type: Type: string

The promotion type being listed.

Nested Schema : items

Type: array

List of currencies

Items

Type: object items

Additional Properties Allowed:

Nested Schema : selectedCurrency

Type: object

Selected currency

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

Nested Schema : sort

Type: array

Sorting criteria.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

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: string

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

Nested Schema : items

Type: object

Properties

order: Type: string

Sort order: asc or desc.
property: Type: string

The property the listing is sorted by.

Example application/json


{
    "total":43,
    "totalResults":43,
    "offset":3,
    "selectedCurrency":{
        "currencyType":null,
        "symbol":"$",
        "deleted":false,
        "displayName":"US Dollar",
        "repositoryId":"en_US",
        "fractionalDigits":2,
        "currencyCode":"USD",
        "numericCode":"840"
    },
    "limit":3,
    "sort":{
        "property":"currencyCode",
        "order":"asc"
    },
    "items":{
        "currencyType":null,
        "symbol":"CHF",
        "deleted":false,
        "displayName":"Swiss Franc",
        "repositoryId":"fr_CH",
        "fractionalDigits":2,
        "currencyCode":"CHF",
        "numericCode":"756"
    }
}

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| |------------------|------------------| |80005|The currency for the price list locale was not found.| |80009|There was an error fetching the currency list.|

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:

{
  "total": 43,
  "totalResults": 43,
  "offset": 3,
  "selectedCurrency": {
    "currencyType": null,
    "symbol": "$",
    "deleted": false,
    "displayName": "US Dollar",
    "repositoryId": "en_US",
    "fractionalDigits": 2,
    "currencyCode": "USD",
    "numericCode": "840"
  },
  "limit": 3,
  "sort": {
    "property": "currencyCode",
    "order": "asc"
  },
  "items": {
    "currencyType": null,
    "symbol": "CHF",
    "deleted": false,
    "displayName": "Swiss Franc",
    "repositoryId": "fr_CH",
    "fractionalDigits": 2,
    "currencyCode": "CHF",
    "numericCode": "756"
  }
}