Skip to content

stockTransactions

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference

/rest/stockMgmt/stockTransactions/{startDate}/{endDate}/{typeList}/{clientGroupId}

GET
Gets Stock Transactions that have been created within the period specified and for the specified Client Group and Types. 

Parameters

startDate - date to get stock transactions from in format dd-mmm-yyyy hh:mm:ss
endDate - date to get stock transactions to in format dd-mmm-yyyy hh:mm:ss
typeList - a list of stock transaction types that you wish to include in the results can be:
USAGE
            USAGE UPDATE
            PURCHASE
            TRANSFER
            CONSUMABLE PURCHASE
clientGroupId - the ID of the client group

e.g. rest/stockMgmt/stockTransactions/29-May-2012%2010:30:00/30-May-2012%2000:00:00/USAGE,PURCHASE/1

available response representations:
  • 200 - XML
<root>
    <stockTransactions>
        <stockTransaction>            <type>Usage</type>     <partNumber>ABC123</partNumber>            <partDescription>flange</partDescription>
            <partUnitSalesValue>34.45</partUnitSalesValue>
            <fromStore>Bob.Smith</fromStore>            <fromStoreResourceId>23</fromStoreResourceId>            <toStore></toStore>            <toStoreResourceId></toStoreResourceId>            <userId>tina.heath</userId>            <dateTime>12/12/2014 12:34</dateTime>            <ref>fgbd5657</ref>            <quantity>23</quantity>            <jobRef>J007TG</jobRef>        </stockTransaction>
    </stockTransactions></root>

See the Stock Management API matrix for the full list of endpoints in this category.