Update warehouse
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"address": "<string>",
"street_address_1": "<string>",
"street_address_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"is_pick_location": true,
"return_name": "<string>",
"return_street_address_1": "<string>",
"return_street_address_2": "<string>",
"return_city": "<string>",
"return_state": "<string>",
"return_zip": "<string>",
"return_country": "<string>",
"return_phone": "<string>",
"return_email": "jsmith@example.com"
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}"
payload = {
"name": "<string>",
"address": "<string>",
"street_address_1": "<string>",
"street_address_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"is_pick_location": True,
"return_name": "<string>",
"return_street_address_1": "<string>",
"return_street_address_2": "<string>",
"return_city": "<string>",
"return_state": "<string>",
"return_zip": "<string>",
"return_country": "<string>",
"return_phone": "<string>",
"return_email": "jsmith@example.com"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
address: '<string>',
street_address_1: '<string>',
street_address_2: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
country: '<string>',
is_pick_location: true,
return_name: '<string>',
return_street_address_1: '<string>',
return_street_address_2: '<string>',
return_city: '<string>',
return_state: '<string>',
return_zip: '<string>',
return_country: '<string>',
return_phone: '<string>',
return_email: 'jsmith@example.com'
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}', 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://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}",
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' => '<string>',
'address' => '<string>',
'street_address_1' => '<string>',
'street_address_2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'country' => '<string>',
'is_pick_location' => true,
'return_name' => '<string>',
'return_street_address_1' => '<string>',
'return_street_address_2' => '<string>',
'return_city' => '<string>',
'return_state' => '<string>',
'return_zip' => '<string>',
'return_country' => '<string>',
'return_phone' => '<string>',
'return_email' => 'jsmith@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"street_address_1\": \"<string>\",\n \"street_address_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"is_pick_location\": true,\n \"return_name\": \"<string>\",\n \"return_street_address_1\": \"<string>\",\n \"return_street_address_2\": \"<string>\",\n \"return_city\": \"<string>\",\n \"return_state\": \"<string>\",\n \"return_zip\": \"<string>\",\n \"return_country\": \"<string>\",\n \"return_phone\": \"<string>\",\n \"return_email\": \"jsmith@example.com\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"street_address_1\": \"<string>\",\n \"street_address_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"is_pick_location\": true,\n \"return_name\": \"<string>\",\n \"return_street_address_1\": \"<string>\",\n \"return_street_address_2\": \"<string>\",\n \"return_city\": \"<string>\",\n \"return_state\": \"<string>\",\n \"return_zip\": \"<string>\",\n \"return_country\": \"<string>\",\n \"return_phone\": \"<string>\",\n \"return_email\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"street_address_1\": \"<string>\",\n \"street_address_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"is_pick_location\": true,\n \"return_name\": \"<string>\",\n \"return_street_address_1\": \"<string>\",\n \"return_street_address_2\": \"<string>\",\n \"return_city\": \"<string>\",\n \"return_state\": \"<string>\",\n \"return_zip\": \"<string>\",\n \"return_country\": \"<string>\",\n \"return_phone\": \"<string>\",\n \"return_email\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"status": "<string>",
"name": "<string>",
"address": "<string>",
"street_address_1": "<string>",
"street_address_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"is_pick_location": true,
"return_name": "<string>",
"return_street_address_1": "<string>",
"return_street_address_2": "<string>",
"return_city": "<string>",
"return_state": "<string>",
"return_zip": "<string>",
"return_country": "<string>",
"return_phone": "<string>",
"return_email": "jsmith@example.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Warehouses
Update warehouse
Update an existing warehouse. All fields are optional.
PUT
/
warehouses
/
{warehouseId}
Update warehouse
curl --request PUT \
--url https://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"address": "<string>",
"street_address_1": "<string>",
"street_address_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"is_pick_location": true,
"return_name": "<string>",
"return_street_address_1": "<string>",
"return_street_address_2": "<string>",
"return_city": "<string>",
"return_state": "<string>",
"return_zip": "<string>",
"return_country": "<string>",
"return_phone": "<string>",
"return_email": "jsmith@example.com"
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}"
payload = {
"name": "<string>",
"address": "<string>",
"street_address_1": "<string>",
"street_address_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"is_pick_location": True,
"return_name": "<string>",
"return_street_address_1": "<string>",
"return_street_address_2": "<string>",
"return_city": "<string>",
"return_state": "<string>",
"return_zip": "<string>",
"return_country": "<string>",
"return_phone": "<string>",
"return_email": "jsmith@example.com"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
address: '<string>',
street_address_1: '<string>',
street_address_2: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
country: '<string>',
is_pick_location: true,
return_name: '<string>',
return_street_address_1: '<string>',
return_street_address_2: '<string>',
return_city: '<string>',
return_state: '<string>',
return_zip: '<string>',
return_country: '<string>',
return_phone: '<string>',
return_email: 'jsmith@example.com'
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}', 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://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}",
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' => '<string>',
'address' => '<string>',
'street_address_1' => '<string>',
'street_address_2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'country' => '<string>',
'is_pick_location' => true,
'return_name' => '<string>',
'return_street_address_1' => '<string>',
'return_street_address_2' => '<string>',
'return_city' => '<string>',
'return_state' => '<string>',
'return_zip' => '<string>',
'return_country' => '<string>',
'return_phone' => '<string>',
'return_email' => 'jsmith@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"street_address_1\": \"<string>\",\n \"street_address_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"is_pick_location\": true,\n \"return_name\": \"<string>\",\n \"return_street_address_1\": \"<string>\",\n \"return_street_address_2\": \"<string>\",\n \"return_city\": \"<string>\",\n \"return_state\": \"<string>\",\n \"return_zip\": \"<string>\",\n \"return_country\": \"<string>\",\n \"return_phone\": \"<string>\",\n \"return_email\": \"jsmith@example.com\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"street_address_1\": \"<string>\",\n \"street_address_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"is_pick_location\": true,\n \"return_name\": \"<string>\",\n \"return_street_address_1\": \"<string>\",\n \"return_street_address_2\": \"<string>\",\n \"return_city\": \"<string>\",\n \"return_state\": \"<string>\",\n \"return_zip\": \"<string>\",\n \"return_country\": \"<string>\",\n \"return_phone\": \"<string>\",\n \"return_email\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/warehouses/{warehouseId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"street_address_1\": \"<string>\",\n \"street_address_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\",\n \"is_pick_location\": true,\n \"return_name\": \"<string>\",\n \"return_street_address_1\": \"<string>\",\n \"return_street_address_2\": \"<string>\",\n \"return_city\": \"<string>\",\n \"return_state\": \"<string>\",\n \"return_zip\": \"<string>\",\n \"return_country\": \"<string>\",\n \"return_phone\": \"<string>\",\n \"return_email\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"status": "<string>",
"name": "<string>",
"address": "<string>",
"street_address_1": "<string>",
"street_address_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"country": "<string>",
"is_pick_location": true,
"return_name": "<string>",
"return_street_address_1": "<string>",
"return_street_address_2": "<string>",
"return_city": "<string>",
"return_state": "<string>",
"return_zip": "<string>",
"return_country": "<string>",
"return_phone": "<string>",
"return_email": "jsmith@example.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
Warehouse ID
Body
application/json
Warehouse name
Maximum string length:
255Street address
Street address line 1
Street address line 2
City
Maximum string length:
255State/province
Maximum string length:
255Postal/ZIP code
Maximum string length:
255Country
Maximum string length:
255Whether this is a pick location
Return-address name/company.
Optional return address printed on carrier labels (currently ParcelPerform)
for orders shipped from this warehouse. The override applies when return_name
or return_street_address_1 is set; any blank field falls back to the
ship-from address. A warehouse group's return address takes precedence.
Maximum string length:
255Return-address street line 1
Maximum string length:
255Return-address street line 2
Maximum string length:
255Return-address city
Maximum string length:
255Return-address state/province
Maximum string length:
255Return-address postal/ZIP code
Maximum string length:
255Return-address country
Maximum string length:
255Return-address phone
Maximum string length:
50Return-address email
Maximum string length:
255Response
Warehouse updated
Warehouse ID
Warehouse status (e.g. active, inactive)
Warehouse name
Street address
Street address line 1
Street address line 2
City
State/province
Postal/ZIP code
Country
Whether this warehouse is a pick location
Return-address name/company.
Optional return address printed on carrier labels (currently ParcelPerform)
for orders shipped from this warehouse. The override applies when return_name
or return_street_address_1 is set; any blank field falls back to the
ship-from address. A warehouse group's return address takes precedence.
Return-address street line 1
Return-address street line 2
Return-address city
Return-address state/province
Return-address postal/ZIP code
Return-address country
Return-address phone
Return-address email
When the warehouse was created
When the warehouse was last updated