GuidesAPI ReferenceChangelog
API Reference

List ReturnShipments.

get
https://api.getbyrd.com/v2/returns
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid
status
array of strings
status
Allowed:
string
enum
Defaults to createdAt

Choose the date field to select intervals from

Allowed:
date-time

Only show returns after specific point in time

date-time

Only show returns before specific point in time

string

Show returns associated with Shipment by Shipment's parcelID or ShipmentUnit's parcelID

reason
array of strings

Filter by return reason

reason
string

Filter by return carrier

string

Filter by courier tracking number

user_ids
array of uuids
user_ids
string

Filter by name or company name of the shipment recipient

string

Filter by SKU of returned product

string

Filter by ID of returned product

string
enum

Filter by return type

Allowed:
boolean

Whether manual search was required to locate original shipment

integer
≥ 1
Defaults to 250

Number of results per page

integer
≥ 0
Defaults to 0

Result page to jump to, 0-indexed

string

The model field to sort results by

string
enum

The direction of result sorting

Allowed:
string

The search term

fields
array of strings

Model fields to search through; comma separated

fields
Responses

Updated 1 day ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago