POST | /SalesOrder/SalesOrderUpdate | Inserts a new sales order
or updates an existing one. | Uses your API Key and applies a mvRecordAction
value on an mvSalesOrder object. We can insert the mvSalesOrder we specified using "Insert" as our
mvRecordAction. SalesOrderId, SalesOrderNo, SalesOrderStatus are mandatory fields. SalesOrderStatus is mandatory if
SalesOrderInventoryLocationID is included in the object. If the SalesOrderClientId is known, it must be included with a value
greater than zero. If the SalesOrderClientId is not known it must be included in the object with a value equal to zero and
-in that case- include also the SalesOrderClientName in the object.
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).
SalesOrderShippingProviderInfo: This field is utilized to specify the shipping provider information for a shipping order. It uses the attributes of the ShippingInfo object,
which are ProviderInfo as a mandatory field and optional fields such as CostInfo, WeightInfo, ShipDateInfo and TrackingId.
We can update an existing Sales Order using "Update".
We can insert a new Sales Order using "Insert". Optionally, we can use
mvInsertUpdateDeleteSourceApplication when an external application ( eg WooCommerce ) is the one that triggers
the SalesOrderUpdate call. SalesOrderId cannot be updated.
A. Insert a new sales order for 10 products going to one of our clients.
Value: {
"mvSalesOrder": {
"SalesOrderClientId": 5358,
"SalesOrderTypeId": 3,
"SalesOrderStatus": "Pending",
"SalesOrderDetails": [
{
"SalesOrderRowProductSKU": "product",
"SalesOrderRowQuantity": "10",
"SalesOrderRowShippedQuantity": "0",
"SalesOrderRowInvoicedQuantity": "0",
"SalesOrderRowUnitPriceWithoutTaxOrDiscount": "0.93"
}
]
},
"mvRecordAction": "Insert"
}
Response: {
"mvSalesOrder": {
"SalesOrderId": 49436,
"SalesOrderTypeId": 3,
"SalesOrderTypeAbbreviation": "SO",
"SalesOrderTypeDescription": "Sales Order",
"SalesOrderNo": "84",
"SalesOrderReferenceNo": "",
"SalesOrderReferenceApplication": "",
"SalesOrderDate": "/Date(1532034000000+0300)/",
"SalesOrderCustomOrderDate1": "/Date(-62135596800000-0000)/",
"SalesOrderCustomOrderDate2": "/Date(-62135596800000-0000)/",
"SalesOrderCurrencyCode": "USD",
"SalesOrderClientID": 5358,
"SalesOrderBillingAddress": "sdfasdfsdf",
"SalesOrderShippingAddress": "dfdsfgdf",
"SalesOrderContactPerson": "",
"SalesOrderInventoryLocationID": 0,
"SalesOrderCustomFlag1": false,
"SalesOrderCustomFlag2": false,
"SalesOrderCustomFlag3": false,
"SalesOrderCustomFlag4": false,
"SalesOrderCustomFlag5": false,
"SalesOrderCustomFlag6": false,
"SalesOrderCustomFlag7": false,
"SalesOrderCustomFlag8": false,
"SalesOrderCustomFlag9": false,
"SalesOrderCustomFlag10": false,
"SalesOrderComments": "",
"SalesOrderTags": "",
"SalesOrderPaymentTermsEnumeration": "None",
"SalesOrderTotalQuantity": 10,
"SalesOrderAmountSubtotalWithoutTaxAndDiscount": 9.3,
"SalesOrderAmountShipping": 0,
"SalesOrderAmountTotalDiscount": 0,
"SalesOrderAmountTotalTax": 0,
"SalesOrderAmountGrandTotal": 9.3,
"SalesOrderDetails": [
{
"SalesOrderRowDetailID": 76069,
"SalesOrderRowProductID": 59373,
"SalesOrderRowProductSKU": "product",
"SalesOrderRowQuantity": 10,
"SalesOrderRowShippedQuantity": 0,
"SalesOrderRowInvoicedQuantity": 0,
"SalesOrderRowUnitPriceWithoutTaxOrDiscount": 0.93,
"SalesOrderRowTaxID": 0,
"SalesOrderTotalTaxAmount": 0,
"SalesOrderRowDiscountID": 0,
"SalesOrderRowTotalDiscountAmount": 0,
"SalesOrderRowTotalAmount": 9.3,
"SalesOrderRowSerialNumbers": [],
"SalesOrderRowBatchNumbers": [],
"SalesOrderRowRemarks": ""
}
],
"SalesOrderStatus": "Pending",
"SalesOrderCreationDate": "/Date(-62135596800000-0000)/",
"SalesOrderLastUpdatedDate": "/Date(-62135596800000-0000)/"
},
"ResponseStatus": {
"ErrorCode": "0"
},
"entityID": 49436
}
B. Partially Ship And Partially Invoice a sales order for 5 products going to one of our clients.
Value: {
"mvSalesOrder": {
"SalesOrderId": 49436,
"SalesOrderNo": "84",
"SalesOrderClientId": 5358,
"SalesOrderInventoryLocationID": 4430,
"SalesOrderDetails": [
{
"SalesOrderRowDetailID": 76069,
"SalesOrderRowProductID": 59373,
"SalesOrderRowProductSKU": "product",
"SalesOrderRowQuantity": "10",
"SalesOrderRowShippedQuantity": "2",
"SalesOrderRowInvoicedQuantity": "2",
"SalesOrderRowUnitPriceWithoutTaxOrDiscount": "0.93"
}
],
"SalesOrderShipDocumentTypeID":2,
"SalesOrderStatus": "PartiallyShippedAndPartiallyInvoiced"
},
"mvRecordAction": "Update"
}
Response: {
"mvSalesOrder": {
"SalesOrderId": 49436,
"SalesOrderTypeId": 3,
"SalesOrderTypeAbbreviation": "SO",
"SalesOrderTypeDescription": "Sales Order",
"SalesOrderNo": "84",
"SalesOrderReferenceNo": "",
"SalesOrderReferenceApplication": "",
"SalesOrderDate": "/Date(1532034000000+0300)/",
"SalesOrderCustomOrderDate1": "/Date(-62135596800000-0000)/",
"SalesOrderCustomOrderDate2": "/Date(-62135596800000-0000)/",
"SalesOrderCurrencyCode": "USD",
"SalesOrderClientID": 5358,
"SalesOrderBillingAddress": "sdfasdfsdf",
"SalesOrderShippingAddress": "dfdsfgdf",
"SalesOrderContactPerson": "",
"SalesOrderInventoryLocationID": 4430,
"SalesOrderCustomFlag1": false,
"SalesOrderCustomFlag2": false,
"SalesOrderCustomFlag3": false,
"SalesOrderCustomFlag4": false,
"SalesOrderCustomFlag5": false,
"SalesOrderCustomFlag6": false,
"SalesOrderCustomFlag7": false,
"SalesOrderCustomFlag8": false,
"SalesOrderCustomFlag9": false,
"SalesOrderCustomFlag10": false,
"SalesOrderComments": "",
"SalesOrderTags": "",
"SalesOrderPaymentTermsEnumeration": "None",
"SalesOrderTotalQuantity": 10,
"SalesOrderAmountSubtotalWithoutTaxAndDiscount": 9.3,
"SalesOrderAmountShipping": 0,
"SalesOrderAmountTotalDiscount": 0,
"SalesOrderAmountTotalTax": 0,
"SalesOrderAmountGrandTotal": 9.3,
"SalesOrderDetails": [
{
"SalesOrderRowDetailID": 76069,
"SalesOrderRowProductID": 59373,
"SalesOrderRowProductSKU": "product",
"SalesOrderRowQuantity": 10,
"SalesOrderRowShippedQuantity": 2,
"SalesOrderRowInvoicedQuantity": 2,
"SalesOrderRowUnitPriceWithoutTaxOrDiscount": 0.93,
"SalesOrderRowTaxID": 0,
"SalesOrderTotalTaxAmount": 0,
"SalesOrderRowDiscountID": 0,
"SalesOrderRowTotalDiscountAmount": 0,
"SalesOrderRowTotalAmount": 9.3,
"SalesOrderRowSerialNumbers": [],
"SalesOrderRowBatchNumbers": [],
"SalesOrderRowRemarks": ""
}
],
"SalesOrderStatus": "PartiallyShippedAndPartiallyInvoiced",
"SalesOrderCreationDate": "/Date(-62135596800000-0000)/",
"SalesOrderLastUpdatedDate": "/Date(-62135596800000-0000)/"
},
"ResponseStatus": {
"ErrorCode": "0"
},
"entityID": 49436
}
|
---|