SFTP Create Trip CSV
- Lalit Kawadker (Unlicensed)
Introduction
This is the document that defines the attribute and field mapping for trip creation through the SFTP file upload.
Attribute mapping with CSV column name
CSV COLUMN NAME | ATTRIBUTE NAME(MAPPED WITH) | REMARK |
|---|---|---|
feedUniqueId | feedUniqueId | Required |
driverNumbers | driverNumbers | Required |
cleanerNumbers | cleanerNumbers |
|
driverName | driverName | Required |
locationSource | locationSource |
|
vehicleNumber | vehicleNumber | Required |
lrNumber | lrnumber | Required |
loadingUniqueId | loading/uniqueId | Required |
loadingAddress | loading/address | Required |
loadingLatitude | loading/lat | In case if loadingUniqueID/address it is not mandatory |
loadingLongitude | loading/lng | In case if loadingUniqueID/address it is not mandatory |
unloadingUniqueId | unloading/uniqueId | Required |
unloadingAddress | unloading/address | Required |
unloadingLatitude | unloading/lat | In case if loadingUniqueID/address it is not mandatory |
unloadingLongitude | unloading/lng | In case if loadingUniqueID/address it is not mandatory |
consignorUniqueId | consignor/uniqueId |
|
consignorName | consignor/name |
|
transporterUniqueId | transporter/uniqueId | Required |
transporterName | transporter/name | Required |
consigneeUniqueId | consignee/uniqueId |
|
consigneeName | consignee/name |
|
consigneeMobileNumbers | consignee/number |
|
consigneeEmails | consignee/email |
|
shareTrip | share_trip |
|
isSmartPhone | smartPhoneEnabled |
|
hasDualSimPhone |
|
|
comment |
|
|
shipmentNumber | shipment_number |
|
ewbNumber | ewbNo |
|
routeCode | route/code |
|
routeName | route/name |
|
container_number |
|
|
waypoint1UniqueId | waypoints[0]{uniqueId} |
|
waypoint1Address | waypoints[0]{address} |
|
waypoint1Latitude | waypoints[0]{lat} |
|
waypoint1Longitude | waypoints[0]{lng} |
|
waypoint2UniqueId | waypoints[1]{uniqueId} |
|
waypoint2Address | waypoints[1]{address} |
|
waypoint2Latitude | waypoints[1]{lat} |
|
waypoint2Longitude | waypoints[1]{lng} |
|
customValues | customValues | JSON format in csv free for all key and value pair (need to onboard the key name) |
primaryattributesgatein | primary_attributes/gate_in |
|
primaryattributesgateout | primary_attributes/gate_out |
|
primaryattributesfeeduniqueid | primary_attributes/feed_unique_id |
|
primaryattributesshipmentnumbers | primary_attributes/shipment_numbers |
|
primaryattributescontainernumber | primary_attributes/container_number |
|
primaryattributestareweight | primary_attributes/tare_weight |
|
primaryattributesnetweight | primary_attributes/net_weight |
|
primaryattributesgrossweight | primary_attributes/gross_weight |
|
primaryattributesmovementsubtype | primary_attributes/movement_subtype |
|
primaryattributesmovementchannel | primary_attributes/movement_channel |
|
primaryattributesbillingtype | primary_attributes/billing_type |
|
primaryattributesyardentrynumber | primary_attributes/yard_entry_number |
|
primaryattributesexpectedtransittime | primary_attributes/expected_transit_time |
|
primaryattributeserptransitdistance | primary_attributes/erp_transit_distance |
|
primaryattributesvehicletyperefcode | primary_attributes/vehicle_type_ref_code |
|
primaryattributesfreightvalue | primary_attributes/freight_value |
|
primaryattributesfreightvaluecurrency | primary_attributes/freight_value_currency |
|
STONumber | customValue/STONumber |
|
Sample CSV file for create trip (GUILTFREE)
Folder structure
There is some folder structure which we have to follow in order to create trip and track the activity of the file operation.
Entry of the CSV file for trip creation.
open_requests/trip_creation →
we need to upload file for the trip creation with required input in files, the file will pick the by the system to process for the create trip and based on add trip API response it will be reroute with respective folder.a. Trip created successfully
processed_requests/trip_creation →
when there is no error in uploaded CSV file and add trip API executed successfully then the file will be transfer to the processed_requests/trip_creation folder with the respective date folder name.
b. erred_requests/trip_creation
when there is any error in payload or add trip API is executed successfully then the file will be transfer to the erred_requests/trip_creation folder with the respective date folder name.
3. Successfully completed file operation.
/archived_requests/trip_creation/{{date}}
When all the file operation got complete and any response from the trip creation CSV file successfully executed after that file will moved from open_requests to /archived_requests/trip_creation folder with the respective date folder name
Flow Diagram
Post your questions in the comment box to get answers from the experts who watch this page.
For engineering support: visit FT Support