Jump to

• Request
• Response

createReason

post

/ccadmin/v1/reasons

Create Reason. Create the reason of given type with the given data. Valid reason types are appeasementReason, cancelReasons, priceOverrideReasons, returnReasons and returnItemDisposition. eg. /ccadmin/v1/reasons?type=returnItemDisposition

Request

Supported Media Types

• application/json

Body ()

Root Schema : createReason_request

Type: object

Show Source

• active: boolean
  Indicates whether reason is enabled or disabled.
• description: string
  Description of the reason.
• id(optional): string
  Id of the reason. It is an optional property to create reason with given id, else system generated id will be considered, by default.
• readableDescription: string
  Name of the reason.

{
    "properties":{
        "readableDescription":{
            "description":"Name of the reason.",
            "type":"string"
        },
        "description":{
            "description":"Description of the reason.",
            "type":"string"
        },
        "active":{
            "description":"Indicates whether reason is enabled or disabled.",
            "type":"boolean"
        },
        "id":{
            "description":"Id of the reason. It is an optional property to create reason with given id, else system generated id will be considered, by default.",
            "type":"string"
        }
    },
    "required":[
        "description",
        "readableDescription",
        "active"
    ],
    "example":{
        "readableDescription":"accepted",
        "description":"accepted",
        "active":false,
        "id":200001
    }
}

Example:

{
    "readableDescription":"accepted",
    "description":"accepted",
    "active":false,
    "id":200001
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createReason_response

Type: object

Show Source

• active(optional): boolean
  Indicates whether reason is enabled or disabled.
• description(optional): string
  Description of the reason.
• id(optional): string
  Id of the reason.
• readableDescription(optional): string
  Name of the reason.

{
    "properties":{
        "readableDescription":{
            "description":"Name of the reason.",
            "type":"string"
        },
        "description":{
            "description":"Description of the reason.",
            "type":"string"
        },
        "active":{
            "description":"Indicates whether reason is enabled or disabled.",
            "type":"boolean"
        },
        "id":{
            "description":"Id of the reason.",
            "type":"string"
        }
    },
    "example":{
        "readableDescription":"accepted",
        "description":"accepted",
        "active":false,
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccadmin/v1/reasons?type=returnItemDisposition"
            }
        ],
        "id":"200001"
    }
}

Example:

{
    "readableDescription":"accepted",
    "description":"accepted",
    "active":false,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/reasons?type=returnItemDisposition"
        }
    ],
    "id":"200001"
}

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| |------------------|------------------| |200217|Error while validating the input reason json| |200211|Error while creating the reason| |200213|Invalid reason type passed.|

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