Create Location
curl --request POST \
--url https://api.loopreturns.com/api/v1/locations \
--header 'Content-Type: application/json' \
--header 'X-Authorization: <api-key>' \
--data '
{
"sales_channel": "shopify",
"name": "Main Warehouse",
"address": {
"address1": "1234 Example Street",
"city": "Townsville",
"country_code": "US",
"name": "Main Warehouse",
"company": "Universal Exports",
"address2": "Unit 19",
"region": "Louisiana",
"postal_code": 90210
},
"external_id": "62291d16-9b61-4fbb-b868-21c2d32dc155"
}
'import requests
url = "https://api.loopreturns.com/api/v1/locations"
payload = {
"sales_channel": "shopify",
"name": "Main Warehouse",
"address": {
"address1": "1234 Example Street",
"city": "Townsville",
"country_code": "US",
"name": "Main Warehouse",
"company": "Universal Exports",
"address2": "Unit 19",
"region": "Louisiana",
"postal_code": 90210
},
"external_id": "62291d16-9b61-4fbb-b868-21c2d32dc155"
}
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sales_channel: 'shopify',
name: 'Main Warehouse',
address: {
address1: '1234 Example Street',
city: 'Townsville',
country_code: 'US',
name: 'Main Warehouse',
company: 'Universal Exports',
address2: 'Unit 19',
region: 'Louisiana',
postal_code: 90210
},
external_id: '62291d16-9b61-4fbb-b868-21c2d32dc155'
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sales_channel' => 'shopify',
'name' => 'Main Warehouse',
'address' => [
'address1' => '1234 Example Street',
'city' => 'Townsville',
'country_code' => 'US',
'name' => 'Main Warehouse',
'company' => 'Universal Exports',
'address2' => 'Unit 19',
'region' => 'Louisiana',
'postal_code' => 90210
],
'external_id' => '62291d16-9b61-4fbb-b868-21c2d32dc155'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.loopreturns.com/api/v1/locations"
payload := strings.NewReader("{\n \"sales_channel\": \"shopify\",\n \"name\": \"Main Warehouse\",\n \"address\": {\n \"address1\": \"1234 Example Street\",\n \"city\": \"Townsville\",\n \"country_code\": \"US\",\n \"name\": \"Main Warehouse\",\n \"company\": \"Universal Exports\",\n \"address2\": \"Unit 19\",\n \"region\": \"Louisiana\",\n \"postal_code\": 90210\n },\n \"external_id\": \"62291d16-9b61-4fbb-b868-21c2d32dc155\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.loopreturns.com/api/v1/locations")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sales_channel\": \"shopify\",\n \"name\": \"Main Warehouse\",\n \"address\": {\n \"address1\": \"1234 Example Street\",\n \"city\": \"Townsville\",\n \"country_code\": \"US\",\n \"name\": \"Main Warehouse\",\n \"company\": \"Universal Exports\",\n \"address2\": \"Unit 19\",\n \"region\": \"Louisiana\",\n \"postal_code\": 90210\n },\n \"external_id\": \"62291d16-9b61-4fbb-b868-21c2d32dc155\"\n}")
.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::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sales_channel\": \"shopify\",\n \"name\": \"Main Warehouse\",\n \"address\": {\n \"address1\": \"1234 Example Street\",\n \"city\": \"Townsville\",\n \"country_code\": \"US\",\n \"name\": \"Main Warehouse\",\n \"company\": \"Universal Exports\",\n \"address2\": \"Unit 19\",\n \"region\": \"Louisiana\",\n \"postal_code\": 90210\n },\n \"external_id\": \"62291d16-9b61-4fbb-b868-21c2d32dc155\"\n}"
response = http.request(request)
puts response.read_body{
"location": {
"id": 9007199254740991,
"sales_channel": "shopify",
"name": "Main Warehouse",
"status": "active",
"address": {
"name": "Main Warehouse",
"company": "Universal Exports",
"address1": "1234 Example Street",
"address2": "Unit 19",
"city": "Townsville",
"region": "Louisiana",
"postal_code": 90210,
"country_code": "US"
},
"external_id": "62291d16-9b61-4fbb-b868-21c2d32dc155"
}
}{
"errors": "Unauthorized."
}{
"message": "The name field is required.",
"errors": {
"name": [
"The name field is required."
]
}
}Locations
Create Location
Create a new location.
POST
/
locations
Create Location
curl --request POST \
--url https://api.loopreturns.com/api/v1/locations \
--header 'Content-Type: application/json' \
--header 'X-Authorization: <api-key>' \
--data '
{
"sales_channel": "shopify",
"name": "Main Warehouse",
"address": {
"address1": "1234 Example Street",
"city": "Townsville",
"country_code": "US",
"name": "Main Warehouse",
"company": "Universal Exports",
"address2": "Unit 19",
"region": "Louisiana",
"postal_code": 90210
},
"external_id": "62291d16-9b61-4fbb-b868-21c2d32dc155"
}
'import requests
url = "https://api.loopreturns.com/api/v1/locations"
payload = {
"sales_channel": "shopify",
"name": "Main Warehouse",
"address": {
"address1": "1234 Example Street",
"city": "Townsville",
"country_code": "US",
"name": "Main Warehouse",
"company": "Universal Exports",
"address2": "Unit 19",
"region": "Louisiana",
"postal_code": 90210
},
"external_id": "62291d16-9b61-4fbb-b868-21c2d32dc155"
}
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sales_channel: 'shopify',
name: 'Main Warehouse',
address: {
address1: '1234 Example Street',
city: 'Townsville',
country_code: 'US',
name: 'Main Warehouse',
company: 'Universal Exports',
address2: 'Unit 19',
region: 'Louisiana',
postal_code: 90210
},
external_id: '62291d16-9b61-4fbb-b868-21c2d32dc155'
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sales_channel' => 'shopify',
'name' => 'Main Warehouse',
'address' => [
'address1' => '1234 Example Street',
'city' => 'Townsville',
'country_code' => 'US',
'name' => 'Main Warehouse',
'company' => 'Universal Exports',
'address2' => 'Unit 19',
'region' => 'Louisiana',
'postal_code' => 90210
],
'external_id' => '62291d16-9b61-4fbb-b868-21c2d32dc155'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.loopreturns.com/api/v1/locations"
payload := strings.NewReader("{\n \"sales_channel\": \"shopify\",\n \"name\": \"Main Warehouse\",\n \"address\": {\n \"address1\": \"1234 Example Street\",\n \"city\": \"Townsville\",\n \"country_code\": \"US\",\n \"name\": \"Main Warehouse\",\n \"company\": \"Universal Exports\",\n \"address2\": \"Unit 19\",\n \"region\": \"Louisiana\",\n \"postal_code\": 90210\n },\n \"external_id\": \"62291d16-9b61-4fbb-b868-21c2d32dc155\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.loopreturns.com/api/v1/locations")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sales_channel\": \"shopify\",\n \"name\": \"Main Warehouse\",\n \"address\": {\n \"address1\": \"1234 Example Street\",\n \"city\": \"Townsville\",\n \"country_code\": \"US\",\n \"name\": \"Main Warehouse\",\n \"company\": \"Universal Exports\",\n \"address2\": \"Unit 19\",\n \"region\": \"Louisiana\",\n \"postal_code\": 90210\n },\n \"external_id\": \"62291d16-9b61-4fbb-b868-21c2d32dc155\"\n}")
.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::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sales_channel\": \"shopify\",\n \"name\": \"Main Warehouse\",\n \"address\": {\n \"address1\": \"1234 Example Street\",\n \"city\": \"Townsville\",\n \"country_code\": \"US\",\n \"name\": \"Main Warehouse\",\n \"company\": \"Universal Exports\",\n \"address2\": \"Unit 19\",\n \"region\": \"Louisiana\",\n \"postal_code\": 90210\n },\n \"external_id\": \"62291d16-9b61-4fbb-b868-21c2d32dc155\"\n}"
response = http.request(request)
puts response.read_body{
"location": {
"id": 9007199254740991,
"sales_channel": "shopify",
"name": "Main Warehouse",
"status": "active",
"address": {
"name": "Main Warehouse",
"company": "Universal Exports",
"address1": "1234 Example Street",
"address2": "Unit 19",
"city": "Townsville",
"region": "Louisiana",
"postal_code": 90210,
"country_code": "US"
},
"external_id": "62291d16-9b61-4fbb-b868-21c2d32dc155"
}
}{
"errors": "Unauthorized."
}{
"message": "The name field is required.",
"errors": {
"name": [
"The name field is required."
]
}
}Authorizations
API Scope: "Locations (write)"
Body
application/json
If a channel with this name is not already associated with the shop, it will be used to create a new channel.
Maximum string length:
255Example:
"shopify"
The name of the location.
Maximum string length:
100Example:
"Main Warehouse"
The status of the location.
Available options:
active, inactive Maximum string length:
100The address of the location.
Show child attributes
Show child attributes
The provided external_id must be unique. If a non-unique external_id is provided, the API will respond with an error.
Required string length:
1 - 64Example:
"62291d16-9b61-4fbb-b868-21c2d32dc155"
Response
Success
Show child attributes
Show child attributes