Where UpdateTrackingNumber will add a tracking number and mark the entire order as shipped, UpdateOrderDetailTrackingQuantity provides the necessary granularity for partial shipping and split shipping of orders.
- Updates the line item statys to Shipped
- Adds the tracking number against the specified line item
- Splits the line item to indicate shipped vs unshipped products if shipping less than the total amount of the product ordered.
- Optionally send the Order Tracking Import AutoResponder
- Optionally allows for a different shipping method to be indicated for the specific tracking number if shipped though a different method or carrier than other items on the order.
¶ Action and Request Parameters
POST /(Client)/api/Shipping/Order/OrderTracking/UpdateOrderDetailTrackingQuantity
¶ Body Parameters
JSON
- OrderDetailId - Specific line item entry on the order being updated with the tracking information.
- TrackingID - Tracking Number being assigned
- Quantity - A count of the specific item being shipped
- SendAR - True/False to send the Order Tracking Import AutoResponder
- ShipMethodID - ID of the Shipping Method to assign to the Tracking Number
- ThirdPartyShipping Code - Alternative shipping method lookup method. 3rd-party shipping code must be set on the desired shipping method.
JSON
[
{
"OrderDetailId": 1,
"TrackingId": "sample string 2",
"Quantity": 3,
"SendAR": true,
"ShipmethodID": 5,
"ThirdPartyShippingCode": "sample string 6"
},
{
"OrderDetailId": 1,
"TrackingId": "sample string 2",
"Quantity": 3,
"SendAR": true,
"ShipmethodID": 5,
"ThirdPartyShippingCode": "sample string 6"
}
]
Responses are provided via HTTP Status Codes.
JSON
200