Megaventory API v2017a

<back to all web services

PurchaseOrderGet

The following routes are available for this service:
GET POST/PurchaseOrder/PurchaseOrderGetGets information on existing purchase 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 PurchaseOrderId descending order.

Examples:



A.

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

Value: 

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

Response: 

{
   "mvPurchaseOrders": [
      {
         "PurchaseOrderId": 49411,
         "PurchaseOrderTypeId": 4,
         "PurchaseOrderTypeAbbreviation": "PO",
         "PurchaseOrderTypeDescription": "Purchase Order",
         "PurchaseOrderNo": "62",
         "PurchaseOrderReferenceNo": "",
         "PurchaseOrderReferenceApplication": "",
         "PurchaseOrderDate": "/Date(1531342800000-0000)/",
         "PurchaseOrderCustomOrderDate1": "/Date(-62135596800000-0000)/",
         "PurchaseOrderCustomOrderDate2": "/Date(-62135596800000-0000)/",
         "PurchaseOrderCurrencyCode": "USD",
         "PurchaseOrderSupplierID": 5357,
         "PurchaseOrderAddress": "",
         "PurchaseOrderPickupAddress": "",
         "PurchaseOrderContactPerson": "c2",
         "PurchaseOrderInventoryLocationID": 0,
         "PurchaseOrderCustomFlag1": false,
         "PurchaseOrderCustomFlag2": false,
         "PurchaseOrderCustomFlag3": false,
         "PurchaseOrderCustomFlag4": false,
         "PurchaseOrderCustomFlag5": false,
         "PurchaseOrderCustomFlag6": false,
         "PurchaseOrderCustomFlag7": false,
         "PurchaseOrderCustomFlag8": false,
         "PurchaseOrderCustomFlag9": false,
         "PurchaseOrderCustomFlag10": false,
         "PurchaseOrderComments": "",
         "PurchaseOrderTags": "",
         "PurchaseOrderPaymentTermsEnumeration": "None",
         "PurchaseOrderTotalQuantity": 1,
         "PurchaseOrderAmountSubtotalWithoutTaxAndDiscount": 0,
         "PurchaseOrderAmountTotalDiscount": 0,
         "PurchaseOrderAmountTotalTax": 0,
         "PurchaseOrderAmountGrandTotal": 0,
         "PurchaseOrderDetails": [
            {
               "PurchaseOrderRowDetailID": 76069,
               "PurchaseOrderRowProductID": 59373,
               "PurchaseOrderRowProductSKU": "product",
               "PurchaseOrderRowProductDescription": "product",
               "PurchaseOrderRowQuantity": 1,
               "PurchaseOrderRowReceivedQuantity": 0,
               "PurchaseOrderRowInvoicedQuantity": 0,
               "PurchaseOrderRowUnitPriceWithoutTaxOrDiscount": 0,
               "PurchaseOrderRowTaxID": 0,
               "PurchaseOrderTotalTaxAmount": 0,
               "PurchaseOrderRowDiscountID": 0,
               "PurchaseOrderRowTotalDiscountAmount": 0,
               "PurchaseOrderRowTotalAmount": 0,
               "PurchaseOrderRowSerialNumbers": [],
               "PurchaseOrderRowBatchNumbers": [],
               "PurchaseOrderRowRemarks": "",
               "PurchaseOrderRowExpectedReceivingDateEarliest": "/Date(-62135596800000-0000)/",
               "PurchaseOrderRowExpectedReceivingDateLatest": "/Date(-62135596800000-0000)/"
            }
         ],
         "PurchaseOrderStatus": "Pending",
         "PurchaseOrderCreationDate": "/Date(1531413275417-0000)/",
         "PurchaseOrderLastUpdatedDate": "/Date(1531413538977-0000)/",
         "PurchaseOrderExpectedReceivingDateEarliest": "/Date(-62135596800000-0000)/",
         "PurchaseOrderExpectedReceivingDateLatest": "/Date(-62135596800000-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/PurchaseOrderGet 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","mvPurchaseOrderNo":"String","mvPurchaseOrderStatus":"ValidStatus"}

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

{"mvPurchaseOrders":[{"PurchaseOrderId":0,"PurchaseOrderTypeId":0,"PurchaseOrderTypeAbbreviation":"String","PurchaseOrderTypeDescription":"String","PurchaseOrderNo":"String","PurchaseOrderReferenceNo":"String","PurchaseOrderReferenceApplication":"String","PurchaseOrderReferenceNo2":"String","PurchaseOrderReferenceApplication2":"String","PurchaseOrderReferenceNo3":"String","PurchaseOrderReferenceApplication3":"String","PurchaseOrderDate":"\/Date(-62135596800000-0000)\/","PurchaseOrderCustomOrderDate1":"\/Date(-62135596800000-0000)\/","PurchaseOrderCustomOrderDate2":"\/Date(-62135596800000-0000)\/","PurchaseOrderCurrencyCode":"String","PurchaseOrderSupplierID":0,"PurchaseOrderSupplierName":"String","PurchaseOrderAddress":"String","PurchaseOrderPickupAddress":"String","PurchaseOrderAddresses":[{"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"}],"PurchaseOrderContactPerson":"String","PurchaseOrderInventoryLocationID":0,"PurchaseOrderCustomFlag1":false,"PurchaseOrderCustomFlag2":false,"PurchaseOrderCustomFlag3":false,"PurchaseOrderCustomFlag4":false,"PurchaseOrderCustomFlag5":false,"PurchaseOrderCustomFlag6":false,"PurchaseOrderCustomFlag7":false,"PurchaseOrderCustomFlag8":false,"PurchaseOrderCustomFlag9":false,"PurchaseOrderCustomFlag10":false,"PurchaseOrderComments":"String","PurchaseOrderTags":"String","PurchaseOrderTotalWeight":0,"PurchaseOrderTotalWeightUnitID":0,"PurchaseOrderPaymentTermsEnumeration":"None","PurchaseOrderPaymentMethod":"None","PurchaseOrderTotalQuantity":0,"PurchaseOrderAmountSubtotalWithoutTaxAndDiscount":0.00,"PurchaseOrderAmountTotalDiscount":0.00,"PurchaseOrderAmountTotalTax":0.00,"PurchaseOrderAmountGrandTotal":0.00,"PurchaseOrderDetails":[{"PurchaseOrderRowDetailID":0,"PurchaseOrderRowProductID":0,"PurchaseOrderRowProductSKU":"String","PurchaseOrderRowProductDescription":"String","PurchaseOrderRowQuantity":0,"PurchaseOrderRowReceivedQuantity":0,"PurchaseOrderRowInvoicedQuantity":0,"PurchaseOrderRowUnitPriceWithoutTaxOrDiscount":0,"PurchaseOrderRowTaxID":0,"PurchaseOrderTotalTaxAmount":0,"PurchaseOrderRowDiscountID":0,"PurchaseOrderRowTotalDiscountAmount":0,"PurchaseOrderRowTotalAmount":0,"PurchaseOrderRowSerialNumbers":["String"],"PurchaseOrderRowBatchNumbers":[{"BatchNumberName":"String","ExpiryDate":"\/Date(-62135596800000-0000)\/","AssignedQTYInDetail":0}],"PurchaseOrderRowRemarks":"String","PurchaseOrderRowTotalWeight":0,"PurchaseOrderRowTotalWeightUnitID":0,"PurchaseOrderRowExpectedReceivingDateEarliest":"\/Date(-62135596800000-0000)\/","PurchaseOrderRowExpectedReceivingDateLatest":"\/Date(-62135596800000-0000)\/"}],"PurchaseOrderReceiveDocumentTypeID":"String","PurchaseOrderReceiveDocumentNo":"String","PurchaseOrderStatus":"ValidStatus","chkReOpenOrCloseRelatedDocs":false,"PurchaseOrderCreationDate":"\/Date(-62135596800000-0000)\/","PurchaseOrderLastUpdatedDate":"\/Date(-62135596800000-0000)\/","PurchaseOrderExpectedReceivingDateEarliest":"\/Date(-62135596800000-0000)\/","PurchaseOrderExpectedReceivingDateLatest":"\/Date(-62135596800000-0000)\/","PurchaseOrderReceiveDocumentIssueDate":"\/Date(-62135596800000-0000)\/"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"InternalErrorCode":"String"}