List Locations

Retrieve a list of locations. The list can be filtered, sorted, and paginated using the parameters below.

GET /locations

List Locations

cURL

curl --request GET \
  --url https://api.loopreturns.com/api/v1/locations \
  --header 'X-Authorization: <api-key>'

import requests

url = "https://api.loopreturns.com/api/v1/locations"

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/locations', 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/locations",
  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/locations"

	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/locations")
  .header("X-Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.loopreturns.com/api/v1/locations")

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

{
  "locations": [
    {
      "id": 123,
      "sales_channel": "<string>",
      "name": "<string>",
      "address": {
        "name": "<string>",
        "company": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "region": "<string>",
        "postal_code": "<string>",
        "country_code": "<string>"
      },
      "external_id": "<string>"
    }
  ],
  "next_page_url": "<string>",
  "previous_page_url": "<string>"
}

{
  "errors": "<string>"
}

Authorizations

X-Authorization · string · header · required

API Scope: "Locations (read)"

Query Parameters

external_id · string

An external_id used to filter the locations.

Maximum string length: 64

limit · integer · default: 50

The maximum number of locations returned.

Required range: x <= 250

sort_order · enum<string> · default: asc

The sort order for the results.

Available options: asc, desc

cursor · string

The cursor to return the next page of results.

Response

200

application/json

Success

locations · object[] · required

Show child attributes

next_page_url · string | null

previous_page_url · string | null