Megaventory API v2017a

<back to all web services

WorkOrderReturnMaterials

The following routes are available for this service:
POST/WorkOrder/WorkOrderReturnMaterialsReturns materials from a work order.Uses your API Key and returns already allocated materials from a Work Order specified by the WorkOrderId

Examples:



A.

Return the material Sugar with quantity of 1 a Work Order with Id 21729.

Value:

 {
    "WorkOrderId":21729,
    "WorkOrderReturnMaterials":[
        {
            "ProductSKU":"Sugar",
            "ReturnQuantity":1
        }
    ]       
}


Response: 

{
  "mvWorkOrder": {
    "WorkOrderId": 21729,
    "WorkOrderTypeId": -8,
    "WorkOrderFinishedGoodTypeId": -9,
    "WorkOrderTypeAbbreviation": "PROD-O",
    "WorkOrderTypeDescription": "Production Order",
    "WorkOrderNo": "3",
    "WorkOrderFinishedGoodSKU": "Cappuccino",
    "WorkOrderStartDate": "/Date(1685307600000-0000)/",
    "WorkOrderDueDate": "/Date(1690491600000-0000)/",
    "WorkOrderPriority": "High",
    "WorkOrderCurrencyCode": "EUR",
    "WorkOrderInventoryLocationID": 1011,
    "WorkOrderComments": "Need to get this done as soon and as efficiently as possible",
    "WorkOrderTags": "",
    "WorkOrderReferenceNo": "",
    "WorkOrderReferenceApplication": "",
    "TopLevelWorkOrderId": 0,
    "WorkOrderOrderedQuantity": 3,
    "WorkOrderReceivedQuantity": 0,
    "WorkOrderTotalMaterialCost": 0,
    "WorkOrderTotalLabourCost": 0,
    "WorkOrderTotalOverheadCost": 0,
    "WorkOrderFinishedGoodUnitCost": 0,
    "WorkOrderDetails": [
      {
        "WorkOrderBOMRowProductSKU": "Sugar",
        "WorkOrderBOMRowProductDescription": "Coffee Ingredient",
        "WorkOrderBOMRowProductVariant": "",
        "WorkOrderBOMRowOrderedQuantity": 3,
        "WorkOrderBOMRowTotalAllocatedQuantity": 0,
        "WorkOrderBOMRowProductQuantityUnit": "",
        "WorkOrderBOMRowRemarks": "",
        "WorkOrderRowAllocatedDetails": []
      },
      {
        "WorkOrderBOMRowProductSKU": "Milk",
        "WorkOrderBOMRowProductDescription": "Coffee Ingredient",
        "WorkOrderBOMRowProductVariant": "",
        "WorkOrderBOMRowOrderedQuantity": 6,
        "WorkOrderBOMRowTotalAllocatedQuantity": 0,
        "WorkOrderBOMRowProductQuantityUnit": "",
        "WorkOrderBOMRowRemarks": "",
        "WorkOrderRowAllocatedDetails": [
          {
            "WorkOrderBOMRowAllocatedQuantity": 2,
            "WorkOrderBOMRowAllocatedDateTime": "/Date(1685367982363-0000)/",
            "WorkOrderBOMRowAllocatedDateTimeFormatted": ""
          }
        ]
      },
      {
        "WorkOrderBOMRowProductSKU": "Coffee",
        "WorkOrderBOMRowProductDescription": "Coffee Ingredient",
        "WorkOrderBOMRowProductVariant": "",
        "WorkOrderBOMRowOrderedQuantity": 9,
        "WorkOrderBOMRowTotalAllocatedQuantity": 0,
        "WorkOrderBOMRowProductQuantityUnit": "",
        "WorkOrderBOMRowRemarks": "",
        "WorkOrderRowAllocatedDetails": [
          {
            "WorkOrderBOMRowAllocatedQuantity": 3,
            "WorkOrderBOMRowAllocatedDateTime": "/Date(1685367982377-0000)/",
            "WorkOrderBOMRowAllocatedDateTimeFormatted": ""
          }
        ]
      }
    ],
    "WorkOrderStatus": "InProcess",
    "WorkOrderCreationDate": "/Date(1685358169057-0000)/",
    "WorkOrderLastUpdatedDate": "/Date(1685613896122+0300)/"
  },
  "ResponseStatus": {
    "ErrorCode": "0"
  },
  "entityID": 21729
}

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

{"APIKEY":"String","WorkOrderId":0,"Comments":"String","WorkOrderReturnMaterials":[{"ProductSKU":"String","ReturnQuantity":0,"ReturnSerialNumbers":["String"],"ReturnBatchNumbers":[{"BatchNumberName":"String","ExpiryDate":"\/Date(-62135596800000-0000)\/","Quantity":0}]}]}

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

{"mvWorkOrder":{"WorkOrderId":0,"WorkOrderTypeId":0,"WorkOrderFinishedGoodTypeId":0,"WorkOrderTypeAbbreviation":"String","WorkOrderTypeDescription":"String","WorkOrderNo":"String","WorkOrderFinishedGoodSKU":"String","WorkOrderStartDate":"\/Date(-62135596800000-0000)\/","WorkOrderDueDate":"\/Date(-62135596800000-0000)\/","WorkOrderPriority":"Medium","WorkOrderCurrencyCode":"String","WorkOrderInventoryLocationID":0,"WorkOrderComments":"String","WorkOrderTags":"String","WorkOrderReferenceNo":"String","WorkOrderReferenceApplication":"String","TopLevelWorkOrderId":0,"WorkOrderOrderedQuantity":0,"WorkOrderReceivedQuantity":0,"WorkOrderTotalMaterialCost":0,"WorkOrderTotalLabourCost":0,"WorkOrderTotalOverheadCost":0,"WorkOrderFinishedGoodUnitCost":0,"WorkOrderDetails":[{"WorkOrderBOMRowProductSKU":"String","WorkOrderBOMRowProductDescription":"String","WorkOrderBOMRowProductVariant":"String","WorkOrderBOMRowOrderedQuantity":0,"WorkOrderBOMRowTotalAllocatedQuantity":0,"WorkOrderBOMRowProductQuantityUnit":"String","WorkOrderBOMRowRemarks":"String","WorkOrderRowAllocatedDetails":[{"WorkOrderBOMRowAllocatedQuantity":0,"WorkOrderBOMRowAllocatedDateTime":"\/Date(-62135596800000-0000)\/","WorkOrderBOMRowAllocatedDateTimeFormatted":"String","WorkOrderBOMRowAllocatedSerialNumbers":["String"],"WorkOrderBOMRowAllocatedBatchNumbers":[{"BatchNumberName":"String","ExpiryDate":"\/Date(-62135596800000-0000)\/","AssignedQTYInDetail":0}]}]}],"WorkOrderStatus":"Pending","WorkOrderCreationDate":"\/Date(-62135596800000-0000)\/","WorkOrderLastUpdatedDate":"\/Date(-62135596800000-0000)\/"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"entityID":0,"InternalErrorCode":"String"}