Get Shipment Items

Get all items for a Happy Returns shipment.

Required API key scope

• Happy Returns Shipments (Read)

GET /happy-returns/shipments/{id}/items

Get Shipment Items

cURL

curl --request GET \
  --url https://api.loopreturns.com/api/v1/happy-returns/shipments/{id}/items \
  --header 'X-Authorization: <api-key>'

200

{
  "current_page": 123,
  "data": [
    {
      "carrier": "<string>",
      "happy_returns_return_bag_barcodes": [
        "<string>"
      ],
      "happy_returns_rma_id": "<string>",
      "happy_returns_shipment_id": "<string>",
      "item_title": "<string>",
      "order_name": "<string>",
      "po_number": "<string>",
      "return_id": 123,
      "shipment_id": 123,
      "shipping_box_barcode": "<string>",
      "sku": "<string>",
      "tracking_number": "<string>",
      "variant_title": "<string>"
    }
  ],
  "first_page_url": "<string>",
  "from": 123,
  "last_page": 123,
  "last_page_url": "<string>",
  "next_page_url": "<string>",
  "path": "<string>",
  "per_page": 123,
  "prev_page_url": "<string>",
  "to": 123,
  "total": 123
}

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.

Example:

1

data · object[]

The data for each item in the shipment.

Show child attributes

first_page_url · string

The link to the first page of paginated results.

Example:

"https://api.loopreturns.com/api/v1/happy-returns/shipments/123/items?page=1"

from · integer

The number of the first item 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/123/items?page=1"

next_page_url · string

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/123/items"

per_page · integer

The number of items per page.

Example:

200

prev_page_url · string

The link to the previous page of paginated results.

to · integer

The number of the last item on the page.

Example:

1

total · integer

The total number of items returned.

Example:

1