Warehouses

Part of the Inventory API. Base URL https://your-domain.com/admin/api/v1 — replace the host with your own installation and the token placeholder with a real Bearer token (see Authentication).

List warehouses

GET /admin/api/v1/inventories/warehouses

Retrieve a paginated list of warehouses with filtering and sorting

🔒 Requires a valid Bearer token.

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include. Available options: company, partnerAddress, creator, locations, supplierWarehouses, routes	`company,partnerAddress`
`filter[id]`	string	No	Comma-separated list of IDs to filter by	`architecto`
`filter[name]`	string	No	Filter by warehouse name	`Main`
`filter[code]`	string	No	Filter by warehouse code	`WH`
`filter[company_id]`	string	No	Filter by company IDs	`architecto`
`filter[partner_address_id]`	string	No	Filter by partner address IDs	`architecto`
`sort`	string	No	Sort field	`-created_at`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/inventories/warehouses?include=company%2CpartnerAddress&filter%5Bid%5D=architecto&filter%5Bname%5D=Main&filter%5Bcode%5D=WH&filter%5Bcompany_id%5D=architecto&filter%5Bpartner_address_id%5D=architecto&sort=-created_at" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/warehouses?include=company%2CpartnerAddress&filter%5Bid%5D=architecto&filter%5Bname%5D=Main&filter%5Bcode%5D=WH&filter%5Bcompany_id%5D=architecto&filter%5Bpartner_address_id%5D=architecto&sort=-created_at", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/inventories/warehouses?include=company%2CpartnerAddress&filter%5Bid%5D=architecto&filter%5Bname%5D=Main&filter%5Bcode%5D=WH&filter%5Bcompany_id%5D=architecto&filter%5Bpartner_address_id%5D=architecto&sort=-created_at', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/warehouses?include=company%2CpartnerAddress&filter%5Bid%5D=architecto&filter%5Bname%5D=Main&filter%5Bcode%5D=WH&filter%5Bcompany_id%5D=architecto&filter%5Bpartner_address_id%5D=architecto&sort=-created_at"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": [
    {
      "id": 1,
      "name": "Your Company",
      "code": "WH",
      "sort": 1,
      "reception_steps": "one_step",
      "delivery_steps": "one_step",
      "created_at": "2026-10-12T09:59:23.000000Z",
      "updated_at": "2026-10-12T09:59:23.000000Z",
      "deleted_at": null
    },
    {
      "id": 1,
      "name": "Your Company",
      "code": "WH",
      "sort": 1,
      "reception_steps": "one_step",
      "delivery_steps": "one_step",
      "created_at": "2026-10-12T09:59:23.000000Z",
      "updated_at": "2026-10-12T09:59:23.000000Z",
      "deleted_at": null
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "page": null,
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "page": null,
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Create warehouse

POST /admin/api/v1/inventories/warehouses

Create a new warehouse

🔒 Requires a valid Bearer token.

Body parameters

Parameter	Type	Required	Description
`name`	string	Yes	Warehouse name. Must not be greater than 255 characters.
`code`	string	Yes	Warehouse code. Must not be greater than 255 characters.
`company_id`	integer	Yes	Company ID. Must match an existing stored value.
`partner_address_id`	integer	No	Partner address ID. Must match an existing stored value.
`reception_steps`	string	No	Incoming shipment workflow step value.
`delivery_steps`	string	No	Outgoing shipment workflow step value.
`supplier_warehouses`	integer[]	No	Must match an existing stored value.

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/inventories/warehouses" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Main Warehouse",
  "code": "WH-MAIN",
  "company_id": 1,
  "partner_address_id": 10,
  "reception_steps": "one_step",
  "delivery_steps": "one_step",
  "supplier_warehouses": [
    16
  ]
}'

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/warehouses", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "Main Warehouse",
  "code": "WH-MAIN",
  "company_id": 1,
  "partner_address_id": 10,
  "reception_steps": "one_step",
  "delivery_steps": "one_step",
  "supplier_warehouses": [
    16
  ]
}),
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/inventories/warehouses', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'name' => 'Main Warehouse',
    'code' => 'WH-MAIN',
    'company_id' => 1,
    'partner_address_id' => 10,
    'reception_steps' => 'one_step',
    'delivery_steps' => 'one_step',
    'supplier_warehouses' => [
      16,
    ],
  ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/warehouses"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "name": "Main Warehouse",
    "code": "WH-MAIN",
    "company_id": 1,
    "partner_address_id": 10,
    "reception_steps": "one_step",
    "delivery_steps": "one_step",
    "supplier_warehouses": [
        16,
    ],
}

response = requests.post(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 201

json

{
  "data": {
    "id": 1,
    "name": "Your Company",
    "code": "WH",
    "sort": 1,
    "reception_steps": "one_step",
    "delivery_steps": "one_step",
    "created_at": "2026-10-12T09:59:23.000000Z",
    "updated_at": "2026-10-12T09:59:23.000000Z",
    "deleted_at": null
  },
  "message": "Warehouse created successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Show warehouse

GET /admin/api/v1/inventories/warehouses/{id}

Retrieve a specific warehouse by ID

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The warehouse ID

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include. Available options: company, partnerAddress, creator, locations, supplierWarehouses, routes	`company,locations`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/inventories/warehouses/{id}?include=company%2Clocations" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/warehouses/{id}?include=company%2Clocations", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/inventories/warehouses/{id}?include=company%2Clocations', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/warehouses/{id}?include=company%2Clocations"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": 1,
    "name": "Your Company",
    "code": "WH",
    "sort": 1,
    "reception_steps": "one_step",
    "delivery_steps": "one_step",
    "created_at": "2026-10-12T09:59:23.000000Z",
    "updated_at": "2026-10-12T09:59:23.000000Z",
    "deleted_at": null
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Update warehouse

PUT /admin/api/v1/inventories/warehouses/{id}

Update an existing warehouse

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The warehouse ID

Body parameters

Parameter	Type	Required	Description
`name`	string	No	Warehouse name. Must not be greater than 255 characters.
`code`	string	No	Warehouse code. Must not be greater than 255 characters.
`company_id`	integer	No	Company ID. Must match an existing stored value.
`partner_address_id`	integer	No	Partner address ID. Must match an existing stored value.
`reception_steps`	string	No	Incoming shipment workflow step value.
`delivery_steps`	string	No	Outgoing shipment workflow step value.
`supplier_warehouses`	integer[]	No	Must match an existing stored value.

cURLJavaScriptPHPPython

bash

curl -X PUT "https://your-domain.com/admin/api/v1/inventories/warehouses/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Main Warehouse",
  "code": "WH-MAIN",
  "company_id": 1,
  "partner_address_id": 10,
  "reception_steps": "one_step",
  "delivery_steps": "one_step",
  "supplier_warehouses": [
    16
  ]
}'

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/warehouses/{id}", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "Main Warehouse",
  "code": "WH-MAIN",
  "company_id": 1,
  "partner_address_id": 10,
  "reception_steps": "one_step",
  "delivery_steps": "one_step",
  "supplier_warehouses": [
    16
  ]
}),
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-domain.com/admin/api/v1/inventories/warehouses/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'name' => 'Main Warehouse',
    'code' => 'WH-MAIN',
    'company_id' => 1,
    'partner_address_id' => 10,
    'reception_steps' => 'one_step',
    'delivery_steps' => 'one_step',
    'supplier_warehouses' => [
      16,
    ],
  ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/warehouses/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "name": "Main Warehouse",
    "code": "WH-MAIN",
    "company_id": 1,
    "partner_address_id": 10,
    "reception_steps": "one_step",
    "delivery_steps": "one_step",
    "supplier_warehouses": [
        16,
    ],
}

response = requests.put(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": 1,
    "name": "Your Company",
    "code": "WH",
    "sort": 1,
    "reception_steps": "one_step",
    "delivery_steps": "one_step",
    "created_at": "2026-10-12T09:59:23.000000Z",
    "updated_at": "2026-10-12T09:59:23.000000Z",
    "deleted_at": null
  },
  "message": "Warehouse updated successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Delete warehouse

DELETE /admin/api/v1/inventories/warehouses/{id}

Soft delete a warehouse

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The warehouse ID

cURLJavaScriptPHPPython

bash

curl -X DELETE "https://your-domain.com/admin/api/v1/inventories/warehouses/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/warehouses/{id}", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-domain.com/admin/api/v1/inventories/warehouses/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/warehouses/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.delete(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "message": "Warehouse deleted successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Restore warehouse

POST /admin/api/v1/inventories/warehouses/{id}/restore

Restore a soft deleted warehouse

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The warehouse ID

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/inventories/warehouses/{id}/restore" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/warehouses/{id}/restore", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/inventories/warehouses/{id}/restore', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/warehouses/{id}/restore"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.post(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": 1,
    "name": "Your Company",
    "code": "WH",
    "sort": 1,
    "reception_steps": "one_step",
    "delivery_steps": "one_step",
    "created_at": "2026-10-12T09:59:23.000000Z",
    "updated_at": "2026-10-12T09:59:23.000000Z",
    "deleted_at": null
  },
  "message": "Warehouse restored successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Force delete warehouse

DELETE /admin/api/v1/inventories/warehouses/{id}/force

Permanently delete a warehouse

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The warehouse ID

cURLJavaScriptPHPPython

bash

curl -X DELETE "https://your-domain.com/admin/api/v1/inventories/warehouses/{id}/force" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/warehouses/{id}/force", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-domain.com/admin/api/v1/inventories/warehouses/{id}/force', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/warehouses/{id}/force"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.delete(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "message": "Warehouse permanently deleted successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Warehouses ​

List warehouses ​

Create warehouse ​

Show warehouse ​

Update warehouse ​

Delete warehouse ​

Restore warehouse ​

Force delete warehouse ​

Warehouses

List warehouses

Create warehouse

Show warehouse

Update warehouse

Delete warehouse

Restore warehouse

Force delete warehouse