Get a List of Products

Get a list of products types or query a specific product type.

Query String Parameters

Name	Type	Description	Required
Action	String	ProductList	Required
StockTypeId	Int	The ID of the stock type to filter the product list. An empty Result array will be returned if the StockTypeID is invalid	Optional
OnlyConsumable	Bool	Indicates whether to include only consumable items in the product list.	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=ProductList

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "StockBatchCode": null,
      "StockConsumable": false,
      "StockCreationDate": "2024-06-19 15:46:14",
      "StockCurrency": "",
      "DepartmentCode": "",
      "StockId": 14396233,
      "StockMake": "Equipment Item",
      "StockMakeAndModel": "Equipment Item Model 001",
      "StockModel": "Model 001",
      "IntegrationTrackingOptionName1": "",
      "IntegrationTrackingOptionName2": "",
      "NominalCode": "",
      "StockNotes": "",
      "StockNumber": "",
      "StockOwnerId": 186499,
      "StockSellingPrice": null,
      "Reference": null,
      "StockStockCode": null,
      "StockTypeName": "Hire Items",
      "InvoiceVatCode": "",
      "StockWeight": null
    },
    {
      "StockBatchCode": null,
      "StockConsumable": false,
      "StockCreationDate": "2024-05-27 14:46:05",
      "StockCurrency": "",
      "DepartmentCode": "",
      "StockId": 14110435,
      "StockMake": "Equipment Item",
      "StockMakeAndModel": "Equipment Item Model 002",
      "StockModel": "Model 002",
      "IntegrationTrackingOptionName1": "",
      "IntegrationTrackingOptionName2": "",
      "NominalCode": "",
      "StockNotes": "",
      "StockNumber": "",
      "StockOwnerId": 186499,
      "StockSellingPrice": null,
      "Reference": null,
      "StockStockCode": null,
      "StockTypeName": "Hire Items",
      "InvoiceVatCode": "",
      "StockWeight": null
    },
    {
      "StockBatchCode": null,
      "StockConsumable": false,
      "StockCreationDate": "2024-06-07 11:04:12",
      "StockCurrency": "",
      "DepartmentCode": "",
      "StockId": 14266609,
      "StockMake": "Equipment Item",
      "StockMakeAndModel": "Equipment Item Model 003",
      "StockModel": "Model 003",
      "IntegrationTrackingOptionName1": "",
      "IntegrationTrackingOptionName2": "",
      "NominalCode": "",
      "StockNotes": "",
      "StockNumber": "",
      "StockOwnerId": 186499,
      "StockSellingPrice": null,
      "Reference": null,
      "StockStockCode": null,
      "StockTypeName": "Hire Items",
      "InvoiceVatCode": "",
      "StockWeight": null
    }
  ]
}