Chile Fifo API
Introduction
Service that allow maintaining Fifo Chile Integration with minimal changes. To obtain your enterpriseKey you can request it from the commercial area.
Disclaimer
This api is only available for Tottus.
Beta server
Service that allow maintaining Fifo Chile Integration with minimal changes. To obtain your enterpriseKey you can request it from the commercial area.
This api is only available for Tottus.
Beta server
Create an order only with vehicle type and pickup info. The order is offered on app.
e0ecd4a1-bbb2-4753-8862-2fb3572aa8ae
Pickup and vehicle info from order
Pick up location reference
landmark
Request type for shipment
oneway
Pick up location [Lat, Lng]
[
-33.4524225,
-70.6241109
]
Wished delivery types
Pick up location address
Portage Circle 95
Successful operation
curl --request POST \
--url https://us-central1-chazki-link-beta.cloudfunctions.net/cf-custom-integrations-beta/api/fazil/chile/fifo/create \
--header 'Content-Type: application/json' \
--header 'Enterprise-Key: e0ecd4a1-bbb2-4753-8862-2fb3572aa8ae' \
--data '{
"pickupLandmark": "landmark",
"requestType": "oneway",
"pickupCoordinates": [
-33.4524225,
-70.6241109
],
"requestedDeliveryTypes": [
"car"
],
"pickupDirection": "Portage Circle 95"
}'
{
"status": "success",
"message": "Successfull",
"data": {
"customer": {
"email": "a@a.com",
"firstName": "Enterprise TodoVa",
"lastName": "",
"phone": 56987654321,
"profileImage": "https://todovadocs.s3-sa-east-1.amazonaws.com/docs/b8a2fd21hljg00a3ujl0.jpeg",
"rating": {
"average": 4.4,
"itemsCount": 406
}
},
"driver": {
"email": "a@a.com",
"firstName": "Enterprise TodoVa",
"lastName": "",
"phone": 56987654321,
"profileImage": "https://todovadocs.s3-sa-east-1.amazonaws.com/docs/b8a2fd21hljg00a3ujl0.jpeg",
"rating": {
"average": 4.4,
"itemsCount": 406
}
},
"shipment": {
"activeDeliveryType": "",
"createdTime": "2018-07-18T10:59:21.536432809-04:00",
"customerPrice": 0,
"id": 320,
"packageReturnInfo": {
"uniqueId": "",
"shortName": "",
"direction": "Portage Circle 95",
"location": {
"type": "Point",
"coordinates": [
-70.5753948,
-33.4002761
]
},
"landMark": "some door 1234",
"placeId": "",
"time": "0001-01-01T00:00:00Z"
},
"packages": [
{
"createdBy": "customer",
"dispatchOrder": 1,
"invoiceNumber": 56746873470,
"productId": "",
"productName": "Remote Tag Adapter",
"productWeight": 0,
"productQty": 1,
"productDelicacy": "",
"productPriority": "",
"receiverContact": {
"name": null,
"phone": null,
"email": null,
"rut": null
},
"packageReceiver": {
"name": null,
"phone": null,
"email": null,
"rut": null
},
"dropoffInfo": {
"uniqueId": null,
"shortName": null,
"direction": null,
"location": null,
"landMark": null,
"placeId": null,
"time": null
},
"requestState": "queued_up",
"timeAtPackageEnded": "0001-01-01T00:00:00Z",
"actionHistory": null,
"ifUnDeliveredOwnSelf": false,
"comments": "",
"supportImages": "",
"driverAccounting": {
"waitingTime": null,
"parkingValue": null,
"tollValue": null,
"adjustment": null,
"notes": null
},
"customerAccounting": {
"waitingTime": null,
"parkingValue": null,
"tollValue": null,
"adjustment": null,
"notes": null
},
"driverReview": {
"rating": null,
"comment": null
},
"serviceReview": {
"rating": null,
"comment": null
}
}
],
"pickupInfo": {
"uniqueId": "",
"shortName": "",
"direction": "Portage Circle 95",
"location": {
"type": "Point",
"coordinates": [
-70.5753948,
-33.4002761
]
},
"landMark": "some door 1234",
"placeId": "",
"time": "0001-01-01T00:00:00Z"
},
"pickupScheduledDate": "0001-01-01T00:00:00Z",
"requestState": "pending",
"requestType": "oneway",
"shipmentImage": "https://www.digithaigroup.com/wp-engine/wp-content/uploads/2015/09/products.png",
"travelDistance": "0,",
"travelTime": 0,
"requestedDeliveryTypes": [
"car"
],
"actionHistory": null,
"systemPackages": null,
"metadata": null,
"price": {
"basePerReturn": 0,
"basePriceConsidered": false,
"couponDescription": "",
"couponDiscAmount": 0,
"couponId": "",
"cusBasePriceWithoutInsurance": 0,
"customerBasePrice": 0,
"customerPrice": 0,
"customerReturnPrice": 0,
"driverBasePrice": 0,
"driverPrice": 0,
"driverReturnPrice": 0,
"insuranceFee": 0,
"netPriceConsidered": true,
"priceModelSet": "",
"priceModelUsed": "",
"returnLocChargeFailed": false,
"returnPerKM": 0
}
}
}
}
Successful operation
Update an order with the complete information in order to create the shipment and the driver continue the flow.
e0ecd4a1-bbb2-4753-8862-2fb3572aa8ae
Complete information for creating the shipment
320
oneway
description
Successful operation
curl --request POST \
--url https://us-central1-chazki-link-beta.cloudfunctions.net/cf-custom-integrations-beta/api/fazil/chile/fifo/update \
--header 'Content-Type: application/json' \
--header 'Enterprise-Key: e0ecd4a1-bbb2-4753-8862-2fb3572aa8ae' \
--data '{
"shipmentId": "320",
"pickupScheduledDate": "",
"shipmentBillingCase": "",
"shipmentImage": "",
"requestType": "oneway",
"pickupLandmark": "",
"metadata": {
"Shopper Web": "https://3pl-app.instaleap.io"
},
"packages": [
{
"invoiceNumber": "1234",
"dispatchOrder": 1,
"productName": "product name",
"receiverName": "name",
"receiverEmail": "email",
"receiverPhone": "987654231",
"receiverRut": "",
"ifUnDeliveredOwnSelf": false,
"productQty": 1,
"dropoffDirection": "address",
"dropoffCoordinates": [
[
-70.5753948,
-33.4002761
]
],
"dropoffLandmark": "landmark"
}
],
"shipmentDesc": "description"
}'
{
"status": "success",
"message": "The order was updated successfully",
"data": {
"uniqueIdentifier": "",
"requestedDeliveryTypes": [
"car"
],
"activeDeliveryType": "car",
"estimatedTimeToPickup": 0,
"fromAcceptToCompleteTime": 0,
"timeAtShipmentCompleted": 0,
"pickupInfo": {
"fullname": "Huelen, Cerro Navia, Región Metropolitana, Chile",
"h3": "87eee459effffff",
"shortname": "Huelen",
"street": "Huelen",
"number": 3431,
"country": "CL",
"municipality": "Cerro Navia",
"province": "Santiago",
"location": {
"type": "Point",
"coordinates": [
-70.7405924,
-33.4214201
]
}
},
"pickupSchedulesDate": "",
"deletedPackages": [],
"packageReturnInfo": {
"fullname": "Huelen, Cerro Navia, Región Metropolitana, Chile",
"h3": "87eee459effffff",
"shortname": "Huelen",
"street": "Huelen",
"number": 3431,
"country": "CL",
"municipality": "Cerro Navia",
"province": "Santiago",
"location": {
"type": "Point",
"coordinates": [
-70.7405924,
-33.4214201
]
}
},
"nextPackageToDeliver": "12345",
"systemPackages": [],
"activePackage": "12345",
"shipmentQty": 1,
"shipmentDesc": "",
"shipmentWeight": 0,
"shipmentImage": "",
"packageReadyToHandOver": false,
"shipmentPriority": "",
"needToBringBack": false,
"isBroughtBack": false,
"supportImages": [
{
"imageType": "other_image",
"imageUrl": "https://todovadocs.s3.sa-east-1.amazonaws.com/docs/other_image.jpeg"
}
],
"returnDisFromLastDrop": 0,
"driverPathToDestination": "",
"cumulativePath": [],
"cumulativePathInfo": {
"lastUpdateTime": "",
"lastTraveledDistance": 0,
"lastToGoDistance": 0
},
"createdTime": "",
"updatedTime": "",
"customerInfo": {
"email": "",
"name": "",
"phone": "",
"rut": ""
},
"enterpriseInfo": {
"comuna": "",
"contact": "",
"giro": "",
"rubro": "",
"name": "",
"phone": "",
"rut": "",
"web": ""
},
"metadata": {
"Shopper Web": "https://3pl-app.instaleap.io"
},
"registerTime": "",
"isAdminIntervened": false,
"notAcceptedForLongTime": false,
"subscribedUsersPool": [],
"reassignedRequestId": "",
"originalRequestId": "",
"firstOriginalRequestId": "",
"requestState": "accepted",
"requestType": "oneway",
"customerReview": {
"rating": 0,
"comment": ""
},
"driverReview": {
"rating": 0,
"comment": ""
},
"serviceReview": {
"rating": 0,
"comment": ""
},
"nextAvailStates": [],
"customerId": "",
"customerType": "enterprise",
"driverId": "",
"id": "ace454bf",
"isRegister": false,
"travelDistance": 23524,
"travelTime": 23,
"travelPolyline": "",
"transbankHistory": [],
"driverInfo": {
"birthate": "",
"deliveryTypes": [
"car"
],
"deviceType": "android",
"email": "example@mail.com",
"incorporationDate": "",
"name": "test",
"patent": "",
"phone": "23522323332",
"rating": 0,
"rut": "23234"
},
"price": {
"basePerReturn": 0,
"basePriceConsidered": false,
"couponDescription": "",
"couponDiscAmount": 0,
"couponId": "",
"cusBasePriceWithoutInsurance": 0,
"customerBasePrice": 0,
"customerPrice": 0,
"customerReturnPrice": 0,
"driverBasePrice": 0,
"driverPrice": 0,
"driverReturnPrice": 0,
"insuranceFee": 0,
"netPriceConsidered": true,
"priceModelSet": "",
"priceModelUsed": "",
"returnLocChargeFailed": false,
"returnPerKM": 0
},
"packages": [
{
"createdBy": "customer",
"dispatchOrder": 1,
"invoiceNumber": 56746873470,
"productId": "",
"productName": "Remote Tag Adapter",
"productWeight": 0,
"productQty": 1,
"productDelicacy": "",
"productPriority": "",
"receiverContact": {
"name": "Foo Bar",
"phone": "56123456789",
"email": "foo@bar.cl",
"rut": "13001067-9"
},
"packageReceiver": {
"name": "Foo Bar",
"phone": "56123456789",
"email": "foo@bar.cl",
"rut": "13001067-9"
},
"dropoffInfo": {
"uniqueId": "",
"shortName": "",
"direction": "Portage Circle 95",
"location": {
"type": null,
"coordinates": null
},
"landMark": "some door 1234",
"placeId": "",
"time": "0001-01-01T00:00:00Z"
},
"requestState": "queued_up",
"timeAtPackageEnded": "0001-01-01T00:00:00Z",
"actionHistory": null,
"ifUnDeliveredOwnSelf": false,
"comments": "",
"supportImages": "",
"driverAccounting": {
"waitingTime": "0,",
"parkingValue": "0,",
"tollValue": "0,",
"adjustment": "0,",
"notes": ""
},
"customerAccounting": {
"waitingTime": "0,",
"parkingValue": "0,",
"tollValue": "0,",
"adjustment": "0,",
"notes": ""
},
"driverReview": {
"rating": 0,
"comment": ""
},
"serviceReview": {
"rating": 0,
"comment": ""
}
}
]
}
}
Successful operation
Cancel the order completely using the shipmentId from creation endpoint.
Shipment ID of the FIFO order that you want to use
320
e0ecd4a1-bbb2-4753-8862-2fb3572aa8ae
Successful operation
curl --request DELETE \
--url https://us-central1-chazki-link-beta.cloudfunctions.net/cf-custom-integrations-beta/api/legacy/chile/shipment/cancel/320 \
--header 'Enterprise-Key: e0ecd4a1-bbb2-4753-8862-2fb3572aa8ae'
{
"status": "success",
"message": "Cancelación exitosa",
"data": ""
}
Successful operation
Pickup and vehicle info from order
Pick up location reference
landmark
Request type for shipment
oneway
Pick up location [Lat, Lng]
[
-33.4524225,
-70.6241109
]
Wished delivery types
Pick up location address
Portage Circle 95
success
Successfull
Complete information for creating the shipment
320
oneway
description
/endpoint/{my_path_variable}