BulkTrack

This method returns tracking information for multiple shipments in a single call.

Only carriers with a native bulk tracking API should implement this method. Each result item carries either tracking_info or error, never both, so a partial failure of the batch doesn't fail the whole call.

Request

Request Body schema: application/json

An object containing the shipments to track.

	Array of objects or null (BulkTrackingItem) The shipments to retrieve tracking information for.
transaction_id required	string <uuid> The transaction ID uniquely represents this request. If the request is retried then this transaction ID will be the same. You should only perform the requested action once per given transaction ID.
	object (Authorization)
	object or null
connection_name	string or null The name of the connection to use, if this app has connection names defined

Responses

200

An object with tracking results for the requested shipments.

post/BulkTrack

Request samples

Payload

application/json

{"items": [{"identifiers": [{"type": "tracking_number",
"value": "12345678901234567890"
}
]
},
{"identifiers": [{"type": "tracking_number",
"value": "09876543210987654321"
}
]
}
],
"transaction_id": "00000000-0000-0000-0000-000000000000",
"metadata": {"username": "auctane-next-day",
"password": "password!",
"meter_number": "8675309"
}
}

Response samples

application/json

{"results": [{"tracking_number": "12345678901234567890",
"tracking_info": {"carrier_name": "UPS",
"tracking_number": "12345678901234567890",
"standardized_status_code": "IT",
"carrier_status_code": "I",
"carrier_status_description": "In Transit",
"shipping_problem": false,
"carrierEnum": 0
}
},
{"tracking_number": "09876543210987654321",
"error": {"code": "carrier_not_connected",
"message": "The carrier account for this shipment is not connected."
}
}
]
}