Skip to content
ShopentlyLearn

Returns, complaints and exchanges

Read customer requests and change their status or recorded refund amount.

Operations

GETList customer request statuses/api/v1/request-statuses

GETList customer requests/api/v1/requests

GETGet a customer request/api/v1/requests/{request_id}

PATCHUpdate the recorded refund amount/api/v1/requests/{request_id}/refund-amount

PATCHUpdate customer request status/api/v1/requests/{request_id}/status

How it works

Use the collection and detail endpoints for the request number and type, related order, submitted items, customer details and refund data. Valid request types are return, exchange and complaint.

Obtain status identifiers from /api/v1/request-statuses. Status and refund amount are separate writes with version checks. Changing the recorded refund amount updates the request record; it does not execute a money transfer.