Megaventory API v2017a

<back to all web services

DocumentGet

Gets information on existing documents.Uses 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 DocumentId descending order.

Examples:



A.

Return the first document whose currency is EUR and its billing address is not empty. The result is returned as an mvDocuments object.

Value:

 {
   "Filters": [
      {
         "FieldName": "DocumentCurrencyCode",
         "SearchOperator": "Equals",
         "SearchValue": "EUR"
      },
      {
         "AndOr": "And",
         "FieldName": "DocumentBillingAddress",
         "SearchOperator": "NotEquals",
         "SearchValue": ""
      }
   ],
   "ReturnTopNRecords": 1
}

Response:

{
   "mvDocuments": [
      {
         "DocumentId": 48222,
         "DocumentTypeId": -3,
         "DocumentTypeAbbreviation": "GO",
         "DocumentTypeDescription": "Goods Outbound",
         "DocumentNo": "dfsd",
         "DocumentReferenceNo": "",
         "DocumentReferenceApplication": "",
         "DocumentDate": "/Date(1522251084943-0000)/",
         "DocumentCustomOrderDate1": "/Date(-62135596800000-0000)/",
         "DocumentCustomOrderDate2": "/Date(-62135596800000-0000)/",
         "DocumentCurrencyCode": "EUR",
         "DocumentSupplierClientID": 5358,
         "DocumentBillingAddress": "sdfasdfsdf",
         "DocumentAddress": "dfdsfgdf",
         "DocumentContactPerson": "",
         "DocumentInventoryLocationID": 3405,
         "DocumentCustomFlag1": false,
         "DocumentCustomFlag2": false,
         "DocumentCustomFlag3": false,
         "DocumentCustomFlag4": false,
         "DocumentCustomFlag5": false,
         "DocumentCustomFlag6": false,
         "DocumentCustomFlag7": false,
         "DocumentCustomFlag8": false,
         "DocumentCustomFlag9": false,
         "DocumentCustomFlag10": false,
         "DocumentShippingProviderID": 0,
         "DocumentTrackingID": "",
         "DocumentComments": "",
         "DocumentPaymentTermsEnumeration": "0",
         "DocumentTags": "",
         "DocumentPaymentTermsEnumeration": "None",
         "DocumentParentDocId": 48221,
         "DocumentTotalQuantity": 2,
         "DocumentAmountSubtotalWithoutTaxAndDiscount": 0,
         "DocumentAmountShipping": 0,
         "DocumentAmountTotalDiscount": 0,
         "DocumentAmountTotalTax": 0,
         "DocumentAmountGrandTotal": 0,
         "DocumentDetails": [
            {
               "DocumentRowDetailID": 76504,
               "DocumentRowProductID": 60424,
               "DocumentRowProductSKU": "serialized",
               "DocumentRowProductDescription": "serialized",
               "DocumentRowQuantity": 1,
               "DocumentRowUnitPriceWithoutTaxOrDiscount": 0,
               "DocumentRowTaxID": 0,
               "DocumentTotalTaxAmount": 0,
               "DocumentRowDiscountID": 0,
               "DocumentRowTotalDiscountAmount": 0,
               "DocumentRowTotalAmount": 0,
               "DocumentRowSerialNumbers": [],
               "DocumentRowBatchNumbers": [],
               "DocumentRowRemarks": ""
            },
            {
               "DocumentRowDetailID": 76504,
               "DocumentRowProductID": 60424,
               "DocumentRowProductSKU": "serialized",
               "DocumentRowProductDescription": "serialized",
               "DocumentRowQuantity": 1,
               "DocumentRowUnitPriceWithoutTaxOrDiscount": 0,
               "DocumentRowTaxID": 0,
               "DocumentTotalTaxAmount": 0,
               "DocumentRowDiscountID": 0,
               "DocumentRowTotalDiscountAmount": 0,
               "DocumentRowTotalAmount": 0,
               "DocumentRowSerialNumbers": [],
               "DocumentRowBatchNumbers": [],
               "DocumentRowRemarks": ""
            }
         ],
         "DocumentStatus": "Verified",
         "DocumentCreationDate": "/Date(1522251084927-0000)/",
         "DocumentLastUpdatedDate": "/Date(1522251084943-0000)/"
      }
   ],
   "ResponseStatus": {
      "ErrorCode": "0"
   }
}

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

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: api.megaventory.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: DocumentGet

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<DocumentGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <Filters xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints">
    <Filter>
      <AndOr>And</AndOr>
      <FieldName>String</FieldName>
      <Group>Undefined</Group>
      <SearchOperator>Undefined</SearchOperator>
      <SearchValue>String</SearchValue>
    </Filter>
  </Filters>
  <ReturnTopNRecords xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints">0</ReturnTopNRecords>
  <APIKEY>String</APIKEY>
  <mvDocumentTypeIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </mvDocumentTypeIDs>
  <mvDocumentNo>String</mvDocumentNo>
  <mvDocumentStatus>ValidStatus</mvDocumentStatus>
</DocumentGet>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<DocumentGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvDocuments xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:mvDocument>
      <d2p1:DocumentId>0</d2p1:DocumentId>
      <d2p1:DocumentTypeId>0</d2p1:DocumentTypeId>
      <d2p1:DocumentTypeAbbreviation>String</d2p1:DocumentTypeAbbreviation>
      <d2p1:DocumentTypeDescription>String</d2p1:DocumentTypeDescription>
      <d2p1:DocumentNo>String</d2p1:DocumentNo>
      <d2p1:DocumentReferenceNo>String</d2p1:DocumentReferenceNo>
      <d2p1:DocumentReferenceApplication>String</d2p1:DocumentReferenceApplication>
      <d2p1:DocumentDate>0001-01-01T00:00:00</d2p1:DocumentDate>
      <d2p1:DocumentCustomOrderDate1>0001-01-01T00:00:00</d2p1:DocumentCustomOrderDate1>
      <d2p1:DocumentCustomOrderDate2>0001-01-01T00:00:00</d2p1:DocumentCustomOrderDate2>
      <d2p1:DocumentCurrencyCode>String</d2p1:DocumentCurrencyCode>
      <d2p1:DocumentSupplierClientID>0</d2p1:DocumentSupplierClientID>
      <d2p1:DocumentSupplierClientName>String</d2p1:DocumentSupplierClientName>
      <d2p1:DocumentBillingAddress>String</d2p1:DocumentBillingAddress>
      <d2p1:DocumentAddress>String</d2p1:DocumentAddress>
      <d2p1:DocumentAddresses>
        <d2p1:mvAddress>
          <d2p1:AddressType>General</d2p1:AddressType>
          <d2p1:AddressLine1>String</d2p1:AddressLine1>
          <d2p1:AddressLine2>String</d2p1:AddressLine2>
          <d2p1:AddressLine3>String</d2p1:AddressLine3>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Phone>String</d2p1:Phone>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:TaxIdNumber>String</d2p1:TaxIdNumber>
          <d2p1:Organization>String</d2p1:Organization>
          <d2p1:City>String</d2p1:City>
          <d2p1:State>String</d2p1:State>
          <d2p1:Country>NONE</d2p1:Country>
          <d2p1:CountryName>String</d2p1:CountryName>
          <d2p1:Longitude>String</d2p1:Longitude>
          <d2p1:Latitude>String</d2p1:Latitude>
          <d2p1:ZipCode>String</d2p1:ZipCode>
        </d2p1:mvAddress>
      </d2p1:DocumentAddresses>
      <d2p1:DocumentContactPerson>String</d2p1:DocumentContactPerson>
      <d2p1:DocumentInventoryLocationID>0</d2p1:DocumentInventoryLocationID>
      <d2p1:DocumentCustomFlag1>false</d2p1:DocumentCustomFlag1>
      <d2p1:DocumentCustomFlag6>false</d2p1:DocumentCustomFlag6>
      <d2p1:DocumentCustomFlag2>false</d2p1:DocumentCustomFlag2>
      <d2p1:DocumentCustomFlag7>false</d2p1:DocumentCustomFlag7>
      <d2p1:DocumentCustomFlag3>false</d2p1:DocumentCustomFlag3>
      <d2p1:DocumentCustomFlag8>false</d2p1:DocumentCustomFlag8>
      <d2p1:DocumentCustomFlag4>false</d2p1:DocumentCustomFlag4>
      <d2p1:DocumentCustomFlag9>false</d2p1:DocumentCustomFlag9>
      <d2p1:DocumentCustomFlag10>false</d2p1:DocumentCustomFlag10>
      <d2p1:DocumentCustomFlag5>false</d2p1:DocumentCustomFlag5>
      <d2p1:DocumentShippingProviderID>0</d2p1:DocumentShippingProviderID>
      <d2p1:DocumentTrackingID>String</d2p1:DocumentTrackingID>
      <d2p1:DocumentShippingInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/Megaventory.Models.DTOs.MvShippingProviderDTOs">
        <d4p1:ProviderInfo>
          <d4p1:ProviderId>0</d4p1:ProviderId>
          <d4p1:ServiceId>String</d4p1:ServiceId>
          <d4p1:PackageId>String</d4p1:PackageId>
        </d4p1:ProviderInfo>
        <d4p1:CostInfo>
          <d4p1:ShippingCost>0</d4p1:ShippingCost>
          <d4p1:OtherCosts>0</d4p1:OtherCosts>
          <d4p1:TotalCost>0</d4p1:TotalCost>
        </d4p1:CostInfo>
        <d4p1:WeightInfo>
          <d4p1:Weight>0</d4p1:Weight>
          <d4p1:WeightUnitId>0</d4p1:WeightUnitId>
        </d4p1:WeightInfo>
        <d4p1:ShipDateInfo>
          <d4p1:ShipDate>String</d4p1:ShipDate>
        </d4p1:ShipDateInfo>
        <d4p1:GenericAftersalesProServicesInfo>
          <d4p1:COD>false</d4p1:COD>
          <d4p1:GTEEC>false</d4p1:GTEEC>
          <d4p1:Protocol>false</d4p1:Protocol>
          <d4p1:Reception>false</d4p1:Reception>
          <d4p1:Insurance>false</d4p1:Insurance>
          <d4p1:ChequeCod>false</d4p1:ChequeCod>
          <d4p1:SpecialRate>false</d4p1:SpecialRate>
          <d4p1:VipDelivery>false</d4p1:VipDelivery>
          <d4p1:SenderCharge>false</d4p1:SenderCharge>
          <d4p1:PackageReturn>false</d4p1:PackageReturn>
          <d4p1:CodTotalInCents>0</d4p1:CodTotalInCents>
          <d4p1:ReturnDocument>false</d4p1:ReturnDocument>
          <d4p1:MorningDelivery>false</d4p1:MorningDelivery>
          <d4p1:SameDayIntracity>false</d4p1:SameDayIntracity>
          <d4p1:SaturdayDelivery>false</d4p1:SaturdayDelivery>
          <d4p1:SeaFreightCyprus>false</d4p1:SeaFreightCyprus>
          <d4p1:RefrigeratedGoods>false</d4p1:RefrigeratedGoods>
          <d4p1:LessThanTwoKilograms>false</d4p1:LessThanTwoKilograms>
          <d4p1:LessThanFourKilograms>false</d4p1:LessThanFourKilograms>
          <d4p1:SubmissionOfTenderDocuments>false</d4p1:SubmissionOfTenderDocuments>
          <d4p1:NextDayAirTransportToIslands>false</d4p1:NextDayAirTransportToIslands>
          <d4p1:ContainsDocumentsOnlyAndIsLessThanTwoKilograms>false</d4p1:ContainsDocumentsOnlyAndIsLessThanTwoKilograms>
        </d4p1:GenericAftersalesProServicesInfo>
        <d4p1:LockerId>0</d4p1:LockerId>
        <d4p1:TrackingId>String</d4p1:TrackingId>
      </d2p1:DocumentShippingInfo>
      <d2p1:DocumentComments>String</d2p1:DocumentComments>
      <d2p1:DocumentTags>String</d2p1:DocumentTags>
      <d2p1:DocumentPaymentTermsEnumeration>None</d2p1:DocumentPaymentTermsEnumeration>
      <d2p1:DocumentPaymentMethod>None</d2p1:DocumentPaymentMethod>
      <d2p1:DocumentParentDocId>0</d2p1:DocumentParentDocId>
      <d2p1:DocumentHandlingDocId>0</d2p1:DocumentHandlingDocId>
      <d2p1:DocumentTotalQuantity>0</d2p1:DocumentTotalQuantity>
      <d2p1:DocumentAmountSubtotalWithoutTaxAndDiscount>0.00</d2p1:DocumentAmountSubtotalWithoutTaxAndDiscount>
      <d2p1:DocumentAmountShipping>0.00</d2p1:DocumentAmountShipping>
      <d2p1:DocumentAmountTotalDiscount>0.00</d2p1:DocumentAmountTotalDiscount>
      <d2p1:DocumentAmountTotalTax>0.00</d2p1:DocumentAmountTotalTax>
      <d2p1:DocumentAmountGrandTotal>0.00</d2p1:DocumentAmountGrandTotal>
      <d2p1:DocumentTotalWeight>0</d2p1:DocumentTotalWeight>
      <d2p1:DocumentTotalWeightUnitID>0</d2p1:DocumentTotalWeightUnitID>
      <d2p1:DocumentDetails>
        <d2p1:mvDocumentRow>
          <d2p1:DocumentRowDetailID>0</d2p1:DocumentRowDetailID>
          <d2p1:DocumentRowProductID>0</d2p1:DocumentRowProductID>
          <d2p1:DocumentRowProductSKU>String</d2p1:DocumentRowProductSKU>
          <d2p1:DocumentRowProductDescription>String</d2p1:DocumentRowProductDescription>
          <d2p1:DocumentRowQuantity>0</d2p1:DocumentRowQuantity>
          <d2p1:DocumentRowUnitPriceWithoutTaxOrDiscount>0.00</d2p1:DocumentRowUnitPriceWithoutTaxOrDiscount>
          <d2p1:DocumentRowTaxID>0</d2p1:DocumentRowTaxID>
          <d2p1:DocumentTotalTaxAmount>0.00</d2p1:DocumentTotalTaxAmount>
          <d2p1:DocumentRowDiscountID>0</d2p1:DocumentRowDiscountID>
          <d2p1:DocumentRowTotalDiscountAmount>0.00</d2p1:DocumentRowTotalDiscountAmount>
          <d2p1:DocumentRowTotalAmount>0.00</d2p1:DocumentRowTotalAmount>
          <d2p1:DocumentRowSerialNumbers xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d2p1:DocumentRowSerialNumbers>
          <d2p1:DocumentRowBatchNumbers>
            <d2p1:BatchNumberDetails>
              <d2p1:AssignedQTYInDetail>0</d2p1:AssignedQTYInDetail>
              <d2p1:BatchNumberName>String</d2p1:BatchNumberName>
              <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
            </d2p1:BatchNumberDetails>
          </d2p1:DocumentRowBatchNumbers>
          <d2p1:DocumentRowRemarks>String</d2p1:DocumentRowRemarks>
          <d2p1:DocumentRowTotalWeight>0</d2p1:DocumentRowTotalWeight>
          <d2p1:DocumentRowTotalWeightUnitID>0</d2p1:DocumentRowTotalWeightUnitID>
        </d2p1:mvDocumentRow>
      </d2p1:DocumentDetails>
      <d2p1:DocumentStatus>ValidStatus</d2p1:DocumentStatus>
      <d2p1:chkReOpenOrCloseRelatedDocs>false</d2p1:chkReOpenOrCloseRelatedDocs>
      <d2p1:DocumentCreationDate>0001-01-01T00:00:00</d2p1:DocumentCreationDate>
      <d2p1:DocumentLastUpdatedDate>0001-01-01T00:00:00</d2p1:DocumentLastUpdatedDate>
    </d2p1:mvDocument>
  </mvDocuments>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <InternalErrorCode>String</InternalErrorCode>
</DocumentGetResponse>

    </soap:Body>
</soap:Envelope>