Create warehouse group
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/warehouse-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"warehouse_ids": [
123
],
"default_warehouse_id": 123,
"externally_managed": true,
"externally_managed_app_integration_account_id": 123,
"externally_managed_warehouse": "<string>",
"app_integration_account_inventory_location_id": 123,
"pull_stocks": true,
"pull_shipments": 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/warehouse-groups"
payload = {
"name": "<string>",
"description": "<string>",
"warehouse_ids": [123],
"default_warehouse_id": 123,
"externally_managed": True,
"externally_managed_app_integration_account_id": 123,
"externally_managed_warehouse": "<string>",
"app_integration_account_inventory_location_id": 123,
"pull_stocks": True,
"pull_shipments": 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.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
warehouse_ids: [123],
default_warehouse_id: 123,
externally_managed: true,
externally_managed_app_integration_account_id: 123,
externally_managed_warehouse: '<string>',
app_integration_account_inventory_location_id: 123,
pull_stocks: true,
pull_shipments: 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/warehouse-groups', 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/warehouse-groups",
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([
'name' => '<string>',
'description' => '<string>',
'warehouse_ids' => [
123
],
'default_warehouse_id' => 123,
'externally_managed' => true,
'externally_managed_app_integration_account_id' => 123,
'externally_managed_warehouse' => '<string>',
'app_integration_account_inventory_location_id' => 123,
'pull_stocks' => true,
'pull_shipments' => 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/warehouse-groups"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouse_ids\": [\n 123\n ],\n \"default_warehouse_id\": 123,\n \"externally_managed\": true,\n \"externally_managed_app_integration_account_id\": 123,\n \"externally_managed_warehouse\": \"<string>\",\n \"app_integration_account_inventory_location_id\": 123,\n \"pull_stocks\": true,\n \"pull_shipments\": 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("POST", 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.post("https://{companyName}.api.joinluminous.com/external/api/v1/warehouse-groups")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouse_ids\": [\n 123\n ],\n \"default_warehouse_id\": 123,\n \"externally_managed\": true,\n \"externally_managed_app_integration_account_id\": 123,\n \"externally_managed_warehouse\": \"<string>\",\n \"app_integration_account_inventory_location_id\": 123,\n \"pull_stocks\": true,\n \"pull_shipments\": 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/warehouse-groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouse_ids\": [\n 123\n ],\n \"default_warehouse_id\": 123,\n \"externally_managed\": true,\n \"externally_managed_app_integration_account_id\": 123,\n \"externally_managed_warehouse\": \"<string>\",\n \"app_integration_account_inventory_location_id\": 123,\n \"pull_stocks\": true,\n \"pull_shipments\": 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{
"data": {
"id": 123,
"uuid": "<string>",
"name": "<string>",
"description": "<string>",
"externally_managed": true,
"externally_managed_app_integration_account_id": 123,
"externally_managed_warehouse": "<string>",
"app_integration_account_inventory_location_id": 123,
"pull_stocks": true,
"pull_shipments": 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",
"warehouses": [
{
"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"
}
],
"default_warehouse": {
"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"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}Warehouse Groups
Create warehouse group
Create a new warehouse group with optional warehouse assignments.
POST
/
warehouse-groups
Create warehouse group
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/warehouse-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"warehouse_ids": [
123
],
"default_warehouse_id": 123,
"externally_managed": true,
"externally_managed_app_integration_account_id": 123,
"externally_managed_warehouse": "<string>",
"app_integration_account_inventory_location_id": 123,
"pull_stocks": true,
"pull_shipments": 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/warehouse-groups"
payload = {
"name": "<string>",
"description": "<string>",
"warehouse_ids": [123],
"default_warehouse_id": 123,
"externally_managed": True,
"externally_managed_app_integration_account_id": 123,
"externally_managed_warehouse": "<string>",
"app_integration_account_inventory_location_id": 123,
"pull_stocks": True,
"pull_shipments": 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.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
warehouse_ids: [123],
default_warehouse_id: 123,
externally_managed: true,
externally_managed_app_integration_account_id: 123,
externally_managed_warehouse: '<string>',
app_integration_account_inventory_location_id: 123,
pull_stocks: true,
pull_shipments: 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/warehouse-groups', 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/warehouse-groups",
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([
'name' => '<string>',
'description' => '<string>',
'warehouse_ids' => [
123
],
'default_warehouse_id' => 123,
'externally_managed' => true,
'externally_managed_app_integration_account_id' => 123,
'externally_managed_warehouse' => '<string>',
'app_integration_account_inventory_location_id' => 123,
'pull_stocks' => true,
'pull_shipments' => 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/warehouse-groups"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouse_ids\": [\n 123\n ],\n \"default_warehouse_id\": 123,\n \"externally_managed\": true,\n \"externally_managed_app_integration_account_id\": 123,\n \"externally_managed_warehouse\": \"<string>\",\n \"app_integration_account_inventory_location_id\": 123,\n \"pull_stocks\": true,\n \"pull_shipments\": 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("POST", 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.post("https://{companyName}.api.joinluminous.com/external/api/v1/warehouse-groups")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouse_ids\": [\n 123\n ],\n \"default_warehouse_id\": 123,\n \"externally_managed\": true,\n \"externally_managed_app_integration_account_id\": 123,\n \"externally_managed_warehouse\": \"<string>\",\n \"app_integration_account_inventory_location_id\": 123,\n \"pull_stocks\": true,\n \"pull_shipments\": 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/warehouse-groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"warehouse_ids\": [\n 123\n ],\n \"default_warehouse_id\": 123,\n \"externally_managed\": true,\n \"externally_managed_app_integration_account_id\": 123,\n \"externally_managed_warehouse\": \"<string>\",\n \"app_integration_account_inventory_location_id\": 123,\n \"pull_stocks\": true,\n \"pull_shipments\": 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{
"data": {
"id": 123,
"uuid": "<string>",
"name": "<string>",
"description": "<string>",
"externally_managed": true,
"externally_managed_app_integration_account_id": 123,
"externally_managed_warehouse": "<string>",
"app_integration_account_inventory_location_id": 123,
"pull_stocks": true,
"pull_shipments": 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",
"warehouses": [
{
"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"
}
],
"default_warehouse": {
"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"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Body
application/json
Warehouse group name
Maximum string length:
255Warehouse group description
IDs of warehouses to assign to this group
ID of the default warehouse for this group
Set to true to mark this warehouse group as managed by an
external WMS integration. When true,
externally_managed_app_integration_account_id, pull_stocks,
and pull_shipments become required.
ID of the app integration account that owns this group.
Required when externally_managed is true.
External WMS-side warehouse identifier.
ID of the inventory location within the app integration account
that this group maps to. Each external warehouse location may be
mapped to at most one externally-managed warehouse group — setting
this to a location already held by another such group returns 422.
Whether to pull stock levels from the external WMS.
Required when externally_managed is true.
Whether to pull shipments from the external WMS.
Required when externally_managed is true.
Return-address name/company.
Optional return address printed on carrier labels (currently ParcelPerform)
for fulfillment orders shipped from this warehouse group. Takes precedence over
the default warehouse's return address. The override applies when return_name
or return_street_address_1 is set; any blank field falls back to the ship-from address.
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 group created
Show child attributes
Show child attributes