purchaseOrders

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/purchaseOrders/{startDate}/{endDate}/{statusIdList}/{clientGroupId}

GET

Gets Purchase Orders and Purchase Order Lines for PO's that have been modified within the period specified and for the specified Client Group and Status.  PO's will are considered to have been modified if they have been created or cancelled or if order lines have been added, modified or deleted.

Parameters

startDate - date to get purchase orders from in format dd-mmm-yyyy hh:mm:ss (uses last modified date on PO)

endDate - date to get purchase orders to in format dd-mmm-yyyy hh:mm:ss (uses last modified date on PO)

statusIdList - a list of PO status IDs

clientGroupId - the ID of the client group

e.g. rest/stockMgmt/purchaseOrders/29-May-2012%2010:30:00/30-May-2012%2000:00:00/1,3/1

available response representations:

• 200 - JSON

{  "purchaseOrders":[    { "vendor":"Travis",      "orderDate":"12/12/2004",      "createdDate":"12/12/2004 12:34:35",      "modifiedDate":"12/12/2004 12:34:35",      "statusId":"2",
      "poRef":"12345",
      "jobRef":"J00ABC",
      "deliveryDate","12/12/2005",      "deliveryStore","Warehouse 1",       "deliveryAdd1","12 Raleigh Road",      "deliveryAdd2","Welly",      "deliveryAdd3","Boardmouth",      "deliveryAdd4","Bedshire",      "deliveryPostCode","AB2 4FG",

      "lines":[            {               "partNumber":"hdhf767",
              "partDescription":"large tap",              "partCategory":"test",              "quantity":"23.4",              "cost":"234.34",              "description":"more words"
            }
       ]

    }  ]}

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