Megaventory API v2017a

<back to all web services

SupplierStockGet

The following routes are available for this service:
GET POST/SupplierStock/SupplierStockGetGets information on current supplier stock listUses 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.

Return the first mvSupplierStockList object with an "ExactStock" ProductStockChoise and a ProductId that is greater than 30. The results are returned as mvSupplierStockList objects. We can add two Filters by using the AndOr operator as shown below:

Value: 

 {
   "Filters": [
      {
         "FieldName": "ProductStockChoise",
         "SearchOperator": "Equals",
         "SearchValue": "ExactStock"
      },
      {
         "AndOr": "And",
         "FieldName": "ProductId",
         "SearchOperator": "GreaterThan",
         "SearchValue": 30
      }
   ],
   "ReturnTopNRecords": 1
}


Response: 

 {
   "mvSupplierStockList": [
      {
         "ProductID": 27388,
         "ProductSKU": "",
         "ProductLeadTimeChoice": "DayRange",
         "ProductLeadTimeExactDate": "/Date(-62135596800000-0000)/",
         "ProductLeadTimeMinDays": 0,
         "ProductLeadTimeMaxDays": 3,
         "ProductStockChoice": "ExactStock",
         "ProductExactStock": 1,
         "ProductStockRangeMin": 0,
         "ProductStockRangeMax": 0,
         "ProductSupplierPrice": 9
      }
   ],
   "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/SupplierStockGet 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","ProductSKU":"String","ProductCategoryID":[0],"ProductMainSupplierID":[0],"includeReferencedObjects":false}

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

{"mvSupplierStockList":[{"ProductID":0,"ProductSKU":"String","mvProduct":{"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)\/"},"mvSupplierClient":{"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"},"ProductLeadTimeChoice":"UseExactDateOrDayRange","ProductLeadTimeExactDate":"\/Date(-62135596800000-0000)\/","ProductLeadTimeMinDays":0,"ProductLeadTimeMaxDays":0,"ProductStockChoice":"UseExactStockOrStockRangeOrNotAvailable","ProductExactStock":0,"ProductStockRangeMin":0,"ProductStockRangeMax":0,"ProductSupplierPrice":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"InternalErrorCode":"String"}