REST API for Oracle Commerce Cloud December 2017

createCurrency

post

/ccadmin/v1/currencies

Create Currency. Endpoint for creating Currency

Request

Supported Media Types

application/json

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request. E.g., en,de,fr_CA.

Body Parameter

Root Schema : createCurrency_request

Example


{
    "currencyType":"loyaltyPoints",
    "symbol":"P",
    "displayName":"PTS",
    "id":"points",
    "currencyCode":"PTS"
}

Properties

currencyCode: Type: string

Required: true

Non ISO 4217 Standard currency code and must be unique. Space is not allowed.
currencyType: Type: string

Required: true

Type of Currency. It must be 'loyaltyPoints'.
displayName: Type: string

Required: true

Readable name of the Currency.
fractionalDigits: Type: integer

Number of digits to the right of the decimal point. Must be greater than or equal to zero.
id: Type: string

Required: true

Id of Currency. It must be lower case & should not contain underscore '_' character. Space is not allowed.
symbol: Type: string

Required: true

The currency symbol. Space is not allowed.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createCurrency_response

Properties

currencyCode: Type: string

currency code of Currency
currencyType: Type: string

Type of Currency.
deleted: Type: boolean

Indicates whether Currency is deleted
displayName: Type: string

Readable name of the Currency
fractionalDigits: Type: integer

fractionalDigits of Currency
numericCode: Type: string

Numeric currency code of Currency
repositoryId: Type: string

repositoryId of Currency
symbol: Type: string

The currency symbol of Currency

Example application/json


{
    "currencyType":"loyaltyPoints",
    "symbol":"P",
    "deleted":false,
    "displayName":"PTS",
    "repositoryId":"points",
    "fractionalDigits":2,
    "currencyCode":"PTS",
    "numericCode":null
}

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| |80202|The request to create the currency could not be performed.| |80208|Currency with {0} already exists.| |80207|Currency Type {0} is not supported. Check the API documentation for more details.| |80206|Format for {0} is incorrect. Please check the API documentation for more details.| |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 Request:

{
  "currencyType": "loyaltyPoints",
  "symbol": "P",
  "displayName": "PTS",
  "id": "points",
  "currencyCode": "PTS"
}

Sample Response Payload returned by endpoint:

{
  "currencyType": "loyaltyPoints",
  "symbol": "P",
  "deleted": false,
  "displayName": "PTS",
  "repositoryId": "points",
  "fractionalDigits": 2,
  "currencyCode": "PTS",
  "numericCode": null
}