Skip to main content
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>"
}
'
{
  "id": "e4b6d4e8-8e6d-41da-abdb-8fc358a9e7f1",
  "name": "Armazém Norte",
  "code": "N-02",
  "isDefault": false
}

​
Body

​
name
string
required
Nome ou apelido do Armazém.
​
code
string
required
Código interno de rasteio (ex: SP-01). Retorna erro 409 se duplicar.
​
zipCode
string
CEP local (opcional).
​
address
string
Logradouro físico (opcional).
​
active
boolean
default:"true"
Status operacional de esteira do armazém.
​
isDefault
boolean
default:"false"
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
​
name
string
required

Nome do depósito

Example:

"Depósito Principal"

​
code
string

Código único (auto-gerado se vazio)

Example:

"DEP-001"

​
type
enum<string>
default:OWN

Tipo do depósito

Available options:
OWN,
STORE,
FULFILLMENT,
THIRD_PARTY
​
companyId
string

ID da empresa associada

​
address
object

Endereço do depósito

​
notes
string

Observações

Response

Depósito criado com sucesso