Criar novo depósito
curl --request POST \
--url https://api.example.com/warehouses \
--header 'Content-Type: application/json' \
--data '
{
"name": "Depósito Principal",
"code": "DEP-001",
"type": "OWN",
"companyId": "<string>",
"address": {
"street": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"notes": "<string>"
}
'import requests
url = "https://api.example.com/warehouses"
payload = {
"name": "Depósito Principal",
"code": "DEP-001",
"type": "OWN",
"companyId": "<string>",
"address": {
"street": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"notes": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Depósito Principal',
code: 'DEP-001',
type: 'OWN',
companyId: '<string>',
address: {
street: '<string>',
number: '<string>',
complement: '<string>',
neighborhood: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>'
},
notes: '<string>'
})
};
fetch('https://api.example.com/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/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' => 'Depósito Principal',
'code' => 'DEP-001',
'type' => 'OWN',
'companyId' => '<string>',
'address' => [
'street' => '<string>',
'number' => '<string>',
'complement' => '<string>',
'neighborhood' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>'
],
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/warehouses"
payload := strings.NewReader("{\n \"name\": \"Depósito Principal\",\n \"code\": \"DEP-001\",\n \"type\": \"OWN\",\n \"companyId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/warehouses")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Depósito Principal\",\n \"code\": \"DEP-001\",\n \"type\": \"OWN\",\n \"companyId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/warehouses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Depósito Principal\",\n \"code\": \"DEP-001\",\n \"type\": \"OWN\",\n \"companyId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "e4b6d4e8-8e6d-41da-abdb-8fc358a9e7f1",
"name": "Armazém Norte",
"code": "N-02",
"isDefault": false
}
Warehouses
Criar Depósito
Cria um novo Centro de Distribuição/Armazém no Hub, permitindo particionar o estoque cross-docking físico do seu negócio.
POST
/
warehouses
Criar novo depósito
curl --request POST \
--url https://api.example.com/warehouses \
--header 'Content-Type: application/json' \
--data '
{
"name": "Depósito Principal",
"code": "DEP-001",
"type": "OWN",
"companyId": "<string>",
"address": {
"street": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"notes": "<string>"
}
'import requests
url = "https://api.example.com/warehouses"
payload = {
"name": "Depósito Principal",
"code": "DEP-001",
"type": "OWN",
"companyId": "<string>",
"address": {
"street": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"notes": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Depósito Principal',
code: 'DEP-001',
type: 'OWN',
companyId: '<string>',
address: {
street: '<string>',
number: '<string>',
complement: '<string>',
neighborhood: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>'
},
notes: '<string>'
})
};
fetch('https://api.example.com/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/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' => 'Depósito Principal',
'code' => 'DEP-001',
'type' => 'OWN',
'companyId' => '<string>',
'address' => [
'street' => '<string>',
'number' => '<string>',
'complement' => '<string>',
'neighborhood' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>'
],
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/warehouses"
payload := strings.NewReader("{\n \"name\": \"Depósito Principal\",\n \"code\": \"DEP-001\",\n \"type\": \"OWN\",\n \"companyId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/warehouses")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Depósito Principal\",\n \"code\": \"DEP-001\",\n \"type\": \"OWN\",\n \"companyId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/warehouses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Depósito Principal\",\n \"code\": \"DEP-001\",\n \"type\": \"OWN\",\n \"companyId\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "e4b6d4e8-8e6d-41da-abdb-8fc358a9e7f1",
"name": "Armazém Norte",
"code": "N-02",
"isDefault": false
}
Body
Nome ou apelido do Armazém.
Código interno de rasteio (ex:
SP-01). Retorna erro 409 se duplicar.CEP local (opcional).
Logradouro físico (opcional).
Status operacional de esteira do armazém.
Se marcado como
true, assume como matriz e retira o flag de “default” dos outros.Response
{
"id": "e4b6d4e8-8e6d-41da-abdb-8fc358a9e7f1",
"name": "Armazém Norte",
"code": "N-02",
"isDefault": false
}
Body
application/json
Nome do depósito
Example:
"Depósito Principal"
Código único (auto-gerado se vazio)
Example:
"DEP-001"
Tipo do depósito
Available options:
OWN, STORE, FULFILLMENT, THIRD_PARTY ID da empresa associada
Endereço do depósito
Show child attributes
Show child attributes
Observações
Response
Depósito criado com sucesso
⌘I