api.hirepos.com/Items

The Items endpoint is used to look up item details by passing any of the various search parameters.

If the search parameters are omitted then the results return an array of the last 100 active Items in order of date modified, from latest modified to oldest. This endpoint is typically used in this scenario for polling once a day to retrieve recently updated items, and update an Online Store's inventory (when the built-in HirePOS Online Store is not used). Although web hooks are the preferred method for this purpose.

GET https://api.hirepos.com/Items

Headers:
AuthKey={YourAPIKey}
AuthSecret={YourAPISecret}

Parameters:
Code={FindCode}
Barcode={FindBarcode}
SupplierCode={FindSupplierCode}
Serial={FindSerialTrackingNumber}


// Example Response...

[
    {
        "Id": 1002,
        "Code": "H2",
        "Description": "Hire 2",
        "Category": "Category 1",
        "ItemType": "Hire",
        "IsHireItem": "True",
        "Barcode": "123456",
        "SupplierCode": "H2000",
        "WebsiteCode": "",
        "WebsiteDescription": "H2",
        "WebsiteLongDescription": "Hire 2",
        "WebsitePrice": "",
        "ImageURL": "",
        "ImageURL2": "",
        "ImageURL3": "",
        "ImageURL4": "",
        "ImageURL5": "",
        "ImageURL6": "",
        "Colour": "",
        "Height": "",
        "Width": "",
        "Depth": "",
        "Length": "",
        "Area": "",
        "Volume": "",
        "Weight": "",
        "Link": "",
        "Link2": "",
        "Slot": "SLOT123",
        "CustomField1": "",
        "CustomField2": "",
        "CustomField3": "",
        "CustomField4": "",
        "CustomField5": "",
        "CustomField6": "",
        "CustomField7": "",
        "CustomField8": "",
        "Tags": "'red','blue','green'",
        "LastModified": "2022-10-04T14:14:22+10:00"
    },
    {
        "Id": 1001,
        "Code": "H1",
        "Description": "Hire 1",
        "Category": "Category 1",
        "ItemType": "Hire",
        "IsHireItem": "True",
        "Barcode": "113456",
        "SupplierCode": "H1000",
        "WebsiteCode": "",
        "WebsiteDescription": "H1",
        "WebsiteLongDescription": "Hire 1",
        "WebsitePrice": "",
        "ImageURL": "",
        "ImageURL2": "",
        "ImageURL3": "",
        "ImageURL4": "",
        "ImageURL5": "",
        "ImageURL6": "",
        "Colour": "",
        "Height": "",
        "Width": "",
        "Depth": "",
        "Length": "",
        "Area": "",
        "Volume": "",
        "Weight": "",
        "Link": "",
        "Link2": "",
        "Slot": "SLOT123",
        "CustomField1": "",
        "CustomField2": "",
        "CustomField3": "",
        "CustomField4": "",
        "CustomField5": "",
        "CustomField6": "",
        "CustomField7": "",
        "CustomField8": "",
        "Tags": "'purple','pink','voilet'",
        "LastModified": "2022-10-02T10:02:22+10:00"
    }
]