GuidesAPI Reference
API Reference

Updates a segment details

Updates details of a segment identified by the segmentId.

This is a partial update, meaning that only the provided fields will be updated.

Changing the status of a segment affects the statuses of other segments in the shipment. The following status changes are allowed:

  • pendingongoing
    • changes previous pending segments to cancelled
    • changes previous ongoing segment to completed (only for the immediate predecessor of this segment)
    • changes previous ongoing segment to cancelled (for segments that are not immediate predecessors of this segment)
    • previous segments in cancelled or completed states are not affected
  • pending || ongoingcancelled
    • no changes for other segments
  • ongoingcompleted
    • next segment with status pending is changed to ongoing

Note: trackingId can be updated through this API call only if the segment is in pending state.

Path Params
string
required

Shipment ID

string
required

Segment ID

Body Params
string
length ≤ 50

Name of the segment

string
length ≤ 1000

Description of the segment

string
enum

Transport mode of the segment

string
enum

Status of the segment

Allowed:
string
length ≤ 50

Unique identifier for identifying the segment in external systems

string
length between 1 and 50

ID of the tracking device that produces data for the segment

date-time

ETD for the segment

date-time

ETA for the segment

metadata
object

Metadata JSON object

Responses
204

Successful (no content)

The segment information was updated

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