QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Migration
Migrate from 2025-01
Reference
API Overview
Returns
Get return detail by ID
get
Get return detail by RMA number
get
Get returns
get
Create Return
post
Approve Return By RMA number
post
Approve Return By Return ID
post
Resolve Return By RMA number
post
Resolve Return By Return ID
post
Reject Return By RMA number
post
Reject Return By Return ID
post
Receive items by RMA number
post
Receive items by Return ID
post
Attach shipments by RMA number
post
Attach shipments by Return ID
post
Return Dropoffs
Record dropped-off return items
post
Return items
Update return items by Return ID
patch
Update return items By RMA number
patch
Item tags
Get item tags
get
Model
Primitive
Address
Money
Envelope
Meta
Error
Resource
Return
Return item
Item tag
Webhook
Webhook Overview
Webhook Specifications
Webhook Outgoing IPs
Webhook Signature
Support
Contact Support

Approve Return By Return ID

post
/returns/{return_id}/approve

Through the approve return API, you can transition a return to approved status.

Request

Path Parameters

return_id
string
required

Body

notify_customer
boolean

Whether to send a notification to the customer.

generate_label
boolean

Whether to execute the creation of labels according to the default configuration during the approval process.

customize_label_info
object
label_reference
string

If generate_label is set to true, this field can be used to customize the reference on the label.

ship_from
Address

If generate_label is set to true, this field is used to specify the sender's address

Example:
{"street_1":"1234 Elm Street","street_2":"Apt 5","city":"New York","state":{"name":"New York"},"postal_code":"10001","country_region":{"code":"USA"}}
ship_to
Address

If generate_label is set to true, this field is used to specify the receipent's address.

Example:
{"street_1":"1234 Elm Street","street_2":"Apt 5","city":"New York","state":{"name":"New York"},"postal_code":"10001","country_region":{"code":"USA"}}
Auth
:
Parameters
:
Body
preparing...