Get Return Notes

Get notes on a specific return using the return’s ID.

Required API key scope

• Returns

GET /warehouse/return/{id}/notes

Get Return Notes

cURL

curl --request GET \
  --url https://api.loopreturns.com/api/v1/warehouse/return/{id}/notes \
  --header 'X-Authorization: <api-key>'

import requests

url = "https://api.loopreturns.com/api/v1/warehouse/return/{id}/notes"

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/warehouse/return/{id}/notes', 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/warehouse/return/{id}/notes",
  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/warehouse/return/{id}/notes"

	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/warehouse/return/{id}/notes")
  .header("X-Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.loopreturns.com/api/v1/warehouse/return/{id}/notes")

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

[
  {
    "id": 123,
    "content": "<string>",
    "created_at": "<string>"
  }
]

{
  "errors": "<string>"
}

true

Authorizations

X-Authorization · string · header · required

Path Parameters

id · integer · required

The unique identifier associated with the return.

Response

200

application/json

Success

id · integer

The unique identifier associated with the return note.

Example:

1

content · string

The content of the note.

Example:

"This is a sample note"

created_at · string

The date and time at which the note was created, in Y-m-d H:i:s format.

Example:

"2023-08-15 13:19:20"