REST API for Oracle Commerce Cloud

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

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

The number of items to return.
offset: integer

Index of the first element to return.
sort: string

Sorting criteria.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : listCurrencies_response

Type: object

Show Source

items: array items

List of currencies
limit: integer

The number of items to return.
offset: integer

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

Selected currency
sort: array sort

Sorting criteria.
total: integer

The total number of items. Deprecated.
totalResults: integer

The total number of items.
type: string

The promotion type being listed.

{
    "properties":{
        "total":{
            "description":"The total number of items. Deprecated.",
            "type":"integer"
        },
        "totalResults":{
            "description":"The total number of items.",
            "type":"integer"
        },
        "offset":{
            "description":"Index of the first element to return.",
            "type":"integer"
        },
        "selectedCurrency":{
            "description":"Selected currency",
            "type":"object",
            "properties":{
                "currencyType":{
                    "description":"Type of Currency",
                    "type":"string"
                },
                "symbol":{
                    "description":"The currency symbol",
                    "type":"string"
                },
                "deleted":{
                    "description":"deleted flag of currency. Applicable to loylatyPoints currencyType.",
                    "type":"string"
                },
                "displayName":{
                    "description":"Readable name of the currency",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The ID of the currency item, which is a locale string.",
                    "type":"string"
                },
                "fractionalDigits":{
                    "description":"Number of digits to the right of the decimal point",
                    "type":"integer"
                },
                "currencyCode":{
                    "description":"currency code of currency",
                    "type":"string"
                },
                "numericCode":{
                    "description":"three-digit numeric currency code",
                    "type":"string"
                }
            }
        },
        "limit":{
            "description":"The number of items to return.",
            "type":"integer"
        },
        "sort":{
            "description":"Sorting criteria.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"The property the listing is sorted by.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Sort order: asc or desc.",
                        "type":"string"
                    }
                }
            }
        },
        "type":{
            "description":"The promotion type being listed.",
            "type":"string"
        },
        "items":{
            "description":"List of currencies",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "currencyType":{
                        "description":"Type of Currency",
                        "type":"string"
                    },
                    "symbol":{
                        "description":"The currency symbol",
                        "type":"string"
                    },
                    "deleted":{
                        "description":"deleted flag of currency. Applicable to loylatyPoints currencyType.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Readable name of the currency",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The ID of the currency item, which is a locale string.",
                        "type":"string"
                    },
                    "fractionalDigits":{
                        "description":"Number of digits to the right of the decimal point",
                        "type":"string"
                    },
                    "currencyCode":{
                        "description":"currency code of Currency",
                        "type":"string"
                    },
                    "numericCode":{
                        "description":"three-digit numeric currency code",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of currencies

Show Source

Array of: object items

{
    "description":"List of currencies",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "currencyType":{
                "description":"Type of Currency",
                "type":"string"
            },
            "symbol":{
                "description":"The currency symbol",
                "type":"string"
            },
            "deleted":{
                "description":"deleted flag of currency. Applicable to loylatyPoints currencyType.",
                "type":"string"
            },
            "displayName":{
                "description":"Readable name of the currency",
                "type":"string"
            },
            "repositoryId":{
                "description":"The ID of the currency item, which is a locale string.",
                "type":"string"
            },
            "fractionalDigits":{
                "description":"Number of digits to the right of the decimal point",
                "type":"string"
            },
            "currencyCode":{
                "description":"currency code of Currency",
                "type":"string"
            },
            "numericCode":{
                "description":"three-digit numeric currency code",
                "type":"string"
            }
        }
    }
}

Nested Schema : selectedCurrency

Type: object

Selected currency

Show Source

currencyCode: string

currency code of currency
currencyType: string

Type of Currency
deleted: string

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

Readable name of the currency
fractionalDigits: integer

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

three-digit numeric currency code
repositoryId: string

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

The currency symbol

{
    "description":"Selected currency",
    "type":"object",
    "properties":{
        "currencyType":{
            "description":"Type of Currency",
            "type":"string"
        },
        "symbol":{
            "description":"The currency symbol",
            "type":"string"
        },
        "deleted":{
            "description":"deleted flag of currency. Applicable to loylatyPoints currencyType.",
            "type":"string"
        },
        "displayName":{
            "description":"Readable name of the currency",
            "type":"string"
        },
        "repositoryId":{
            "description":"The ID of the currency item, which is a locale string.",
            "type":"string"
        },
        "fractionalDigits":{
            "description":"Number of digits to the right of the decimal point",
            "type":"integer"
        },
        "currencyCode":{
            "description":"currency code of currency",
            "type":"string"
        },
        "numericCode":{
            "description":"three-digit numeric currency code",
            "type":"string"
        }
    }
}

Nested Schema : sort

Type: array

Sorting criteria.

Show Source

Array of: object items

{
    "description":"Sorting criteria.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"The property the listing is sorted by.",
                "type":"string"
            },
            "order":{
                "description":"Sort order: asc or desc.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

currencyCode: string

currency code of Currency
currencyType: string

Type of Currency
deleted: string

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

Readable name of the currency
fractionalDigits: string

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

three-digit numeric currency code
repositoryId: string

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

The currency symbol

{
    "type":"object",
    "properties":{
        "currencyType":{
            "description":"Type of Currency",
            "type":"string"
        },
        "symbol":{
            "description":"The currency symbol",
            "type":"string"
        },
        "deleted":{
            "description":"deleted flag of currency. Applicable to loylatyPoints currencyType.",
            "type":"string"
        },
        "displayName":{
            "description":"Readable name of the currency",
            "type":"string"
        },
        "repositoryId":{
            "description":"The ID of the currency item, which is a locale string.",
            "type":"string"
        },
        "fractionalDigits":{
            "description":"Number of digits to the right of the decimal point",
            "type":"string"
        },
        "currencyCode":{
            "description":"currency code of Currency",
            "type":"string"
        },
        "numericCode":{
            "description":"three-digit numeric currency code",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

order: string

Sort order: asc or desc.
property: string

The property the listing is sorted by.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"The property the listing is sorted by.",
            "type":"string"
        },
        "order":{
            "description":"Sort order: asc or desc.",
            "type":"string"
        }
    }
}

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

Root Schema : errorModel

Type: object

Show Source

devMessage: string

An optional non-localized message containing technical information for developers
errorCode: string

The numerical code identifying the error
errors: array errors

An optional list of errors if multiple errors were encountered
message: string

The localized message describing the error
moreInfo: string

An optional non-localized message with more information
o:errorPath: string

An optional machine readable description of where the error occurred
status: string

The HTTP status code
type: 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: string

An optional non-localized message containing technical information for developers
errorCode: string

The numerical code identifying the error
message: string

The localized message describing the error
moreInfo: string

An optional non-localized message with more information
o:errorPath: string

An optional machine readable description of where the error occurred
status: 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"
        }
    }
}