1.0.0
OAS 3.0.0

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.

Client Libraries
Shell
Ruby
Node.js
PHP
Python
More

Create order

Create FIFO order

Create an order only with vehicle type and pickup info. The order is offered on app.

Headers
  • enterprise-key
    required
    string
    Examplee0ecd4a1-bbb2-4753-8862-2fb3572aa8ae
Body
application/json

Pickup and vehicle info from order

pickupLandmark
string

Pick up location reference

Examplelandmark
requestType
string

Request type for shipment

Exampleoneway
pickupCoordinates
array number[]

Pick up location [Lat, Lng]

Example[ -33.4524225, -70.6241109 ]
requestedDeliveryTypes
array string[]

Wished delivery types

pickupDirection
string

Pick up location address

ExamplePortage Circle 95
Responses
  • 200

    Successful operation

POST/fazil/chile/fifo/create
Shell cURL
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
      }
    }
  }
}

Update order

Update FIFO order

Update an order with the complete information in order to create the shipment and the driver continue the flow.

Headers
  • enterprise-key
    required
    string
    Examplee0ecd4a1-bbb2-4753-8862-2fb3572aa8ae
Body
application/json

Complete information for creating the shipment

shipmentId
string
Example320
pickupScheduledDate
string
shipmentBillingCase
string
shipmentImage
string
requestType
string
Exampleoneway
pickupLandmark
string
metadata
object
packages
array object[]
shipmentDesc
string
Exampledescription
Responses
  • 200

    Successful operation

POST/fazil/chile/fifo/update
Shell cURL
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": ""
        }
      }
    ]
  }
}

Cancel order

Cancel FIFO order

Cancel the order completely using the shipmentId from creation endpoint.

Path Parameters
  • shipmentId
    required
    string

    Shipment ID of the FIFO order that you want to use

    Example320
Headers
  • enterprise-key
    required
    string
    Examplee0ecd4a1-bbb2-4753-8862-2fb3572aa8ae
Responses
  • 200

    Successful operation

DELETE/legacy/chile/shipment/cancel/{shipmentId}
Shell cURL
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": ""
}

CreateOrderRequest

Pickup and vehicle info from order

{} CreateOrderRequest
pickupLandmark
string

Pick up location reference

Examplelandmark
requestType
string

Request type for shipment

Exampleoneway
pickupCoordinates
array number[]

Pick up location [Lat, Lng]

Example[ -33.4524225, -70.6241109 ]
requestedDeliveryTypes
array string[]

Wished delivery types

pickupDirection
string

Pick up location address

ExamplePortage Circle 95

CreateOrderResponse

{} CreateOrderResponse
status
string
Examplesuccess
message
string
ExampleSuccessfull
data
object

UpdateOrderRequest

Complete information for creating the shipment

{} UpdateOrderRequest
shipmentId
string
Example320
pickupScheduledDate
string
shipmentBillingCase
string
shipmentImage
string
requestType
string
Exampleoneway
pickupLandmark
string
metadata
object
packages
array object[]
shipmentDesc
string
Exampledescription
  • Global Environment
    { "exampleKey": "exampleValue" }
  • Global Environment
    { "exampleKey": "exampleValue" }
{
"pickupLandmark": "landmark",
"requestType": "oneway",
"pickupCoordinates": [
-33.4524225,
-70.6241109
],
"requestedDeliveryTypes": [
"car"
],
"pickupDirection": "Portage Circle 95"
}
Response
.,,uod8B8bou,,. ..,uod8BBBBBBBBBBBBBBBBRPFT?l!i:. ||||||||||||||!?TFPRBBBBBBBBBBBBBBB8m=, |||| '""^^!!||||||||||TFPRBBBVT!:...! |||| '""^^!!|||||?!:.......! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! ||||, ||||.........` |||||!!-._ ||||.......;. ':!|||||||||!!-._ ||||.....bBBBBWdou,. bBBBBB86foi!|||||||!!-..:|||!..bBBBBBBBBBBBBBBY! ::!?TFPRBBBBBB86foi!||||||||!!bBBBBBBBBBBBBBBY..! :::::::::!?TFPRBBBBBB86ftiaabBBBBBBBBBBBBBBY....! :::;`"^!:;::::::!?TFPRBBBBBBBBBBBBBBBBBBBY......! ;::::::...''^::::::::::!?TFPRBBBBBBBBBBY........! .ob86foi;::::::::::::::::::::::::!?TFPRBY..........` .b888888888886foi;:::::::::::::::::::::::..........` .b888888888888888888886foi;::::::::::::::::...........b888888888888888888888888888886foi;:::::::::......`!Tf998888888888888888888888888888888886foi;:::....` '"^!|Tf9988888888888888888888888888888888!::..` '"^!|Tf998888888888888888888888889!! '` '"^!|Tf9988888888888888888!!` iBBbo. '"^!|Tf998888888889!` WBBBBbo. '"^!|Tf9989!` YBBBP^' '"^!` `
    Go Home