Megaventory API v2017a

<back to all web services

WorkOrderGet

The following routes are available for this service:
GET POST/WorkOrder/WorkOrderGetGets information on work orders.Uses your API Key and some Filters in an array format and returns the search results using the given filters. Optionally, you can use the number of the Work Order (mvWorkOrderNo), its status mvWorkOrderStatus (Pending, Cancelled, InProcess, Closed, InProcessPartiallyCompleted or Completed) and 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 ProductId descending order.

Examples:




A.

Return the first work order with Pending status and Medium priority. The result is returned as an mvWorkOrders object.

Value: 

 {
   "Filters": [
      {
         "FieldName": "WorkOrderStatus",
         "SearchOperator": "Equals",
         "SearchValue": "Pending"
      },
      {
         "AndOr": "And",
         "FieldName": "WorkOrderPriority",
         "SearchOperator": "Equals",
         "SearchValue": "Medium"
      }
   ],
   "ReturnTopNRecords": 1
}

Response: 

 {
   "mvWorkOrders": [
      {
         "WorkOrderId": 49429,
         "WorkOrderNo": "33",
         "WorkOrderFinishedGoodSKU": "prod111",
         "WorkOrderStartDate": "/Date(1531774800000-0000)/",
         "WorkOrderDueDate": "/Date(-62135596800000-0000)/",
         "WorkOrderPriority": "Medium",
         "WorkOrderCurrencyCode": "USD",
         "WorkOrderInventoryLocationID": 3405,
         "WorkOrderComments": "",
         "WorkOrderTags": "",
         "WorkOrderReferenceNo": "CreatedFromClipboard[26]",
         "WorkOrderReferenceApplication": "",
         "TopLevelWorkOrderId": 0,
         "WorkOrderOrderedQuantity": 1,
         "WorkOrderReceivedQuantity": 0,
         "WorkOrderTotalMaterialCost": 0,
         "WorkOrderTotalLabourCost": 0,
         "WorkOrderTotalOverheadCost": 0,
         "WorkOrderFinishedGoodUnitCost": 0,
         "WorkOrderDetails": [
            {
               "WorkOrderBOMRowProductSKU": "PROD11",
               "WorkOrderBOMRowProductDescription": "PROD11",
               "WorkOrderBOMRowOrderedQuantity": 2,
               "WorkOrderBOMRowTotalAllocatedQuantity": 0,
               "WorkOrderBOMRowProductQuantityUnit": "",
               "WorkOrderBOMRowRemarks": "",
               "WorkOrderRowAllocatedDetails": []
            }
         ],
         "WorkOrderStatus": "Pending",
         "WorkOrderCreationDate": "/Date(1531822563533-0000)/",
         "WorkOrderLastUpdatedDate": "/Date(1531822563533-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/WorkOrderGet HTTP/1.1 
Host: api.megaventory.com 
Content-Type: application/xml
Content-Length: length

<WorkOrderGet 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>
  <mvWorkOrderNo>String</mvWorkOrderNo>
  <mvWorkOrderStatus>Pending</mvWorkOrderStatus>
</WorkOrderGet>

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

<WorkOrderGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvWorkOrders xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:mvWorkOrder>
      <d2p1:WorkOrderId>0</d2p1:WorkOrderId>
      <d2p1:WorkOrderTypeId>0</d2p1:WorkOrderTypeId>
      <d2p1:WorkOrderFinishedGoodTypeId>0</d2p1:WorkOrderFinishedGoodTypeId>
      <d2p1:WorkOrderTypeAbbreviation>String</d2p1:WorkOrderTypeAbbreviation>
      <d2p1:WorkOrderTypeDescription>String</d2p1:WorkOrderTypeDescription>
      <d2p1:WorkOrderNo>String</d2p1:WorkOrderNo>
      <d2p1:WorkOrderFinishedGoodSKU>String</d2p1:WorkOrderFinishedGoodSKU>
      <d2p1:WorkOrderStartDate>0001-01-01T00:00:00</d2p1:WorkOrderStartDate>
      <d2p1:WorkOrderDueDate>0001-01-01T00:00:00</d2p1:WorkOrderDueDate>
      <d2p1:WorkOrderPriority>Medium</d2p1:WorkOrderPriority>
      <d2p1:WorkOrderCurrencyCode>String</d2p1:WorkOrderCurrencyCode>
      <d2p1:WorkOrderInventoryLocationID>0</d2p1:WorkOrderInventoryLocationID>
      <d2p1:WorkOrderComments>String</d2p1:WorkOrderComments>
      <d2p1:WorkOrderTags>String</d2p1:WorkOrderTags>
      <d2p1:WorkOrderReferenceNo>String</d2p1:WorkOrderReferenceNo>
      <d2p1:WorkOrderReferenceApplication>String</d2p1:WorkOrderReferenceApplication>
      <d2p1:TopLevelWorkOrderId>0</d2p1:TopLevelWorkOrderId>
      <d2p1:WorkOrderOrderedQuantity>0</d2p1:WorkOrderOrderedQuantity>
      <d2p1:WorkOrderReceivedQuantity>0</d2p1:WorkOrderReceivedQuantity>
      <d2p1:WorkOrderTotalMaterialCost>0</d2p1:WorkOrderTotalMaterialCost>
      <d2p1:WorkOrderTotalLabourCost>0</d2p1:WorkOrderTotalLabourCost>
      <d2p1:WorkOrderTotalOverheadCost>0</d2p1:WorkOrderTotalOverheadCost>
      <d2p1:WorkOrderFinishedGoodUnitCost>0</d2p1:WorkOrderFinishedGoodUnitCost>
      <d2p1:WorkOrderDetails>
        <d2p1:mvWorkOrderRow>
          <d2p1:WorkOrderBOMRowProductSKU>String</d2p1:WorkOrderBOMRowProductSKU>
          <d2p1:WorkOrderBOMRowProductDescription>String</d2p1:WorkOrderBOMRowProductDescription>
          <d2p1:WorkOrderBOMRowProductVariant>String</d2p1:WorkOrderBOMRowProductVariant>
          <d2p1:WorkOrderBOMRowOrderedQuantity>0</d2p1:WorkOrderBOMRowOrderedQuantity>
          <d2p1:WorkOrderBOMRowTotalAllocatedQuantity>0</d2p1:WorkOrderBOMRowTotalAllocatedQuantity>
          <d2p1:WorkOrderBOMRowProductQuantityUnit>String</d2p1:WorkOrderBOMRowProductQuantityUnit>
          <d2p1:WorkOrderBOMRowRemarks>String</d2p1:WorkOrderBOMRowRemarks>
          <d2p1:WorkOrderRowAllocatedDetails>
            <d2p1:mvWorkOrderRowAllocatedDetails>
              <d2p1:WorkOrderBOMRowAllocatedQuantity>0</d2p1:WorkOrderBOMRowAllocatedQuantity>
              <d2p1:WorkOrderBOMRowAllocatedDateTime>0001-01-01T00:00:00</d2p1:WorkOrderBOMRowAllocatedDateTime>
              <d2p1:WorkOrderBOMRowAllocatedDateTimeFormatted>String</d2p1:WorkOrderBOMRowAllocatedDateTimeFormatted>
              <d2p1:WorkOrderBOMRowAllocatedSerialNumbers xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>String</d8p1:string>
              </d2p1:WorkOrderBOMRowAllocatedSerialNumbers>
              <d2p1:WorkOrderBOMRowAllocatedBatchNumbers>
                <d2p1:BatchNumberDetails>
                  <d2p1:AssignedQTYInDetail>0</d2p1:AssignedQTYInDetail>
                  <d2p1:BatchNumberName>String</d2p1:BatchNumberName>
                  <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
                </d2p1:BatchNumberDetails>
              </d2p1:WorkOrderBOMRowAllocatedBatchNumbers>
            </d2p1:mvWorkOrderRowAllocatedDetails>
          </d2p1:WorkOrderRowAllocatedDetails>
        </d2p1:mvWorkOrderRow>
      </d2p1:WorkOrderDetails>
      <d2p1:WorkOrderStatus>Pending</d2p1:WorkOrderStatus>
      <d2p1:WorkOrderCreationDate>0001-01-01T00:00:00</d2p1:WorkOrderCreationDate>
      <d2p1:WorkOrderLastUpdatedDate>0001-01-01T00:00:00</d2p1:WorkOrderLastUpdatedDate>
    </d2p1:mvWorkOrder>
  </mvWorkOrders>
  <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>
</WorkOrderGetResponse>