Return vendor authorizations

Create, read, update and delete return vendor authorizations, the returns of purchased stock to a supplier.

A return vendor authorization records stock you send back to a supplier against lines of a purchase order. These endpoints create, list, read, update and delete returns and remove their notes and files. This area has 7 endpoints, each available in all seven SDKs.

Only a draft return vendor authorization can be deleted. Any other status returns 400 stock_committed, and a delete cannot be undone.

At a glance

Endpoint	Method	Path	What it does
Create a return vendor authorization	POST	/return_vendor_authorizations	Creates a return to a supplier for purchase order lines and returns it under return_vendor_authorization.
Delete a draft return vendor authorization	DELETE	/return_vendor_authorizations/{rva_id}	Deletes a draft return vendor authorization. Nothing comes back.
Update a return vendor authorization	PATCH	/return_vendor_authorizations/{rva_id}	Changes the date, note or custom attributes of a return vendor authorization and returns it under return_vendor_authorization.
Delete a return vendor authorization note	DELETE	/return_vendor_authorizations/{rva_id}/notes/{note_id}	Deletes one note from a return vendor authorization. Nothing comes back.
Delete a return vendor authorization note file	DELETE	/return_vendor_authorizations/{rva_id}/notes/{note_id}/files/{file_id}	Removes one attachment from a return vendor authorization note. Nothing comes back.
List return vendor authorizations	GET	/return_vendor_authorizations	Returns one page of return vendor authorizations.
Retrieve a return vendor authorization	GET	/return_vendor_authorizations/{rva_id}	Returns one return vendor authorization with its lines under return_vendor_authorization.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Every write body is wrapped in return_vendor_authorization.
• The create names a purchase order and its lines. Each line takes purchase_order_line and rva_qty; create_as_draft: true saves a draft.
• The reads and the update accept the rva_ id or the code. The delete takes the rva_ id only; a code returns 404.
• Listings page by cursor. Records are under data; pass pagination.next_cursor as cursor while pagination.has_more is true.