OrderShipmentList_Update
Description
This function is used to mark a shipment as shipped in Miva. Its input parameters are an array of shipments. The shpmnt_id
is required, so you will first need to create a shipment using OrderItemList_CreateShipment.
Request Body Parameters
Parameter |
Type |
Description |
Shipment_Updates |
Object |
Shipment Object containing individual shipments |
shpmnt_id |
Number |
ID of Shipment to Update |
mark_shipped |
Boolean |
true/false. This set to true will trigger shipment shipped emails (if emails are set to automatic) |
tracknum |
String |
Tracking Number |
tracktype |
String |
Tracking Type. Default Types include “CanadaPost”, “Endicia”, “FedEx”, “UPS”, “USPS”. |
cost |
Number |
Actual Shipping Cost. Used for reporting purposes to compare shipping costs vs what the customer paid. |
weight |
Number |
Actual Weight. Used for Reporting |
Response Parameters
Parameter |
Type |
Description |
success |
Boolean |
Boolean value indicating if the request was successful |
Example Request
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "OrderShipmentList_Update",
"Shipment_Updates": [
{
"shpmnt_id": 114,
"mark_shipped": true,
"tracknum": "12345",
"tracktype": "UPS",
"cost": "5.00"
},
{
"shpmnt_id": 12345,
"mark_shipped": true,
"tracknum": "4567",
"tracktype": "UPS",
"cost": "5.00"
}
]
}
Example Response