Get Shipment Information

Get high level information from a Happy Returns shipment.

Required API key scope

• Happy Returns Shipments (Read)

GET /happy-returns/shipments/{happy_returns_shipment_id}

Get Shipment Information

cURL

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

import requests

url = "https://api.loopreturns.com/api/v1/happy-returns/shipments/{happy_returns_shipment_id}"

headers = {"X-Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Authorization': '<api-key>'}};

fetch('https://api.loopreturns.com/api/v1/happy-returns/shipments/{happy_returns_shipment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.loopreturns.com/api/v1/happy-returns/shipments/{happy_returns_shipment_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.loopreturns.com/api/v1/happy-returns/shipments/{happy_returns_shipment_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.loopreturns.com/api/v1/happy-returns/shipments/{happy_returns_shipment_id}")
  .header("X-Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.loopreturns.com/api/v1/happy-returns/shipments/{happy_returns_shipment_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "loop_shipment_id": 123,
  "happy_returns_shipment_id": "<string>",
  "line_item_count": 123,
  "return_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "errors": "<string>"
}

{
  "message": "<string>"
}

Authorizations

X-Authorization · string · header · required

Path Parameters

happy_returns_shipment_id · string · required

The unique identifier associated with the shipment.

Response

200

application/json

Success

loop_shipment_id · integer

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

Example:

12345

happy_returns_shipment_id · string

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

Example:

"123456"

line_item_count · integer

The number of line items included in the shipment.

Example:

2

return_count · integer

The number of Loop returns represented in the shipment.

Example:

1

created_at · string<date-time>

The date and time at which the shipment was created, using the ISO 8601 date format.

Example:

"2024-03-19T12:34:56+00:00"

updated_at · string<date-time>

The date and time at which the shipment was last updated, using the ISO 8601 date format.

Example:

"2024-03-20T12:34:56+00:00"