Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Happy Returns Shipment Items

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

Path parameters

idinteger required

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

Query parameters

pageinteger
Example:1

The page number of paginated results to return.

Response

Success

current_pageinteger

The identifier associated with the current page.

first_page_urlstring

The link to the first page of paginated results.

frominteger

The number of the first item on the page.

last_pageinteger

The identifier associated with the last page.

last_page_urlstring

The link to the last page of paginated results.

next_page_urlstring nullable

The link to the next page of paginated results.

pathstring

The endpoint's path.

per_pageinteger

The number of items per page.

prev_page_urlstring nullable

The link to the previous page of paginated results.

tointeger

The number of the last item on the page.

totalinteger

The total number of items returned.

Example response

{
  "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",
      "created_at": "2024-03-19T12:34:56+00:00"
    }
  ],
  "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",
  "path": "https://api.loopreturns.com/api/v1/happy-returns/shipments/123/items",
  "per_page": 200,
  "to": 1,
  "total": 1
}