Return Requests API (/return_requests)

Create and work with return requests to return inventory items to suppliers.

The URL to access return requests is: https://<instance>/api/return_requests


This resource is associated with Receipts API.


The Return Requests API includes these methods:

Verb Path Action Description
GET /api/return_requests index Query return requests
GET /api/return_requests/:id show Query a return request by ID 
POST /api/return_requests create Create a return request in draft status 
POST /api/return_requests/:id/submit submit Submit a return request for approval
PUT/PATCH /api/return_requests/:id update  Update a return request that is in draft status
DELETE /api/return_requests/:id destroy Delete a return request in draft status only 

For more information about the Return Requests API payload, see Receipts API Example Calls.


Element Description Req'd Unique Allowable Value In Out Data Type
address Address yes yes yes Address
created-at Created Date yes datetime
created-by Created By yes User
id ID yes integer
lines Return Lines yes yes yes ReturnRequestLine
number Return # yes yes string(255)
rma RMA yes yes string(255)
status Status yes yes string(255)
updated-at Updated Date yes datetime
updated-by Updated By yes User

Related Items

Build on the Coupa Platform

Our API-based open integration platform lets technology partners and independent software vendors (ISVs) integrate their products with Coupa

The Coupa Core API

Our RESTful API provides robust access to read, edit, or integrate your data with the Coupa platform.

Get Started with the API

General information about using the Coupa API and when you should consider using CSV.

OAuth 2.0 and OIDC

Coupa is deprecating legacy API Keys and requiring the use of OAuth 2.0 / OIDC. Starting with R34, no new API Keys will be issued, and API Keys will no longer be supported with R35.