Megaventory API v2017a

<back to all web services

PurchaseOrderUpdate

The following routes are available for this service:
POST/PurchaseOrder/PurchaseOrderUpdateInserts a new purchase order or updates an existing one.Uses your API Key and applies a mvRecordAction value on an mvPurchaseOrder object. We can insert the mvPurchaseOrder we specified using "Insert" as our mvRecordAction. PurchaseOrderId, PurchaseOrderNo, PurchaseOrderStatus are mandatory fields. PurchaseOrderStatus is mandatory if PurchaseOrderInventoryLocationID is included in the object. If the PurchaseOrderSupplierId is known, it must be included with a value greater than zero. If the PurchaseOrderSupplierId is not known it must be included in the object with a value equal to zero and -in that case- include also the PurchaseOrderSupplierName in the object.

We can update an existing Purchase Order using "Update". We can insert a new Purchase Order using "Insert". Optionally, we can use mvInsertUpdateDeleteSourceApplication when an external application ( eg WooCommerce ) is the one that triggers the PurchaseOrderUpdate call. PurchaseOrderId cannot be updated.

Examples:



A.

Insert a new purchase order for 10 products coming from the same supplier.

Value:

 {
   "mvPurchaseOrder": {
      "PurchaseOrderSupplierId": 5357,
      "PurchaseOrderTypeId": 4,
      "PurchaseOrderInventoryLocationID": 4430,
      "PurchaseOrderStatus": "Verified",
      "PurchaseOrderNo": "2342",
      "PurchaseOrderDetails": [
         {
            "PurchaseOrderRowProductSKU": "product",
            "PurchaseOrderRowQuantity": "10",
            "PurchaseOrderRowReceivedQuantity": "0",
            "PurchaseOrderRowInvoicedQuantity": "0",
            "PurchaseOrderRowUnitPriceWithoutTaxOrDiscount": "0.93"
         }
      ]
   },
   "mvRecordAction": "Insert"
}


Response: 

 {
   "mvPurchaseOrder": {
      "PurchaseOrderId": 49435,
      "PurchaseOrderTypeId": 4,
      "PurchaseOrderTypeAbbreviation": "PO",
      "PurchaseOrderTypeDescription": "Purchase Order",
      "PurchaseOrderNo": "63",
      "PurchaseOrderReferenceNo": "",
      "PurchaseOrderReferenceApplication": "",
      "PurchaseOrderDate": "/Date(1532034000000+0300)/",
      "PurchaseOrderCustomOrderDate1": "/Date(-62135596800000-0000)/",
      "PurchaseOrderCustomOrderDate2": "/Date(-62135596800000-0000)/",
      "PurchaseOrderCurrencyCode": "USD",
      "PurchaseOrderSupplierID": 5357,
      "PurchaseOrderAddress": "",
      "PurchaseOrderPickupAddress": "",
      "PurchaseOrderContactPerson": "",
      "PurchaseOrderInventoryLocationID": 4430,
      "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": 10,
      "PurchaseOrderAmountSubtotalWithoutTaxAndDiscount": 9.3,
      "PurchaseOrderAmountTotalDiscount": 0,
      "PurchaseOrderAmountTotalTax": 0,
      "PurchaseOrderAmountGrandTotal": 9.3,
      "PurchaseOrderDetails": [
         {
            "PurchaseOrderRowDetailID": 76207,
            "PurchaseOrderRowProductID": 59373,
            "PurchaseOrderRowProductSKU": "product",
            "PurchaseOrderRowQuantity": 10,
            "PurchaseOrderRowReceivedQuantity": 0,
            "PurchaseOrderRowInvoicedQuantity": 0,
            "PurchaseOrderRowUnitPriceWithoutTaxOrDiscount": 0.93,
            "PurchaseOrderRowTaxID": 0,
            "PurchaseOrderTotalTaxAmount": 0,
            "PurchaseOrderRowDiscountID": 0,
            "PurchaseOrderRowTotalDiscountAmount": 0,
            "PurchaseOrderRowTotalAmount": 9.3,
            "PurchaseOrderRowSerialNumbers": [],
            "PurchaseOrderRowBatchNumbers": [],
            "PurchaseOrderRowRemarks": "",
            "PurchaseOrderRowExpectedReceivingDateEarliest": "/Date(-62135596800000-0000)/",
            "PurchaseOrderRowExpectedReceivingDateLatest": " /Date(-62135596800000-0000)/"
         }
      ],
      "PurchaseOrderStatus": "Verified",
      "PurchaseOrderCreationDate": "/Date(-62135596800000-0000)/",
      "PurchaseOrderLastUpdatedDate": "/Date(-62135596800000-0000)/",
      "PurchaseOrderExpectedReceivingDateEarliest": "/Date(-62135596800000-0000)/",
      "PurchaseOrderExpectedReceivingDateLatest": "/Date(-62135596800000-0000)/"
   },
   "ResponseStatus": {
      "ErrorCode": "0"
   },
   "entityID": 49435
}

B.

PartiallyReceive a purchase order for 2 products coming from the same supplier.

Value:

 {
   "mvPurchaseOrder": {
      "PurchaseOrderId": 49435,
      "PurchaseOrderNo": "66",
      "PurchaseOrderSupplierId": 5357,
      "PurchaseOrderTypeId": 4,
      "PurchaseOrderInventoryLocationID": 4430,
      "PurchaseOrderDetails": [
         {
            "PurchaseOrderRowDetailID": 76207,
            "PurchaseOrderRowProductID": 59373,
            "PurchaseOrderRowProductSKU": "product",
            "PurchaseOrderRowQuantity": "10",
            "PurchaseOrderRowReceivedQuantity": "2",
            "PurchaseOrderRowInvoicedQuantity": "0",
            "PurchaseOrderRowUnitPriceWithoutTaxOrDiscount": "0.93"
         }
      ],

      "PurchaseOrderReceiveDocumentTypeID":-2,
      "PurchaseOrderStatus": "PartiallyReceived"
   },
   "mvRecordAction": "ReceiveItems"
}


Response: 

 {
   "mvPurchaseOrder": {
      "PurchaseOrderId": 49435,
      "PurchaseOrderTypeId": 4,
      "PurchaseOrderTypeAbbreviation": "PO",
      "PurchaseOrderTypeDescription": "Purchase Order",
      "PurchaseOrderNo": "66",
      "PurchaseOrderReferenceNo": "",
      "PurchaseOrderReferenceApplication": "",
      "PurchaseOrderDate": "/Date(1532034000000+0300)/",
      "PurchaseOrderCustomOrderDate1": "/Date(-62135596800000-0000)/",
      "PurchaseOrderCustomOrderDate2": "/Date(-62135596800000-0000)/",
      "PurchaseOrderCurrencyCode": "USD",
      "PurchaseOrderSupplierID": 5357,
      "PurchaseOrderAddress": "",
      "PurchaseOrderPickupAddress": "",
      "PurchaseOrderContactPerson": "",
      "PurchaseOrderInventoryLocationID": 4430,
      "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": 10,
      "PurchaseOrderAmountSubtotalWithoutTaxAndDiscount": 9.3,
      "PurchaseOrderAmountTotalDiscount": 0,
      "PurchaseOrderAmountTotalTax": 0,
      "PurchaseOrderAmountGrandTotal": 9.3,
      "PurchaseOrderDetails": [
         {
            "PurchaseOrderRowDetailID": 76207,
            "PurchaseOrderRowProductID": 59373,
            "PurchaseOrderRowProductSKU": "product",
            "PurchaseOrderRowQuantity": 10,
            "PurchaseOrderRowReceivedQuantity": 2,
            "PurchaseOrderRowInvoicedQuantity": 0,
            "PurchaseOrderRowUnitPriceWithoutTaxOrDiscount": 0.93,
            "PurchaseOrderRowTaxID": 0,
            "PurchaseOrderTotalTaxAmount": 0,
            "PurchaseOrderRowDiscountID": 0,
            "PurchaseOrderRowTotalDiscountAmount": 0,
            "PurchaseOrderRowTotalAmount": 9.3,
            "PurchaseOrderRowRemarks": "",
            "PurchaseOrderRowSerialNumbers": [],
            "PurchaseOrderRowBatchNumbers": [],
            "PurchaseOrderRowExpectedReceivingDateEarliest": "/Date(-62135596800000-0000)/",
            "PurchaseOrderRowExpectedReceivingDateLatest": " /Date(-62135596800000-0000)/"
         }
      ],
      "PurchaseOrderStatus": "PartiallyReceived",
      "PurchaseOrderCreationDate": "/Date(-62135596800000-0000)/",
      "PurchaseOrderLastUpdatedDate": "/Date(-62135596800000-0000)/",
      "PurchaseOrderExpectedReceivingDateEarliest": "/Date(-62135596800000-0000)/",
      "PurchaseOrderExpectedReceivingDateLatest": "/Date(-62135596800000-0000)/"
   },
   "ResponseStatus": {
      "ErrorCode": "0"
   },
   "entityID": 49435
}

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/PurchaseOrderUpdate HTTP/1.1 
Host: api.megaventory.com 
Content-Type: text/jsv
Content-Length: length

{
	APIKEY: String,
	mvPurchaseOrder: 
	{
		PurchaseOrderId: 0,
		PurchaseOrderTypeId: 0,
		PurchaseOrderTypeAbbreviation: String,
		PurchaseOrderTypeDescription: String,
		PurchaseOrderNo: String,
		PurchaseOrderReferenceNo: String,
		PurchaseOrderReferenceApplication: String,
		PurchaseOrderDate: 0001-01-01,
		PurchaseOrderCustomOrderDate1: 0001-01-01,
		PurchaseOrderCustomOrderDate2: 0001-01-01,
		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: 0001-01-01,
						AssignedQTYInDetail: 0
					}
				],
				PurchaseOrderRowRemarks: String,
				PurchaseOrderRowTotalWeight: 0,
				PurchaseOrderRowTotalWeightUnitID: 0,
				PurchaseOrderRowExpectedReceivingDateEarliest: 0001-01-01,
				PurchaseOrderRowExpectedReceivingDateLatest: 0001-01-01
			}
		],
		PurchaseOrderReceiveDocumentTypeID: String,
		PurchaseOrderReceiveDocumentNo: String,
		PurchaseOrderStatus: ValidStatus,
		chkReOpenOrCloseRelatedDocs: False,
		PurchaseOrderCreationDate: 0001-01-01,
		PurchaseOrderLastUpdatedDate: 0001-01-01,
		PurchaseOrderExpectedReceivingDateEarliest: 0001-01-01,
		PurchaseOrderExpectedReceivingDateLatest: 0001-01-01,
		PurchaseOrderReceiveDocumentIssueDate: 0001-01-01
	},
	mvRecordAction: Insert,
	mvInsertUpdateDeleteSourceApplication: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	mvPurchaseOrder: 
	{
		PurchaseOrderId: 0,
		PurchaseOrderTypeId: 0,
		PurchaseOrderTypeAbbreviation: String,
		PurchaseOrderTypeDescription: String,
		PurchaseOrderNo: String,
		PurchaseOrderReferenceNo: String,
		PurchaseOrderReferenceApplication: String,
		PurchaseOrderDate: 0001-01-01,
		PurchaseOrderCustomOrderDate1: 0001-01-01,
		PurchaseOrderCustomOrderDate2: 0001-01-01,
		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: 0001-01-01,
						AssignedQTYInDetail: 0
					}
				],
				PurchaseOrderRowRemarks: String,
				PurchaseOrderRowTotalWeight: 0,
				PurchaseOrderRowTotalWeightUnitID: 0,
				PurchaseOrderRowExpectedReceivingDateEarliest: 0001-01-01,
				PurchaseOrderRowExpectedReceivingDateLatest: 0001-01-01
			}
		],
		PurchaseOrderReceiveDocumentTypeID: String,
		PurchaseOrderReceiveDocumentNo: String,
		PurchaseOrderStatus: ValidStatus,
		chkReOpenOrCloseRelatedDocs: False,
		PurchaseOrderCreationDate: 0001-01-01,
		PurchaseOrderLastUpdatedDate: 0001-01-01,
		PurchaseOrderExpectedReceivingDateEarliest: 0001-01-01,
		PurchaseOrderExpectedReceivingDateLatest: 0001-01-01,
		PurchaseOrderReceiveDocumentIssueDate: 0001-01-01
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	entityID: 0,
	relatedDocumentID: 0,
	InternalErrorCode: String
}