Update the Freight Cost or Price

If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can update the freight cost or freight price of a shipment in MYOB Acumatica.

Testing of the Request

Before you test the code below, do the following to configure your client application and the MYOB Acumatica instance to be used:
  1. Deploy a new MYOB Acumatica instance with the U100 dataset. For details on deploying an instance, see To Deploy an MYOB Acumatica Instance.
  2. To sign in to the instance in the client application, use the tenant name (which you specified when you created the instance) and the HEADOFFICE branch.
  3. If you use Postman as the client application for testing, in the IntegrationDevelopmentGuide.postman_collection.json collection (which is located in the IntegrationDevelopment\Help folder of the Help-and-Training-Examples repository on GitHub), make sure the collection variables have the proper values.
  4. On the Enable/Disable Features (CS100000) form, make sure that the Inventory and Order Management feature is enabled.
  5. Configure the shipment settings as follows:
    Tip: If you use the IntegrationDevelopmentGuide.postman_collection.json Postman collection for testing, you do not need to perform the following configuration steps because they are performed in the pre-request script.
    1. On the Details tab of the Ship via Codes (CS207500) form, for the LOCAL ship via code, select the Manual calculation method, and save your changes.
    2. On the Shipping tab of the Shipments (SO302000) form, for the 000058 shipment, specify LOCAL in the Ship Via box and save your changes.

Request

You can use the following request example to specify the freight cost and freight price of the 000058 shipment through the contract-based REST API.
Tip: In the request example below, <MYOB Acumatica instance URL> is the URL of the MYOB Acumatica instance (such as https://my.acumatica.com/MyInstance). You can omit the instance name in the URL (that is, you can use https://my.acumatica.com) if the instance is installed in the root of the website.
PUT / HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/23.200.001/Shipment
Accept: application/json
Content-Type: application/json

{
    "FreightPrice": { "value": 2.0000 },
    "FreightCost": { "value": 1.0000 },
    "OverrideFreightPrice": { "value": true },
    "ShipmentNbr": { "value": "000058" }
}

Usage Notes

To update the freight cost or freight price of a shipment in MYOB Acumatica, you use the following fields of the Shipment entity:
  • FreightPrice: The freight price
  • FreightCost: The freight cost
  • OverrideFreightPrice: The field that makes the FreightPrice field either read-only (when its value is false) or available for editing (when its value is true)