QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Migration
Migrate from legacy version
Migrate from 2024-07
Reference
API Overview
Returns
Get return detail by ID
get
Get return detail by RMA number
get
Get returns
get
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

Address

street_1
string or null

First line of the street address.

street_2
string or null

Second line of the street address.

city
string or null

The location's city, town, or village.

state
The State Schema or null

The state or region of the location, such as a province, state, or prefecture.

name
string

The state or region of the location, such as a province, state, or prefecture.Show all...

postal_code
string or null

The postal code of the location (also known as zip code, postcode, Eircode, etc.).

country_region
The Country Schema or null

The address country/region in ISO 3166-1 alpha-3 format.

Example:
USA
code
string

The address country/region in ISO 3166-1 alpha-3 format.Show all...

Example
preparing...