Introduction
A ShipmentLog is a record of shipment transported by a specified vehicle for a duration of time.
**Important Note on Date Range Searches:** When you search for events using a fromDate and toDate, the API returns all events that were active at any point during your search period. This is the intended behavior.
Specifically, an event is returned if:
  • It starts and ends within your specified time frame.
  • It started **before** your fromDate but ends within your time frame.
  • It starts within your time frame but ends **after** your toDate.
  • It started **before** your fromDate and ends **after** your toDate, overlapping the entire period.
Properties

activeFrom

The date the shipment was started. Default [UtcNow].

activeTo

The date the shipment was ended. Default [MaxDate].

commodity

The commodity shipped. Maximum length [255] Default [""].

dateTime

The date and time the log was created.

device

The Device associated with this log.

documentNumber

The identifier of the shipment document. Default [""].

driver

The User who created this log.

id

The unique identifier for the specific Entity object in the Geotab system. See Id.

shipperName

The name of the shipper. Default [""].

version

The version of the entity.
Rate limits
MethodDescriptionLimitPeriodStatus
GetLimit of 350 Get requests per 1m.3501mInactive
SetLimit of 350 Set requests per 1m.3501mInactive
AddLimit of 100 Add requests per 1m.1001mInactive
RemoveLimit of 100 Remove requests per 1m.1001mInactive
GetCountOfLimit of 100 GetCountOf requests per 1m.1001mInactive
GetFeedLimit of 60 GetFeed requests per 1m.601mActive
Pagination

Results limit

50000

Supported sort

Date sorts by the ShipmentLog.DateTime property.

Version

Timeout Limit
MethodDescriptionLimitStatus
GetFeed180Active

Loading API Runner...