24/7 Support: 800.608.6482

Navigation


OrderShipmentList_Update

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

Shipment_Updates Type:
Object
Title:
Shipment Updates
Shipment Object containing individual shipments
shpmnt_id Type:
Number
Title:
Shipment Id
ID of Shipment to Update
mark_shipped Type:
Boolean
Title:
Mark Shipped
true/false. This set to true will trigger shipment shipped emails (if emails are set to automatic)
tracknum Type:
String
Title:
Tracking Number
Tracking Number
tracktype Type:
String
Title:
Tracking Type
Tracking Type. Default Types include "CanadaPost", "Endicia", "FedEx", "UPS", "USPS".
cost Type:
Number
Title:
Shipping Cost
Actual Shipping Cost. Used for reporting purposes to compare shipping costs vs what the customer paid.
weight Type:
Number
Title:
Shipping Weight
Actual Weight. Used for Reporting

Response Parameters

success boolean value for if the request was successfull

Example Request

Example Response

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.