Skip to content

OrderShipmentList_Load_Query#


Description#

This function loads a list of order shipments.

Request Parameters#

Parameter
Type Description
count Number Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
filter String A string for filtering returned data
offset Number Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
sort String The order for sorting returned data

Response Parameters#

Parameter
Type Description
success Boolean Boolean value indicating if the API request was successful
total_count Number The number of order shipments returned
start_offset Number The offset starting point for pagination of return data
id Number Shipment ID
code String The shipping code for the order
batch_id Number The batch ID associated with the order
order_id Number Order ID associated with the shipment
status String The order status for the shipment
labelcount Number The number of labels for the shipment
ship_date Number The shipment date
tracknum String The tracking number for the shipment
tracktype String The tracking type for the shipment
tracklink String The tracking link for the shipment
weight Number The shipping weight
cost Number Shipping total for the order
formatted_cost String Currency formatted shipping cost

Example Request#

{
    "Store_code": "beta",
    "Function": "OrderShipmentList_Load_Query",
    "Count": 36,
    "Offset": 0,
    "Sort": "-order_id"
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 5,
        "start_offset": 0,
        "data": [
            {
                "id": 18,
                "code": "200331-20211002-00018",
                "batch_id": 0,
                "order_id": 200331,
                "status": 100,
                "labelcount": 0,
                "ship_date": 0,
                "tracknum": "",
                "tracktype": "",
                "tracklink": "",
                "weight": 10.0,
                "cost": 0.0,
                "formatted_cost": "$0.00"
            },
            {
                "id": 4,
                "code": "01001-20210614-00004",
                "batch_id": 0,
                "order_id": 1001,
                "status": 200,
                "labelcount": 0,
                "ship_date": 1623692856,
                "tracknum": "55555",
                "tracktype": "",
                "tracklink": "",
                "weight": 0.0,
                "cost": 0.0,
                "formatted_cost": "$0.00"
            },
            {
                "id": 3,
                "code": "01001-20210614-00003",
                "batch_id": 0,
                "order_id": 1001,
                "status": 200,
                "labelcount": 0,
                "ship_date": 1623692684,
                "tracknum": "12345",
                "tracktype": "",
                "tracklink": "",
                "weight": 0.0,
                "cost": 0.0,
                "formatted_cost": "$0.00"
            },
            {
                "id": 2,
                "code": "01000-20210614-00002",
                "batch_id": 0,
                "order_id": 1000,
                "status": 200,
                "labelcount": 0,
                "ship_date": 1623691778,
                "tracknum": "55555",
                "tracktype": "",
                "tracklink": "",
                "weight": 0.0,
                "cost": 0.0,
                "formatted_cost": "$0.00"
            },
            {
                "id": 1,
                "code": "01000-20210614-00001",
                "batch_id": 0,
                "order_id": 1000,
                "status": 200,
                "labelcount": 0,
                "ship_date": 1623691615,
                "tracknum": "12345",
                "tracktype": "",
                "tracklink": "",
                "weight": 0.0,
                "cost": 0.0,
                "formatted_cost": "$0.00"
            }
        ]
    }
}