Megaventory API v2017a

<back to all web services

SalesOrderGet

Gets information on existing sales ordersUses your API Key and some Filters in an array format and returns the search results using 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 SalesOrderId descending order.

Examples:



A.

Return the first mvSalesOrders object that we have to pickup out of Athens. The results are returned as mvSalesOrders objects.

Value: 

 {
   "Filters": [
      {
         "FieldName": "SalesOrderShippingAddress",
         "SearchOperator": "NotEquals",
         "SearchValue": "Athens"
      }
   ],
   "ReturnTopNRecords": 1
}

Response: 

{
   "mvSalesOrders": [
      {
         "SalesOrderId": 49411,
         "SalesOrderTypeId": 3,
         "SalesOrderTypeAbbreviation": "SO",
         "SalesOrderTypeDescription": "Sales Order",
         "SalesOrderNo": "62",
         "SalesOrderReferenceNo": "",
         "SalesOrderReferenceApplication": "",
         "SalesOrderDate": "/Date(1531342800000-0000)/",
         "SalesOrderCustomOrderDate1": "/Date(-62135596800000-0000)/",
         "SalesOrderCustomOrderDate2": "/Date(-62135596800000-0000)/",
         "SalesOrderCurrencyCode": "USD",
         "SalesOrderClientID": 5357,
         "SalesOrderAddress": "",
         "SalesOrderShippingAddress": "",
         "SalesOrderContactPerson": "c2",
         "SalesOrderInventoryLocationID": 0,
         "SalesOrderCustomFlag1": false,
         "SalesOrderCustomFlag2": false,
         "SalesOrderCustomFlag3": false,
         "SalesOrderCustomFlag4": false,
         "SalesOrderCustomFlag5": false,
         "SalesOrderCustomFlag6": false,
         "SalesOrderCustomFlag7": false,
         "SalesOrderCustomFlag8": false,
         "SalesOrderCustomFlag9": false,
         "SalesOrderCustomFlag10": false,
         "SalesOrderComments": "",
         "SalesOrderTags": "",
         "SalesOrderPaymentTermsEnumeration": "None",
         "SalesOrderTotalQuantity": 1,
         "SalesOrderAmountSubtotalWithoutTaxAndDiscount": 0,
         "SalesOrderAmountTotalDiscount": 0,
         "SalesOrderAmountTotalTax": 0,
         "SalesOrderAmountGrandTotal": 0,
         "SalesOrderDetails": [
            {
               "SalesOrderRowDetailID": 76498,
               "SalesOrderRowProductID": 59333,
               "SalesOrderRowProductSKU": "product",
               "SalesOrderRowProductDescription": "product",
               "SalesOrderRowQuantity": 1,
               "SalesOrderRowShippedQuantity": 0,
               "SalesOrderRowInvoicedQuantity": 0,
               "SalesOrderRowUnitPriceWithoutTaxOrDiscount": 0,
               "SalesOrderRowTaxID": 0,
               "SalesOrderTotalTaxAmount": 0,
               "SalesOrderRowDiscountID": 0,
               "SalesOrderRowTotalDiscountAmount": 0,
               "SalesOrderRowTotalAmount": 0,
               "SalesOrderRowSerialNumbers": [],
               "SalesOrderRowBatchNumbers": [],
               "SalesOrderRowRemarks": ""
            }
         ],
         "SalesOrderStatus": "Pending",
         "SalesOrderCreationDate": "/Date(1531413275417-0000)/",
         "SalesOrderLastUpdatedDate": "/Date(1531413538977-0000)/"
      }
   ],
   "ResponseStatus": {
      "ErrorCode": "0"
   }
}

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

HTTP + SOAP12

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

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

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

<SalesOrderGet 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>
  <mvSalesOrderNo>String</mvSalesOrderNo>
  <mvSalesOrderStatus>ValidStatus</mvSalesOrderStatus>
</SalesOrderGet>

    </soap12:Body>
</soap12:Envelope>

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

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

<SalesOrderGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvSalesOrders xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:mvSalesOrder>
      <d2p1:SalesOrderId>0</d2p1:SalesOrderId>
      <d2p1:SalesOrderTypeId>0</d2p1:SalesOrderTypeId>
      <d2p1:SalesOrderTypeAbbreviation>String</d2p1:SalesOrderTypeAbbreviation>
      <d2p1:SalesOrderTypeDescription>String</d2p1:SalesOrderTypeDescription>
      <d2p1:SalesOrderNo>String</d2p1:SalesOrderNo>
      <d2p1:SalesOrderReferenceNo>String</d2p1:SalesOrderReferenceNo>
      <d2p1:SalesOrderReferenceApplication>String</d2p1:SalesOrderReferenceApplication>
      <d2p1:SalesOrderDate>0001-01-01T00:00:00</d2p1:SalesOrderDate>
      <d2p1:SalesOrderCustomOrderDate1>0001-01-01T00:00:00</d2p1:SalesOrderCustomOrderDate1>
      <d2p1:SalesOrderCustomOrderDate2>0001-01-01T00:00:00</d2p1:SalesOrderCustomOrderDate2>
      <d2p1:SalesOrderCurrencyCode>String</d2p1:SalesOrderCurrencyCode>
      <d2p1:SalesOrderClientID>0</d2p1:SalesOrderClientID>
      <d2p1:SalesOrderClientName>String</d2p1:SalesOrderClientName>
      <d2p1:SalesOrderBillingAddress>String</d2p1:SalesOrderBillingAddress>
      <d2p1:SalesOrderShippingAddress>String</d2p1:SalesOrderShippingAddress>
      <d2p1:SalesOrderAddresses>
        <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:SalesOrderAddresses>
      <d2p1:SalesOrderContactPerson>String</d2p1:SalesOrderContactPerson>
      <d2p1:SalesOrderInventoryLocationID>0</d2p1:SalesOrderInventoryLocationID>
      <d2p1:SalesOrderCustomFlag1>false</d2p1:SalesOrderCustomFlag1>
      <d2p1:SalesOrderCustomFlag2>false</d2p1:SalesOrderCustomFlag2>
      <d2p1:SalesOrderCustomFlag3>false</d2p1:SalesOrderCustomFlag3>
      <d2p1:SalesOrderCustomFlag4>false</d2p1:SalesOrderCustomFlag4>
      <d2p1:SalesOrderCustomFlag5>false</d2p1:SalesOrderCustomFlag5>
      <d2p1:SalesOrderCustomFlag6>false</d2p1:SalesOrderCustomFlag6>
      <d2p1:SalesOrderCustomFlag7>false</d2p1:SalesOrderCustomFlag7>
      <d2p1:SalesOrderCustomFlag8>false</d2p1:SalesOrderCustomFlag8>
      <d2p1:SalesOrderCustomFlag9>false</d2p1:SalesOrderCustomFlag9>
      <d2p1:SalesOrderCustomFlag10>false</d2p1:SalesOrderCustomFlag10>
      <d2p1:SalesOrderComments>String</d2p1:SalesOrderComments>
      <d2p1:SalesOrderTags>String</d2p1:SalesOrderTags>
      <d2p1:SalesOrderPaymentTermsEnumeration>None</d2p1:SalesOrderPaymentTermsEnumeration>
      <d2p1:SalesOrderPaymentMethod>None</d2p1:SalesOrderPaymentMethod>
      <d2p1:SalesOrderTotalQuantity>0</d2p1:SalesOrderTotalQuantity>
      <d2p1:SalesOrderAmountSubtotalWithoutTaxAndDiscount>0.00</d2p1:SalesOrderAmountSubtotalWithoutTaxAndDiscount>
      <d2p1:SalesOrderAmountShipping>0.00</d2p1:SalesOrderAmountShipping>
      <d2p1:SalesOrderAmountTotalDiscount>0.00</d2p1:SalesOrderAmountTotalDiscount>
      <d2p1:SalesOrderAmountTotalTax>0.00</d2p1:SalesOrderAmountTotalTax>
      <d2p1:SalesOrderAmountGrandTotal>0.00</d2p1:SalesOrderAmountGrandTotal>
      <d2p1:SalesOrderTotalWeight>0</d2p1:SalesOrderTotalWeight>
      <d2p1:SalesOrderTotalWeightUnitID>0</d2p1:SalesOrderTotalWeightUnitID>
      <d2p1:SalesOrderDetails>
        <d2p1:mvSalesOrderRow>
          <d2p1:SalesOrderRowDetailID>0</d2p1:SalesOrderRowDetailID>
          <d2p1:SalesOrderRowProductID>0</d2p1:SalesOrderRowProductID>
          <d2p1:SalesOrderRowProductSKU>String</d2p1:SalesOrderRowProductSKU>
          <d2p1:SalesOrderRowProductDescription>String</d2p1:SalesOrderRowProductDescription>
          <d2p1:SalesOrderRowQuantity>0</d2p1:SalesOrderRowQuantity>
          <d2p1:SalesOrderRowShippedQuantity>0</d2p1:SalesOrderRowShippedQuantity>
          <d2p1:SalesOrderRowInvoicedQuantity>0</d2p1:SalesOrderRowInvoicedQuantity>
          <d2p1:SalesOrderRowUnitPriceWithoutTaxOrDiscount>0</d2p1:SalesOrderRowUnitPriceWithoutTaxOrDiscount>
          <d2p1:SalesOrderRowTaxID>0</d2p1:SalesOrderRowTaxID>
          <d2p1:SalesOrderTotalTaxAmount>0</d2p1:SalesOrderTotalTaxAmount>
          <d2p1:SalesOrderRowDiscountID>0</d2p1:SalesOrderRowDiscountID>
          <d2p1:SalesOrderRowTotalDiscountAmount>0</d2p1:SalesOrderRowTotalDiscountAmount>
          <d2p1:SalesOrderRowTotalAmount>0</d2p1:SalesOrderRowTotalAmount>
          <d2p1:SalesOrderRowSerialNumbers xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d2p1:SalesOrderRowSerialNumbers>
          <d2p1:SalesOrderRowBatchNumbers>
            <d2p1:BatchNumberDetails>
              <d2p1:AssignedQTYInDetail>0</d2p1:AssignedQTYInDetail>
              <d2p1:BatchNumberName>String</d2p1:BatchNumberName>
              <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
            </d2p1:BatchNumberDetails>
          </d2p1:SalesOrderRowBatchNumbers>
          <d2p1:SalesOrderRowRemarks>String</d2p1:SalesOrderRowRemarks>
          <d2p1:SalesOrderRowTotalWeight>0</d2p1:SalesOrderRowTotalWeight>
          <d2p1:SalesOrderRowTotalWeightUnitID>0</d2p1:SalesOrderRowTotalWeightUnitID>
        </d2p1:mvSalesOrderRow>
      </d2p1:SalesOrderDetails>
      <d2p1:SalesOrderShippingProviderInfo 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:SalesOrderShippingProviderInfo>
      <d2p1:SalesOrderShipDocumentTypeID>String</d2p1:SalesOrderShipDocumentTypeID>
      <d2p1:SalesOrderShipDocumentNo>String</d2p1:SalesOrderShipDocumentNo>
      <d2p1:SalesOrderStatus>ValidStatus</d2p1:SalesOrderStatus>
      <d2p1:chkReOpenOrCloseRelatedDocs>false</d2p1:chkReOpenOrCloseRelatedDocs>
      <d2p1:SalesOrderCreationDate>0001-01-01T00:00:00</d2p1:SalesOrderCreationDate>
      <d2p1:SalesOrderLastUpdatedDate>0001-01-01T00:00:00</d2p1:SalesOrderLastUpdatedDate>
      <d2p1:SalesOrderShipDocumentIssueDate>0001-01-01T00:00:00</d2p1:SalesOrderShipDocumentIssueDate>
    </d2p1:mvSalesOrder>
  </mvSalesOrders>
  <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>
</SalesOrderGetResponse>

    </soap12:Body>
</soap12:Envelope>