Get Parcel

This method is used to find tracking numbers and labels of a parcel order.

Please note that this end-point has rate-limiting, therefore, it will only allow 20 requests per minute.

If you are using this endpoint within a loop we highly recommend adding a gap/delay between each iteration.

Endpoint

Method URI Headers
GET parcel-orders/{shipment_order_id} default
GET parcel-orders/tracking-number/{tracking_number} default

Response

Field Type Description
success Boolean true or false
message String Message
data Array An array containing received rates or if request has failed an object containing validation errors
+shipment_order_id Integer Related Shipment Order ID
+main_tracking_number String Main tracking number
+status String Current status of the shipment eg:label_ready, void, pending_refund
+sub_tracking_numbers Array An array containing tracking numbers
package_details [] Array An array containing all the package information
+tracking_number String Tracking number of the specific package
+items [] Array An array of the package items
++sku String SKU of the specific package item
++quantity String Quantity of the specific package item
++price String Price of the specific package item
+final_price Float Final price
+carrier String Carrier
+tags [] Array Shows an array of tags
+label String Label Url
+customs_form String Customs form Url (only when the shipment is international)

Response Examples

Successful

{
    "success": true,
    "data": {
        "shipment_order_id": 123123123,
        "main_tracking_number": "123123123123123Z",
        "status": "label_ready",
        "sub_tracking_numbers": [
            "123123123123123Z",
            "231231231234223Z"
        ],
        "package_details": [
            {
                "tracking_number": "1Z5RR1050313482583",
                "items": [
                    {
                        "sku": "SKU1",
                        "quantity": "1",
                        "price": "1.00"
                    },
                    {
                        "sku": "SKU2",
                        "quantity": "2",
                        "price": "2.00"
                    }
                ]
            }
        ],
        "final_price": 23.32,
        "carrier": "fedex",
        "tags": ["High Value", "Fragile"],
        "service": "FedEx Ground",
        "label": "label_url.com/label"
    },
    "message": "Parcel Order label ready"
}

Failed

{
    "success": false,
    "message": "This shipment is in Processing stage and the label can not be viewed right now."
}
{
    "success": false,
    "message": "Too Many Requests! Please slow down"
}