omnilabs.shomnilabs.shdocs
Log InGet demo
ChannelReportingSaleProduct GroupProductWarehouseCarrierTemplateWebhooks
Log InGet demo

Warehouse

Endpoints for managing warehouses in the system.

# Endpoints

  • GET/warehouses# Retrieve a list of all warehouses with pagination support.
  • GET/warehouse/{warehouse_id}# Retrieve details of a specific warehouse by ID.
  • POST/warehouse# Create a new warehouse.
  • PUT/warehouse/{warehouse_id}# Update details of an existing warehouse by ID.
  • DELETE/warehouse/{warehouse_id}# Delete a warehouse by ID.

Warehouse

id

The unique identifier of the warehouse.

team_id

The team ID associated with the warehouse.

name

The name of the warehouse.

address_id

The address ID associated with the warehouse.

carrier_id

The carrier ID associated with the warehouse.

created_at

The date and time when the warehouse was created.

address

The address details of the warehouse, including contact name, street, city, state, postal code, country, phone, and email.

{} The Warehouse resource
1{
2  "id": "clz0ztrqy0004gg7tra9aqmvm",
3  "team_id": "clymtb8g90000maj34h0mwyc5",
4  "name": "Milan (main)",
5  "address_id": "clz0ztrqy0005gg7tzvgbd236",
6  "carrier_id": "clz2j73q20007x15qrl33auat",
7  "created_at": "2024-07-25T08:10:03.322Z",
8  "address": {
9    "id": "clz0ztrqy0005gg7tzvgbd236",
10    "contact_name": "Luca Santini",
11    "street": "Via Macedonio Melloni",
12    "city": "Milano",
13    "state": "Milano",
14    "postal_code": "20129",
15    "country": "Italy",
16    "phone": "+39028321789",
17    "email": "luca@gmail.com",
18    "created_at": "2024-07-25T08:10:03.322Z"
19  }
20}
get

Get List of Warehouses

Retrieve a list of all warehouses with pagination support.

cURL
curl -X GET "https://api.omnilabs.sh/warehouses?page=1&take=5" -H "Authorization: Bearer {{BEARER_TOKEN}}"

Parameters

pagenumberoptional

The page number for pagination.

takenumberoptional

The number of warehouses to return per page.

Response
{
  "data": [
    {
      "id": "clz0ztrqy0004gg7tra9aqmvm",
      "team_id": "clymtb8g90000maj34h0mwyc5",
      "name": "Milan (main)",
      "address_id": "clz0ztrqy0005gg7tzvgbd236",
      "carrier_id": "clz2j73q20007x15qrl33auat",
      "created_at": "2024-07-25T08:10:03.322Z",
      "address": {
        "id": "clz0ztrqy0005gg7tzvgbd236",
        "contact_name": "Luca Santini",
        "street": "Via Macedonio Melloni",
        "city": "Milano",
        "state": "Milano",
        "postal_code": "20129",
        "country": "Italy",
        "phone": "+39028321789",
        "email": "luca@gmail.com",
        "created_at": "2024-07-25T08:10:03.322Z"
      }
    }
  ],
  "total": 1,
  "take": 5,
  "current_page": 1,
  "last_page": 1
}
get

Get Warehouse by ID

Retrieve details of a specific warehouse by its ID.

cURL
curl -X GET "https://api.omnilabs.sh/warehouse/clxad0j6l00004mb24jicpgsd" -H "Authorization: Bearer {{BEARER_TOKEN}}"

Parameters

warehouse_idstringrequired

The unique ID of the warehouse.

Response
{
  "id": "clz0ztrqy0004gg7tra9aqmvm",
  "team_id": "clymtb8g90000maj34h0mwyc5",
  "name": "Milan (main)",
  "address_id": "clz0ztrqy0005gg7tzvgbd236",
  "carrier_id": "clz2j73q20007x15qrl33auat",
  "created_at": "2024-07-25T08:10:03.322Z",
  "address": {
    "id": "clz0ztrqy0005gg7tzvgbd236",
    "contact_name": "Luca Santini",
    "street": "Via Macedonio Melloni",
    "city": "Milano",
    "state": "Milano",
    "postal_code": "20129",
    "country": "Italy",
    "phone": "+39028321789",
    "email": "luca@gmail.com",
    "created_at": "2024-07-25T08:10:03.322Z"
  }
}
post

Create a Warehouse

Create a new warehouse with its name, address details, and associated carrier.

cURL
curl -X POST "https://api.omnilabs.sh/warehouse" -H "Authorization: Bearer {{BEARER_TOKEN}}" -H "Content-Type: application/json" -d '{"name": "Berlin (sec)", "address": {"contact_name": "Leopold Stazt", "street": "91 Ferdinand-Schultze-Straße", "city": "Berlin", "state": "Berlin", "postal_code": "13055", "country": "Germany", "phone": "+44028321789", "email": "leopold@omnilabs.sh"}, "carrier_id": "clz2j73q20007x15qrl33auat"}'

Parameters

namestringrequired

The name of the warehouse.

addressobjectrequired

The address details of the warehouse.

carrier_idstringrequired

The carrier ID associated with the warehouse.

Response
"ok"
put

Update Warehouse Details

Update the details of an existing warehouse by ID. Any entry can be updated.

cURL
curl -X PUT "https://api.omnilabs.sh/warehouse/clz0ztrqy0004gg7tra9aqmvm" -H "Authorization: Bearer {{BEARER_TOKEN}}" -H "Content-Type: application/json" -d '{"name": "London (main)"}'

Parameters

namestringoptional

The new name of the warehouse.

addressobjectoptional

The updated address details of the warehouse.

carrier_idstringoptional

The new carrier ID associated with the warehouse.

Response
"ok"
delete

Delete a Warehouse

Delete a specific warehouse by ID.

cURL
curl -X DELETE "https://api.omnilabs.sh/warehouse/clz0ztrqy0004gg7tra9aqmvm" -H "Authorization: Bearer {{BEARER_TOKEN}}"

Parameters

warehouse_idstringrequired

The unique ID of the warehouse.

Response
"ok"
© Omnilabs 2026. All rights reserved.