api.warehouses¶

/api/warehouses/
- GET /api/warehouses/
/api/warehouses/(d+)/
- GET /api/warehouses/(d+)/
/api/warehouses/(d+)/warehouse_inventory/
- GET /api/warehouses/(d+)/warehouse_inventory/

/api/warehouses/¶

GET /api/warehouses/¶

Description:

Return a list of warehouses

can_lock	requires_lock	has_etag	requires_etag
False	False	False	False

Response:

<warehouses>
        <warehouses>
            <warehouse uri="/warehouses/X/" id="X">
                <!-- See GET /warehouse/X/ response for details -->
            </warehouse>
            [...]
        </warehouses>
        ...
</warehouses>

/api/warehouses/(d+)/¶

GET /api/warehouses/(d+)/¶

Description:

Return details for a specific warehouse

can_lock	requires_lock	has_etag	requires_etag
False	False	False	False

Response:

<warehouse uri="/warehouses/X/" id="X">
    <name>[str]</name>
    <special_name>[enum: None | Inventory | Reserved | Transit]</special_name> <!-- An Enum for special warehouse or Null to indicate a regular warehouse. -->
</warehouse>

/api/warehouses/(d+)/warehouse_inventory/¶

GET /api/warehouses/(d+)/warehouse_inventory/¶

Description:

Return all inventory contained in the warehouse.

can_lock	requires_lock	has_etag	requires_etag
False	False	False	False

Response:

<warehouse_inventories>
    <warehouse_inventory uri="/product_inventory/x/warehouse_inventory/y/">
        <!-- see GET /product_inventory/x/warehouse_inventory/y/ -->
    </warehouse_inventory>
    ...
</warehouse_inventories>