Jump to

• Request
• Response

createCurrency

post

/ccadmin/v1/currencies

Create Currency. Endpoint for creating Currency

Request

Supported Media Types

• application/json

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request. E.g., en,de,fr_CA.

Body ()

Root Schema : createCurrency_request

Type: object

Show Source

• currencyCode: string
  Non ISO 4217 Standard currency code and must be unique. Space is not allowed.
• currencyType: string
  Type of Currency. It must be 'loyaltyPoints'.
• displayName: string
  Readable name of the Currency.
• fractionalDigits(optional): integer
  Number of digits to the right of the decimal point. Must be greater than or equal to zero.
• id: string
  Id of Currency. It must be lower case & should not contain underscore '_' character. Space is not allowed.
• symbol: string
  The currency symbol. Space is not allowed.

{
    "properties":{
        "currencyType":{
            "description":"Type of Currency. It must be 'loyaltyPoints'.",
            "type":"string"
        },
        "symbol":{
            "description":"The currency symbol. Space is not allowed.",
            "type":"string"
        },
        "displayName":{
            "description":"Readable name of the Currency.",
            "type":"string"
        },
        "fractionalDigits":{
            "description":"Number of digits to the right of the decimal point. Must be greater than or equal to zero.",
            "type":"integer"
        },
        "id":{
            "description":"Id of Currency. It must be lower case & should not contain underscore '_' character. Space is not allowed.",
            "type":"string"
        },
        "currencyCode":{
            "description":"Non ISO 4217 Standard currency code and must be unique. Space is not allowed.",
            "type":"string"
        }
    },
    "required":[
        "currencyType",
        "symbol",
        "displayName",
        "id",
        "currencyCode"
    ],
    "example":{
        "currencyType":"loyaltyPoints",
        "symbol":"P",
        "displayName":"PTS",
        "id":"points",
        "currencyCode":"PTS"
    }
}

Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createCurrency_response

Type: object

Show Source

• currencyCode(optional): string
  currency code of Currency
• currencyType(optional): string
  Type of Currency.
• deleted(optional): boolean
  Indicates whether Currency is deleted
• displayName(optional): string
  Readable name of the Currency
• fractionalDigits(optional): integer
  fractionalDigits of Currency
• numericCode(optional): string
  Numeric currency code of Currency
• repositoryId(optional): string
  repositoryId of Currency
• symbol(optional): string
  The currency symbol of Currency

{
    "properties":{
        "currencyType":{
            "description":"Type of Currency.",
            "type":"string"
        },
        "symbol":{
            "description":"The currency symbol of Currency",
            "type":"string"
        },
        "deleted":{
            "description":"Indicates whether Currency is deleted",
            "type":"boolean"
        },
        "displayName":{
            "description":"Readable name of the Currency",
            "type":"string"
        },
        "repositoryId":{
            "description":"repositoryId of Currency",
            "type":"string"
        },
        "fractionalDigits":{
            "description":"fractionalDigits of Currency",
            "type":"integer"
        },
        "currencyCode":{
            "description":"currency code of Currency",
            "type":"string"
        },
        "numericCode":{
            "description":"Numeric currency code of Currency",
            "type":"string"
        }
    }
}

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

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): 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(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): 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"
        }
    }
}

Back to Top