Jump to

• Request
• Response

getReturnReasons

get

/ccstore/v1/merchant/returnReasons

Get Return Reasons. Lists the return reasons that can be given while receiving items against a return request

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

Type: object

Show Source

• items: array items
  The list of all Return Reasons for Return Request

{
    "properties":{
        "items":{
            "description":"The list of all Return Reasons for Return Request",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayKey":{
                        "description":"Display Key of the Return Reason",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Display Name of the Return Reason",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of all Return Reasons for Return Request

Show Source

• Array of: object items

{
    "description":"The list of all Return Reasons for Return Request",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayKey":{
                "description":"Display Key of the Return Reason",
                "type":"string"
            },
            "displayName":{
                "description":"Display Name of the Return Reason",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayKey: string
  Display Key of the Return Reason
• displayName: string
  Display Name of the Return Reason

{
    "type":"object",
    "properties":{
        "displayKey":{
            "description":"Display Key of the Return Reason",
            "type":"string"
        },
        "displayName":{
            "description":"Display Name of the Return Reason",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "items":[
        {
            "displayKey":"defective",
            "displayName":"Defective"
        },
        {
            "displayKey":"didNotLike",
            "displayName":"Did Not Like"
        },
        {
            "displayKey":"didNotMeetExpectations",
            "displayName":"Did Not Meet Expectations"
        },
        {
            "displayKey":"incorrectColor",
            "displayName":"Incorrect Color"
        },
        {
            "displayKey":"incorrectItem",
            "displayName":"Incorrect Item"
        },
        {
            "displayKey":"incorrectSize",
            "displayName":"Incorrect Size"
        }
    ]
}

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