24/7 Support: 800.608.6482

Navigation


OrderShipmentList_Load_Query

This function loads a list of order shipments.

Request Parameters

store_code Type:
String
Title:
Store Code
Store code to run the function against. Found in the Miva Admin under Settings > Store Details
function Type:
String
Title:
Order Shipment List Load Query
The name of the function being executed
count Type:
Number
Title:
Count
Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
offset Type:
Number
Title:
Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
sort Type:
String
Title:
Sort
The order for sorting any returned data

Response Parameters

success Type:
Boolean
Title:
Status Response
Boolean value indicating if the api request was successful
total_count Type:
Number
Title:
Total Count
the number of order shipments returned
start_offset Type:
Number
Title:
Start Offset
the offset starting point for pagination of return data
id Type:
Number
Title:
ID
shipment id
code Type:
String
Title:
Shipment Code
The shipping code for the order
batch_id Type:
Number
Title:
Batch ID
The batch id associated with the order
order_id Type:
Number
Title:
Order ID
order id associated with the shipment
status Type:
String
Title:
Order Status
The order status for the shipment
labelcount Type:
Number
Title:
Label Count
The number of labels for the shipment
ship_date Type:
Number
Title:
Ship Date
The shipment date
tracknum Type:
String
Title:
Tracking Number
The tracking number for the shipment
tracktype Type:
String
Title:
Tracking Type
The tracking type for the shipment
tracklink Type:
String
Title:
Tracking Link
The tracking link for the shipment
weight Type:
Number
Title:
Shipment Weight
The shipping weight
cost Type:
Number
Title:
Shipping Cost
Shipping total for the order
formatted_cost Type:
String
Title:
Currency Formatted Shipping Cost
Currency formatted shipping cost

Example Request

Example Response

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