Write the Tracking Number to a Shipment

If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can set the tracking number of a package 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. 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.
  3. 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.
  4. On the Shipments (SO302000) form, for the shipment with the 000058 number, on the Packages tab, add a package with the SMALL box ID.

Request

You can use the following request example to specify the tracking number of the package with the ec062915-9061-ec11-9e19-9828a61840c3 ID, which is shipped in the shipment with the 5d79d031-8763-ea11-b82d-00155d408001 ID 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 ?$expand=Packages&$select=Packages/TrackingNbr HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/23.200.001/Shipment
Accept: application/json
Content-Type: application/json

{
    "id": "5d79d031-8763-ea11-b82d-00155d408001",
    "Packages": [
        {
            "id": "ec062915-9061-ec11-9e19-9828a61840c3",
            "TrackingNbr": { "value": "398305336619" }
        }
    ]
}

Usage Notes

You can learn the value of the id field of the shipment in the SOShipment database table, and the value of the id field of the package in the SOPackageDetail database table.