Megaventory API v2017a

<back to all web services

ProductGet

The following routes are available for this service:
GET POST/Product/ProductGetGets information on existing productsUses your API Key and some Filters in an array format and returns the search results using the given filters. Optionally, you can use ReturnTopNRecords to limit the number of the results to the specified number (omit, or add ReturnTopNRecords = -1 to get all the available results). The ReturnTopNRecords chooses the top records in a ProductID descending order.

Examples:



A.

Get all the finished goods manufactured from a work order.
We can add two Filters by using the AndOr operator as shown below:

Value:

{
   "Filters": [
      {
         "FieldName": "ProductType",
         "SearchOperator": "Equals",
         "SearchValue": "ManufactureFromWorkOrder"
      }
   ],
   "ReturnTopNRecords": 1
}


Response:

{
   "mvProducts": [
      {
         "ProductID": 27412,
         "ProductType": "ManufactureFromWorkOrder",
         "ProductSKU": "prod111",
         "ProductEAN": "",
         "ProductDescription": "manufacture test",
         "ProductVersion": "",
         "ProductLongDescription": "",
         "ProductCategoryID": 0,
         "ProductUnitOfMeasurement": "",
         "ProductSellingPrice": 0,
         "ProductPurchasePrice": 0,
         "ProductUnitCost": 0,
         "ProductWeight": 0,
         "ProductLength": 0,
         "ProductBreadth": 0,
         "ProductHeight": 0,
         "ProductImageURL": "",
         "ProductComments": "",
         "ProductCustomField1": "",
         "ProductCustomField2": "",
         "ProductCustomField3": "",
         "ProductCustomField4": "",
         "ProductCustomField5": "",
         "ProductCustomField6": "",
         "ProductCustomField7": "",
         "ProductCustomField8": "",
         "ProductCustomField9": "",
         "ProductCustomField10": "",
         "ProductCustomField11": "",
         "ProductCustomField12": "",
         "ProductCustomField13": "",
         "ProductCustomField14": "",
         "ProductCustomField15": "",
         "ProductCustomField16": "",
         "ProductCustomField17": "",
         "ProductCustomField18": "",
         "ProductCustomField19": "",
         "ProductCustomField20": "",
         "ProductOption1": "",
         "ProductOption2": "",
         "ProductOption3": "",
         "ProductOption4": "",
         "ProductOption5": "",
         "ProductOption6": "",
         "ProductOption7": "",
         "ProductOption8": "",
         "ProductOption9": "",
         "ProductOption10": "",
         "ProductMainSupplierID": 0,
         "ProductMainSupplierPrice": 0,
         "ProductMainSupplierSKU": "",
         "ProductMainSupplierDescription": "",
         "ProductCreationDate": "/Date(1530110485503-0000)/"
      }
   ],
   "ResponseStatus": {
      "ErrorCode": "0"
   }
}


B.

Get all the products that have a product image and a selling price less than 20.

Value:

{
   "Filters": [
      {
         "FieldName": "ProductImageURL",
         "SearchOperator": "NotEquals",
         "SearchValue": ""
      },
      {
         "AndOr": "And",
         "FieldName": "ProductSellingPrice",
         "SearchOperator": "LessThan",
         "SearchValue": 20
      }
   ]
}


Response:

{
   "mvProducts": [
      {
         "ProductID": 27397,
         "ProductType": "BuyFromSupplier",
         "ProductSKU": "aass2s1",
         "ProductEAN": "",
         "ProductDescription": "aass2s1",
         "ProductVersion": "",
         "ProductLongDescription": "",
         "ProductCategoryID": 0,
         "ProductUnitOfMeasurement": "",
         "ProductSellingPrice": 0,
         "ProductPurchasePrice": 0,
         "ProductUnitCost": 0,
         "ProductWeight": 0,
         "ProductLength": 0,
         "ProductBreadth": 0,
         "ProductHeight": 0,
         "ProductImageURL": "https://lh3.googleusercontent.com/TMOtFhRVZ53_tX8vfVK17NDcAhcYkW-U_XgL21t_KYQwPgkE-ddTPwurMlfQe2x-dYFPA5dkJEqWQfgoPNz-=w2736-h1616",
         "ProductComments": "",
         "ProductCustomField1": "",
         "ProductCustomField2": "",
         "ProductCustomField3": "",
         "ProductCustomField4": "",
         "ProductCustomField5": "",
         "ProductCustomField6": "",
         "ProductCustomField7": "",
         "ProductCustomField8": "",
         "ProductCustomField9": "",
         "ProductCustomField10": "",
         "ProductCustomField11": "",
         "ProductCustomField12": "",
         "ProductCustomField13": "",
         "ProductCustomField14": "",
         "ProductCustomField15": "",
         "ProductCustomField16": "",
         "ProductCustomField17": "",
         "ProductCustomField18": "",
         "ProductCustomField19": "",
         "ProductCustomField20": "",
         "ProductOption1": "",
         "ProductOption2": "",
         "ProductOption3": "",
         "ProductOption4": "",
         "ProductOption5": "",
         "ProductOption6": "",
         "ProductOption7": "",
         "ProductOption8": "",
         "ProductOption9": "",
         "ProductOption10": "",
         "ProductMainSupplierID": 5361,
         "ProductMainSupplierPrice": 5,
         "ProductMainSupplierSKU": "",
         "ProductMainSupplierDescription": "",
         "ProductCreationDate": "/Date(1519499361953-0000)/"
      }
   ],
   "ResponseStatus": {
      "ErrorCode": "0"
   }
}

To override the Content-type in your clients HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/ProductGet HTTP/1.1 
Host: api.megaventory.com 
Content-Type: text/csv
Content-Length: length

AndOr,Group,FieldName,SearchOperator,SearchValue
And,Undefined,String,Undefined,String

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

ProductID,ProductType,ProductSKU,ProductEAN,ProductDescription,ProductVersion,ProductLongDescription,ProductCategoryID,mvProductCategory,ProductUnitOfMeasurement,ProductSellingPrice,ProductPurchasePrice,ProductUnitCost,ProductWeight,ProductWeightUnitID,mvProductWeightUnit,ProductLength,ProductBreadth,ProductHeight,ProductImageURL,ProductComments,ProductCustomField1,ProductCustomField2,ProductCustomField3,ProductCustomField4,ProductCustomField5,ProductCustomField6,ProductCustomField7,ProductCustomField8,ProductCustomField9,ProductCustomField10,ProductCustomField11,ProductCustomField12,ProductCustomField13,ProductCustomField14,ProductCustomField15,ProductCustomField16,ProductCustomField17,ProductCustomField18,ProductCustomField19,ProductCustomField20,ProductMainSupplierID,mvProductMainSupplier,ProductMainSupplierPrice,ProductMainSupplierSKU,ProductMainSupplierDescription,ProductCreationDate,ProductOption1,ProductOption2,ProductOption3,ProductOption4,ProductOption5,ProductOption6,ProductOption7,ProductOption8,ProductOption9,ProductOption10,IsInventorySerialised,IsBatchNumbersEnabled,SerialNumberPrefix,SerialNumberLength,IsPurchasable,PurchasableStartDate,PurchasableEndDate,IsSellable,SellableStartDate,SellableEndDate
0,BuyFromSupplier,String,String,String,String,String,0,"{ProductCategoryID:0,ProductCategoryName:String,ProductCategoryDescription:String}",String,0,0,[{}],0,0,"{WeightUnitID:0,WeightUnitAbbrev:String,WeightUnitName:String,WeightUnitConversionToGrams:0}",0,0,0,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,0,"{SupplierClientID:0,SupplierClientType:Both,SupplierClientName:String,SupplierClientBillingAddress:String,SupplierClientShippingAddress1:String,SupplierClientShippingAddress2:String,SupplierClientAddresses:[{AddressType:General,AddressLine1:String,AddressLine2:String,AddressLine3:String,Name:String,Phone:String,Email:String,TaxIdNumber:String,Organization:String,City:String,State:String,Country:NONE,CountryName:String,Longitude:String,Latitude:String,ZipCode:String}],SupplierClientPhone1:String,SupplierClientPhone2:String,SupplierClientFax:String,SupplierClientIM:String,SupplierClientEmail:String,SupplierClientCurrency:String,SupplierClientPaymentTermsEnum:None,SupplierClientPaymentMethodEnum:None,SupplierClientComments:String,SupplierClientCustomField1:String,SupplierClientCustomField2:String,SupplierClientCustomField3:String,SupplierClientCustomField4:String,SupplierClientCustomField5:String,SupplierClientCustomField6:String,SupplierClientCustomField7:String,SupplierClientCustomField8:String,SupplierClientCustomField9:String,SupplierClientCustomField10:String,SupplierClientOption1:False,SupplierClientOption2:False,SupplierClientOption3:False,SupplierClientOption4:False,SupplierClientOption5:False,SupplierClientOption6:False,SupplierClientOption7:False,SupplierClientOption8:False,SupplierClientOption9:False,SupplierClientOption10:False,SupplierClientCreationDate:0001-01-01,mvContacts:[{ContactId:0,ContactName:String,ContactDepartment:String,ContactAddress:String,ContactFullAddress:{AddressType:General,AddressLine1:String,AddressLine2:String,AddressLine3:String,Name:String,Phone:String,Email:String,TaxIdNumber:String,Organization:String,City:String,State:String,Country:NONE,CountryName:String,Longitude:String,Latitude:String,ZipCode:String},ContactEmail:String,ContactPhone1:String,ContactPhone2:String,ContactFax:String,ContactIM:String,ContactCustomField1:String,ContactCustomField2:String,ContactIsPrimary:False,mvSuppliersClients:[{SupplierClientID:0,SupplierClientType:Both,SupplierClientName:String,SupplierClientBillingAddress:String,SupplierClientShippingAddress1:String,SupplierClientShippingAddress2:String,SupplierClientAddresses:[{AddressType:General,AddressLine1:String,AddressLine2:String,AddressLine3:String,Name:String,Phone:String,Email:String,TaxIdNumber:String,Organization:String,City:String,State:String,Country:NONE,CountryName:String,Longitude:String,Latitude:String,ZipCode:String}],SupplierClientPhone1:String,SupplierClientPhone2:String,SupplierClientFax:String,SupplierClientIM:String,SupplierClientEmail:String,SupplierClientCurrency:String,SupplierClientPaymentTermsEnum:None,SupplierClientPaymentMethodEnum:None,SupplierClientComments:String,SupplierClientCustomField1:String,SupplierClientCustomField2:String,SupplierClientCustomField3:String,SupplierClientCustomField4:String,SupplierClientCustomField5:String,SupplierClientCustomField6:String,SupplierClientCustomField7:String,SupplierClientCustomField8:String,SupplierClientCustomField9:String,SupplierClientCustomField10:String,SupplierClientOption1:False,SupplierClientOption2:False,SupplierClientOption3:False,SupplierClientOption4:False,SupplierClientOption5:False,SupplierClientOption6:False,SupplierClientOption7:False,SupplierClientOption8:False,SupplierClientOption9:False,SupplierClientOption10:False,SupplierClientCreationDate:0001-01-01,mvContacts:[{ContactId:0,ContactName:String,ContactDepartment:String,ContactAddress:String,ContactFullAddress:{AddressType:General,AddressLine1:String,AddressLine2:String,AddressLine3:String,Name:String,Phone:String,Email:String,TaxIdNumber:String,Organization:String,City:String,State:String,Country:NONE,CountryName:String,Longitude:String,Latitude:String,ZipCode:String},ContactEmail:String,ContactPhone1:String,ContactPhone2:String,ContactFax:String,ContactIM:String,ContactCustomField1:String,ContactCustomField2:String,ContactIsPrimary:False,mvSuppliersClients:[{SupplierClientID:0,SupplierClientType:Both,SupplierClientName:String,SupplierClientBillingAddress:String,SupplierClientShippingAddress1:String,SupplierClientShippingAddress2:String,SupplierClientAddresses:[{AddressType:General,AddressLine1:String,AddressLine2:String,AddressLine3:String,Name:String,Phone:String,Email:String,TaxIdNumber:String,Organization:String,City:String,State:String,Country:NONE,CountryName:String,Longitude:String,Latitude:String,ZipCode:String}],SupplierClientPhone1:String,SupplierClientPhone2:String,SupplierClientFax:String,SupplierClientIM:String,SupplierClientEmail:String,SupplierClientCurrency:String,SupplierClientPaymentTermsEnum:None,SupplierClientPaymentMethodEnum:None,SupplierClientComments:String,SupplierClientCustomField1:String,SupplierClientCustomField2:String,SupplierClientCustomField3:String,SupplierClientCustomField4:String,SupplierClientCustomField5:String,SupplierClientCustomField6:String,SupplierClientCustomField7:String,SupplierClientCustomField8:String,SupplierClientCustomField9:String,SupplierClientCustomField10:String,SupplierClientOption1:False,SupplierClientOption2:False,SupplierClientOption3:False,SupplierClientOption4:False,SupplierClientOption5:False,SupplierClientOption6:False,SupplierClientOption7:False,SupplierClientOption8:False,SupplierClientOption9:False,SupplierClientOption10:False,SupplierClientCreationDate:0001-01-01,mvContacts:[{ContactId:0,ContactName:String,ContactDepartment:String,ContactAddress:String,ContactFullAddress:{AddressType:General,AddressLine1:String,AddressLine2:String,AddressLine3:String,Name:String,Phone:String,Email:String,TaxIdNumber:String,Organization:String,City:String,State:String,Country:NONE,CountryName:String,Longitude:String,Latitude:String,ZipCode:String},ContactEmail:String,ContactPhone1:String,ContactPhone2:String,ContactFax:String,ContactIM:String,ContactCustomField1:String,ContactCustomField2:String,ContactIsPrimary:False,mvSuppliersClients:[{}]}],SupplierClientTaxID:String}]}],SupplierClientTaxID:String}]}],SupplierClientTaxID:String}",0.00,String,String,0001-01-01,False,False,False,False,False,False,False,False,False,False,False,False,String,,False,0001-01-01,0001-01-01,False,0001-01-01,0001-01-01