Create Location

Create a new location.

POST /locations

Create Location

cURL

curl --request POST \
  --url https://api.loopreturns.com/api/v1/locations \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "sales_channel": "<string>",
  "name": "<string>",
  "address": {
    "address1": "<string>",
    "city": "<string>",
    "country_code": "<string>",
    "name": "<string>",
    "company": "<string>",
    "address2": "<string>",
    "region": "<string>",
    "postal_code": "<string>"
  },
  "external_id": "<string>"
}
'

import requests

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

payload = {
    "sales_channel": "<string>",
    "name": "<string>",
    "address": {
        "address1": "<string>",
        "city": "<string>",
        "country_code": "<string>",
        "name": "<string>",
        "company": "<string>",
        "address2": "<string>",
        "region": "<string>",
        "postal_code": "<string>"
    },
    "external_id": "<string>"
}
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: '<string>',
    name: '<string>',
    address: {
      address1: '<string>',
      city: '<string>',
      country_code: '<string>',
      name: '<string>',
      company: '<string>',
      address2: '<string>',
      region: '<string>',
      postal_code: '<string>'
    },
    external_id: '<string>'
  })
};

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' => '<string>',
    'name' => '<string>',
    'address' => [
        'address1' => '<string>',
        'city' => '<string>',
        'country_code' => '<string>',
        'name' => '<string>',
        'company' => '<string>',
        'address2' => '<string>',
        'region' => '<string>',
        'postal_code' => '<string>'
    ],
    'external_id' => '<string>'
  ]),
  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\": \"<string>\",\n  \"name\": \"<string>\",\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"region\": \"<string>\",\n    \"postal_code\": \"<string>\"\n  },\n  \"external_id\": \"<string>\"\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\": \"<string>\",\n  \"name\": \"<string>\",\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"region\": \"<string>\",\n    \"postal_code\": \"<string>\"\n  },\n  \"external_id\": \"<string>\"\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\": \"<string>\",\n  \"name\": \"<string>\",\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"region\": \"<string>\",\n    \"postal_code\": \"<string>\"\n  },\n  \"external_id\": \"<string>\"\n}"

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

201

{
  "location": {
    "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>"
  }
}

{
  "errors": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

X-Authorization · string · header · required

API Scope: "Locations (write)"

Body

application/json

sales_channel · string · required

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: 255

Example:

"shopify"

name · string · required

The name of the location.

Maximum string length: 100

Example:

"Main Warehouse"

status · enum<string> · required

The status of the location.

Available options: active, inactive

Maximum string length: 100

address · object · required

The address of the location.

Show child attributes

external_id · string | null

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 - 64

Example:

"62291d16-9b61-4fbb-b868-21c2d32dc155"

Response

201

application/json

Success

location · object · required

Show child attributes