Get Shipment Items

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

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.

data.carrier

string

The carrier associated with the item.

Example:

"ups"

data.happy_returns_return_bag_barcodes

string[]

The identifier that appears on Happy Returns polybags.

Example:

["HRABCDEF-1234-1"]

data.happy_returns_rma_id

string

The identifier shared with the customer for dropping the item off at a Return Bar.

Example:

"HRABCDEF"

data.happy_returns_shipment_id

string

The unique identifier associated with the shipment, assigned by Happy Returns.

Example:

"45678"

data.item_title

string

The name of the item.

Example:

"T-Shirt"

data.order_name

string

The name of the order.

Example:

"#1234"

data.po_number

string

The identifier associated with a consolidated shipment from Happy Returns.

Example:

"PO-123456"

data.return_id

integer

The return's unique identifier.

Example:

123

data.shipment_id

integer

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

Example:

12345

data.shipping_box_barcode

string

The identifier that appears on the outside of a consolidated box shipped by Happy Returns.

Example:

"SB-12345678"

data.sku

string

The SKU of the product variant being returned.

Example:

"SKU-123456"

data.tracking_number

string

The return's tracking number.

Example:

"1Z1234567890"

data.variant_title

string

The name of the product variant.

Example:

"Blue"

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.

integer

The number of the last item on the page.

Example:

1

total

integer

The total number of items returned.

Example:

1

Get Shipments List Label Requests

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
}

Using the API

APIs

Required API key scope

Authorizations

Path Parameters

Response