api.product_inventory

/api/product_inventory/

GET /api/product_inventory/

Description:

Return the list of all product inventories
can_lock requires_lock has_etag requires_etag
False False False False

Response:

<product_inventories>
        <product_inventory uri="/product_inventory/X/" id="X">
            <available>[decimal]</available>
            <reserved>[decimal]</reserved>
            <coming_for_stock>[decimal]</coming_for_stock>
            <coming_for_customer>[decimal]</coming_for_customer>
            <warehouses>[decimal]</warehouses>
            <in_transit>[decimal]</in_transit>
            <total>[decimal]</total>
            <product uri="/products/X/" id="X"/>
        </product_inventory>
        ...
</product_inventories>

/api/product_inventory/(d+)/

GET /api/product_inventory/(d+)/

Description:

Return a specific product inventory. Note that the product and product inventory have a matching ID.
can_lock requires_lock has_etag requires_etag
False False False False

Response:

<product_inventory uri="/product_inventory/X/" id="X">
    <available>[decimal]</available>
    <reserved>[decimal]</reserved>
    <coming_for_stock>[decimal]</coming_for_stock>
    <coming_for_customer>[decimal]</coming_for_customer>
    <warehouses>[decimal]</warehouses>
    <in_transit>[decimal]</in_transit>
    <total>[decimal]</total>
    <product uri="/products/X/" id="X"/>
</product_inventory>

/api/product_inventory/(d+)/adjust_inventory/

POST /api/product_inventory/(d+)/adjust_inventory/

Description:

Adjust the inventory of a product
can_lock requires_lock has_etag requires_etag
False False False False

Request:

<adjustment>
    <quantity>[decimal]</quantity>
    <cost>[decimal]</cost>
    <source_id>[str]</source_id>
    <note>[str]</note>
    <serial_numbers>
        <serial_number>[str]</serial_number>
        [...]
    </serial_numbers>
</adjustment>

Response:

<response>
    <product_inventory uri="/product_inventory/X/" id="X">
        <!-- See GET /product_inventory/X/ response for details. -->
    </product_inventory>
    <product uri="/products/X/" id="X">
        <!-- See GET /product/X/ response for details. -->
    </product>
</response>

/api/product_inventory/(d+)/warehouse_inventory/

GET /api/product_inventory/(d+)/warehouse_inventory/

Description:

Returns the inventory from all warehouses the product is located.
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>

/api/product_inventory/(d+)/warehouse_inventory/(d+)/

GET /api/product_inventory/(d+)/warehouse_inventory/(d+)/

Description:

Displays inventory of product x at warehouse y
can_lock requires_lock has_etag requires_etag
False False False False

Response:

<warehouse_inventory uri="/product_inventory/x/warehouse_inventory/y/">
    <warehouse uri="/warehouses/y/" id="y">
        <!-- see GET /warehouses/x/ -->
    </warehouse>
    <product uri="/products/x/" id="x"/>
    <total>[double]</total>
</warehouse_inventory>

/api/product_inventory/(d+)/warehouse_inventory/(d+)/serial_numbers/

GET /api/product_inventory/(d+)/warehouse_inventory/(d+)/serial_numbers/

Description:

Return the serial numbers for product x at warehouse y
can_lock requires_lock has_etag requires_etag
False False False False

Response:

<serial_numbers>
    <serial_number uri="/products/x/serial_numbers/y/" id="y">
        <!-- see GET /products/X/serial_numbers/Y/ -->
    </serial_number>
    ...
</serial_numbers>