Jump to

• Request
• Response

Retrieve return requests

get

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

Retrieves all return requests for the specified order.

Prerequisite: The user must be logged in. See REST API Authentication.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The order ID to retreive all related return requests.

Header Parameters

• X-CCAsset-Language(optional): string
  Instructs the endpoint to use the specified locale code for content returned in the response. The locale supplied in the header must be supported by your store.
• X-CCOrganization(optional): string
  Current organization context of the logged in user

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : listReturnRequests_response

Type: object

Show Source

• items(optional): array items
  List of all return requests related to an order.

{
    "properties":{
        "items":{
            "description":"List of all return requests related to an order.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "returnRequestId":{
                        "description":"The ID of the return request.",
                        "type":"string"
                    },
                    "isExchangeRequest":{
                        "description":"Either it is exchange / return request.",
                        "type":"boolean"
                    },
                    "returnItems":{
                        "description":"List of return items in the return request.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "quantityToReturn":{
                                    "description":"The quantity Returned of the return item.",
                                    "type":"integer"
                                },
                                "productId":{
                                    "description":"The Product ID of the return item.",
                                    "type":"string"
                                },
                                "returnReason":{
                                    "description":"The return reason of the return item.",
                                    "type":"string"
                                },
                                "actionCode":{
                                    "description":"The action code that has been set on the externalData item by the configurator system.",
                                    "type":"string"
                                },
                                "additionalProperties":{
                                    "description":"Additional properties returned by return request validation webhook",
                                    "type":"object"
                                },
                                "state":{
                                    "description":"The state of the return item.",
                                    "type":"string"
                                },
                                "catRefId":{
                                    "description":"The SKU ID of the return item.",
                                    "type":"string"
                                },
                                "returnRequired":{
                                    "description":"Boolean value to determine if the item has to be physically received.",
                                    "type":"boolean"
                                }
                            }
                        }
                    },
                    "nonreturnable":{
                        "description":"Indicates whether the item is returnable or not",
                        "type":"boolean"
                    },
                    "totalRefund":{
                        "description":"The total refund amount of the return request.",
                        "type":"number"
                    },
                    "returnLabel":{
                        "description":"Return label of the return request",
                        "type":"string"
                    },
                    "authorizationNumber":{
                        "description":"RMA of the return request",
                        "type":"string"
                    },
                    "createdDate":{
                        "description":"The authorization date of the return request.",
                        "type":"string"
                    },
                    "state":{
                        "description":"Status of Return Request.",
                        "type":"string"
                    },
                    "additionalProperties":{
                        "description":"Additional properties returned by return request validation webhook",
                        "type":"object"
                    },
                    "totalReturnQuantity":{
                        "description":"The total returned quantity in the return request.",
                        "type":"number"
                    },
                    "trackingNumber":{
                        "description":"Tracking Number of return request",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "operation":{
                        "description":"The return operation of the return request",
                        "type":"string"
                    },
                    "nonReturnableReason":{
                        "description":"Non returnable reason for the item being non-returnable ",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of all return requests related to an order.

Show Source

• Array of: object items

{
    "description":"List of all return requests related to an order.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "returnRequestId":{
                "description":"The ID of the return request.",
                "type":"string"
            },
            "isExchangeRequest":{
                "description":"Either it is exchange / return request.",
                "type":"boolean"
            },
            "returnItems":{
                "description":"List of return items in the return request.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "quantityToReturn":{
                            "description":"The quantity Returned of the return item.",
                            "type":"integer"
                        },
                        "productId":{
                            "description":"The Product ID of the return item.",
                            "type":"string"
                        },
                        "returnReason":{
                            "description":"The return reason of the return item.",
                            "type":"string"
                        },
                        "actionCode":{
                            "description":"The action code that has been set on the externalData item by the configurator system.",
                            "type":"string"
                        },
                        "additionalProperties":{
                            "description":"Additional properties returned by return request validation webhook",
                            "type":"object"
                        },
                        "state":{
                            "description":"The state of the return item.",
                            "type":"string"
                        },
                        "catRefId":{
                            "description":"The SKU ID of the return item.",
                            "type":"string"
                        },
                        "returnRequired":{
                            "description":"Boolean value to determine if the item has to be physically received.",
                            "type":"boolean"
                        }
                    }
                }
            },
            "nonreturnable":{
                "description":"Indicates whether the item is returnable or not",
                "type":"boolean"
            },
            "totalRefund":{
                "description":"The total refund amount of the return request.",
                "type":"number"
            },
            "returnLabel":{
                "description":"Return label of the return request",
                "type":"string"
            },
            "authorizationNumber":{
                "description":"RMA of the return request",
                "type":"string"
            },
            "createdDate":{
                "description":"The authorization date of the return request.",
                "type":"string"
            },
            "state":{
                "description":"Status of Return Request.",
                "type":"string"
            },
            "additionalProperties":{
                "description":"Additional properties returned by return request validation webhook",
                "type":"object"
            },
            "totalReturnQuantity":{
                "description":"The total returned quantity in the return request.",
                "type":"number"
            },
            "trackingNumber":{
                "description":"Tracking Number of return request",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "operation":{
                "description":"The return operation of the return request",
                "type":"string"
            },
            "nonReturnableReason":{
                "description":"Non returnable reason for the item being non-returnable ",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• additionalProperties(optional): object additionalProperties
  Additional properties returned by return request validation webhook
• authorizationNumber(optional): string
  RMA of the return request
• createdDate(optional): string
  The authorization date of the return request.
• isExchangeRequest(optional): boolean
  Either it is exchange / return request.
• nonreturnable(optional): boolean
  Indicates whether the item is returnable or not
• nonReturnableReason(optional): string
  Non returnable reason for the item being non-returnable
• operation(optional): string
  The return operation of the return request
• returnItems(optional): array returnItems
  List of return items in the return request.
• returnLabel(optional): string
  Return label of the return request
• returnRequestId(optional): string
  The ID of the return request.
• state(optional): string
  Status of Return Request.
• totalRefund(optional): number
  The total refund amount of the return request.
• totalReturnQuantity(optional): number
  The total returned quantity in the return request.
• trackingNumber(optional): array trackingNumber
  Tracking Number of return request

{
    "type":"object",
    "properties":{
        "returnRequestId":{
            "description":"The ID of the return request.",
            "type":"string"
        },
        "isExchangeRequest":{
            "description":"Either it is exchange / return request.",
            "type":"boolean"
        },
        "returnItems":{
            "description":"List of return items in the return request.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "quantityToReturn":{
                        "description":"The quantity Returned of the return item.",
                        "type":"integer"
                    },
                    "productId":{
                        "description":"The Product ID of the return item.",
                        "type":"string"
                    },
                    "returnReason":{
                        "description":"The return reason of the return item.",
                        "type":"string"
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the externalData item by the configurator system.",
                        "type":"string"
                    },
                    "additionalProperties":{
                        "description":"Additional properties returned by return request validation webhook",
                        "type":"object"
                    },
                    "state":{
                        "description":"The state of the return item.",
                        "type":"string"
                    },
                    "catRefId":{
                        "description":"The SKU ID of the return item.",
                        "type":"string"
                    },
                    "returnRequired":{
                        "description":"Boolean value to determine if the item has to be physically received.",
                        "type":"boolean"
                    }
                }
            }
        },
        "nonreturnable":{
            "description":"Indicates whether the item is returnable or not",
            "type":"boolean"
        },
        "totalRefund":{
            "description":"The total refund amount of the return request.",
            "type":"number"
        },
        "returnLabel":{
            "description":"Return label of the return request",
            "type":"string"
        },
        "authorizationNumber":{
            "description":"RMA of the return request",
            "type":"string"
        },
        "createdDate":{
            "description":"The authorization date of the return request.",
            "type":"string"
        },
        "state":{
            "description":"Status of Return Request.",
            "type":"string"
        },
        "additionalProperties":{
            "description":"Additional properties returned by return request validation webhook",
            "type":"object"
        },
        "totalReturnQuantity":{
            "description":"The total returned quantity in the return request.",
            "type":"number"
        },
        "trackingNumber":{
            "description":"Tracking Number of return request",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "operation":{
            "description":"The return operation of the return request",
            "type":"string"
        },
        "nonReturnableReason":{
            "description":"Non returnable reason for the item being non-returnable ",
            "type":"string"
        }
    }
}

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

• Array of: object items

{
    "description":"List of return items in the return request.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "quantityToReturn":{
                "description":"The quantity Returned of the return item.",
                "type":"integer"
            },
            "productId":{
                "description":"The Product ID of the return item.",
                "type":"string"
            },
            "returnReason":{
                "description":"The return reason of the return item.",
                "type":"string"
            },
            "actionCode":{
                "description":"The action code that has been set on the externalData item by the configurator system.",
                "type":"string"
            },
            "additionalProperties":{
                "description":"Additional properties returned by return request validation webhook",
                "type":"object"
            },
            "state":{
                "description":"The state of the return item.",
                "type":"string"
            },
            "catRefId":{
                "description":"The SKU ID of the return item.",
                "type":"string"
            },
            "returnRequired":{
                "description":"Boolean value to determine if the item has to be physically received.",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : trackingNumber

Type: array

Tracking Number of return request

Show Source

• Array of: string

{
    "description":"Tracking Number of return request",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• actionCode(optional): string
  The action code that has been set on the externalData item by the configurator system.
• additionalProperties(optional): object additionalProperties
  Additional properties returned by return request validation webhook
• catRefId(optional): string
  The SKU ID of the return item.
• productId(optional): string
  The Product ID of the return item.
• quantityToReturn(optional): integer
  The quantity Returned of the return item.
• returnReason(optional): string
  The return reason of the return item.
• returnRequired(optional): boolean
  Boolean value to determine if the item has to be physically received.
• state(optional): string
  The state of the return item.

{
    "type":"object",
    "properties":{
        "quantityToReturn":{
            "description":"The quantity Returned of the return item.",
            "type":"integer"
        },
        "productId":{
            "description":"The Product ID of the return item.",
            "type":"string"
        },
        "returnReason":{
            "description":"The return reason of the return item.",
            "type":"string"
        },
        "actionCode":{
            "description":"The action code that has been set on the externalData item by the configurator system.",
            "type":"string"
        },
        "additionalProperties":{
            "description":"Additional properties returned by return request validation webhook",
            "type":"object"
        },
        "state":{
            "description":"The state of the return item.",
            "type":"string"
        },
        "catRefId":{
            "description":"The SKU ID of the return item.",
            "type":"string"
        },
        "returnRequired":{
            "description":"Boolean value to determine if the item has to be physically received.",
            "type":"boolean"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional properties returned by return request validation webhook

Example Response (links)

[
    {
        "rel":"self",
        "href":"http://store.example.com/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 following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:

Error Code	Description	Possible Fix
28107	Order not found.	Enter a valid order ID

The error response:

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