Developer DocsDriver
UserDriverLogin
This resource allows drivers to log in using their created accounts’ loginname and password as parameters.
End Point
POST /users/driver/loginRequest Information
URI Parameters: None
Body Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| LoginName | driver's account loginname | string | required |
| Password | driver's account password | string | required |
Sample Schema Content-type: application/json
json
{
"LoginName": "T1315",
"Password": "T1315*1"
}Response Information
A successful request to this API will return the driver/ user’s account information as well as the Trucker’s information.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": {
"token": "AB5539DF9F194A34442BADAA36DA8FBA97EB7D2FC541A78FBF25C9631CEEE625",
"userInfo": {
"Id": 6793,
"Email": "JDBAGAY@DRIVER.COM",
"FirstName": "JUAN",
"MidlleName": "DUMAGING",
"LastName": "BAGAY",
"ImageName": "default-user-img.png",
"UserTypeId": 7,
"UserTypeName": "Driver",
"BusinessUnitId": 16
},
"truckerInfo": {
"Id": 21,
"Name": "JOLLY HAULING SERVICES",
"TIN": "412-276-011-000",
"Address": {
"Id": 14,
"Line1": "127 A S. ASISTIO STREET",
"Line2": "GRACE PARK EAST,",
"CityMunicipalityName": "Caloocan City",
"StateProvinceName": "Metro Manila",
"CountryName": "Philippines",
"PostalCode": null
}
},
"driverInfo": {
"Id": 116,
"FirstName": "JUAN",
"MiddleName": "DUMAGING",
"LastName": "BAGAY",
"LicenseNo": "N04-99-434243",
"LicenseExpiry": "2022-01-25T00:00:00",
"FileName": null,
"FilePath": null,
"ImageUrl": null
}
}
}Trucks
This resource allows to get all active trucks based on the driver account's tagged trucker.
End Point
GET /driver/trucksRequest Information
URI Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| truckerId | trucker Id (can be found in driver's account details) | int | required |
Body Parameters: None
Response Information
A successful request to this API will return the list of all active trucks under a certain trucker and it's details (truck type/truck timebound/etc.).
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": [
{
"Id": 56,
"PlateNo": "WLG487",
"Status": true,
"TruckType": {
"LoadPlans": [],
"ShipmentType": null,
"Trucks": [],
"Truckings": [],
"Id": 8,
"Type": "4W CLOSED VAN",
"WeightCapacity": 2000.0000,
"VolumeCapacity": 10.0000,
"ImageLink": null,
"ShipmentTypeId": 32,
"Status": true,
"CreatedDate": null,
"LastUpdatedDate": "2022-02-17T16:30:39.317",
"CreatedByUserId": null,
"LastUpdatedByUserId": 48
},
"TruckTimeBound": {
"ExpiryDate": "2025-07-17T00:00:00",
"EmissionExpiryDate": "2026-07-31T00:00:00",
"ORDate": "2025-07-17T00:00:00",
"PlateNo": "WLG487",
"TruckType": "TY003",
"ORExpiryDate": "2026-07-17T00:00:00",
"isforBilling": "N",
"isforBillingDate": null,
"LTFRBRegDate": "2025-07-17T00:00:00",
"AlertInsuranceExpiryDate": "2025-07-07T00:00:00",
"AlertEmissionExpiryDate": "2026-07-21T00:00:00",
"AlertORExpiryDate": "2026-07-07T00:00:00",
"AlertLTFRBExpiryDate": "2025-07-07T00:00:00",
"InsuranceCoverage": "1,000,000"
}
}
]
}TruckDriverTagging
This resource allows to insert a record of the selected plate number, application name and it's other details.
End Point
POST /truck-driver-taggingsRequest Information
URI Parameters: None
Body Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| TruckerId | trucker Id (can be found in driver's account details (trucker info)) | int | required |
| DriverId | driver Id (can be found in driver's account details (driver info)) | int | required |
| TruckId | Id of the selected truck | int | required |
| MobileNo | mobile number of driver | int | optional (default value: "") |
| DeviceIMEI | device's IMEI | int | optional |
| FCMToken | firebase token | int | required |
| FCMDispatchToken | dispatcher's firebase token | int | optional |
| SourceApp | application name | int | required |
| LastTruckingId | last dispatch number accepted by the driver | int | optional (default value: 0) |
| SendTruckingId | recently sent dispatch number to driver | int | optional (default value: 0) |
| AppVersion | application version | int | required |
Sample Schema Content-type: application/json
json
{
"TruckerId": 21,
"DriverId": 113,
"TruckId": 56,
"MobileNo": "",
"DeviceIMEI": null,
"FCMToken": "f-zh7JMBSS6QY11a9hSzWW:APA91bGo7S7Be6HaTl6vT-kVMkmGrc8QFPWac06ELwuDp8GKvxn8jFYV-LZbVu1B2eGOuM8gbi0hCEDcFYyn6m8Gqu99G6H4NWxarxOPMUDsmbt2FBpQ62rnDj4qFZ7i1qPAdkWxNe-M",
"FCMDispatchToken": null,
"SourceApp": "Fast Driver App",
"LastTruckingId": 0,
"SendTruckingId": 0,
"AppVersion": 1.2
}Response Information
A successful request to this API will return the saved truck driver taggings details.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": "Truck driver tag created.",
"data": {
"Id": 97998,
"TruckerId": 21,
"DriverId": 113,
"TruckId": 56,
"MobileNo": "",
"FCMToken": "f-zh7JMBSS6QY11a9hSzWW:APA91bGo7S7Be6HaTl6vT-kVMkmGrc8QFPWac06ELwuDp8GKvxn8jFYV-LZbVu1B2eGOuM8gbi0hCEDcFYyn6m8Gqu99G6H4NWxarxOPMUDsmbt2FBpQ62rnDj4qFZ7i1qPAdkWxNe-M",
"FCMDispatchToken": null,
"DeviceIMEI": null,
"SourceApp": "Fast Driver App",
"LastTruckingId": null,
"SendTruckingId": null,
"isActive": true,
"CreatedDate": "2023-07-03T11:04:46.3187566+08:00",
"LastUpdatedDate": null,
"CreatedByUserId": null,
"LastUpdatedByUserId": null,
"AppVersion": 1.2,
"Driver": null,
"Truck": null,
"User": null,
"Trucking": null,
"Trucking1": null,
"User1": null,
"TruckDriverTagLocations": []
}
}Truckings
Dispatch Information
This resource allows users to get disptached shipment and its dispatch details using truckingId as its paramater.
End Point
GET /truckings/dispatchRequest Information
URI Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| truckingId | dispatch number (from SMS notification) tagging id of truck | int | required |
Body Parameters: None
Response Information
Request to this API will return the dispatch information and delivery details of the given truckingId. A status code of 404 will be returned when no record is found.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": {
"TruckingId": {
"status": "SUCCESS",
"message": null,
"data": {
"TruckingId": 250316,
"DispatchNo": "00250316",
"DispatchDate": "2023-07-11T00:00:00",
"DispatchTime": "13:51:33",
"TruckCallDate": "2023-07-11T00:00:00",
"TruckCallTime": "13:52:00",
"TruckingOrigin": {
"Id": 0,
"Line1": "Bagong Bayan",
"Line2": null,
"CityMunicipalityName": "Quezon City",
"StateProvinceName": "Metro Manila",
"CountryName": "Philippines",
"PostalCode": "1110"
},
"TruckingDestination": {
"Id": 0,
"Line1": "Bagbag",
"Line2": null,
"CityMunicipalityName": "Quezon City",
"StateProvinceName": "Metro Manila",
"CountryName": "Philippines",
"PostalCode": "1116"
},
"PickupDate": null,
"PickupTime": null,
"OperationSiteId": 26,
"OperationSiteName": "Manila - Navotas Operations",
"Remarks": "asdfasfsa",
"TruckingTypeId": 20,
"TruckingCreatedByUserId": 84,
"DeliveryDetails": [
{
"RequestType": "Pickup/Delivery",
"RequestDeliveryDate": "2018-04-21T00:00:00",
"RequestDeliveryTime": "08:00:00",
"ShipmentId": 353493,
"CustomerId": 30,
"ShipperName": "COLGATE PALMOLIVE PHILS. INC",
"DeliverTo": "shiena",
"DeliveryAddress": "TANDANG SORA AVE, Tandang Sora\nQuezon City, Metro Manila\nPhilippines, 1116",
"CargoDescription": "COLGATE PALMOLIVE PRODUCTS",
"CustomerDocumentType": "Delivery Note",
"CustomerDocumentNo": "21122641632812",
"CustomerDocumentId": 286987,
"ShipperPhoneNo": null,
"PickupAddress": "CALLE INDUSTRIYA, Libis, Quezon City, Metro Manila, Philippines 1110",
"ConsigneePhoneNo": "N/A",
"TotalCBM": 75600.000000,
"DeclaredValue": 120.0000,
"CheckIns": [],
"DeliveryAddressCoordinates": {
"Longitude": 121.05037030,
"Latitude": 14.67209660
},
"OriginAddressCoordinates": {
"Longitude": 121.08388710,
"Latitude": 14.60529000
}
}
]
}
}Accept Dispatch
This resource allows users to push a notification whether the dispatch request has been accepted or declined.
End Point
POST /truckings/dispatch/acceptRequest Information
URI Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| Accept | flag that indicates if dispatch has been accepted or declined (0 - declined, 1 - accepted) | boolean | required |
| TruckingId | dispatch number (from SMS/Push notification) | int | required |
| TagId | driver's tag id | int | required |
| DispatchUserId | TMS dispatcher id | int | required |
Body Parameters: None
Sample Schema Content-type: application/json
json
{
"Accept": true,
"TruckingId": 107670,
"TagId": 1381,
"DispatchUserId": 2726
}Response Information
Request to this API will return a message which indicates that the dispatch has been accepted or declined.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": "Accept Electronic Dispatch notice successfully sent to Dispatcher.",
"data": null
}TruckingHistory
This resource allows users(drivers) to get their previous trucking transactions.
End Point
GET /truckings/historyRequest Information
URI Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| truckId | tagged truck id for user/driver | int | required |
| driverId | user id/ driver id | int | required |
| page | page number (pagination) | int | required |
Body Parameters: None
Response Information
A successful request to this API will return a list of 20 records. A status code of 404 will be returned when no record is found.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": [
{
"Id": 107688,
"DispatchDate": "2020-10-05T00:00:00",
"DispatchTime": "11:59:47",
"OriginLine1": "Tanza",
"OriginCityMunicipalityName": "Navotas City",
"OriginStateProvinceName": "Metro Manila",
"OriginPostalCode": "1490",
"OriginCountryName": "Philippines",
"DestinationLine1": "Fort Bonifacio (now part of Taguig City)",
"DestinationCityMunicipalityName": "Makati City",
"DestinationStateProvinceName": "Metro Manila",
"DestinationPostalCode": "1201",
"DestinationCountryName": "Philippines",
"Remarks": null
},
{
"Id": 107687,
"DispatchDate": "2020-10-05T00:00:00",
"DispatchTime": "11:21:32",
"OriginLine1": "Tanza",
"OriginCityMunicipalityName": "Navotas City",
"OriginStateProvinceName": "Metro Manila",
"OriginPostalCode": "1490",
"OriginCountryName": "Philippines",
"DestinationLine1": "Fort Bonifacio (now part of Taguig City)",
"DestinationCityMunicipalityName": "Makati City",
"DestinationStateProvinceName": "Metro Manila",
"DestinationPostalCode": "1201",
"DestinationCountryName": "Philippines",
"Remarks": null
},
{
"Id": 107680,
"DispatchDate": "2020-09-30T00:00:00",
"DispatchTime": "19:14:29",
"OriginLine1": "Navotas",
"OriginCityMunicipalityName": "Navotas City",
"OriginStateProvinceName": "Metro Manila",
"OriginPostalCode": "1485",
"OriginCountryName": "Philippines",
"DestinationLine1": "Port Area South",
"DestinationCityMunicipalityName": "Manila City",
"DestinationStateProvinceName": "Metro Manila",
"DestinationPostalCode": "1018",
"DestinationCountryName": "Philippines",
"Remarks": null
}
]
}TruckDriverLocation
PushTruckLocation
This resource allows the insertion of longitude and latitude (GPS data) details of a truck's current location.
End Point
POST /truck-locationsRequest Information
URI Parameters: None
Body Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| TruckLocations | truck's location updates | array | required |
| TruckLocation.TruckId | truck's id | int | required |
| TruckLocation.TruckingId | dispatch number | int | required |
| TruckLocation.Longitude | truck's location in longitude | decimal | required |
| TruckLocation.Latitude | truck's location in latitude | decimal | required |
| TruckLocation.Speed | truck's navigation speed | decimal | required |
| TruckLocation.Source | update source | string | required |
| TruckLocation.Timestamp | update timestamp | datetime | required |
Sample Schema Content-type: application/json
json
[
{
"TruckId": 206,
"TruckingId": 107670,
"Longitude": 10.3219173,
"Latitude": 123.9187487,
"Speed": 5,
"PlateNo": "NEG9138",
"Source": "canigao",
"SiteId": 38,
"TimeStamp": "2023-06-30T02:28:28.100Z"
}
]Response Information
A successful request to this API will insert a GPS data (longitude, latitude) of a truck’s current location and return the inserted details.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": "Success adding 1 location record(s) to database.",
"data": null
}CheckInTypes
This resource allows the mobile application to get all trucking checkin types.
End Point
GET /checkin-types/truckingRequest Information
URI Parameters: None
Body Parameters: None
Response Information
Request to this API will return a list of all trucking checkin types. A status code of 404 will be returned when no record is found.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": [
{
"Id": 19,
"Name": "Start Loading",
"Sequence": 2
},
{
"Id": 15,
"Name": "Picked up",
"Sequence": 4
},
{
"Id": 11,
"Name": "Unloading In Consignee",
"Sequence": 15
}
]
}CheckIns
Checkins
This resource allows users to update the status of the shipment or new movement of the shipment (e.g. Loaded to Truck, Arrived In Warehouse, Warehouse Receiving, Unloading In Consignee).
End Point
POST /checkinsRequest Information
URI Parameters: None
Body Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| CheckInTypeId | shipment checkin type id | int | required |
| CheckInDate | date the shipment being checked in | date | required |
| CheckInTime | time the shipment being checked in (in 24 hrs format) | time | required |
| CheckInBusinessUnitId | businessunit id where the shipment was checked in | int | optional |
| Longitude | truck's location in longitude | decimal | required |
| Latitude | truck's location in latitude | decimal | required |
| Remarks | checkin remarks | string | required |
| TruckingId | trucking where check in is tag | int | required |
| TruckingTypeId | trucking type of tag trucking | int | required |
| CheckInShipments | list of shipments being checked in and their documents | array | required |
ShipmentId | shipment id | int | required |
ShipmentCustomerDocumentId | shipment's customer document id | int | required |
| PhotosBase64 | ist of photos(based64 coded) for images taken upon check in update | string | optional |
| SourceApp | application name | string | optional |
Sample Schema Content-type: application/json
json
{
"CheckInTypeId": 15,
"CheckInDate": "09-17-2020",
"CheckInTime": "08:00",
"CheckInBusinessUnitId": 16,
"Longitude": 10.3219173,
"Latitude": 123.9187487,
"Remarks": "TEST ONLY",
"TruckingId": "107670",
"TruckingTypeId": "20",
"CheckInShipments": [
{
"ShipmentId": 352456,
"ShipmentCustomerDocumentId": null
},
{
"ShipmentId": 352455,
"ShipmentCustomerDocumentId": null
}
],
"PhotosBase64": [],
"SourceApp": "App Name"
}Response Information
A successful request to this API will return the saved checkin (shipment new movement) and its details.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": {
"Id": 267723,
"CheckInTypeId": 15,
"CheckInDate": "2020-09-17T00:00:00",
"CheckInTime": "08:00:00",
"CheckInBusinessUnitId": 16,
"CheckInSourceId": 107670,
"Longitude": 10.3219173,
"Latitude": 123.9187487,
"Status": 10,
"Remarks": "TEST ONLY",
"CheckInPodSignatureId": null,
"IsTruckerUpdate": true,
"CreatedDate": "2023-06-30T15:05:31.7554792+08:00",
"LastUpdatedDate": null,
"CreatedByUserId": null,
"LastUpdatedByUserId": null,
"IsWithDiscrepancy": null,
"BusinessUnit": null,
"CheckInPodSignature": null,
"CheckInType": {
"CheckIns": [],
"CustomerCheckInTypes": [],
"Id": 15,
"Name": "Picked up",
"ReferenceTable": "Shipment",
"Sequence": 4,
"CanReoccur": null,
"IsStatic": null,
"ForTrucking": true,
"ForAirFreight": false,
"ForSeaFreight": false,
"ForRoro": true,
"IsGeneric": false
},
"CheckInPictures": [],
"CheckInShipments": [
{
"Id": 305678,
"CheckInId": 267723,
"ShipmentId": 352456,
"ShipmentCustomerDocumentId": null,
"IsDisplay": true,
"Remarks": null,
"Shipment": {
"Address": null,
"Address1": null,
"BusinessUnit": null,
"BusinessUnit1": null,
"BusinessUnit2": null,
"CheckInShipments": [],
"Customer": null,
"Customer1": null,
"DeliveryExceptions": [],
"PickupDeliveryRequests": [],
"PickupExceptions": [],
"RatesMaster": null,
"RatesMaster1": null,
"Service": null,
"User": null,
"ShipmentMaster": null,
"ShipmentType": null,
"User1": null,
"User2": null,
"User3": null,
"ShipmentCharges": [],
"ShipmentCustomerDocuments": [],
"ShipmentMetrics": [],
"TruckingDeliveries": [],
"Id": 352456,
"BusinessUnitId": 16,
"ServiceId": 7,
"ShipmentTypeId": 57,
"DocumentNo": null,
"DocumentDate": null,
"BookingDate": "2023-06-30T00:00:00",
"BookingTime": "11:01:47",
"PaymentMode": "A",
"CustomerId": 240,
"CustomerAddressId": 230,
"CustomerContactId": 599,
"CustomerContactPhoneId": 600,
"BillToCustomerId": 240,
"BillToCustomerAddressId": 230,
"BillToCustomerContactId": 599,
"BillToCustomerContactPhoneId": 600,
"RateId": null,
"Quantity": 2,
"TotalCBM": 0.00012,
"TotalWeight": 14.0,
"DeclaredValue": 120.0,
"IsRevenue": null,
"Revenue": 0.0,
"IsTaxInclusive": null,
"TaxAmount": 0.0,
"TaxPercentage": 0.0,
"Description": "asdfafas",
"BookingRemarks": "aafasfasfdaasdfa",
"DeliverTo": "shiena",
"DeliveryAddressId": 478176,
"DeliverToContactNo": "0920245687",
"ConsigneeEmailAddress": "na",
"DeliveryDate": "2020-09-17T00:00:00",
"DeliveryTime": "08:00:00",
"DeliveryRemarks": null,
"ReceivedByName": "TEST ONLY",
"OriginAddressId": 478177,
"PickUpBussinessUnitId": 26,
"PickupDate": "2023-06-30T00:00:00",
"PickupTime": "11:03:00",
"VanNumber": "VN847643833",
"SealNumber": "SN98303822324",
"ParentShipmentId": 352457,
"IsConsolidation": true,
"IsMultipleDelivery": false,
"TransportStatusId": 35,
"TransportStatusRemarks": "For pickup from customer",
"LoadingStatusId": 10,
"LastCheckInId": 267721,
"QRCode": null,
"CustomerBillId": null,
"CustomerBillNumber": null,
"CustomerBillDate": null,
"PODTransmittalId": null,
"PODTransmittalRemarks": null,
"IsPODTransmittalReturn": null,
"RevenueShipmentId": null,
"BillingTransmittalId": null,
"IsAcknowledgedBillingTransmittal": null,
"BillingTransmittalSequence": null,
"BillingTransmittalRemarks": null,
"ShipperEmailAddress": "csr@tempemail.com",
"ShipperName": "",
"ShipperContactNo": null,
"ArrivedDate": null,
"RequestedDeliveryDate": "2023-06-30T00:00:00",
"RequestedDeliveryTime": "11:02:00",
"ForwardingServiceType": "DD",
"WaybillNumber": null,
"ShipmentMasterId": null,
"Length": null,
"Width": null,
"Height": null,
"TotalVolumeWeight": null,
"UnitOfMeasure": "LTR",
"CratingTypeId": null,
"CreatedDate": "2023-06-30T11:05:06.597",
"LastUpdatedDate": "2023-06-30T11:12:37.247",
"CreatedByUserId": 84,
"LastUpdatedByUserId": 84,
"PONumber": null,
"podtlctrno": null,
"OrReferenceNo": null,
"IEManifestNumber": null,
"ForDispatch": true,
"IEDeliveryListNumber": null,
"Source": null,
"ConfirmStatus": null,
"ActualQTY": null,
"InitialRateId": null,
"InitialRevenue": null,
"RateConfirmationDate": null,
"TruckConfirmStatusId": null,
"EditedRevenueDate": null,
"HubOperationSiteBusinessUnitId": null,
"HubLocationId": null,
"ShipmentCategoryId": null,
"Status1": null,
"ActualPickupDate": "2020-09-17T00:00:00",
"ActualPickupTime": "08:00:00",
"IsWithDiscrepancy": null,
"VoucherId": null,
"IsOfflinePOD": null,
"IsSendNotification": null,
"ShipperAddress": null,
"IsDropped": null,
"LoadPlanId": null,
"DocumentationProcessedById": null,
"DocumentationProcessedDate": null,
"DocumentationLastUpdatedById": null,
"DocumentationLastUpdatedDate": null,
"PODReceivedBy": null,
"BookedBy": "adf",
"VesselVoyageId": null
},
"ShipmentCustomerDocument": null
},
{
"Id": 305679,
"CheckInId": 267723,
"ShipmentId": 352455,
"ShipmentCustomerDocumentId": null,
"IsDisplay": true,
"Remarks": null,
"Shipment": {
"Address": null,
"Address1": null,
"BusinessUnit": null,
"BusinessUnit1": null,
"BusinessUnit2": null,
"CheckInShipments": [],
"Customer": null,
"Customer1": null,
"DeliveryExceptions": [],
"PickupDeliveryRequests": [],
"PickupExceptions": [],
"RatesMaster": null,
"RatesMaster1": null,
"Service": null,
"User": null,
"ShipmentMaster": null,
"ShipmentType": null,
"User1": null,
"User2": null,
"User3": null,
"ShipmentCharges": [],
"ShipmentCustomerDocuments": [],
"ShipmentMetrics": [],
"TruckingDeliveries": [],
"Id": 352455,
"BusinessUnitId": 16,
"ServiceId": 7,
"ShipmentTypeId": 57,
"DocumentNo": null,
"DocumentDate": null,
"BookingDate": "2023-06-30T00:00:00",
"BookingTime": "11:01:47",
"PaymentMode": "A",
"CustomerId": 240,
"CustomerAddressId": 230,
"CustomerContactId": 599,
"CustomerContactPhoneId": 600,
"BillToCustomerId": 240,
"BillToCustomerAddressId": 230,
"BillToCustomerContactId": 599,
"BillToCustomerContactPhoneId": 600,
"RateId": null,
"Quantity": 2,
"TotalCBM": 0.00012,
"TotalWeight": 14.0,
"DeclaredValue": 120.0,
"IsRevenue": null,
"Revenue": 0.0,
"IsTaxInclusive": null,
"TaxAmount": 0.0,
"TaxPercentage": 0.0,
"Description": "asdfafas",
"BookingRemarks": "aafasfasfda",
"DeliverTo": "shiena",
"DeliveryAddressId": 478174,
"DeliverToContactNo": "0920245687",
"ConsigneeEmailAddress": "na",
"DeliveryDate": "2020-09-17T00:00:00",
"DeliveryTime": "08:00:00",
"DeliveryRemarks": null,
"ReceivedByName": "TEST ONLY",
"OriginAddressId": 478175,
"PickUpBussinessUnitId": 26,
"PickupDate": "2023-06-30T00:00:00",
"PickupTime": "11:03:00",
"VanNumber": "VN847643833",
"SealNumber": "SN98303822324",
"ParentShipmentId": 352457,
"IsConsolidation": true,
"IsMultipleDelivery": false,
"TransportStatusId": 35,
"TransportStatusRemarks": "For pickup from customer",
"LoadingStatusId": 10,
"LastCheckInId": 267721,
"QRCode": null,
"CustomerBillId": null,
"CustomerBillNumber": null,
"CustomerBillDate": null,
"PODTransmittalId": null,
"PODTransmittalRemarks": null,
"IsPODTransmittalReturn": null,
"RevenueShipmentId": null,
"BillingTransmittalId": null,
"IsAcknowledgedBillingTransmittal": null,
"BillingTransmittalSequence": null,
"BillingTransmittalRemarks": null,
"ShipperEmailAddress": "csr@tempemail.com",
"ShipperName": "",
"ShipperContactNo": null,
"ArrivedDate": null,
"RequestedDeliveryDate": "2023-06-30T00:00:00",
"RequestedDeliveryTime": "11:02:00",
"ForwardingServiceType": "DD",
"WaybillNumber": null,
"ShipmentMasterId": null,
"Length": null,
"Width": null,
"Height": null,
"TotalVolumeWeight": null,
"UnitOfMeasure": "LTR",
"CratingTypeId": null,
"CreatedDate": "2023-06-30T11:04:46.87",
"LastUpdatedDate": "2023-06-30T11:12:37.247",
"CreatedByUserId": 84,
"LastUpdatedByUserId": 84,
"PONumber": null,
"podtlctrno": null,
"OrReferenceNo": null,
"IEManifestNumber": null,
"ForDispatch": true,
"IEDeliveryListNumber": null,
"Source": null,
"ConfirmStatus": null,
"ActualQTY": null,
"InitialRateId": null,
"InitialRevenue": null,
"RateConfirmationDate": null,
"TruckConfirmStatusId": null,
"EditedRevenueDate": null,
"HubOperationSiteBusinessUnitId": null,
"HubLocationId": null,
"ShipmentCategoryId": null,
"Status1": null,
"ActualPickupDate": "2020-09-17T00:00:00",
"ActualPickupTime": "08:00:00",
"IsWithDiscrepancy": null,
"VoucherId": null,
"IsOfflinePOD": null,
"IsSendNotification": null,
"ShipperAddress": null,
"IsDropped": null,
"LoadPlanId": null,
"DocumentationProcessedById": null,
"DocumentationProcessedDate": null,
"DocumentationLastUpdatedById": null,
"DocumentationLastUpdatedDate": null,
"PODReceivedBy": null,
"BookedBy": "adf",
"VesselVoyageId": null
},
"ShipmentCustomerDocument": null
}
]
}
}Checkins/Pod
This resource allows users to update the status of the shipment to delivered (delivery as shipment's new movement)
End Point
POST /checkins/podRequest Information
URI Parameters: None
Body Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| ReceivedBy | name of receiver | string | required |
| SignatureBase64 | signature of receiver (based64 coded) | string | required |
| Remarks | POD remarks | string | required |
| CheckIn | list of checkins | array | optional |
| CheckIn.CheckInTypeId | id of the shipment'sheckin | int | required |
| CheckIn.CheckInDate | date the shipment being checked in | date | required |
| CheckIn.CheckInTime | time the shipment being checked in (in 24 hrs format) | time | required |
| CheckIn.CheckInBusinessUnitId | businessunit id where the shipment was checked in | int | optional |
| CheckIn.Longitude | truck location in longitude | decimal | required |
| CheckIn.Latitude | truck location in latitude nt | decimal | required |
| CheckIn.Remarks | checkin remarks | string | required |
| CheckIn.TruckingId | trucking where check in is tag | int | required |
| CheckIn.TruckingTypeId | trucking type of tag trucking | int | required |
| CheckIn.CheckInShipments | list of shipments being checked in and their documents | array | required |
ShipmentId | shipment id | int | required |
ShipmentCustomerDocumentId | shipment's customer document id | int | required |
| PhotosBase64 | List of photos(based64 coded) for images taken upon check in update | string | required |
Sample Schema Content-type: application/json
json
{
"ReceivedBy": "TEST ONLY",
"SignatureBase64": null,
"Remarks": "TEST",
"CheckIn": {
"CheckInTypeId": 7,
"CheckInDate": "09-17-2020",
"CheckInTime": "08:00",
"CheckInBusinessUnitId": 16,
"Longitude": 10.3219173,
"Latitude": 123.9187487,
"Remarks": "TEST ONLY",
"TruckingId": "107670",
"TruckingTypeId": "20",
"CheckInShipments": [
{
"ShipmentId": 352456,
"ShipmentCustomerDocumentId": null
},
{
"ShipmentId": 352455,
"ShipmentCustomerDocumentId": null
}
],
"PhotosBase64": []
}
}Response Information
A successful request to this API will return the saved POD checkin (shipment delivery) and its details.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": {
"nC": {
"Id": 267722,
"CheckInTypeId": 7,
"CheckInDate": "2020-09-17T00:00:00",
"CheckInTime": "08:00:00",
"CheckInBusinessUnitId": 16,
"CheckInSourceId": 107670,
"Longitude": 10.3219173,
"Latitude": 123.9187487,
"Status": 10,
"Remarks": "TEST ONLY",
"CheckInPodSignatureId": null,
"IsTruckerUpdate": true,
"CreatedDate": "2023-06-30T14:32:17.7530427+08:00",
"LastUpdatedDate": null,
"CreatedByUserId": null,
"LastUpdatedByUserId": null,
"IsWithDiscrepancy": null,
"BusinessUnit": null,
"CheckInPodSignature": null,
"CheckInType": {
"CheckIns": [],
"CustomerCheckInTypes": [],
"Id": 7,
"Name": "Delivered",
"ReferenceTable": "Shipment",
"Sequence": 17,
"CanReoccur": null,
"IsStatic": true,
"ForTrucking": true,
"ForAirFreight": null,
"ForSeaFreight": null,
"ForRoro": true,
"IsGeneric": false
},
"CheckInPictures": [],
"CheckInShipments": [
{
"Id": 305676,
"CheckInId": 267722,
"ShipmentId": 352456,
"ShipmentCustomerDocumentId": null,
"IsDisplay": true,
"Remarks": null,
"Shipment": null,
"ShipmentCustomerDocument": null
},
{
"Id": 305677,
"CheckInId": 267722,
"ShipmentId": 352455,
"ShipmentCustomerDocumentId": null,
"IsDisplay": true,
"Remarks": null,
"Shipment": null,
"ShipmentCustomerDocument": null
}
]
},
"hC": {
"Id": 0,
"CheckInTypeId": 24,
"CheckInDate": "2020-09-17T00:00:00",
"CheckInTime": "08:00:00",
"CheckInBusinessUnitId": 16,
"CheckInSourceId": 107670,
"Longitude": 10.3219173,
"Latitude": 123.9187487,
"Status": 10,
"Remarks": "TEST ONLY",
"CheckInPodSignatureId": null,
"IsTruckerUpdate": true,
"CreatedDate": "2023-06-30T14:32:17.7530427+08:00",
"LastUpdatedDate": null,
"CreatedByUserId": null,
"LastUpdatedByUserId": null,
"IsWithDiscrepancy": null,
"BusinessUnit": null,
"CheckInPodSignature": null,
"CheckInType": null,
"CheckInPictures": [],
"CheckInShipments": []
}
}
}DeliveryExceptionTypes
This resource allows the mobile application to get all delivery exception types (reason for not being able to deliver shipment).
End Point
GET /delivery-exception-typesRequest Information
URI Parameters: None
Body Parameters: None
Response Information
Request to this API will return a list of all delivery exception types. A status code of 404 will be returned when no record is found.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": [
{
"Id": 1,
"Name": "Advance Pick-Up",
"LocalName": "Puntahan sa naka saad na petsa\r\n",
"Status": true
},
{
"Id": 2,
"Name": "Packages Received/Walked-In beyond Cut-Off Time",
"LocalName": "Pangarga ay hindi umabot sa cut-off",
"Status": true
},
{
"Id": 3,
"Name": "Recipient Not In",
"LocalName": "Walang tatanggap",
"Status": true
}
]
}DeliveryExceptions
This resource allows users to update the status of the shipment to delivery exception (shipment cannot be delivered).
End Point
POST /delivery-exceptionRequest Information
URI Parameters: None
Body Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| DexTypeId | shipment delivery exception type id | int | required |
| DexDate | date the shipment delivery exception | date | required |
| DexTime | time the shipment delivery exception (in 24 hrs format) | time | required |
| BusinessUnitId | businessunit id where the shipment was dexed in | int | optional |
| Remarks | DEX remarks | string | required |
| TruckingId | Dispatch number | int | optional |
| PhotosBase64 | List of photos in base64 format | array | optional |
| DexShipments | List of shipments being checked in and their documents for dexing | array | required |
ShipmentId | shipment id | int | required |
ShipmentCustomerDocumentId | shipment's customer document id | int | required |
Sample Schema Content-type: application/json
json
{
"DexTypeId": 6,
"DexDate": "06-30-2023",
"DexTime": "15:30",
"BusinessUnitId": 16,
"Remarks": "TEST ONLY",
"DexShipments": [
{
"ShipmentId": 186369,
"ShipmentCustomerDocumentId": null
}
],
"TruckingId": null,
"PhotosBase64": []
}Response Information
A successful request to this API will return the saved DEX checkins (shipment delivery exception) and its details.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": {
"Id": 267720,
"CheckInTypeId": 6,
"CheckInDate": "2023-06-30T00:00:00",
"CheckInTime": "15:30:00",
"CheckInBusinessUnitId": 16,
"CheckInSourceId": null,
"Longitude": null,
"Latitude": null,
"Status": 10,
"Remarks": "TEST ONLY",
"CheckInPodSignatureId": null,
"IsTruckerUpdate": true,
"CreatedDate": "2023-06-30T11:40:08.6240255+08:00",
"LastUpdatedDate": null,
"CreatedByUserId": null,
"LastUpdatedByUserId": null,
"BusinessUnit": null,
"CheckInPodSignature": null,
"CheckInType": null,
"CheckInPictures": [],
"CheckInShipments": [
{
"Id": 305672,
"CheckInId": 267720,
"ShipmentId": 186369,
"ShipmentCustomerDocumentId": null,
"IsDisplay": true,
"Remarks": null,
"Shipment": null,
"ShipmentCustomerDocument": null
}
]
}
}PickupExceptionTypes
This resource allows the mobile application to get all pickup exception types (reason for not being able to pickup shipment).
End Point
GET /pickup-exception-typesRequest Information
URI Parameters: None
Body Parameters: None
Response Information
Request to this API will return a list of all pickup exception types. A status code of 404 will be returned when no record is found.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": [
{
"Id": 1,
"Name": "Incorrect/Incomplete Address"
},
{
"Id": 2,
"Name": "Illegible Label"
},
{
"Id": 3,
"Name": "Shipper not around"
}
]
}PickupExceptions
This resource allows users to update the status of the shipment to pickup exception (shipment cannot be picked up).
End Point
POST /pickup-exceptionsRequest Information
URI Parameters: None
Body Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| PUXTypeId | shipment pickup exception type id | int | required |
| PUXDate | date the shipment pickup exception | date | required |
| PUXTime | time the shipment pickup exception (in 24 hrs format) | time | required |
| BusinessUnitId | businessunit id where the shipment was PUXed in | int | optional |
| Remarks | PUX remarks | string | required |
| PUXShipments | list of shipments being checked in and their documents for PUX | array | required |
ShipmentId | shipment id | int | required |
ShipmentCustomerDocumentId | shipment's customer document id | int | required |
Sample Schema Content-type: application/json
json
{
"PUXTypeId": 1,
"PUXDate": "09-17-2020",
"PUXTime": "16:30",
"BusinessUnitId": 16,
"Remarks": "TEST PUX ONLY",
"PUXShipments": [
{
"ShipmentId": 187393,
"ShipmentCustomerDocumentId": null
}
]
}Response Information
A successful request to this API will return the saved PUX checkins (shipment pickup exception) and its details.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",
"message": null,
"data": {
"Id": 139325,
"CheckInTypeId": 13,
"CheckInDate": "2020-09-17T00:00:00",
"CheckInTime": "16:30:00",
"CheckInBusinessUnitId": 16,
"CheckInSourceId": null,
"Longitude": null,
"Latitude": null,
"Status": 10,
"Remarks": "TEST PUX ONLY",
"CheckInPodSignatureId": null,
"IsTruckerUpdate": true,
"CreatedDate": "2020-09-25T00:00:00+08:00",
"LastUpdatedDate": null,
"CreatedByUserId": null,
"LastUpdatedByUserId": null,
"BusinessUnit": null,
"CheckInPodSignature": null,
"CheckInType": null,
"CheckInPictures": [],
"CheckInShipments": [
{
"Id": 174956,
"CheckInId": 139325,
"ShipmentId": 187393,
"ShipmentCustomerDocumentId": null,
"IsDisplay": true,
"Shipment": null,
"ShipmentCustomerDocument": null
}
]
}
}Additional Pickup/Delivery Request
This resource allows to get the details of the additional for pickup/delivery shipment requests for a dispatch that accepts an array of Shipment Ids as a parameter.
End Point
GET /truckings/shipmentsRequest Information
URI Parameters:
| Name | Description | Type | Additional Info |
|---|---|---|---|
| ids | array of shipment ids | array | required |
Body Parameters: None
Response Information
A request to this API will return the details of the additional shipments (whether it is for pickup or delivery). A status code of 404 will be returned when no record is found.
Sample Response Format Content-type: application/json
json
{
"status": "SUCCESS",{
"status": "SUCCESS",
"message": null,
"data": {
"TruckingId": 249234,
"DispatchNo": "00249234",
"DeliveryDetails": [
{
"RequestType": "Pickup/Delivery",
"RequestDeliveryDate": null,
"RequestDeliveryTime": null,
"ShipmentId": 352009,
"CustomerId": 2805,
"ShipperName": "Albert Einstein",
"DeliverTo": "shiena",
"DeliveryAddress": "ceb, ceb, Alcantara, Cebu, Philippines 6033",
"CargoDescription": "asfasf",
"CustomerDocumentType": null,
"CustomerDocumentNo": null,
"CustomerDocumentId": null,
"ShipperPhoneNo": null,
"PickupAddress": "nav, nav, Caloocan City, Metro Manila, Philippines 1411",
"ConsigneePhoneNo": "0920245687",
"CheckIns": [],
"DeliveryAddressCoordinates": null,
"OriginAddressCoordinates": null
},
{
"RequestType": "Pickup/Delivery",
"RequestDeliveryDate": null,
"RequestDeliveryTime": null,
"ShipmentId": 351480,
"CustomerId": 263,
"ShipperName": "NEXTRADE PHILIPPINES, INC.",
"DeliverTo": "24/7 Convenience Store",
"DeliveryAddress": "Cebu City, Cebu, Philippines, 6000",
"CargoDescription": "Various Products",
"CustomerDocumentType": "Document",
"CustomerDocumentNo": "61",
"CustomerDocumentId": 282430,
"ShipperPhoneNo": null,
"PickupAddress": "Unit 801 Fort Legend Towers, 3rd Avenue , Taguig City, Metro Manila, Philippines 1630",
"ConsigneePhoneNo": "N/A",
"CheckIns": [],
"DeliveryAddressCoordinates": null,
"OriginAddressCoordinates": null
}
]
}
}