Glue API: Retrieve return reasons

Last updated:
Edit on GitHub

This endpoint allows retrieving returns reasons.

Installation

For details on the modules that provide the API functionality and how to install them, see Glue API: Return Management feature integration

Retrieve return reasons

To retrieve return reasons, send the request:

GET /return-reasons

Request

Request sample: retrieve return reasons

GET https://glue.mysprykershop.com/return-reasons

Response

Response sample: retrieve return reasons 
{
    "data": [
        {
            "type": "return-reasons",
            "id": null,
            "attributes": {
                "reason": "Damaged"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/return-reasons"
            }
        },
        {
            "type": "return-reasons",
            "id": null,
            "attributes": {
                "reason": "Wrong Item"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/return-reasons"
            }
        },
        {
            "type": "return-reasons",
            "id": null,
            "attributes": {
                "reason": "No longer needed"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/return-reasons"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/return-reasons"
    }
}
ATTRIBUTE TYPE DESCRIPTION
reason String Predefined return reason.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.