Run in PostmanStatus PageContact SupportCustomer Ticket Portal
API Reference

List active references

get
https://demo.vizionapi.com/references

List all active references, sorted by creation date (newest first).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

Include pagination metadata in response. See pagination.

integer

Requested limit per paginated page

integer

Requested paginated page

boolean
Defaults to true

Filter on active

string

Filter on container_id

string

Filter on bill_of_lading

string

Filter on booking_number

callback_urls
array of strings
length between 1 and 5

Filter on callback_url

callback_urls

URL to receive webhook based updates from Vizions API.

string
enum

Filter on carrier_code

string
enum

Filter on last_update_status

deactivate_reason
array of strings
length ≥ 1

Filter on deactivate_reason. Repeat the parameter to filter on multiple reasons. Combine with active=false to return deactivated references — by default only active references (where deactivate_reason is null) are returned.

deactivate_reason

Specifies the reason a reference was deactivated.

  • carrier_not_found: Used when an ACI reference is deactivated because the carrier could not be identified.
  • data_not_found: Used when an ACI reference is deactivated because no carrier returned matching data for the shipment identifier.
  • newer_data_found_on_another_carrier: Used when an ACI reference is deactivated because a different carrier reported more recent data for the same shipment identifier.
  • auto_unsubscribed: Generic reason for auto-unsubscribe behavior.
  • container_removed_from_bol: Used for child references when the container is no longer found on the parent bill of lading.
  • customer_unsubscribed: Used when the customer manually unsubscribes from the reference.
  • exceeded_extraction_attempt_threshold: Used when the maximum number of extraction attempts has been reached without success.
  • inferred_shipment_completion: Used to indicate that based on similar journeys, the reference is not expected to yield any new events.
  • internal_operations: Used when the reference is deactivated by vizion for internal operations.
  • invalid_container: Used when the carrier reports that the specified identifier is not a valid container.
  • invalid_bill_of_lading: Used when the carrier reports that the specified identifier is not a valid bill of lading.
  • invalid_booking_number: Used when the carrier reports that the specified identifier is not a valid booking number.
  • shipment_completed: Used when we detect that the shipment has been completed and no further updates are expected.
  • too_long_without_updates: Used when a reference has gone too long without any new updates and is automatically deactivated.

date-time

Filter start range of created_at

date-time

Filter end range of created_at

tag_ids
array of uuids
length between 1 and 10

Filter on tag_ids

tag_ids

Unique identifier.

tag_names
array of strings
length between 1 and 10

Filter on tag_names

tag_names

Tag name. Must be 1-50 characters. Allowed characters: alphanumeric, spaces, hyphens, underscores, colons, and forward slashes. Tag names must be unique. Original casing is preserved.

Responses

Updated about 1 month ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago