GET
/
happy-returns
/
shipments
/
{id}
/
items
curl --request GET \
  --url https://api.loopreturns.com/api/v1/happy-returns/shipments/{id}/items \
  --header 'X-Authorization: <api-key>'
{
  "current_page": 1,
  "data": [
    {
      "carrier": "ups",
      "happy_returns_return_bag_barcodes": [
        "HRABCDEF-1234-1"
      ],
      "happy_returns_rma_id": "HRABCDEF",
      "happy_returns_shipment_id": "45678",
      "item_title": "T-Shirt",
      "order_name": "#1234",
      "po_number": "PO-123456",
      "return_id": 123,
      "shipment_id": 12345,
      "shipping_box_barcode": "SB-12345678",
      "sku": "SKU-123456",
      "tracking_number": "1Z1234567890",
      "variant_title": "Blue"
    }
  ],
  "first_page_url": "https://api.loopreturns.com/api/v1/happy-returns/shipments/123/items?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://api.loopreturns.com/api/v1/happy-returns/shipments/123/items?page=1",
  "next_page_url": "<string>",
  "path": "https://api.loopreturns.com/api/v1/happy-returns/shipments/123/items",
  "per_page": 200,
  "prev_page_url": "<string>",
  "to": 1,
  "total": 1
}

Authorizations

​
X-Authorization
string
header
required

Path Parameters

​
id
integer
required

The unique identifier associated with the shipment, assigned by Loop.

Response

200
application/json
Success
​
current_page
integer

The identifier associated with the current page.

​
data
object[]

The data for each item in the shipment.

​
first_page_url
string

The link to the first page of paginated results.

​
from
integer

The number of the first item on the page.

​
last_page
integer

The identifier associated with the last page.

​
last_page_url
string

The link to the last page of paginated results.

​
next_page_url
string

The link to the next page of paginated results.

​
path
string

The endpoint's path.

​
per_page
integer

The number of items per page.

​
prev_page_url
string

The link to the previous page of paginated results.

​
to
integer

The number of the last item on the page.

​
total
integer

The total number of items returned.

Get Shipments