Check reference status

Check on the update status of a shipment by using the Get reference endpoint. The different messages you can expect to receive when checking the last status update are defined in the table below. The last_update_status field will provide the most recent status for your shipment information.

Message	Definition	What happens next
data_received	Data received and payload generated. Payload available at GET Reference Update endpoint. Payload sent to webhook successfully if using webhook.	Vizion will check for new or updated data for your shipment in 12 hours.
no_data	No data is available from the carrier. Tracking could be too early or too late, or the identifier could be incorrect.	Vizion will check for new or updated data for your shipment in 12 hours.
extraction_failed	An error has occurred during processing for this attempt and Vizion did not receive any data. Errors can be both carrier side or Vizion side if any of our services are down.	Vizion will check for new or updated data for your shipment in 12 hours.
webhook_failed	Vizion received data, built a payload but received an error response from the customer application URL.	Vizion will check for new or updated data for your shipment in 12 hours and attempt to send you a payload regardless of new or updated data.
duplicate_payload	Vizion received data but there is no update to the shipment.	Vizion did not generate a new payload as there was no new or updated data for your shipment. Vizion will check for new or updated data for your shipment in 12 hours.
auto_carrier_not_found	No supported carrier returned data for your shipment when using the auto carrier identification feature.	Vizion will mark your reference as inactive. We will not continue to try and find the appropriate carrier.
auto_carrier_failed	An error occurred while identifying the carrier for your shipment.	Vizion will mark your reference as inactive. We will not continue to try and find the appropriate carrier.
new_container_journey	With auto-unsubscribe, if the latest update contains entirely different milestones that occurred later than the last available milestone in the previous update's milestone list, the API will determine that the container has started a new journey and automatically unsubscribe.	Vizion will mark your reference as inactive as a new journey has begun.

Example response using Get reference endpoint:

{
  "id": "77ca0b50-f2bd-4b5c-9270-72245b6b899f",
  "container_id": "TCLU1791408",
  "bill_of_lading": "ONEYSINA68242400",
  "carrier_scac": "ONEY",
  "callback_url": "https://webhook.site/39d4933d-b0bd-4c49-92ba-621ea282773e",
  "organization_id": "29c0635d-efb1-4871-b173-b3022a13d1c1",
  "parent_reference_id": "4957db10-203c-4607-aff9-13e40d023972",
  "active": true,
  "last_update_status": "data_received",
  "created_at": "2020-12-16T14:54:44.359Z",
  "updated_at": "2020-12-23T16:21:02.807Z",
  "last_update_attempted_at": "2020-12-23T16:21:02.764Z",
  "retry_count": 14,
  "organization": {
    "id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
    "name": "Vizion",
    "active": true,
    "created_at": "2020-01-17T01:35:25.139Z",
    "updated_at": "2020-01-17T01:35:25.139Z"
  }
}