GET v1/Product?pageNumber={pageNumber}&pageSize={pageSize}&code={code}&name={name}&alternateCode={alternateCode}&barcode={barcode}&isArchived={isArchived}&quantityInStockMin={quantityInStockMin}&quantityInStockMax={quantityInStockMax}&includeSupplierDetails={includeSupplierDetails}

This method gets a paged list of top level product information, including summary inventory quantities.

Request Information

URI Parameters

Name Description Type Additional information
pageNumber

The page number for the list you wish to retrieve

integer

Optional

Must be greater than 1

Default value is 1 if not specified

pageSize

The page size for the list you wish to retrieve

integer

Optional

Must be greater than 1 and less than 500

Default value is 500 if not specified

code

Filter the list on a particular product code or code fragment

string

Optional

name

Filter the list on a particular product name or name fragment

string

Optional

alternateCode

Filter the list on a particular alternate code or alternate code fragment

string

Optional

barcode

Filter the list on a particular barcode or barcode fragment

string

Optional

isArchived

Filter the list to either archived or non-archived products

boolean

Optional

Default value is both if not specified

quantityInStockMin

Filter the list to products with aggregated stock-in-hand quantity across all warehouses that is greater than or equal to the supplied minimum value

decimal number

Optional

quantityInStockMax

Filter the list to products with aggregated stock-in-hand quantity across all warehouses that is less than or equal to the supplied maximum value

decimal number

Optional

includeSupplierDetails

Include child collection on each product containing data related to suppliers and their products

boolean

Optional

Body Parameters

None.

Response Information

Resource Description

A list of product data from the Tradevine database

IPagedCollection (of Product)

Name Description Type
TotalCount

The total number of records in the resultset including those returned on this page

integer
PageNumber

The page number of the current resultset

integer
PageSize

The page size of the current resultset

integer
List

The list of records in this page of the resultset

Collection of Product

Response Formats

application/json

Sample:

{
  "TotalCount": 1440,
  "PageNumber": 1,
  "PageSize": 10,
  "List": [
    {
      "ProductID": 3451582911247567682,
      "OrganisationID": 3479979772659009354,
      "Code": "MSP-152",
      "Name": "Baking Powder 1kg",
      "Description": "Baking Powder 1kg - for all your cooking needs. Widely usable in all baking recipes",
      "AlternateCode": "EDMNDS4535",
      "EnableInventory": true,
      "UnitOfMeasure": "Each",
      "Barcode": "68568957899",
      "InternalNotes": "Private note so say this powder leads to dense cakes that often result in indigestion",
      "ExternalNotes": "Public note so say this powder is sure to leave your sponge nice and fluffy",
      "ProductCategoryID": 3479979772660940830,
      "Weight": 1000.0,
      "Length": 140.0,
      "Width": 80.0,
      "Height": 60.0,
      "Currency": 10109,
      "TaxClassID": 3479979772669744181,
      "TaxCode": "GST",
      "QuantityInStock": 100.0,
      "QuantityAvailableToSell": 78.0,
      "QuantityAvailableToShip": 90.0,
      "CostPrice": 90.0,
      "SellPriceIncTax": 114.89,
      "SellPriceExTax": 99.9,
      "MinimumStockQuantity": 10.0,
      "OverrideSalesGLAccountCode": null,
      "OverrideSalesGLAccountName": null,
      "OverridePurchaseGLAccountCode": null,
      "OverridePurchaseGLAccountName": null,
      "PhotoIdentifier": null,
      "IsManualOrderApprovalNeeded": false,
      "IsBoM": false,
      "IsBoMComponent": false,
      "IsBoMWeightAutocalculated": null,
      "IsArchived": false,
      "CreatedDate": "2012-08-07T11:42:52Z",
      "CreatedBy": 3479979772662022396,
      "ModifiedDate": "2013-03-02T00:04:52Z",
      "ModifiedBy": 3479979772662022396,
      "QuantityAvailableForShipmentAllocation": null,
      "QuantityReorderBalance": null,
      "TradeMeListings": null,
      "TradeMeOffers": null,
      "SoftAllocated": null,
      "MediumAllocated": null,
      "HardAllocated": null,
      "SoftPurchase": null,
      "HardPurchase": null,
      "BoMSoftAllocated": null,
      "BoMTradeMeListings": null,
      "BoMTradeMeOffers": null,
      "Photos": [
        {
          "PhotoID": null,
          "OrganisationID": null,
          "FileName": null,
          "ContentsBase64": null,
          "TradevineUrl": "https://nz.tradevine.com/my-account-name/ProductPhoto/GetPhoto?photoID=3602768739505780893",
          "PublicUrl": "https://nz.tradevine.com/BlobStorage/GetFullPhoto?photoID=3602768739505780893&organisationID=3479979772659009354",
          "PublicThumbnailUrl": "https://nz.tradevine.com/BlobStorage/GetPhotoThumbnail?photoID=3602768739505780893&organisationID=3479979772659009354&size=100",
          "CreatedDate": null,
          "CreatedBy": null,
          "ModifiedDate": null,
          "ModifiedBy": null
        }
      ],
      "PerWarehouseInventory": [
        {
          "QuantityInStockSnapshot": 312.0,
          "AverageFIFOCost": 85.0,
          "TotalInventoryValueSnapshot": null,
          "WarehouseID": 3479979772662022613,
          "WarehouseCode": "WH1",
          "QuantityAvailableToSell": null,
          "QuantityAvailableForShipmentAllocation": null,
          "QuantityAvailableToShip": null,
          "QuantityReorderBalance": null,
          "TradeMeListings": null,
          "TradeMeOffers": null,
          "SoftAllocated": null,
          "MediumAllocated": null,
          "HardAllocated": null,
          "SoftPurchase": null,
          "HardPurchase": null,
          "BoMSoftAllocated": null,
          "BoMTradeMeListings": null,
          "BoMTradeMeOffers": null
        }
      ],
      "ProductSuppliers": [
        {
          "ProductSupplierID": 33546957475474,
          "SupplierID": 3487940363376548,
          "SupplierCode": "SU-231",
          "SupplierName": "ACME Enterpises Ltd",
          "SupplierProductCode": "ACME-79867-233",
          "Price": 90.0,
          "IsPriceIncTax": false,
          "IsPreferredSupplier": true,
          "DefaultPurchaseOrderQuantity": 100.0,
          "CreatedDate": "2012-08-07T11:42:52Z",
          "CreatedBy": 3479979772662022396,
          "ModifiedDate": "2013-03-02T00:04:52Z",
          "ModifiedBy": 3479979772662022396
        }
      ],
      "BoMComponents": null
    },
    {
      "ProductID": 3479979772705247895,
      "OrganisationID": 3479979772659009354,
      "Code": "MSP-153",
      "Name": "White Plastic Bag",
      "Description": "White plastic bag normally found in local dairies",
      "AlternateCode": null,
      "EnableInventory": false,
      "UnitOfMeasure": "Each",
      "Barcode": "5474754786",
      "InternalNotes": "Product to be deprecated in favour of more eco-fiendly paper bags in August this year",
      "ExternalNotes": "Please request these if you really need them and reuse if possible",
      "ProductCategoryID": 3479979772660940830,
      "Weight": 12.0,
      "Length": 180.0,
      "Width": 100.0,
      "Height": 90.0,
      "Currency": 10109,
      "TaxClassID": 3479979772669744181,
      "TaxCode": "GST",
      "QuantityInStock": null,
      "QuantityAvailableToSell": null,
      "QuantityAvailableToShip": null,
      "CostPrice": 0.01,
      "SellPriceIncTax": 0.15,
      "SellPriceExTax": 0.135,
      "MinimumStockQuantity": 500.0,
      "OverrideSalesGLAccountCode": "200",
      "OverrideSalesGLAccountName": "Sales",
      "OverridePurchaseGLAccountCode": "458",
      "OverridePurchaseGLAccountName": "Expense Items",
      "PhotoIdentifier": null,
      "IsManualOrderApprovalNeeded": false,
      "IsBoM": false,
      "IsBoMComponent": false,
      "IsBoMWeightAutocalculated": null,
      "IsArchived": false,
      "CreatedDate": "2012-08-07T11:45:05Z",
      "CreatedBy": 3479979772662022396,
      "ModifiedDate": "2013-03-02T00:40:22Z",
      "ModifiedBy": 3479979772662022396,
      "QuantityAvailableForShipmentAllocation": null,
      "QuantityReorderBalance": null,
      "TradeMeListings": null,
      "TradeMeOffers": null,
      "SoftAllocated": null,
      "MediumAllocated": null,
      "HardAllocated": null,
      "SoftPurchase": null,
      "HardPurchase": null,
      "BoMSoftAllocated": null,
      "BoMTradeMeListings": null,
      "BoMTradeMeOffers": null,
      "Photos": null,
      "PerWarehouseInventory": null,
      "ProductSuppliers": null,
      "BoMComponents": null
    }
  ]
}