Warehouses

get_warehouses

Get list of warehouses for the authenticated user's organization

get_warehouses

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_warehouses",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "active": true
      }
  }
}

const result = await client.callTool({
  "name": "get_warehouses",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "active": true
  }
});

result = await session.call_tool("get_warehouses", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "active": true
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for warehouse name, code, or email

relationsArray<string>

Relations to include (e.g., ["contact", "logo"])

activeboolean

Filter by active status

get_warehouse

Get a specific warehouse by ID

get_warehouse

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_warehouse",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_warehouse",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_warehouse", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The warehouse ID

relationsArray<string>

Relations to include

create_warehouse

Create a new warehouse in the authenticated user's organization

create_warehouse

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_warehouse",
    "arguments": {
        "warehouse_data": {
          "name": "string",
          "code": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_warehouse",
  "arguments": {
    "warehouse_data": {
      "name": "string",
      "code": "string"
    }
  }
});

result = await session.call_tool("create_warehouse", arguments={
  "warehouse_data": {
    "name": "string",
    "code": "string"
  }
})

Request Body

{
  "warehouse_data": {
    "name": "string",
    "code": "string"
  }
}

Body

application/json

warehouse_dataobjectrequired

The data for creating the warehouse

Show child attributes

namestringrequired

The warehouse name (required)

codestringrequired

The warehouse code (required)

[key: string]any

update_warehouse

Update an existing warehouse

update_warehouse

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_warehouse",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "warehouse_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_warehouse",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "warehouse_data": {}
  }
});

result = await session.call_tool("update_warehouse", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "warehouse_data": {}
})

Parameters

idstring<uuid>required

The warehouse ID

warehouse_dataobjectrequired

The data for updating the warehouse

delete_warehouse

Delete a warehouse

delete_warehouse

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_warehouse",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_warehouse",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_warehouse", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The warehouse ID

Stack Overflow Website Demo