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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/PurchaseOrderGet HTTP/1.1 
Host: api.megaventory.com 
Content-Type: application/xml
Content-Length: length

<PurchaseOrderGet 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>
  <mvPurchaseOrderNo>String</mvPurchaseOrderNo>
  <mvPurchaseOrderStatus>ValidStatus</mvPurchaseOrderStatus>
</PurchaseOrderGet>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PurchaseOrderGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvPurchaseOrders xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:mvPurchaseOrder>
      <d2p1:PurchaseOrderId>0</d2p1:PurchaseOrderId>
      <d2p1:PurchaseOrderTypeId>0</d2p1:PurchaseOrderTypeId>
      <d2p1:PurchaseOrderTypeAbbreviation>String</d2p1:PurchaseOrderTypeAbbreviation>
      <d2p1:PurchaseOrderTypeDescription>String</d2p1:PurchaseOrderTypeDescription>
      <d2p1:PurchaseOrderNo>String</d2p1:PurchaseOrderNo>
      <d2p1:PurchaseOrderReferenceNo>String</d2p1:PurchaseOrderReferenceNo>
      <d2p1:PurchaseOrderReferenceApplication>String</d2p1:PurchaseOrderReferenceApplication>
      <d2p1:PurchaseOrderDate>0001-01-01T00:00:00</d2p1:PurchaseOrderDate>
      <d2p1:PurchaseOrderCustomOrderDate1>0001-01-01T00:00:00</d2p1:PurchaseOrderCustomOrderDate1>
      <d2p1:PurchaseOrderCustomOrderDate2>0001-01-01T00:00:00</d2p1:PurchaseOrderCustomOrderDate2>
      <d2p1:PurchaseOrderCurrencyCode>String</d2p1:PurchaseOrderCurrencyCode>
      <d2p1:PurchaseOrderSupplierID>0</d2p1:PurchaseOrderSupplierID>
      <d2p1:PurchaseOrderSupplierName>String</d2p1:PurchaseOrderSupplierName>
      <d2p1:PurchaseOrderAddress>String</d2p1:PurchaseOrderAddress>
      <d2p1:PurchaseOrderPickupAddress>String</d2p1:PurchaseOrderPickupAddress>
      <d2p1:PurchaseOrderAddresses>
        <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:PurchaseOrderAddresses>
      <d2p1:PurchaseOrderContactPerson>String</d2p1:PurchaseOrderContactPerson>
      <d2p1:PurchaseOrderInventoryLocationID>0</d2p1:PurchaseOrderInventoryLocationID>
      <d2p1:PurchaseOrderCustomFlag1>false</d2p1:PurchaseOrderCustomFlag1>
      <d2p1:PurchaseOrderCustomFlag2>false</d2p1:PurchaseOrderCustomFlag2>
      <d2p1:PurchaseOrderCustomFlag3>false</d2p1:PurchaseOrderCustomFlag3>
      <d2p1:PurchaseOrderCustomFlag4>false</d2p1:PurchaseOrderCustomFlag4>
      <d2p1:PurchaseOrderCustomFlag5>false</d2p1:PurchaseOrderCustomFlag5>
      <d2p1:PurchaseOrderCustomFlag6>false</d2p1:PurchaseOrderCustomFlag6>
      <d2p1:PurchaseOrderCustomFlag7>false</d2p1:PurchaseOrderCustomFlag7>
      <d2p1:PurchaseOrderCustomFlag8>false</d2p1:PurchaseOrderCustomFlag8>
      <d2p1:PurchaseOrderCustomFlag9>false</d2p1:PurchaseOrderCustomFlag9>
      <d2p1:PurchaseOrderCustomFlag10>false</d2p1:PurchaseOrderCustomFlag10>
      <d2p1:PurchaseOrderComments>String</d2p1:PurchaseOrderComments>
      <d2p1:PurchaseOrderTags>String</d2p1:PurchaseOrderTags>
      <d2p1:PurchaseOrderTotalWeight>0</d2p1:PurchaseOrderTotalWeight>
      <d2p1:PurchaseOrderTotalWeightUnitID>0</d2p1:PurchaseOrderTotalWeightUnitID>
      <d2p1:PurchaseOrderPaymentTermsEnumeration>None</d2p1:PurchaseOrderPaymentTermsEnumeration>
      <d2p1:PurchaseOrderPaymentMethod>None</d2p1:PurchaseOrderPaymentMethod>
      <d2p1:PurchaseOrderTotalQuantity>0</d2p1:PurchaseOrderTotalQuantity>
      <d2p1:PurchaseOrderAmountSubtotalWithoutTaxAndDiscount>0.00</d2p1:PurchaseOrderAmountSubtotalWithoutTaxAndDiscount>
      <d2p1:PurchaseOrderAmountTotalDiscount>0.00</d2p1:PurchaseOrderAmountTotalDiscount>
      <d2p1:PurchaseOrderAmountTotalTax>0.00</d2p1:PurchaseOrderAmountTotalTax>
      <d2p1:PurchaseOrderAmountGrandTotal>0.00</d2p1:PurchaseOrderAmountGrandTotal>
      <d2p1:PurchaseOrderDetails>
        <d2p1:mvPurchaseOrderRow>
          <d2p1:PurchaseOrderRowDetailID>0</d2p1:PurchaseOrderRowDetailID>
          <d2p1:PurchaseOrderRowProductID>0</d2p1:PurchaseOrderRowProductID>
          <d2p1:PurchaseOrderRowProductSKU>String</d2p1:PurchaseOrderRowProductSKU>
          <d2p1:PurchaseOrderRowProductDescription>String</d2p1:PurchaseOrderRowProductDescription>
          <d2p1:PurchaseOrderRowQuantity>0</d2p1:PurchaseOrderRowQuantity>
          <d2p1:PurchaseOrderRowReceivedQuantity>0</d2p1:PurchaseOrderRowReceivedQuantity>
          <d2p1:PurchaseOrderRowInvoicedQuantity>0</d2p1:PurchaseOrderRowInvoicedQuantity>
          <d2p1:PurchaseOrderRowUnitPriceWithoutTaxOrDiscount>0</d2p1:PurchaseOrderRowUnitPriceWithoutTaxOrDiscount>
          <d2p1:PurchaseOrderRowTaxID>0</d2p1:PurchaseOrderRowTaxID>
          <d2p1:PurchaseOrderTotalTaxAmount>0</d2p1:PurchaseOrderTotalTaxAmount>
          <d2p1:PurchaseOrderRowDiscountID>0</d2p1:PurchaseOrderRowDiscountID>
          <d2p1:PurchaseOrderRowTotalDiscountAmount>0</d2p1:PurchaseOrderRowTotalDiscountAmount>
          <d2p1:PurchaseOrderRowTotalAmount>0</d2p1:PurchaseOrderRowTotalAmount>
          <d2p1:PurchaseOrderRowSerialNumbers xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d2p1:PurchaseOrderRowSerialNumbers>
          <d2p1:PurchaseOrderRowBatchNumbers>
            <d2p1:BatchNumberDetails>
              <d2p1:AssignedQTYInDetail>0</d2p1:AssignedQTYInDetail>
              <d2p1:BatchNumberName>String</d2p1:BatchNumberName>
              <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
            </d2p1:BatchNumberDetails>
          </d2p1:PurchaseOrderRowBatchNumbers>
          <d2p1:PurchaseOrderRowRemarks>String</d2p1:PurchaseOrderRowRemarks>
          <d2p1:PurchaseOrderRowTotalWeight>0</d2p1:PurchaseOrderRowTotalWeight>
          <d2p1:PurchaseOrderRowTotalWeightUnitID>0</d2p1:PurchaseOrderRowTotalWeightUnitID>
          <d2p1:PurchaseOrderRowExpectedReceivingDateEarliest>0001-01-01T00:00:00</d2p1:PurchaseOrderRowExpectedReceivingDateEarliest>
          <d2p1:PurchaseOrderRowExpectedReceivingDateLatest>0001-01-01T00:00:00</d2p1:PurchaseOrderRowExpectedReceivingDateLatest>
        </d2p1:mvPurchaseOrderRow>
      </d2p1:PurchaseOrderDetails>
      <d2p1:PurchaseOrderReceiveDocumentTypeID>String</d2p1:PurchaseOrderReceiveDocumentTypeID>
      <d2p1:PurchaseOrderReceiveDocumentNo>String</d2p1:PurchaseOrderReceiveDocumentNo>
      <d2p1:PurchaseOrderStatus>ValidStatus</d2p1:PurchaseOrderStatus>
      <d2p1:chkReOpenOrCloseRelatedDocs>false</d2p1:chkReOpenOrCloseRelatedDocs>
      <d2p1:PurchaseOrderCreationDate>0001-01-01T00:00:00</d2p1:PurchaseOrderCreationDate>
      <d2p1:PurchaseOrderLastUpdatedDate>0001-01-01T00:00:00</d2p1:PurchaseOrderLastUpdatedDate>
      <d2p1:PurchaseOrderExpectedReceivingDateEarliest>0001-01-01T00:00:00</d2p1:PurchaseOrderExpectedReceivingDateEarliest>
      <d2p1:PurchaseOrderExpectedReceivingDateLatest>0001-01-01T00:00:00</d2p1:PurchaseOrderExpectedReceivingDateLatest>
      <d2p1:PurchaseOrderReceiveDocumentIssueDate>0001-01-01T00:00:00</d2p1:PurchaseOrderReceiveDocumentIssueDate>
    </d2p1:mvPurchaseOrder>
  </mvPurchaseOrders>
  <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>
</PurchaseOrderGetResponse>