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)/",
         "IsInventorySerialised": false,
         "IsBatchNumbersEnabled": false,
         "SerialNumberPrefix": "",
         "SerialNumberLength": 11,
         "IsPurchasable": true,
         "PurchasableStartDate": "/Date(1519499361953-0000)/",
         "PurchasableEndDate": "/Date(1519499361953-0000)/",
         "IsSellable": true,
         "SellableStartDate": "/Date(1519499361953-0000)/",
         "SellableEndDate": "/Date(1519499361953-0000)/",
         "DefaultSalesQuantity": 1,
         "DefaultPurchaseQuantity": 1,
         "MinimumSalesQuantity": 1,
         "MinimumPurchaseQuantity": 1,
         "MaximumSalesQuantity": 10,
         "MaximumPurchaseQuantity": 100
      }
   ],
   "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)/",
         "IsInventorySerialised": false,
         "IsBatchNumbersEnabled": false,
         "SerialNumberPrefix": "",
         "SerialNumberLength": 11,
         "IsPurchasable": true,
         "PurchasableStartDate": "/Date(1519499361953-0000)/",
         "PurchasableEndDate": "/Date(1519499361953-0000)/",
         "IsSellable": true,
         "SellableStartDate": "/Date(1519499361953-0000)/",
         "SellableEndDate": "/Date(1519499361953-0000)/",
         "DefaultSalesQuantity": 1,
         "DefaultPurchaseQuantity": 1,
         "MinimumSalesQuantity": 1,
         "MinimumPurchaseQuantity": 1,
         "MaximumSalesQuantity": 10,
         "MaximumPurchaseQuantity": 100
      }
   ],
   "ResponseStatus": {
      "ErrorCode": "0"
   }
}

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"Filters":[{"AndOr":"And","Group":"Undefined","FieldName":"String","SearchOperator":"Undefined","SearchValue":"String"}],"ReturnTopNRecords":0,"APIKEY":"String","ProductID":0,"ProductSKU":"String","ProductCategoryID":0,"ProductMainSupplierID":0,"includeReferencedObjects":false,"showDeleted":"showOnlyUndeleted"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"mvProducts":[{"ProductID":0,"ProductType":"BuyFromSupplier","ProductSKU":"String","ProductEAN":"String","ProductDescription":"String","ProductVersion":"String","ProductLongDescription":"String","ProductCategoryID":0,"mvProductCategory":{"ProductCategoryID":0,"ProductCategoryName":"String","ProductCategoryDescription":"String"},"ProductUnitOfMeasurement":"String","ProductSellingPrice":0,"ProductPurchasePrice":0,"ProductUnitCost":[{}],"ProductWeight":0,"ProductWeightUnitID":0,"mvProductWeightUnit":{"WeightUnitID":0,"WeightUnitAbbrev":"String","WeightUnitName":"String","WeightUnitConversionToGrams":0},"ProductLength":0,"ProductBreadth":0,"ProductHeight":0,"ProductImageURL":"String","ProductComments":"String","ProductCustomField1":"String","ProductCustomField2":"String","ProductCustomField3":"String","ProductCustomField4":"String","ProductCustomField5":"String","ProductCustomField6":"String","ProductCustomField7":"String","ProductCustomField8":"String","ProductCustomField9":"String","ProductCustomField10":"String","ProductCustomField11":"String","ProductCustomField12":"String","ProductCustomField13":"String","ProductCustomField14":"String","ProductCustomField15":"String","ProductCustomField16":"String","ProductCustomField17":"String","ProductCustomField18":"String","ProductCustomField19":"String","ProductCustomField20":"String","ProductMainSupplierID":0,"mvProductMainSupplier":{"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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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"},"ProductMainSupplierPrice":0.00,"ProductMainSupplierSKU":"String","ProductMainSupplierDescription":"String","ProductCreationDate":"\/Date(-62135596800000-0000)\/","ProductOption1":false,"ProductOption2":false,"ProductOption3":false,"ProductOption4":false,"ProductOption5":false,"ProductOption6":false,"ProductOption7":false,"ProductOption8":false,"ProductOption9":false,"ProductOption10":false,"IsInventorySerialised":false,"IsBatchNumbersEnabled":false,"SerialNumberPrefix":"String","IsPurchasable":false,"PurchasableStartDate":"\/Date(-62135596800000-0000)\/","PurchasableEndDate":"\/Date(-62135596800000-0000)\/","IsSellable":false,"SellableStartDate":"\/Date(-62135596800000-0000)\/","SellableEndDate":"\/Date(-62135596800000-0000)\/","DefaultSalesQuantity":0,"DefaultPurchaseQuantity":0,"MinimumSalesQuantity":0,"MinimumPurchaseQuantity":0,"MaximumSalesQuantity":0,"MaximumPurchaseQuantity":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"InternalErrorCode":"String"}