PathSegment

  • Represents a part of a path, either sent by the API customer or the API server, containing information about the movement or routing.

  • Includes information about the source and destination hubs, the line and rotation being followed, and the vehicle used for the segment.

  • Defined by a JSON object with required fields for sourceHub, destinationHub, line, lineRotation, and vehicle.

Represents a part of a path, either sent by the API customer to the API server (e.g., state change) or by the API server to the API customer (e.g., routing a shipment).

JSON representation 
{
  "sourceHub": string,
  "destinationHub": string,
  "line": string,
  "lineRotation": string,
  "vehicle": string
}
Fields
sourceHub

string

Required. Source of the segment.
destinationHub

string

Required. Destination of the segment.
line

string

Required. Line being followed for this segment.
lineRotation

string

Required. Rotation being followed for this segment.
vehicle

string

Required. Vehicle followed by this segment.