Update Destination

Update a destination.

Required API key scope

• Destinations (Write)

PUT /destinations/{id}

Update Destination

cURL

curl --request PUT \
  --url https://api.loopreturns.com/api/v1/destinations/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "name": "Example Destination",
  "type": "warehouse",
  "address": {
    "address1": "123 Main St",
    "city": "Columbus",
    "country": "United States",
    "country_code": "US",
    "name": "Main Warehouse",
    "company": "Universal Exports",
    "address2": "Unit 456",
    "state": "Ohio",
    "zip": "43210",
    "phone": "[phone]"
  },
  "enabled": true
}
'

import requests

url = "https://api.loopreturns.com/api/v1/destinations/{id}"

payload = {
    "name": "Example Destination",
    "type": "warehouse",
    "address": {
        "address1": "123 Main St",
        "city": "Columbus",
        "country": "United States",
        "country_code": "US",
        "name": "Main Warehouse",
        "company": "Universal Exports",
        "address2": "Unit 456",
        "state": "Ohio",
        "zip": "43210",
        "phone": "[phone]"
    },
    "enabled": True
}
headers = {
    "X-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Example Destination',
    type: 'warehouse',
    address: {
      address1: '123 Main St',
      city: 'Columbus',
      country: 'United States',
      country_code: 'US',
      name: 'Main Warehouse',
      company: 'Universal Exports',
      address2: 'Unit 456',
      state: 'Ohio',
      zip: '43210',
      phone: '[phone]'
    },
    enabled: true
  })
};

fetch('https://api.loopreturns.com/api/v1/destinations/{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/destinations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Example Destination',
    'type' => 'warehouse',
    'address' => [
        'address1' => '123 Main St',
        'city' => 'Columbus',
        'country' => 'United States',
        'country_code' => 'US',
        'name' => 'Main Warehouse',
        'company' => 'Universal Exports',
        'address2' => 'Unit 456',
        'state' => 'Ohio',
        'zip' => '43210',
        'phone' => '[phone]'
    ],
    'enabled' => true
  ]),
  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/destinations/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Example Destination\",\n  \"type\": \"warehouse\",\n  \"address\": {\n    \"address1\": \"123 Main St\",\n    \"city\": \"Columbus\",\n    \"country\": \"United States\",\n    \"country_code\": \"US\",\n    \"name\": \"Main Warehouse\",\n    \"company\": \"Universal Exports\",\n    \"address2\": \"Unit 456\",\n    \"state\": \"Ohio\",\n    \"zip\": \"43210\",\n    \"phone\": \"[phone]\"\n  },\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.loopreturns.com/api/v1/destinations/{id}")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Example Destination\",\n  \"type\": \"warehouse\",\n  \"address\": {\n    \"address1\": \"123 Main St\",\n    \"city\": \"Columbus\",\n    \"country\": \"United States\",\n    \"country_code\": \"US\",\n    \"name\": \"Main Warehouse\",\n    \"company\": \"Universal Exports\",\n    \"address2\": \"Unit 456\",\n    \"state\": \"Ohio\",\n    \"zip\": \"43210\",\n    \"phone\": \"[phone]\"\n  },\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Example Destination\",\n  \"type\": \"warehouse\",\n  \"address\": {\n    \"address1\": \"123 Main St\",\n    \"city\": \"Columbus\",\n    \"country\": \"United States\",\n    \"country_code\": \"US\",\n    \"name\": \"Main Warehouse\",\n    \"company\": \"Universal Exports\",\n    \"address2\": \"Unit 456\",\n    \"state\": \"Ohio\",\n    \"zip\": \"43210\",\n    \"phone\": \"[phone]\"\n  },\n  \"enabled\": true\n}"

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

200

{
  "id": 1,
  "type": "warehouse",
  "name": "Example Destination",
  "enabled": true,
  "provider_location_id": 42424242,
  "address": {
    "name": "Main Warehouse",
    "company": "Universal Exports",
    "address1": "123 Main St",
    "address2": "Unit 456",
    "city": "Columbus",
    "state": "Ohio",
    "zip": "43210",
    "country": "United States",
    "country_code": "US"
  }
}

{
  "errors": "Unauthorized."
}

{
  "code": "NOT_FOUND",
  "message": "The destination could not be found. Please verify that the provided id is correct."
}

{
  "message": "The name field is required."
}

Authorizations

X-Authorization · string · header · required

Path Parameters

id · integer · required

The destination's unique identifier.

Body

application/json

name · string · required

The destination's name.

Maximum string length: 191

Example:

"Example Destination"

type · enum<string> · required

The type of location represented by the destination.

Available options: warehouse, donate

Example:

"warehouse"

address · object · required

The destination's address.

Show child attributes

enabled · boolean

Whether the destination is enabled as a return destination.

Example:

true

Response

200

application/json

Success

A physical location such as a warehouse or donation center to which returns are shipped.

id · integer

The destination's unique identifier.

Example:

1

type · enum<string>

The type of location represented by the destination.

Available options: warehouse, donate

Example:

"warehouse"

name · string

The destination's name.

Example:

"Example Destination"

enabled · boolean

Whether the destination is enabled as a return destination.

Example:

true

provider_location_id · integer | null

The numeric location identifier from the commerce platform (for example Shopify) when a location is linked to this destination in Loop. null when no location is linked. The linked location's source field indicates which provider the ID belongs to.

Example:

42424242

address · object

The destination's address.

Show child attributes