List shipment requests

Get a list of shipments for the marketplace associated with the user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The name of the carrier handling the return.

string

The email of the customer associated to the return.

string

The name of the customer associated to the return

string
enum

The field to filter by the date

Allowed:
date-time

The end date for filtering the returns

boolean

Flag indicating if the search is for pre-approvals

boolean

Flag indicating if the search is for pre-validations

string

Language code for the export

string

The name of the marketplace associated to the return

string

The return shipping method name.

string
enum

Filter by Mode

Allowed:
string

The name of the item

number
required

The current page of results, each containing 15 returns

paymentMethods
array of strings

List of payment methods associated to the return

paymentMethods
Allowed:
payments
array of strings

The payment status of the return

payments
Allowed:
boolean

If the return is pre processed

string

The name of the order associated to the return

reasonTypes
array of strings

The types of the return

reasonTypes
Allowed:
string
shippingTypes
array of strings

List of shipping types associated to the return

shippingTypes
Allowed:
string
enum

The field by which results are sorted

string
enum

The order by which results are sorted

Allowed:
date-time

The start date for filtering the returns

statuses
array of strings

The current states of the return

statuses
Allowed:
string

The tracking number for the return.

trackingStatuses
array of strings

The current tracking status of the return

trackingStatuses
string
enum
Defaults to returns

Type of export list

Allowed:
Response

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