Create a warehouse
curl --request POST \
--url https://api.example.com/api/warehouses \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'organization-id: <organization-id>' \
--data '
{
"name": "<string>",
"primary": true,
"code": "<string>",
"address": "<string>",
"city": "<string>",
"country": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"website": "<string>"
}
'import requests
url = "https://api.example.com/api/warehouses"
payload = {
"name": "<string>",
"primary": True,
"code": "<string>",
"address": "<string>",
"city": "<string>",
"country": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"website": "<string>"
}
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'organization-id': '<organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
primary: true,
code: '<string>',
address: '<string>',
city: '<string>',
country: '<string>',
phoneNumber: '<string>',
email: '<string>',
website: '<string>'
})
};
fetch('https://api.example.com/api/warehouses', 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.example.com/api/warehouses",
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>',
'primary' => true,
'code' => '<string>',
'address' => '<string>',
'city' => '<string>',
'country' => '<string>',
'phoneNumber' => '<string>',
'email' => '<string>',
'website' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"organization-id: <organization-id>"
],
]);
$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.example.com/api/warehouses"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"primary\": true,\n \"code\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
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.example.com/api/warehouses")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"primary\": true,\n \"code\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/warehouses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"primary\": true,\n \"code\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyWarehouses
Create a warehouse
POST
/
api
/
warehouses
Create a warehouse
curl --request POST \
--url https://api.example.com/api/warehouses \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'organization-id: <organization-id>' \
--data '
{
"name": "<string>",
"primary": true,
"code": "<string>",
"address": "<string>",
"city": "<string>",
"country": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"website": "<string>"
}
'import requests
url = "https://api.example.com/api/warehouses"
payload = {
"name": "<string>",
"primary": True,
"code": "<string>",
"address": "<string>",
"city": "<string>",
"country": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"website": "<string>"
}
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'organization-id': '<organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
primary: true,
code: '<string>',
address: '<string>',
city: '<string>',
country: '<string>',
phoneNumber: '<string>',
email: '<string>',
website: '<string>'
})
};
fetch('https://api.example.com/api/warehouses', 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.example.com/api/warehouses",
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>',
'primary' => true,
'code' => '<string>',
'address' => '<string>',
'city' => '<string>',
'country' => '<string>',
'phoneNumber' => '<string>',
'email' => '<string>',
'website' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"organization-id: <organization-id>"
],
]);
$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.example.com/api/warehouses"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"primary\": true,\n \"code\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
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.example.com/api/warehouses")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"primary\": true,\n \"code\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/warehouses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"primary\": true,\n \"code\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"website\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyHeaders
Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.
Example:
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Body
application/json
The name of the warehouse
Whether the warehouse is primary
The code of the warehouse
The address of the warehouse
The city of the warehouse
The country of the warehouse
The phone number of the warehouse
The email of the warehouse
The website of the warehouse
Response
201 - undefined
⌘I