POST /freightmatch/{stopId}/arriveDepart
Create callin record for an arrival or departure event
Roles that can access this endpoint are Freight Matching.
Parameters
| name |
description |
type |
default |
type |
| stopId |
(Required) ID of the stop for the arrive/depart event |
path
|
|
String
|
| orderId |
(Required) ID of the order for the arrive/depart event |
query
|
|
String
|
| movementId |
(Required) ID of the movement for the arrive/depart event |
query
|
|
String
|
| carrierId |
(Required) ID of the carrier for the arrive/depart event |
query
|
|
String
|
| eventType |
(Required) eventType for the arrive/depart event |
query
|
|
String
|
| eventDateTime |
(Required) Date and time of the arrive/depart event |
query
|
|
Date
|
| latitude |
(Optional) Latitude of the arrive/depart event |
query
|
|
BigDecimal
|
| longitude |
(Optional) Longitude of the event |
query
|
|
BigDecimal
|
| remark |
(Optional) Remark for the arrive/depart event |
query
|
|
String
|
Result
Response
of type:
text/plain
Additional details
If latitude and longitude are not provided, the latitude and longitude values from the stop record will be used.
If the stop record does not have latitude and longitude values, the latitude and longitude values from the stop's city ID value will be used.
Valid event type codes
- X3 - Arrive at pickup location
- X1 - Arrive at delivery location
- AF - Depart from pickup location
- CD - Depart from delivery location
If the Freight Matching control file is setup to enable auto dispatch, the submitted stop will update the respective actual_arrival or actual_departure fields with the submitted eventDateTime
Try It Out
Request