Megaventory API v2017a

<back to all web services

WorkOrderAllocateMaterials

The following routes are available for this service:
POST/WorkOrder/WorkOrderAllocateMaterialsAllocates materials to a work order.Uses your API Key and allocates materials to the Work Order specified by the WorkOrderId. WorkOrderAllocateMaterials field contains all the information for the materials to be allocated: the ProductSKU and the AllocateQuantity fields are mandatory. If the material contains serial and/or batch numbers, use the AllocateSerialNumbers and the AllocateBatchNumbers field to specify the information of the material.

AutoInsertBatchNumbersToProductRows: this field is used to automatically attach batch numbers to the material that is being allocated, depending on the order that you have selected (e.g. if you want to attach first the batch numbers that have the closest expiry date, give this field the value ByExpiryDate).

Examples:



A.

Allocate Materials for Work Order with Id 67795.

Value:

{
  "WorkOrderId": 67795,
  "Comments": "Material Allocation",
  "WorkOrderAllocateMaterials": [
    {
      "ProductSKU": "Product 1",
      "AllocateQuantity": 2
    }
  ]
}


Response: 

{
  "mvWorkOrder": {
    "WorkOrderId": 67795,
    "WorkOrderTypeId": -8,
    "WorkOrderFinishedGoodTypeId": -9,
    "WorkOrderTypeAbbreviation": "WO",
    "WorkOrderTypeDescription": "Work order",
    "WorkOrderNo": "44",
    "WorkOrderFinishedGoodSKU": "Finished Good 1",
    "WorkOrderStartDate": "/Date(1684184400000-0000)/",
    "WorkOrderDueDate": "/Date(-62135596800000-0000)/",
    "WorkOrderPriority": "Medium",
    "WorkOrderCurrencyCode": "USD",
    "WorkOrderInventoryLocationID": 4442,
    "WorkOrderComments": "",
    "WorkOrderTags": "",
    "WorkOrderReferenceNo": "",
    "WorkOrderReferenceApplication": "",
    "TopLevelWorkOrderId": 0,
    "WorkOrderOrderedQuantity": 15,
    "WorkOrderReceivedQuantity": 0,
    "WorkOrderTotalMaterialCost": 8.283835057,
    "WorkOrderTotalLabourCost": 0,
    "WorkOrderTotalOverheadCost": 0,
    "WorkOrderFinishedGoodUnitCost": 4.141917529,
    "WorkOrderDetails": [
      {
        "WorkOrderBOMRowProductSKU": "batch-product",
        "WorkOrderBOMRowProductDescription": "Product that requires batch numbers",
        "WorkOrderBOMRowProductVariant": "",
        "WorkOrderBOMRowOrderedQuantity": 15,
        "WorkOrderBOMRowTotalAllocatedQuantity": 0,
        "WorkOrderBOMRowProductQuantityUnit": "",
        "WorkOrderBOMRowRemarks": "",
        "WorkOrderRowAllocatedDetails": [
          {
            "WorkOrderBOMRowAllocatedQuantity": 2,
            "WorkOrderBOMRowAllocatedDateTime": "/Date(1685484867053-0000)/",
            "WorkOrderBOMRowAllocatedDateTimeFormatted": ""
          }
        ]
      },
      {
        "WorkOrderBOMRowProductSKU": "Product 1",
        "WorkOrderBOMRowProductDescription": "Product Description",
        "WorkOrderBOMRowProductVariant": "",
        "WorkOrderBOMRowOrderedQuantity": 15,
        "WorkOrderBOMRowTotalAllocatedQuantity": 0,
        "WorkOrderBOMRowProductQuantityUnit": "Kg",
        "WorkOrderBOMRowRemarks": "",
        "WorkOrderRowAllocatedDetails": [
          {
            "WorkOrderBOMRowAllocatedQuantity": 2,
            "WorkOrderBOMRowAllocatedDateTime": "/Date(1685484948599+0300)/",
            "WorkOrderBOMRowAllocatedDateTimeFormatted": ""
          }
        ]
      }
    ],
    "WorkOrderStatus": "InProcess",
    "WorkOrderCreationDate": "/Date(1684225634023-0000)/",
    "WorkOrderLastUpdatedDate": "/Date(1685484948816+0300)/"
  },
  "ResponseStatus": {
    "ErrorCode": "0"
  },
  "entityID": 67795
}


B.

Allocate Materials when product requires Batch Numbers for Work Order with Id 67795 .

Value:

{
  "WorkOrderId": 67795,
  "Comments": "Material Allocation",
  "WorkOrderAllocateMaterials": [
    {
      "ProductSKU": "batch-product",
      "AllocateQuantity": 2,
      "AllocateBatchNumbers": [
        {
          "BatchNumberName": "bn2",
          "Quantity": 2
        }
      ]
    }
  ]
}


Response: 

{
  "mvWorkOrder": {
    "WorkOrderId": 67795,
    "WorkOrderTypeId": -8,
    "WorkOrderFinishedGoodTypeId": -9,
    "WorkOrderTypeAbbreviation": "WO",
    "WorkOrderTypeDescription": "Work order",
    "WorkOrderNo": "44",
    "WorkOrderFinishedGoodSKU": "Finished Good 1",
    "WorkOrderStartDate": "/Date(1684184400000-0000)/",
    "WorkOrderDueDate": "/Date(-62135596800000-0000)/",
    "WorkOrderPriority": "Medium",
    "WorkOrderCurrencyCode": "USD",
    "WorkOrderInventoryLocationID": 4442,
    "WorkOrderComments": "",
    "WorkOrderTags": "",
    "WorkOrderReferenceNo": "",
    "WorkOrderReferenceApplication": "",
    "TopLevelWorkOrderId": 0,
    "WorkOrderOrderedQuantity": 15,
    "WorkOrderReceivedQuantity": 0,
    "WorkOrderTotalMaterialCost": 11.611548184,
    "WorkOrderTotalLabourCost": 0,
    "WorkOrderTotalOverheadCost": 0,
    "WorkOrderFinishedGoodUnitCost": 5.805774092,
    "WorkOrderDetails": [
      {
        "WorkOrderBOMRowProductSKU": "batch-product",
        "WorkOrderBOMRowProductDescription": "Product that requires batch numbers",
        "WorkOrderBOMRowProductVariant": "",
        "WorkOrderBOMRowOrderedQuantity": 15,
        "WorkOrderBOMRowTotalAllocatedQuantity": 0,
        "WorkOrderBOMRowProductQuantityUnit": "",
        "WorkOrderBOMRowRemarks": "",
        "WorkOrderRowAllocatedDetails": [
          {
            "WorkOrderBOMRowAllocatedQuantity": 2,
            "WorkOrderBOMRowAllocatedDateTime": "/Date(1685485280514+0300)/",
            "WorkOrderBOMRowAllocatedDateTimeFormatted": ""
          },
          {
            "WorkOrderBOMRowAllocatedQuantity": 2,
            "WorkOrderBOMRowAllocatedDateTime": "/Date(1685484867053-0000)/",
            "WorkOrderBOMRowAllocatedDateTimeFormatted": ""
          }
        ]
      },
      {
        "WorkOrderBOMRowProductSKU": "Product 1",
        "WorkOrderBOMRowProductDescription": "Product Description",
        "WorkOrderBOMRowProductVariant": "",
        "WorkOrderBOMRowOrderedQuantity": 15,
        "WorkOrderBOMRowTotalAllocatedQuantity": 0,
        "WorkOrderBOMRowProductQuantityUnit": "Kg",
        "WorkOrderBOMRowRemarks": "",
        "WorkOrderRowAllocatedDetails": [
          {
            "WorkOrderBOMRowAllocatedQuantity": 2,
            "WorkOrderBOMRowAllocatedDateTime": "/Date(1685484948600-0000)/",
            "WorkOrderBOMRowAllocatedDateTimeFormatted": ""
          }
        ]
      }
    ],
    "WorkOrderStatus": "InProcess",
    "WorkOrderCreationDate": "/Date(1684225634023-0000)/",
    "WorkOrderLastUpdatedDate": "/Date(1685485280643+0300)/"
  },
  "ResponseStatus": {
    "ErrorCode": "0"
  },
  "entityID": 67795
}

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/WorkOrderAllocateMaterials HTTP/1.1 
Host: api.megaventory.com 
Content-Type: application/xml
Content-Length: length

<WorkOrderAllocateMaterials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <APIKEY>String</APIKEY>
  <WorkOrderId>0</WorkOrderId>
  <Comments>String</Comments>
  <WorkOrderAllocateMaterials xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:MvWorkOrderAllocateMaterial>
      <d2p1:AllocateQuantity>0</d2p1:AllocateQuantity>
      <d2p1:ProductSKU>String</d2p1:ProductSKU>
      <d2p1:AllocateSerialNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:AllocateSerialNumbers>
      <d2p1:AllocateBatchNumbers>
        <d2p1:BatchNumber>
          <d2p1:BatchNumberName>String</d2p1:BatchNumberName>
          <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
          <d2p1:Quantity>0</d2p1:Quantity>
        </d2p1:BatchNumber>
      </d2p1:AllocateBatchNumbers>
    </d2p1:MvWorkOrderAllocateMaterial>
  </WorkOrderAllocateMaterials>
  <AutoInsertBatchNumbersToProductRows>Undefined</AutoInsertBatchNumbersToProductRows>
</WorkOrderAllocateMaterials>

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

<WorkOrderAllocateMaterialsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvWorkOrder xmlns:d2p1="https://api.megaventory.com/types">
    <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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1: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>
  </mvWorkOrder>
  <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>
  <entityID>0</entityID>
  <InternalErrorCode>String</InternalErrorCode>
</WorkOrderAllocateMaterialsResponse>