API Reference

Retrieves Shipments

get
https://{defaultHost}/api2/v1/shipments

Shipments are defined as Orders. Use this endpoint to view and manage Shipments received by your Sellers.

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

the page number in the paged results being requests

string

the limit of records per page

string

URI encoded search string for searching various columns of an order/shipment (order number and buyer name, email, and shipping address)

string

Status of Shipment. Possible statuses to filter by: pending_shipment, shipped, delivered, payout_complete, canceled, returned

string

Sort in ascending or descending order (e.g. order_by=created_at%20desc or order_by=created_at%20asc)

string

format YYYY-MM-DD (must be used with end_date)

string

format YYYY-MM-DD (must be used with start_date)

boolean

filters shipments based on filled flag

boolean

filters shipments based on pre_order flag

string

filters shipments to include a specific country ISO

string

filters shipments to exclude a specific country ISO

store_ids[]
array of strings

filters shipments based on store.id (e.g. store_ids[]=1&store_ids[]=2&store_ids[]=3)

store_ids[]
product_ids[]
array of strings

filters shipments based on line_item.product_id (e.g. product_ids[]=1&product_ids[]=2&product_ids[]=3)

product_ids[]
Response

Updated 7 months ago

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

Updated 7 months ago