Open Visibility API (1.0.0)

Download OpenAPI specification:Download

Open Visibility API specification

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

open-visibility

Open Visibility API providing real-time visibility information for authorized parties.

Get real-time visibility statuses of working shipments associated with this token and sorted by shipment start

Authorizations:

bearerAuth

query Parameters

cursor

string

Example: cursor=c2l4Zm9sZF9hcGlfZXhhbXBsZQ==

Cursor to get the next page of transports visibility data

Responses

Response samples

200

Content type

application/json

{"shipments": [{"shipment_id": "T1234",
"shipper_transport_number": "T1234",
"platform_transport_number": "983549358",
"latest_position": {"license_plate": "001ABC",
"timestamp": "2021-01-24T10:57:56.452Z",
"position": {"lat": 59.4365094,
"lng": 24.7428656
}
},
"stops": [{"stop_id": "123",
"type": "loading",
"status": "unvisited",
"deliveries": [{"delivery_id": "123",
"purchase_order_number": "123",
"order_number": "123",
"delivery_number": "123"
}
],
"eta": "2020-10-06T15:00:00.00Z",
"eta_checked_at": "2020-10-06T01:00:00.00Z",
"eta_source": "internal"
}
]
}
],
"page_info": {"cursor": "c2l4Zm9sZF9hcGlfZXhhbXBsZQ=="
}
}