listReturnRequests

get

/ccstore/v1/orders/{id}/returnRequests

Lists all return requests for a given order ID. Optionally takes the x-ccasset-language headers to get translated content in another language. Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization context of logged in user.

Request

Supported Media Types
Path Parameters
  • The order ID to retreive all related return requests.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listReturnRequests_response
Type: object
Show Source
Nested Schema : items
Type: array
List of all return requests related to an order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional properties returned by return request validation webhook
Nested Schema : returnItems
Type: array
List of return items in the return request.
Show Source
Nested Schema : trackingNumber
Type: array
Tracking Number of return request
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional properties returned by return request validation webhook
Example Response (links)
[
    {
        "rel":"self",
        "href":"http://slc12lyv.us.oracle.com:8080/ccstoreui/v1/orders/o30411/returnRequests"
    }
]
Example Response (items)
[
    {
        "returnRequestId":"200002",
        "returnLabel":"a5445afg5",
        "isExchangeRequest":false,
        "authorizationNumber":"12345",
        "createdDate":1.513930292E12,
        "returnItems":[
            {
                "quantityToReturn":1,
                "productId":"Product_36Exy",
                "returnReason":"Did Not Like",
                "additionalProperties":{
                    "name2":"value2",
                    "name1":"value1"
                },
                "state":"AWAITING_RETURN",
                "catRefId":"Sku_36Fxy"
            }
        ],
        "totalRefund":24.63,
        "additionalProperties":{
            "name2":"value2",
            "name1":"value1"
        },
        "state":"Approved",
        "totalReturnQuantity":1,
        "trackingNumber":[
            "1234567890"
        ],
        "operation":"process"
    },
    {
        "returnRequestId":"200001",
        "returnLabel":"a5445afg5",
        "isExchangeRequest":false,
        "authorizationNumber":"12345",
        "createdDate":1.513929715E12,
        "returnItems":[
            {
                "quantityToReturn":1,
                "productId":"Product_36Exy",
                "returnReason":"Did Not Like",
                "additionalProperties":{
                    "name2":"value2",
                    "name1":"value1"
                },
                "state":"AWAITING_RETURN",
                "catRefId":"Sku_36Fxy"
            }
        ],
        "totalRefund":24.63,
        "additionalProperties":{
            "name2":"value2",
            "name1":"value1"
        },
        "state":"Approved",
        "totalReturnQuantity":1,
        "trackingNumber":[
            "1234567890"
        ],
        "operation":"process"
    },
    {
        "returnRequestId":"100003",
        "returnLabel":null,
        "isExchangeRequest":false,
        "authorizationNumber":"100003",
        "createdDate":1.513774357E12,
        "returnItems":[
            {
                "quantityToReturn":1,
                "productId":"Product_36Exy",
                "returnReason":"Did Not Like",
                "additionalProperties":{
                },
                "state":"AWAITING_RETURN",
                "catRefId":"Sku_36Fxy"
            }
        ],
        "totalRefund":24.63,
        "additionalProperties":{
        },
        "state":"Approved",
        "totalReturnQuantity":1,
        "trackingNumber":null,
        "operation":"process"
    },
    {
        "returnRequestId":"100002",
        "returnLabel":null,
        "isExchangeRequest":false,
        "authorizationNumber":"100002",
        "createdDate":1.513774188E12,
        "returnItems":[
            {
                "quantityToReturn":1,
                "productId":"Product_36Exy",
                "returnReason":"Did Not Like",
                "additionalProperties":{
                },
                "state":"AWAITING_RETURN",
                "catRefId":"Sku_36Fxy"
            }
        ],
        "totalRefund":24.63,
        "additionalProperties":{
        },
        "state":"Approved",
        "totalReturnQuantity":1,
        "trackingNumber":null,
        "operation":"process"
    },
    {
        "returnRequestId":"100001",
        "returnLabel":null,
        "isExchangeRequest":false,
        "authorizationNumber":"100001",
        "createdDate":1.513773501E12,
        "returnItems":[
            {
                "quantityToReturn":1,
                "productId":"Product_36Exy",
                "returnReason":"Did Not Like",
                "additionalProperties":{
                },
                "state":"AWAITING_RETURN",
                "catRefId":"Sku_36Fxy"
            }
        ],
        "totalRefund":24.63,
        "additionalProperties":{
        },
        "state":"Approved",
        "totalReturnQuantity":1,
        "trackingNumber":null,
        "operation":"process"
    }
]

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top