Skip to content
On this page

Basic

Create Booking

This resource allows customers to save multiple shipment transactions or to book multiple shipments with its required shipment information.

End Point

POST /shipments/booking/many

Request Information

URI Parameters: None

Body Parameters:

NameDescriptionTypeAdditional Info
BookingsArray of BookingsArray<Booking>required

Booking:

NameDescriptionTypeAdditional Info
CustomerIdcustomer account's login idintrequired
BusinessUnitIdshipment's business unit id
(Please click here for list of Business Units.)
intrequired
OperationSiteIdshipment's operation site id
(Please click here for list of Operation Sites.)
intrequired
ServiceIdshipment's service id
(Please click here for list of Services.)
intrequired
ShipmentTypeIdshipment's shipment type id
(Please click here for list of Shipment Types.)
intrequired
ForwardingServiceTypeshipment's forwarding service type
(Please click here for list of Forwarding Service Types.)
stringrequired only for courier, airfreight, and seafreight services
PickupDatedate when to pick up shipmentdaterequired
PickupTimetime when to pick up shipmenttimerequired
PickupAddressaddress where to pick up shipmentobjectrequired
PickupAddress.Streetstreet of pickup addressstringrequired
PickupAddress.Barangaybarangay of pickup addressstringrequired
PickupAddress.PostalCodepickup address’ postal code based on serviceable areastringrequired
Remarksshipment remarksstringoptional
RequestedDeliveryDatedate when the customer wants the shipment to be delivereddateoptional
RequestedDeliveryTimetime when the customer wants the shipment to be deliveredtimeoptional
Weightshipment’s total weight in kilogramsdecimalrequired
CBMshipment's total CBMdecimalrequired
Distancedistance in km from origin to destinationdecimaloptional
DeclaredValueshipment’s declared valuedecimalrequired (minimum value: 100)
PackageDimensionsdimensions of the shipment's packagearrayrequired
Lengthshipment’s packaging length in cmdecimalrequired only if shipment type name is “Own Packaging”
Widthshipment’s packaging width in cmdecimalrequired only if shipment type name is “Own Packaging”
Heightshipment’s packaging height in cmdecimalrequired only if shipment type name is “Own Packaging”
Weightshipment’s packaging weight in kgdecimalrequired
Quantityshipment’s packaging quantityintrequired
UnitOfMeasureshipment's unit of measure
(Please click here for list of Unit of Measures.)
stringrequired
ShipmentCategoryIdshipment category id
(Please click here for list of Unit of Measures.)
intoptional
CargoDescriptiondescription of cargostringoptional
ConsigneeNamename of shipment receiverstringrequired
ConsigneeContactNocontact no of shipment receiverstringoptional
ConsigneeEmailAddressemail address of shipment receiverstringrequired
ConsigneeAddressaddress of shipment receiver/ delivery addressobjectrequired
ConsigneeAddress.Streetstreet of delivery addressstringrequired
ConsigneeAddress.Barangaybarangay of delivery addressstringrequired
ConsigneeAddress.PostalCodedelivery address’ postal code based on serviceable areastringrequired
CustomerDocumentsshipment customer documentsarrayrequired
DocumentTypeIdshipments's customer document type id
(Please click here for list of Document Types.)
intrequired
DocumentNocustomer document numberstringrequired
ConsigneeNamecustomer document consignee namestringoptional
ConsigneeAddresscustomer document consignee addressstringoptional
Quantitycustomer document quantityintoptional
Sourceapplication/client namestringoptional

Sample Schema Content-type: application/json

json
{
    "Bookings": [
        {
            "CustomerId": 245,
            "BusinessUnitId": 16,
            "OperationSiteId": 26,
            "ServiceId": 5,
            "ShipmentTypeId": 17,
            "ForwardingServiceType": null,
            "PickupDate": "2021-02-11",
            "PickupTime": "08:00",
            "PickupAddress": {
                "Street": "Makati Street",
                "Barangay": "Barangay 123",
                "PostalCode": 1000
            },
            "Remarks": "Test API booking",
            "RequestedDeliveryDate": "2021-02-14",
            "RequestedDeliveryTime": "08:00",
            "Weight": 1,
            "CBM": 0.010,
            "Distance" : 2.3,
            "DeclaredValue": 100.00,
            "PackageDimensions": [
                {
                    "Length": null,
                    "Width": null,
                    "Height": null,
                    "Weight": 10.0,
                    "Quantity": 2
                }
            ],
            "UnitOfMeasure": "PC",
            "ShipmentCategoryId": null,
            "CargoDescription": "Assorted",
            "ConsigneeName": "Shiena Grace Formentera",
            "ConsigneeContactNo": "09123456789",
            "ConsigneeEmailAddress": "consigneeemail@email.com",
            "ConsigneeAddress": {
                "Street": "Makati Street 2",
                "Barangay": "Barangay 456",
                "PostalCode": 4025
            },
            "CustomerDocuments":[
                {
                    "DocumentTypeId": 1,
                    "DocumentNo": "INV#123546",                    
                    "ConsigneeName": "Shiena Grace Formentera",
                    "ConsigneeAddress" : "Makati Street, Cabuyao City, Laguna",
                    "Quantity" : 1
                }   
            ],
            "Source": "Online Booking"
        },
        {
            "CustomerId": 245,
            "BusinessUnitId": 16,
            "OperationSiteId": 26,
            "ServiceId": 5,
            "ShipmentTypeId": 17,
            "ForwardingServiceType": null,
            "PickupDate": "2021-02-11",
            "PickupTime": "08:00",
            "PickupAddress": {
                "Street": "Makati Street",
                "Barangay": "Barangay 123",
                "PostalCode": 1000
            },
            "Remarks": "Test API Booking",
            "RequestedDeliveryDate": "2021-02-14",
            "RequestedDeliveryTime": "08:00",
            "Weight": 1,
            "CBM": 0.010,
            "Distance" : 2.3,
            "DeclaredValue": 100.00,
            "PackageDimensions": [
                {
                    "Length": null,
                    "Width": null,
                    "Height": null,
                    "Weight": 10.0,
                    "Quantity": 2
                }
            ],
            "UnitOfMeasure": "PC",
            "ShipmentCategoryId": null,
            "CargoDescription": "Assorted",
            "ConsigneeName": "Shiena Grace Formentera",
            "ConsigneeContactNo": "09123456789",
            "ConsigneeEmailAddress": "consigneeemail@email.com",
            "ConsigneeAddress": {
                "Street": "Makati Street 2",
                "Barangay": "Barangay 456",
                "PostalCode": 4025
            },
            "CustomerDocuments":[
                {
                    "DocumentTypeId": 1,
                    "DocumentNo": "INV#123546",
                    "ConsigneeName": "Shiena Grace Formentera",
                    "ConsigneeAddress" : "Makati Street, Cabuyao City, Laguna",
                    "Quantity" : 1
                }   
            ],
            "Source": "Online Booking"
        }
    ]
}

Response Information

A successful request to this API will save the booked shipments and their information and will return a success booking status and the shipment’s tracking number.

Sample Response Format Content-type: application/json

json
{
    "status": "SUCCESS",
    "message": null,
    "data": [
        {
            "TrackingId": "00190964",
            "BookingDate": "11/02/2021",
            "BookingTime": "14:42:35"
        },
        {
            "TrackingId": "00190965",
            "BookingDate": "11/02/2021",
            "BookingTime": "14:42:35"
        }
    ]
}

Create Booking (Bulk)

This resource allows customers to save multiple shipment transactions or to book multiple shipments having bulk number of customer documents.

End Point

POST /shipments/booking/bulk

Request Information

URI Parameters: None

Body Parameters:

NameDescriptionTypeAdditional Info
CallBackApiUrlCallback API urlstringrequired
CustomerTransactionNoCustomer transaction numberstringrequired (case-sensitive)
NotificationEmailNotification email addressstringoptional (comma separated)
BookingsArray of BookingsArray < Booking >required

Booking:

NameDescriptionTypeAdditional Info
CustomerIdcustomer account's login idintrequired
BusinessUnitIdshipment's business unit id
(Please click here for list of Business Units.)
intrequired
OperationSiteIdshipment's operation site id
(Please click here for list of Operation Sites.)
intrequired
ServiceIdshipment's service id
(Please click here for list of Services.)
intrequired
ShipmentTypeIdshipment's shipment type id
(Please click here for list of Shipment Types.)
intrequired
ForwardingServiceTypeshipment's forwarding service type
(Please click here for list of Forwarding Service Types.)
stringrequired only for courier, airfreight, and seafreight services
PickupDatedate when to pick up shipmentdaterequired
PickupTimetime when to pick up shipmenttimerequired
PickupAddressaddress where to pick up shipmentstringrequired
PickupAddress.Streetstreet of pickup addressstringrequired
PickupAddress.Barangaybarangay of pickup addressstringrequired
PickupAddress.PostalCodepickup address’ postal code based on serviceable areastringrequired
Remarksshipment remarksstringoptional
RequestedDeliveryDatedate when the customer wants the shipment to be delivereddateoptional
RequestedDeliveryTimetime when the customer wants the shipment to be deliveredtimeoptional
Weightshipment’s total weight in kilogramsdecimalrequired
CBMshipment's total CBMdecimalrequired
Distancedistance in km from origin to destinationdecimaloptional
DeclaredValueshipment’s declared valuedecimalrequired (minimum value: 100)
PackageDimensionsdimensions of the shipment's packagearrayrequired
Lengthshipment’s packaging length in cmdecimalrequired only if shipment type name is “Own Packaging”
Widthshipment’s packaging width in cmdecimalrequired only if shipment type name is “Own Packaging”
Heightshipment’s packaging height in cmdecimalrequired only if shipment type name is “Own Packaging”
Weightshipment’s packaging weight in kgdecimalrequired
Quantityshipment’s packaging quantityintrequired
UnitOfMeasureshipment's unit of measure
(Please click here for list of Unit of Measures.)
stringrequired
ShipmentCategoryIdshipment category id
(Please click here for list of Unit of Measures.)
intoptional
CargoDescriptiondescription of cargostringoptional
ConsigneeNamename of shipment receiverstringrequired
ConsigneeContactNocontact no of shipment receiverstringoptional
ConsigneeEmailAddressemail address of shipment receiverstringrequired
ConsigneeAddressaddress of shipment receiver/ delivery addressobjectrequired
ConsigneeAddress.Streetstreet of delivery addressstringrequired
ConsigneeAddress.Barangaybarangay of delivery addressstringrequired
ConsigneeAddress.PostalCodedelivery address’ postal code based on serviceable areastringrequired
CustomerDocumentsshipment customer documentsarrayrequired
DocumentTypeIdshipments's customer document type id
(Please click here for list of Document Types.)
intrequired
DocumentNocustomer document numberstringrequired
ConsigneeNamecustomer document consignee namestringoptional
ConsigneeAddresscustomer document consignee addressstringoptional
Quantitycustomer document quantityintoptional
Sourceapplication/client namestringoptional

Sample Schema Content-type: application/json

json
{
    "CallBackApiUrl": "https://api.customer.com/callback_api_name",   
    "CustomerTransactionNo": "ABC121212",
    "NotificationEmail": "email@customer.com",
    "Bookings": [
        {
            "CustomerId": 245,
            "BusinessUnitId": 16,
            "OperationSiteId": 26,
            "ServiceId": 5,
            "ShipmentTypeId": 17,
            "ForwardingServiceType": null,
            "PickupDate": "2021-02-11",
            "PickupTime": "08:00",
            "PickupAddress": {
                "Street": "Makati Street",
                "Barangay": "Barangay 123",
                "PostalCode": 1000
            },
            "Remarks": "Test API booking",
            "RequestedDeliveryDate": "2021-02-14",
            "RequestedDeliveryTime": "08:00",
            "Weight": 1,
            "CBM": 0.010,
            "Distance" : 2.3,
            "DeclaredValue": 100.00,
            "PackageDimensions": [
                {
                    "Length": null,
                    "Width": null,
                    "Height": null,
                    "Weight": 10.0,
                    "Quantity": 2
                }
            ],
            "UnitOfMeasure": "PC",
            "ShipmentCategoryId": null,
            "CargoDescription": "Assorted",
            "ConsigneeName": "Shiena Grace Formentera",
            "ConsigneeContactNo": "09123456789",
            "ConsigneeEmailAddress": "consigneeemail@email.com",
            "ConsigneeAddress": {
                "Street": "Makati Street 2",
                "Barangay": "Barangay 456",
                "PostalCode": 4025
            },
            "CustomerDocuments":[
                {
                    "DocumentTypeId": 1,
                    "DocumentNo": "INV#123546",                    
                    "ConsigneeName": "Shiena Grace Formentera",
                    "ConsigneeAddress" : "Makati Street, Cabuyao City, Laguna",
                    "Quantity": 1
                }   
            ],
            "Source": "Online Booking"

        },
        {
            "CustomerId": 245,
            "BusinessUnitId": 16,
            "OperationSiteId": 26,
            "ServiceId": 5,
            "ShipmentTypeId": 17,
            "ForwardingServiceType": null,
            "PickupDate": "2021-02-11",
            "PickupTime": "08:00",
            "PickupAddress": {
                "Street": "Makati Street",
                "Barangay": "Barangay 123",
                "PostalCode": 1000
            },
            "Remarks": "Test API Booking",
            "RequestedDeliveryDate": "2021-02-14",
            "RequestedDeliveryTime": "08:00",
            "Weight": 1,
            "CBM": 0.010,
            "Distance" : 2.3,
            "DeclaredValue": 100.00,
            "PackageDimensions": [
                {
                    "Length": null,
                    "Width": null,
                    "Height": null,
                    "Weight": 10.0,
                    "Quantity": 2
                }
            ],
            "UnitOfMeasure": "PC",
            "ShipmentCategoryId": null,
            "CargoDescription": "Assorted",
            "ConsigneeName": "Shiena Grace Formentera",
            "ConsigneeContactNo": "09123456789",
            "ConsigneeEmailAddress": "consigneeemail@email.com",
            "ConsigneeAddress": {
                "Street": "Makati Street 2",
                "Barangay": "Barangay 456",
                "PostalCode": 4025
            },
            "CustomerDocuments":[
                {
                    "DocumentTypeId": 1,
                    "DocumentNo": "INV#123546",
                    "ConsigneeName": "Shiena Grace Formentera",
                    "ConsigneeAddress" : "Makati Street, Cabuyao City, Laguna",
                    "Quantity": 1
                }   
            ],
            "Source": "Online Booking"
        }
    ]
}

Response Information

A request to this API will return a Success or Error status and a request message. A status code 202 will be returned if the request is successful.

Sample Response Format Content-type: application/json

json
{
    "status": "SUCCESS",
    "message": "Your request is being processed.",
    "data": null
}

Sample Callback API Payload Content-type: application/json

json
{
    "status": "SUCCESS",
    "message": null,
    "data": {
        "CustomerTransactionNo": "ABC121212",
        "Bookings": [
            {
                "TrackingId": "00190964",
                "BookingDate": "11/02/2021",
                "BookingTime": "14:42:35"
            },
            {
                "TrackingId": "00190965",
                "BookingDate": "11/02/2021",
                "BookingTime": "14:42:35"
            }
        ]
    }
}

Retries

Our system has a retry protocol whenever we get an error response from the client (i.e. a non-202 HTTP status code). Our retry phases are as follows:

  1. If the status update still fails after the 5th retry, the API will send an email notification to the customer.

Cancel Booking

This resource allows customers to cancel saved or booked shipment transactions (cancel by shipment Id).

End Point

POST /shipments/booking-cancel/v2/{id}

Request Information

URI Parameters:

NameDescriptionTypeAdditional Info
sourceapplication/client namestringrequired

Body Parameters: None

Response Information

A successful request to this API will cancel the booked shipment.

Sample Response Format Content-type: application/json

json
{
    "status": "SUCCESS",
    "message": "Successfully cancelled the transaction.",
    "data": null
}

Track Shipment

This resource allows customer to request the shipping status of up to 10 shipments at a time using the Shipment Tracking Number(s) as parameter.

End Point

GET /shipments/status

Request Information

URI Parameters

NameDescriptionTypeAdditional Info
tracking_numbersList of tracking numbers separated by commastringrequired

Body Parameters: None.

Response Information

Request to this API may return a list of responses for each Tracking number submitted. A status code 200 will be returned even if no record is found.

Sample Response Format Content-type: application/json

json
[
    {
        "TrackingNo": "00224668",
        "Response": "Found",
        "ResultDetails": {
            "MovementHistory": [
                {
                    "DateTime": "2021-07-12T11:06:53",
                    "Details": "Received by TEST CUSTOMER.",
                    "MovementType": "Received",
                    "Location": "---",
                    "ImageUrl": [
                        "https://canigao.s3-ap-southeast-1.amazonaws.com/images/pod/2021071211065760305063.jpeg",
                        "https://canigao.s3-ap-southeast-1.amazonaws.com/images/pod/2021071211065750930066.jpeg"
                    ],
                    "CheckinTypeId": 7,
                    "ShipmentCustomerDocumentNo": "5342"
                },
                {
                    "DateTime": "2021-07-12T11:04:40",
                    "Details": "Unloading In Consignee",
                    "MovementType": "Unloading In Consignee",
                    "Location": "---",
                    "ImageUrl": null,
                    "CheckinTypeId": 11,
                    "ShipmentCustomerDocumentNo": "5342"
                },
                {
                    "DateTime": "2021-07-12T11:04:00",
                    "Details": "Warehouse Receiving",
                    "MovementType": "Warehouse Receiving",
                    "Location": "---",
                    "ImageUrl": null,
                    "CheckinTypeId": 12,
                    "ShipmentCustomerDocumentNo": "5342"
                },
                {
                    "DateTime": "2021-07-12T11:03:12",
                    "Details": "Arrived in wareHouse",
                    "MovementType": "Arrived",
                    "Location": "---",
                    "ImageUrl": null,
                    "CheckinTypeId": 10,
                    "ShipmentCustomerDocumentNo": "423"
                },
                {
                    "DateTime": "2021-07-12T11:02:08",
                    "Details": "Picked up",
                    "MovementType": "Picked up",
                    "Location": "---",
                    "ImageUrl": null,
                    "CheckinTypeId": 15,
                    "ShipmentCustomerDocumentNo": "5342"
                },
                {
                    "DateTime": "2021-07-12T11:02:08",
                    "Details": "Picked up",
                    "MovementType": "Picked up",
                    "Location": "---",
                    "ImageUrl": null,
                    "CheckinTypeId": 15,
                    "ShipmentCustomerDocumentNo": "423"
                },
                {
                    "DateTime": "2021-07-12T10:58:14.243",
                    "Details": "Dispatched from Cainta to Mabini.",
                    "MovementType": "Out for Delivery",
                    "Location": "MANILA",
                    "ImageUrl": null,
                    "CheckinTypeId": null,
                    "ShipmentCustomerDocumentNo": null
                }
            ],
            "DocumentNo": null,
            "DocumentDate": null,
            "BookingDate": "2021-07-12T00:00:00",
            "PortOrigin": "MANILA",
            "PortDestination": "Visayas",
            "DeliveryInfo": {
                "DispatchDate": "7/12/2021",
                "DispatchTime": "10:56:18",
                "DeliveryDate": "7/12/2021",
                "DeliveryTime": "11:06:53",
                "TrackerUrl": "http://fastdemo.iot.com.ph/tms/map.php?region=luzon&plateno=ACI2549&date_from=7/12/2021&date_to=7/12/2021&time_from=10:56:18&time_to=11:06:53"
            }
        }
    }
]

Track Shipment by Customer Reference

This resource allows customer to request the shipping status of shipment transactions by customer using customer id and customer document number as parameters.

End Point

GET /shipments/status/cust-doc

Request Information

URI Parameters

NameDescriptionTypeAdditional Info
customerIdcustomer id of shipment transactionsintrequired

Body Parameters:

NameDescriptionTypeAdditional Info
DocumentNosarray of shipment customer document numbersarrayrequired

Response Information

Request to this API may return shipments per customer having shipment customer documents given in the parameters together with its status. A status code 200 will be returned even if no record is found.

Sample Response Format Content-type: application/json

json
[
    {
        "TrackingNo": "00224668",
        "Response": "Found",
        "ResultDetails": {
            "MovementHistory": [
                {
                    "DateTime": "2021-07-12T11:06:53",
                    "Details": "Received by TEST CUSTOMER.",
                    "MovementType": "Received",
                    "Location": "---",
                    "ImageUrl": [
                        "https://canigao.s3-ap-southeast-1.amazonaws.com/images/pod/2021071211065760305063.jpeg",
                        "https://canigao.s3-ap-southeast-1.amazonaws.com/images/pod/2021071211065750930066.jpeg"
                    ],
                    "CheckinTypeId": 7,
                    "ShipmentCustomerDocumentNo": "5342"
                },
                {
                    "DateTime": "2021-07-12T11:04:40",
                    "Details": "Unloading In Consignee",
                    "MovementType": "Unloading In Consignee",
                    "Location": "---",
                    "ImageUrl": null,
                    "CheckinTypeId": 11,
                    "ShipmentCustomerDocumentNo": "5342"
                },
                {
                    "DateTime": "2021-07-12T11:04:00",
                    "Details": "Warehouse Receiving",
                    "MovementType": "Warehouse Receiving",
                    "Location": "---",
                    "ImageUrl": null,
                    "CheckinTypeId": 12,
                    "ShipmentCustomerDocumentNo": "5342"
                },
                {
                    "DateTime": "2021-07-12T11:03:12",
                    "Details": "Arrived in wareHouse",
                    "MovementType": "Arrived",
                    "Location": "---",
                    "ImageUrl": null,
                    "CheckinTypeId": 10,
                    "ShipmentCustomerDocumentNo": "423"
                },
                {
                    "DateTime": "2021-07-12T11:02:08",
                    "Details": "Picked up",
                    "MovementType": "Picked up",
                    "Location": "---",
                    "ImageUrl": null,
                    "CheckinTypeId": 15,
                    "ShipmentCustomerDocumentNo": "5342"
                },
                {
                    "DateTime": "2021-07-12T11:02:08",
                    "Details": "Picked up",
                    "MovementType": "Picked up",
                    "Location": "---",
                    "ImageUrl": null,
                    "CheckinTypeId": 15,
                    "ShipmentCustomerDocumentNo": "423"
                },
                {
                    "DateTime": "2021-07-12T10:58:14.243",
                    "Details": "Dispatched from Cainta to Mabini.",
                    "MovementType": "Out for Delivery",
                    "Location": "MANILA",
                    "ImageUrl": null,
                    "CheckinTypeId": null,
                    "ShipmentCustomerDocumentNo": null
                }
            ],
            "DocumentNo": "00224668",
            "DocumentDate": null,
            "BookingDate": null,
            "CustomerDocumentNo": "423, 5342",
            "PortOrigin": "MANILA",
            "PortDestination": "Visayas",
            "DeliveryInfo": {
                "DispatchDate": "12/07/2021",
                "DispatchTime": "10:56:18",
                "DeliveryDate": "12/07/2021",
                "DeliveryTime": "11:06:53",
                "TrackerUrl": "http://fastdemo.iot.com.ph/tms/map.php?region=luzon&plateno=ACI2549&date_from=12/07/2021&date_to=12/07/2021&time_from=10:56:18&time_to=11:06:53"
            }
        }
    }
]