Create a Shipment for Two Sales Orders with Allocations and Package Specifications
If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can create a shipment with allocations and package specifications in a single API call.
Testing of the Request
- Deploy a new MYOB Acumatica instance with the U100 dataset. For details on deploying an instance, see To Deploy an MYOB Acumatica Instance.
- 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.
- 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.
- On the Enable/Disable Features (CS100000) form, make sure that the Inventory and Order Management, Lot and Serial Tracking, and Advanced SO Invoices features are enabled.
Also, in this example, a shipment will be created for two sales orders. Before you create the shipment, you need to create two sales orders. You can do this on the Sales Orders (SO301000) form or through the contract-based REST API, as described in Create a Sales Order with the Unit of Measure Specified. The sales orders must have the following settings.
| Element | Sales Order 1 | Sales Order 2 |
|---|---|---|
| Order Type | SO | SO |
| Customer | GOODFOOD | GOODFOOD |
| Branch column (in the only row on the Details tab) | HEADOFFICE | HEADOFFICE |
| Inventory ID column (in the only row on the Details tab) | APJAM08 | APJAM32 |
| Quantity column (in the only row on the Details tab) | 2 | 1 |
| UOM column (in the only row on the Details tab) | PIECE | BOX |
| Warehouse column (in the only row on the Details tab) | WHOLESALE | WHOLESALE |
Request
You can use the following example of an HTTP request to create a shipment for the two sales orders that you created. For the first sales order (in this example, its ID is 000071; if the sales order you added has a different number, it should be used in the code), you take one jar of jam from the L2R3S1 location and another jar of jam from the L3R2S1 location. For the second sales order (in this example, its ID is 000072; if the sales order you added has a different number, it should be used in the code), you take jars of jam from the L1R3S2 location. Also, you indicate that all jars of jam of both sales orders should be packed into one large box.
<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=Details,Details/Allocations,Packages,Packages/PackageContents HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/23.200.001/Shipment
Accept: application/json
Content-Type: application/json
{
"CustomerID": { "value": "GOODFOOD" },
"Details": [
{
"OrderNbr": { "value": "000071" },
"OrderType": { "value": "SO" },
"OrderLineNbr": { "value": 1 },
"Allocations": [
{
"InventoryID": { "value": "APJAM08" },
"LocationID": { "value": "L2R3S1" },
"Qty": { "value": 1 },
"UOM": { "value": "PIECE" }
},
{
"InventoryID": { "value": "APJAM08" },
"LocationID": { "value": "L3R2S1" },
"Qty": { "value": 1 },
"UOM": { "value": "PIECE" }
}
]
},
{
"OrderNbr": { "value": "000072" },
"OrderType": { "value": "SO" },
"OrderLineNbr": { "value": 1 },
"Allocations": [
{
"InventoryID": { "value": "APJAM32" },
"LocationID": { "value": "L1R3S2" },
"Qty": { "value": 6 },
"UOM": { "value": "PIECE" }
}
]
}
],
"LocationID": { "value": "MAIN" },
"Operation": { "value": "Issue" },
"Packages": [
{
"BoxID": { "value": "LARGE" },
"UOM": { "value": "KG" },
"Weight": { "value": 15 },
"PackageContents": [
{
"InventoryID": { "value": "APJAM08" },
"LotSerialNbr": { "value": "" },
"Quantity": { "value": 1 },
"UOM": { "value": "PIECE" },
"OrigOrderType": { "value": "SO" },
"OrigOrderNbr": { "value": "000071" }
},
{
"InventoryID": { "value": "APJAM08" },
"LotSerialNbr": { "value": "" },
"Quantity": { "value": 1 },
"UOM": { "value": "PIECE" },
"OrigOrderType": { "value": "SO" },
"OrigOrderNbr": { "value": "000071" }
},
{
"InventoryID": { "value": "APJAM32" },
"LotSerialNbr": { "value": "" },
"Quantity": { "value": 6 },
"UOM": { "value": "PIECE" },
"OrigOrderType": { "value": "SO" },
"OrigOrderNbr": { "value": "000072" }
}
]
}
],
"WarehouseID": { "value": "WHOLESALE" }
}