Jump to

• Request
• Response

listCancelReasons

get

/ccagent/v1/merchant/orderCancelReasons

List Cancel Reasons. Lists the Cancel Reasons for cancelling an order

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listCancelReasons_response

Type: object

Show Source

• items: array items
  The list of all Cancel Reasons

{
    "properties":{
        "items":{
            "description":"The list of all Cancel Reasons",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayValue":{
                        "description":"Display Name of the cancel reason",
                        "type":"string"
                    },
                    "Key":{
                        "description":"Display Key of the cancel reason",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of all Cancel Reasons

Show Source

• Array of: object items

{
    "description":"The list of all Cancel Reasons",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayValue":{
                "description":"Display Name of the cancel reason",
                "type":"string"
            },
            "Key":{
                "description":"Display Key of the cancel reason",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayValue: string
  Display Name of the cancel reason
• Key: string
  Display Key of the cancel reason

{
    "type":"object",
    "properties":{
        "displayValue":{
            "description":"Display Name of the cancel reason",
            "type":"string"
        },
        "Key":{
            "description":"Display Key of the cancel reason",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    {
        "displayValue":"Bad product review",
        "key":"badProductReview"
    },
    {
        "displayValue":"Better competitor price",
        "key":"betterCompetitorPrice"
    },
    {
        "displayValue":"Change of mind",
        "key":"changeOfMind"
    },
    {
        "displayValue":"Item available at discount currently",
        "key":"itemAvailableAtDiscountCurrently"
    },
    {
        "displayValue":"No longer needed",
        "key":"noLongerNeeded"
    },
    {
        "displayValue":"No update on shipment status",
        "key":"noUpdateOnShipmentStatus"
    }
]

Default Response

The error response

Body ()

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"
        }
    }
}

Back to Top