Skip to main content
GET
Get Shipments

Authorizations

X-Authorization
string
header
required

Query Parameters

from
string<date-time>

The start date and time for the shipment list, using the ISO 8601 date format.

Example:

"2024-01-01T00:00:00.000Z"

to
string<date-time>

The end date and time for the shipment list, using the ISO 8601 date format.

Example:

"2024-03-31T23:59:59.000Z"

page
integer

The page number of paginated results to return.

Required range: x >= 1
Example:

1

Response

Success

current_page
integer

The identifier associated with the current page.

Example:

1

data
object[]

The data for each entry in the shipment list.

first_page_url
string

The link to the first page of paginated results.

Example:

"https://api.loopreturns.com/api/v1/happy-returns/shipments/list?from=2022-01-01&to=2023-03-01&page=1"

from
integer

The number of the first shipment on the page.

Example:

1

last_page
integer

The identifier associated with the last page.

Example:

1

last_page_url
string

The link to the last page of paginated results.

Example:

"https://api.loopreturns.com/api/v1/happy-returns/shipments/list?from=2022-01-01&to=2023-03-01&page=1"

next_page_url
string | null

The link to the next page of paginated results.

path
string

The endpoint's path.

Example:

"https://api.loopreturns.com/api/v1/happy-returns/shipments/list"

per_page
integer

The number of shipments per page.

Example:

200

prev_page_url
string | null

The link to the previous page of paginated results.

to
integer

The number of the last shipment on the page.

Example:

1

total
integer

The total number of shipments returned.

Example:

1