Megaventory API v2017a

<back to all web services

SerialNumberGet

The following routes are available for this service:
GET POST/Product/SerialNumberGetGets information on existing serial numbersUses your API Key along with optional Filters, and Pagination parameters to retrieve Serial Number information. If no Filters are provided, all serial numbers will be returned.

Query Parameters:


  • Page (int, optional) = Page number starting from 1
  • Limit (int, optional) = Maximum number of records per page (max 1000)

Examples:



A.

Return all serial numbers (no filters) with default pagination

Value:

{
  "Page": 1,
  "Limit": 100
}


Response:

{
  "mvSerialNumbers": [
    {
      "SerialNumberId": 305,
      "SerialNumber": "SerialA",
      "ProductId": 7571,
      "InventoryLocationId": 6770,
      "DateCreated": "/Date(1727691143980-0000)/",
      "SerialNumberStatus": "Available",
      "SerialNumberDocuments": []
    }
  ],
  "ResponseStatus": {
    "ErrorCode": "0"
  }
}


B.

Return serial numbers with a name of either "SerialA" or "SerialB" , page 2 with 50 results per page

Value:

{
  "Page": 2,
  "Limit": 50,
  "Filters": [
    {
      "FieldName": "SerialNumber",
      "SearchOperator": "Equals",
      "SearchValue": "SerialA"
    },
    {
      "AndOr": "Or",
      "FieldName": "SerialNumber",
      "SearchOperator": "Equals",
      "SearchValue": "SerialB"
    }
  ]
}


Response:

{
  "mvSerialNumbers": [
    {
      "SerialNumberId": 503,
      "SerialNumber": "SerialA",
      "ProductId": 7571,
      "InventoryLocationId": 6770,
      "DateCreated": "/Date(1727691143980-0000)/",
      "SerialNumberStatus": "Available",
      "SerialNumberDocuments": []     
    },
    {
      "SerialNumberId": 341,
      "SerialNumber": "SerialB",
      "ProductId": 7571,
      "InventoryLocationId": 6770,
      "DateCreated": "/Date(1725280940387-0000)/",
      "SerialNumberStatus": "Available",
      "SerialNumberDocuments": []
    },
    {
      "SerialNumberId": 347,
      "SerialNumber": "SerialB",
      "ProductId": 7572,
      "InventoryLocationId": 6770,
      "DateCreated": "/Date(1725281874650-0000)/",
      "SerialNumberStatus": "Shipped",
      "SerialNumberDocuments": []
    }
  ],
  "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/SerialNumberGet 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"}],"APIKEY":"String","Page":0,"Limit":0}

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

{"mvSerialNumbers":[{"SerialNumberId":0,"SerialNumber":"String","ProductId":0,"InventoryLocationId":0,"DateCreated":"\/Date(-62135596800000-0000)\/","SerialNumberStatus":"Created","SerialNumberStatusText":"String","SerialNumberProduct":{"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},"SerialNumberInventoryLocation":{"InventoryLocationID":0,"InventoryLocationName":"String","InventoryLocationAbbreviation":"String","InventoryLocationAddress":"String","Address":{"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"},"InventoryLocationCurrencyCode":"String","InventoryLocationCompanyId":0,"InventoryLocationIsDeleted":false,"InventoryLocationIsTransit":false},"SerialNumberDocuments":[{"DocumentAccessUrl":"String","DocumentSupplierClientName":"String","InventoryLocationName":"String","ToInventoryLocationName":"String","DocumentId":0,"DocumentTypeId":0,"DocumentTypeAbbreviation":"String","DocumentTypeDescription":"String","DocumentNo":"String","DocumentReferenceNo":"String","DocumentReferenceApplication":"String","DocumentReferenceNo2":"String","DocumentReferenceApplication2":"String","DocumentReferenceNo3":"String","DocumentReferenceApplication3":"String","DocumentDate":"\/Date(-62135596800000-0000)\/","DocumentCustomOrderDate1":"\/Date(-62135596800000-0000)\/","DocumentCustomOrderDate2":"\/Date(-62135596800000-0000)\/","DocumentCurrencyCode":"String","DocumentSupplierClientID":0,"DocumentBillingAddress":"String","DocumentShippingAddress":"String","DocumentAddresses":[{"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"}],"DocumentContactPerson":"String","DocumentInventoryLocationID":0,"DocumentCustomFlag1":false,"DocumentCustomFlag2":false,"DocumentCustomFlag3":false,"DocumentCustomFlag4":false,"DocumentCustomFlag5":false,"DocumentCustomFlag6":false,"DocumentCustomFlag7":false,"DocumentCustomFlag8":false,"DocumentCustomFlag9":false,"DocumentCustomFlag10":false,"DocumentShippingProviderID":0,"DocumentTrackingID":"String","DocumentShippingInfo":{"ProviderInfo":{"ProviderId":0,"ServiceId":"String","PackageId":"String"},"CostInfo":{"ShippingCost":0,"OtherCosts":0,"TotalCost":0},"WeightInfo":{"Weight":0,"WeightUnitId":0},"ShipmentDimensionsInfo":{"ShipmentDimensionsLength":0,"ShipmentDimensionsWidth":0,"ShipmentDimensionsHeight":0,"ShipmentDimensionsUnit":"String"},"ShipDateInfo":{"ShipDate":"String"},"GenericAftersalesProServicesInfo":{"COD":false,"GTEEC":false,"Protocol":false,"Reception":false,"Insurance":false,"ChequeCod":false,"SpecialRate":false,"VipDelivery":false,"SenderCharge":false,"PackageReturn":false,"ReturnDocument":false,"CodTotalInCents":0,"MorningDelivery":false,"SameDayIntracity":false,"SaturdayDelivery":false,"SeaFreightCyprus":false,"RefrigeratedGoods":false,"LessThanTwoKilograms":false,"LessThanFourKilograms":false,"SubmissionOfTenderDocuments":false,"NextDayAirTransportToIslands":false,"ContainsDocumentsOnlyAndIsLessThanTwoKilograms":false},"TrackingId":"String","LockerId":0},"DocumentComments":"String","DocumentTags":"String","DocumentPaymentTermsEnumeration":"None","DocumentPaymentMethod":"None","DocumentParentDocId":0,"DocumentHandlingDocId":0,"DocumentTotalQuantity":0,"DocumentAmountSubtotalWithoutTaxAndDiscount":0.00,"DocumentAmountShipping":0.00,"DocumentAmountTotalDiscount":0.00,"DocumentAmountTotalTax":0.00,"DocumentAmountGrandTotal":0.00,"DocumentTotalWeight":0,"DocumentTotalWeightUnitID":0,"DocumentDetails":[{"DocumentRowDetailID":0,"DocumentRowProductID":0,"DocumentRowProductSKU":"String","DocumentRowProductDescription":"String","DocumentRowQuantity":0,"DocumentRowUnitPriceWithoutTaxOrDiscount":0.00,"DocumentRowTaxID":0,"DocumentTotalTaxAmount":0.00,"DocumentRowDiscountID":0,"DocumentRowTotalDiscountAmount":0.00,"DocumentRowTotalAmount":0.00,"DocumentRowSerialNumbers":["String"],"DocumentRowBatchNumbers":[{"BatchNumberName":"String","ExpiryDate":"\/Date(-62135596800000-0000)\/","AssignedQTYInDetail":0}],"DocumentRowRemarks":"String","DocumentRowTotalWeight":0,"DocumentRowTotalWeightUnitID":0}],"DocumentStatus":"ValidStatus","chkReOpenOrCloseRelatedDocs":false,"DocumentCreationDate":"\/Date(-62135596800000-0000)\/","DocumentLastUpdatedDate":"\/Date(-62135596800000-0000)\/","DocumentExcludeFromForecasting":false}],"SerialNumberLastDocument":{"DocumentAccessUrl":"String","DocumentSupplierClientName":"String","InventoryLocationName":"String","ToInventoryLocationName":"String","DocumentId":0,"DocumentTypeId":0,"DocumentTypeAbbreviation":"String","DocumentTypeDescription":"String","DocumentNo":"String","DocumentReferenceNo":"String","DocumentReferenceApplication":"String","DocumentReferenceNo2":"String","DocumentReferenceApplication2":"String","DocumentReferenceNo3":"String","DocumentReferenceApplication3":"String","DocumentDate":"\/Date(-62135596800000-0000)\/","DocumentCustomOrderDate1":"\/Date(-62135596800000-0000)\/","DocumentCustomOrderDate2":"\/Date(-62135596800000-0000)\/","DocumentCurrencyCode":"String","DocumentSupplierClientID":0,"DocumentBillingAddress":"String","DocumentShippingAddress":"String","DocumentAddresses":[{"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"}],"DocumentContactPerson":"String","DocumentInventoryLocationID":0,"DocumentCustomFlag1":false,"DocumentCustomFlag2":false,"DocumentCustomFlag3":false,"DocumentCustomFlag4":false,"DocumentCustomFlag5":false,"DocumentCustomFlag6":false,"DocumentCustomFlag7":false,"DocumentCustomFlag8":false,"DocumentCustomFlag9":false,"DocumentCustomFlag10":false,"DocumentShippingProviderID":0,"DocumentTrackingID":"String","DocumentShippingInfo":{"ProviderInfo":{"ProviderId":0,"ServiceId":"String","PackageId":"String"},"CostInfo":{"ShippingCost":0,"OtherCosts":0,"TotalCost":0},"WeightInfo":{"Weight":0,"WeightUnitId":0},"ShipmentDimensionsInfo":{"ShipmentDimensionsLength":0,"ShipmentDimensionsWidth":0,"ShipmentDimensionsHeight":0,"ShipmentDimensionsUnit":"String"},"ShipDateInfo":{"ShipDate":"String"},"GenericAftersalesProServicesInfo":{"COD":false,"GTEEC":false,"Protocol":false,"Reception":false,"Insurance":false,"ChequeCod":false,"SpecialRate":false,"VipDelivery":false,"SenderCharge":false,"PackageReturn":false,"ReturnDocument":false,"CodTotalInCents":0,"MorningDelivery":false,"SameDayIntracity":false,"SaturdayDelivery":false,"SeaFreightCyprus":false,"RefrigeratedGoods":false,"LessThanTwoKilograms":false,"LessThanFourKilograms":false,"SubmissionOfTenderDocuments":false,"NextDayAirTransportToIslands":false,"ContainsDocumentsOnlyAndIsLessThanTwoKilograms":false},"TrackingId":"String","LockerId":0},"DocumentComments":"String","DocumentTags":"String","DocumentPaymentTermsEnumeration":"None","DocumentPaymentMethod":"None","DocumentParentDocId":0,"DocumentHandlingDocId":0,"DocumentTotalQuantity":0,"DocumentAmountSubtotalWithoutTaxAndDiscount":0.00,"DocumentAmountShipping":0.00,"DocumentAmountTotalDiscount":0.00,"DocumentAmountTotalTax":0.00,"DocumentAmountGrandTotal":0.00,"DocumentTotalWeight":0,"DocumentTotalWeightUnitID":0,"DocumentDetails":[{"DocumentRowDetailID":0,"DocumentRowProductID":0,"DocumentRowProductSKU":"String","DocumentRowProductDescription":"String","DocumentRowQuantity":0,"DocumentRowUnitPriceWithoutTaxOrDiscount":0.00,"DocumentRowTaxID":0,"DocumentTotalTaxAmount":0.00,"DocumentRowDiscountID":0,"DocumentRowTotalDiscountAmount":0.00,"DocumentRowTotalAmount":0.00,"DocumentRowSerialNumbers":["String"],"DocumentRowBatchNumbers":[{"BatchNumberName":"String","ExpiryDate":"\/Date(-62135596800000-0000)\/","AssignedQTYInDetail":0}],"DocumentRowRemarks":"String","DocumentRowTotalWeight":0,"DocumentRowTotalWeightUnitID":0}],"DocumentStatus":"ValidStatus","chkReOpenOrCloseRelatedDocs":false,"DocumentCreationDate":"\/Date(-62135596800000-0000)\/","DocumentLastUpdatedDate":"\/Date(-62135596800000-0000)\/","DocumentExcludeFromForecasting":false}}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]}}