Megaventory API v2017a

<back to all web services

SalesOrderGet

The following routes are available for this service:
GET POST/SalesOrder/SalesOrderGetGets 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 .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/SalesOrderGet 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","mvSalesOrderNo":"String","mvSalesOrderStatus":"ValidStatus"}

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

{"mvSalesOrders":[{"SalesOrderId":0,"SalesOrderTypeId":0,"SalesOrderTypeAbbreviation":"String","SalesOrderTypeDescription":"String","SalesOrderNo":"String","SalesOrderReferenceNo":"String","SalesOrderReferenceApplication":"String","SalesOrderDate":"\/Date(-62135596800000-0000)\/","SalesOrderCustomOrderDate1":"\/Date(-62135596800000-0000)\/","SalesOrderCustomOrderDate2":"\/Date(-62135596800000-0000)\/","SalesOrderCurrencyCode":"String","SalesOrderClientID":0,"SalesOrderClientName":"String","SalesOrderBillingAddress":"String","SalesOrderShippingAddress":"String","SalesOrderAddresses":[{"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"}],"SalesOrderContactPerson":"String","SalesOrderInventoryLocationID":0,"SalesOrderCustomFlag1":false,"SalesOrderCustomFlag2":false,"SalesOrderCustomFlag3":false,"SalesOrderCustomFlag4":false,"SalesOrderCustomFlag5":false,"SalesOrderCustomFlag6":false,"SalesOrderCustomFlag7":false,"SalesOrderCustomFlag8":false,"SalesOrderCustomFlag9":false,"SalesOrderCustomFlag10":false,"SalesOrderComments":"String","SalesOrderTags":"String","SalesOrderPaymentTermsEnumeration":"None","SalesOrderPaymentMethod":"None","SalesOrderTotalQuantity":0,"SalesOrderAmountSubtotalWithoutTaxAndDiscount":0.00,"SalesOrderAmountShipping":0.00,"SalesOrderAmountTotalDiscount":0.00,"SalesOrderAmountTotalTax":0.00,"SalesOrderAmountGrandTotal":0.00,"SalesOrderTotalWeight":0,"SalesOrderTotalWeightUnitID":0,"SalesOrderDetails":[{"SalesOrderRowDetailID":0,"SalesOrderRowProductID":0,"SalesOrderRowProductSKU":"String","SalesOrderRowProductDescription":"String","SalesOrderRowQuantity":0,"SalesOrderRowShippedQuantity":0,"SalesOrderRowInvoicedQuantity":0,"SalesOrderRowUnitPriceWithoutTaxOrDiscount":0,"SalesOrderRowTaxID":0,"SalesOrderTotalTaxAmount":0,"SalesOrderRowDiscountID":0,"SalesOrderRowTotalDiscountAmount":0,"SalesOrderRowTotalAmount":0,"SalesOrderRowSerialNumbers":["String"],"SalesOrderRowBatchNumbers":[{"BatchNumberName":"String","ExpiryDate":"\/Date(-62135596800000-0000)\/","AssignedQTYInDetail":0}],"SalesOrderRowRemarks":"String","SalesOrderRowTotalWeight":0,"SalesOrderRowTotalWeightUnitID":0}],"SalesOrderShippingProviderInfo":{"ProviderInfo":{"ProviderId":0,"ServiceId":"String","PackageId":"String"},"CostInfo":{"ShippingCost":0,"OtherCosts":0,"TotalCost":0},"WeightInfo":{"Weight":0,"WeightUnitId":0},"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},"SalesOrderShipDocumentTypeID":"String","SalesOrderShipDocumentNo":"String","SalesOrderStatus":"ValidStatus","chkReOpenOrCloseRelatedDocs":false,"SalesOrderCreationDate":"\/Date(-62135596800000-0000)\/","SalesOrderLastUpdatedDate":"\/Date(-62135596800000-0000)\/","SalesOrderShipDocumentIssueDate":"\/Date(-62135596800000-0000)\/"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"InternalErrorCode":"String"}