Content Comparison

{
    "Content-Type": "application/json"
}

{
    "email": "sandbox_dev@gmail.com",
    "password": "password"
}

Status: 200 OK!
{
    "success": true,
    "results": {
        "apiKey": "fb77c9653bf5e736d191b46bbfed7c2bd",
        "clientId": "SANDBOX_DEV",
        "sessionToken": "b45e2fb77c9653bf5e736d19e1fd18ebbffd0f6d3dd25af118e5eb38851bf4d"
    }
}

• Session token expires after 20 minutes of use.

• Session duration refreshes every login or on API (createPost, getPost, etc.) calls given that the token is still valid.

• QUOTA_EXCEEDED error message occurs when you reach a certain number of login API request per second. For bulk API calls, please use the login API once and reuse the session token. You may also retry the operation after 1-2 seconds.

Status: 401 Unauthorized
{
    "success": false,
    "results": "EMAIL_NOT_FOUND"
}

Status: 401 Unauthorized
{
    "success": false,
    "results": "INVALID_PASSWORD"
}

Status: 401 Unauthorized
{
    "success": false,
    "results": "QUOTA_EXCEEDED : Exceeded quota for verifying passwords."
}

{
	"email": "sample@email.com",
	"password": "1234456"
}

{
    "success": true,
    "results": {
        "accessTokenExpiresAt": 1650941635051,
        "refreshTokenExpiresAt": 1653532435052,
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnQiOiJTQU5EQk9YX0RFViIsImxtaUF1dGhLZXkiOiIyRjlCNTdGQTlDNzRGOEUwQ0YyM0NCMDUyQjJDNDM4RTBBRDhEOTUxREE5QzczQkM1QjZEQUYxOEZDMDNFMjVBIiwiZW1haWwiOiJjaHJpc0BkZXYuZmxlZXQucGgiLCJpYXQiOjE2NTA5NDA0MzUsImV4cCI6MTY1MDk0MTYzNX0.5ulcbOQkNP5ESFmf8xVvGhdEi_U7tPb32Uvyqpevp_I",
        "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnQiOiJTQU5EQk9YX0RFViIsImxtaUF1dGhLZXkiOiIyRjlCNTdGQTlDNzRGOEUwQ0YyM0NCMDUyQjJDNDM4RTBBRDhEOTUxREE5QzczQkM1QjZEQUYxOEZDMDNFMjVBIiwiZW1haWwiOiJjaHJpc0BkZXYuZmxlZXQucGgiLCJjbGllbnRBcGlLZXkiOiJiMmY1YzVhNi1hZGIwLTQ5MTktODZkMy1mMzIwNTdlN2RlZGMiLCJpYXQiOjE2NTA5NDA0MzUsImV4cCI6MTY1MzUzMjQzNX0.eKG-NTpoApJ314nQ2Vgj8mZF8QrwV7oUuEmZLif3JrI"
    }
} 

• To use Login API v2 on our existing endpoints (e.g. /getpost), “x-access-token" must be defined in the HEADERS instead of the "Auth-token" and value for it should be “Bearer {{accessToken}}”.

• apiKey is no longer required to be defined in the Parameters on our existing endpoints
  (e.g. /getpost) if “x-access-token" is defined in the Headers.

• For LoginV2 bulk API calls, please use the Refresh token API (/refreshToken). https://ctoglobal.atlassian.net/wiki/spaces/ITX/pages/600834269/v3#Refresh-Token-BUSINESSProvider

Status: 401 Unauthorized
{
    "success": false,
    "results": "INVALID_EMAIL"
}

Status: 401 Unauthorized
{
    "success": false,
    "results": "INVALID_PASSWORD"
}

{
    "Auth-Token": "<Auth token acquired on api LOGIN>"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
}

To use "x-access-token" for our Login V2 successfully, “auth-token” must no longer be defined in the headers.

{
    "apiKey": "<apiKey will be acquired on login API>"
}

There is no need to define the apiKey in the parameters for our LoginV2.

Status: 200 OK!
{
    "success": true,
    "results": [
        {
            "id": "SANDBOX_BUSINESS",
            "name": "Sandbox Business",
            "serviceType": "onDemand"
        },
        {
            "id": "SANDBOX_QA",
            "name": "Sandbox_QA",
            "serviceType": "scheduled"
        }
    ]
}

{
    "Auth-Token": "<Auth token acquired on api LOGIN>"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
}

To use "x-access-token" for our Login V2 successfully, “auth-token” must no longer be defined in the headers.

{
    "apiKey": "<apiKey will be acquired on login API>"
}

There is no need to define the apiKey in the parameters for our LoginV2.

Status: 200 OK!
{
    "success": true,
    "results": [
        {
            "id": "-KnmC5Y0pFYBquoDL1zo",
            "info": {
                "code": "A1",
                "name": "Area 1",
                "stores": [
                    "-LDnYzs1xbK-FeQ0VPFr"                
                ]
            }
        }
    ]
}

{
    "Auth-Token": "<Auth token acquired on api LOGIN>"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
}

To use "x-access-token" for our Login V2 successfully, “auth-token” must no longer be defined in the headers.

{
    "apiKey": "<apiKey will be acquired on login API>",
    "areaCode": "<area code acquired from getListOfAreas API>"
}

There is no need to define the apiKey in the parameters for our LoginV2.

{
    "areaCode": "<area code acquired from getListOfAreas API>"
}

https://us-central1-fleet-staging-2333a.cloudfunctions.net
/getListOfStores?apiKey=7c5dd55738b964944f9357bcc7f45ce6d857ff18&areaCode=A1

Status: 200 OK!
{
    "success": true,
    "results": [
        {
            "id": "-LDnYzs1xbK-FeQ0VPFr",
            "info": {
                "address": "7391 Building 9 Bakawan St. Corner Mayapis St., San Antonio Village, Makati, 1203 Metro Manila",
                "advanceStart": false,
                "code": "main_store",
                "default": true,
                "latitude": 14.5601823,
                "longitude": 121.00680469999998,
                "name": "Main Store",
                "province": "Metro Manila",
                "provinceKey": "MM"
            }
        }
    ],
    "total": 1
}

{
    "Auth-Token": "<Auth token acquired on api LOGIN>"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
}

To use "x-access-token" for our Login V2 successfully, “auth-token” must no longer be defined in the headers.

https://us-central1-fleet-dev-ph.cloudfunctions.net/v3/getCreatePostTemplate?apiKey=7c5dd55738b964944f9357bcc7f45ce6d857ff18&partnerId=SANDBOX_DX

status: 200 OK!
{
    "success": true,
    "result": {
        "requestBody": {
            "refNo": "",
            "pickupDetails": {
                "customerName": "",
                "contactNumber": "",
                "emailAddress": "",
                "lat": 0,
                "long": 0,
                "tags": [],
                "remarks": "",
                "barangay": "",
                "province": "",
                "postalCode": "",
                "pickupDateTime": "",
                "pickupAddress": "",
                "pickupCity": ""
            },
            "deliveryDetails": {
                "customerName": "",
                "contactNumber": "",
                "emailAddress": "",
                "lat": 0,
                "long": 0,
                "tags": [],
                "remarks": "",
                "barangay": "",
                "province": "",
                "postalCode": "",
                "deliveryDateTime": "",
                "deliveryAddress": "",
                "deliveryCity": "",
                "itemDescription": "",
                "itemPrice": 0,
                "codAmount": 0,
                "productSize": "",
                "length": 0,
                "width": 0,
                "height": 0,
                "weight": 0,
                "metaFields": {
                    "shipment": ""
                }
            }
        },
        "metaFieldSchema": {
            "shipment": {
                "required": true,
                "type": "string",
                "description": "Shipment/Parcel Size",
                "values": [
                    "big-pouch",
                    "box"
                ],
                "details": [
                    {
                        "value": "big-pouch",
                        "description": "Big Pouch (100 pesos within metro manila)"
                    },
                    {
                        "value": "box",
                        "description": "Box"
                    }
                ]
            }
        }
    }
}

• Price quotation is not available for partners with “on demand” service type.

• Inches is used as a unit of measurement for length, width and height. (Please see sample request response).

• Kg is used as a unit of measurement for weight. (Please see sample request response).

{
    "Auth-Token": "<Auth token acquired on api LOGIN>",
    "Content-Type": "application/json"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
}

To use "x-access-token" for our Login V2 successfully, “auth-token” must no longer be defined in the headers.

{
    "apiKey": "<apiKey will be acquired on login API>",
    "partnerId": "<provider’s id, can be acquired on getPartners API >"
}

There is no need to define the apiKey in the parameters for our LoginV2.

{
	"pickup": {
		"province": "metro manila",
		"city": "pasig city",
		"barangay": "pinagbuhatan"
	},
	"delivery": {
		"province": "rizal",
		"city": "cainta",
		"barangay": "san andres"
	}
}

Status: 200 OK!
{
    "success": true,
    "result": {
        "destinations": [
            "REGION 4-A"
            "NCR"
        ],
        "estimatedPickupDays": 3,
        "estimatedDeliveryDays": 6,
        "products": [
            {
                "size": "L",
                "price": 165,
                "description": "12 x 18 x 2",
                "name": "Large Pouch",
                "length": 12,
                "width": 18,
                "height": 2,
                "weight": 3
            },
            {
                "size": "XL",
                "price": 310,
                "description": "18 x 12 x 9",
                "name": "Box",
                "length": 18,
                "width": 12,
                "height": 9,
                "weight": 6
            }
        ]
    }
}

Status: 400 Bad Request
{
    "success": false,
    "result": "Pickup/delivery location is not serviceable by the selected provider."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Missing partnerId. Please check your dashboard documentation."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid partner id. Either it's not existing or you don't have rights to post to the partner."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Price quotation is not yet available for on demand providers."
}

{
    "Auth-Token": "<Auth token acquired on api LOGIN>",
    "Content-Type": "application/json"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
    "Content-Type": "application/json"
}

To use "x-access-token" for our Login V2 successfully, “Auth-Token” must no longer be defined in the headers.

{
    "apiKey": "<REQUIRED, apiKey will be acquired on login API>",
    "partnerId": "<REQUIRED, preferred partner/provider, can be acquired on getPartners API>"
}

There is no need to define the apiKey in the parameters for our LoginV2.

• To view the Deliveries PH address library, kindly refer to this pages:

  • DPH Standard Address format

  • DPH PSGC Address format

• Lat/long fields is required for on demand providers.

• Barangay field is not required but will affect the accuracy of identifying if the pickup/delivery location is serviceable by the provider or not.

• Availability of product sizes varies to each providers and pickup/delivery location.

• To be able to get the available sizes and price of a provider, see /getQuotation API.

• productSize field is currently not available for on demand providers. Leave an empty string instead.

{
    "refNo": "order-001",
    "businessStoreID": "",
    "isPSGC": false,
    "isAutoReattempt": false,
    "pickupDetails": {
        "senderName": "Christian Pick up",
        "contactNumber": "09123456789",
        "emailAddress": "a@gmail.com",
        "pickupDateTime": "2020-09-29T21:05",
        "pickupAddress": "536 Calbayog St. Highway Hills Mandaluyong City",
        "pickupCity": "Mandaluyong City",
        "province": "Metro Manila",
        "barangay": "Highway Hills",
        "postalCode": "1556",
        "lat": 14.5776292,
        "long": 121.0463673,
        "tags": [],
        "remarks": "my remarks"
    },
    "deliveryDetails": {
        "recipientName": "Christian Delivery",
        "contactNumber": "09123456789",
        "emailAddress": "a@email.com",
        "deliveryDateTime": "2020-09-29T22:06",
        "deliveryAddress": "Vermont Royale, Antipolo",
        "deliveryCity": "Antipolo",
        "province": "Rizal",
        "barangay": "San Roque",
        "postalCode": "1870",
        "declaredValue": 200,
        "productSize": "L",
        "vehicleType": "MOTORCYCLE",
        "width": 0, 
        "height": 0,
        "length": 10,
        "weight": 0,
        "codAmount": 250,
        "lat": 14.5776292,
        "long": 121.0463673,
        "tags": [],
        "itemDescription": "Brand New Phone X",
        "remarks": "Please handle with care. Ask the guards for direction.",
        "metaFields": {},
         "quantity": 50,
        "items": [{
            "name": "Sample item 1",
            "quantity": 10,
            "unitPrice":20.00,
            "declaredValue":5,
            "dimensions":{
               "length":2.55,
               "width":1.56,
               "height":1.28,
               "breadth":5.29,
               "depth":2.41,
               "weight":1.51
            }
            },
            {
            "name": "Sample item 2",
            "quantity": 15,
            "unitPrice":140.34,
            "declaredValue":500.55,
            "dimensions":{
               "length":2.55,
               "width":1.56,
               "height":1.28,
               "breadth":5.29,
               "depth":2.41,
               "weight":1.51
            }
            },
            {
            "name": "Sample item 3",
            "quantity": 100,
            "unitPrice":120.23,
            "declaredValue":500.55,
            "dimensions":{
               "length":2.55,
               "width":1.56,
               "height":1.28,
               "breadth":5.29,
               "depth":2.41,
               "weight":1.51
            }     
        } 
        ]
    }
}

Status: 200 OK!
{
    "success": true,
    "message": "Job posted on marketplace",
    "result": {
        "postId": "3nHfPLXUGWYhlQ5TcNva",
        "customerName": "Christian Pick up",
        "contactNumber": "09123456789",
        "emailAddress": "a@gmail.com",
        "completionDateTime": 1601384700000,
        "pickupAddress": "536 Calbayog St. Highway Hills Mandaluyong City",
        "pickupCity": "Mandaluyong City",
        "province": "Metro Manila",
        "barangay": "Highway Hills",
        "postalCode": "1556",
        "lat": 14.5776292,
        "long": 121.0463673,
        "tags": [
            "-LI4Qgef9HIHhb2AzGzW",
            "-LK5fMS1u-Qsv-G1tc9l"
        ],
        "metaTags": "{\"-LI4Qgef9HIHhb2AzGzW\":{\"colorIndex\":1,\"label\":\"API\"},\"-LK5fMS1u-Qsv-G1tc9l\":{\"colorIndex\":4,\"label\":\"Pick-up\"}}",
        "storeName": "",
        "details": "",
        "remarks": "my remarks",
        "transactions": [],
        "attempts": {},
        "approximateShippingFee": 115,
        "billableShippingFee": 0,
        "actualShippingFee": 0,
        "finalShippingFee": 0,
        "metaState": "",
        "lastUpdateRemarks": "",
        "businessId": "DRINKKA",
        "businessName": "Drinkka_DEMO",
        "businessStoreId": null,
        "storeId": null,
        "courierName": "Sandbox_DX",
        "createdAt": 1601372523479,
        "partnerId": "SANDBOX_DX",
        "refNo": "order-001",
        "status": "ASSIGNED",
        "meta": "{\"customerName\":\"Christian Delivery\",\"contactNumber\":\"09123456789\",\"emailAddress\":\"a@email.com\",\"completionDateTime\":1601388360000,\"deliveryAddress\":\"Vermont Royale, Antipolo\",\"deliveryCity\":\"Antipolo\",\"province\":\"Rizal\",\"barangay\":\"San Roque\",\"postalCode\":\"1870\",\"itemPrice\":200,\"dimension\":{\"length\":10,\"width\":0,\"height\":0},\"codAmount\":250,\"lat\":14.5776292,\"long\":121.0463673,\"tags\":[\"-LI4Qgef9HIHhb2AzGzW\",\"-LK5fK2Pq--uEhN4T9UG\"],\"metaTags\":\"{\\\"-LI4Qgef9HIHhb2AzGzW\\\":{\\\"colorIndex\\\":1,\\\"label\\\":\\\"API\\\"},\\\"-LK5fK2Pq--uEhN4T9UG\\\":{\\\"colorIndex\\\":3,\\\"label\\\":\\\"Delivery\\\"}}\",\"details\":\"Brand New Phone X\",\"remarks\":\"Please handle with care. Ask the guards for direction.\",\"trackingNumber\":\"\",\"trackingUrl\":\"\",\"weight\":0}",
        "metaFields": {},
        "items": [
            {
                "name": "Sample item 1",
                "quantity": 10,
                "unitPrice": 20,
                "declaredValue": 5,
                "dimensions": {
                    "length": 2.55,
                    "width": 1.56,
                    "height": 1.28,
                    "breadth": 5.29,
                    "depth": 2.41,
                    "weight": 1.51
                }
            },
            {
                "name": "Sample item 2",
                "quantity": 15,
                "unitPrice": 140.34,
                "declaredValue": 500.55,
                "dimensions": {
                    "length": 2.55,
                    "width": 1.56,
                    "height": 1.28,
                    "breadth": 5.29,
                    "depth": 2.41,
                    "weight": 1.51
                }
            },
            {
                "name": "Sample item 3",
                "quantity": 100,
                "unitPrice": 120.23,
                "declaredValue": 500.55,
                "dimensions": {
                    "length": 2.55,
                    "width": 1.56,
                    "height": 1.28,
                    "breadth": 5.29,
                    "depth": 2.41,
                    "weight": 1.51
                }
            }
        ]
    }
}

{
    "refNo": "order-001",
    "businessStoreID": "",
    "isPSGC": true,
    "isAutoReattempt": false,
    "pickupDetails": {
        "senderName": "Christian Pick up",
        "contactNumber": "09123456789",
        "emailAddress": "a@gmail.com",
        "pickupDateTime": "2020-09-29T21:05",
        "pickupAddress": "536 Calbayog St. Highway Hills Mandaluyong City",
        "pickupCity": "Mandaluyong City",
        "province": "Metro Manila",
        "barangay": "Highway Hills",
        "postalCode": "1556",
        "lat": 14.5776292,
        "long": 121.0463673,
        "tags": [],
        "remarks": "my remarks"
    },
    "deliveryDetails": {
        "recipientName": "Christian Delivery",
        "contactNumber": "09123456789",
        "emailAddress": "a@email.com",
        "deliveryDateTime": "2020-09-29T22:06",
        "deliveryAddress": "Vermont Royale, Antipolo",
        "deliveryCity": "Antipolo",
        "province": "Rizal",
        "barangay": "San Roque",
        "postalCode": "1870",
        "declaredValue": 200,
        "productSize": "L",
        "width": 0, 
        "height": 0,
        "length": 10,
        "weight": 0,
        "codAmount": 250,
        "lat": 14.5776292,
        "long": 121.0463673,
        "tags": [],
        "itemDescription": "Brand New Phone X",
        "remarks": "Please handle with care. Ask the guards for direction.",
        "metaFields": {},
        "items": [{
            "name": "Sample item 1",
            "quantity": 10,
            "unitPrice":20.00,
            "declaredValue":5,
            "dimensions":{
               "length":2.55,
               "width":1.56,
               "height":1.28,
               "breadth":5.29,
               "depth":2.41,
               "weight":1.51
            }
            },
            {
            "name": "Sample item 2",
            "quantity": 15,
            "unitPrice":140.34,
            "declaredValue":500.55,
            "dimensions":{
               "length":2.55,
               "width":1.56,
               "height":1.28,
               "breadth":5.29,
               "depth":2.41,
               "weight":1.51
            }
            },
            {
            "name": "Sample item 3",
            "quantity": 100,
            "unitPrice":120.23,
            "declaredValue":500.55,
            "dimensions":{
               "length":2.55,
               "width":1.56,
               "height":1.28,
               "breadth":5.29,
               "depth":2.41,
               "weight":1.51
            }     
        } 
        ]
    }
}

Status: 200 OK!
{
    "success": true,
    "message": "Job posted on marketplace",
    "result": {
        "postId": "3nHfPLXUGWYhlQ5TcNva",
        "customerName": "Christian Pick up",
        "contactNumber": "09123456789",
        "emailAddress": "a@gmail.com",
        "completionDateTime": 1601384700000,
        "pickupAddress": "536 Calbayog St. Highway Hills Mandaluyong City",
        "pickupCity": "CITY OF MANDALUYONG",
        "province": "SECOND DISTRICT",
        "barangay": "HIGHWAY HILLS",
        "postalCode": "1556",
        "lat": 14.5776292,
        "long": 121.0463673,
        "tags": [
            "-LI4Qgef9HIHhb2AzGzW",
            "-LK5fMS1u-Qsv-G1tc9l"
        ],
        "metaTags": "{\"-LI4Qgef9HIHhb2AzGzW\":{\"colorIndex\":1,\"label\":\"API\"},\"-LK5fMS1u-Qsv-G1tc9l\":{\"colorIndex\":4,\"label\":\"Pick-up\"}}",
        "storeName": "",
        "details": "",
        "remarks": "my remarks",
        "transactions": [],
        "attempts": {},
        "approximateShippingFee": 115,
        "billableShippingFee": 0,
        "actualShippingFee": 0,
        "finalShippingFee": 0,
        "metaState": "",
        "lastUpdateRemarks": "",
        "businessId": "DRINKKA",
        "businessName": "Drinkka_DEMO",
        "businessStoreId": null,
        "storeId": null,
        "courierName": "Sandbox_DX",
        "createdAt": 1601372523479,
        "partnerId": "SANDBOX_DX",
        "refNo": "order-001",
        "status": "ASSIGNED",
        "meta": "{\"customerName\":\"Christian Delivery\",\"contactNumber\":\"09123456789\",\"emailAddress\":\"a@email.com\",\"completionDateTime\":1601388360000,\"deliveryAddress\":\"Vermont Royale, Antipolo\",\"deliveryCity\":\"CITY OF ANTIPOLO\",\"province\":\"RIZAL\",\"barangay\":\"SAN ROQUE\",\"postalCode\":\"1870\",\"itemPrice\":200,\"dimension\":{\"length\":10,\"width\":0,\"height\":0},\"codAmount\":250,\"lat\":14.5776292,\"long\":121.0463673,\"tags\":[\"-LI4Qgef9HIHhb2AzGzW\",\"-LK5fK2Pq--uEhN4T9UG\"],\"metaTags\":\"{\\\"-LI4Qgef9HIHhb2AzGzW\\\":{\\\"colorIndex\\\":1,\\\"label\\\":\\\"API\\\"},\\\"-LK5fK2Pq--uEhN4T9UG\\\":{\\\"colorIndex\\\":3,\\\"label\\\":\\\"Delivery\\\"}}\",\"details\":\"Brand New Phone X\",\"remarks\":\"Please handle with care. Ask the guards for direction.\",\"trackingNumber\":\"\",\"trackingUrl\":\"\",\"weight\":0}",
        "metaFields": {},
        "items": [
            {
                "name": "Sample item 1",
                "quantity": 10,
                "unitPrice": 20,
                "declaredValue": 5,
                "dimensions": {
                    "length": 2.55,
                    "width": 1.56,
                    "height": 1.28,
                    "breadth": 5.29,
                    "depth": 2.41,
                    "weight": 1.51
                }
            },
            {
                "name": "Sample item 2",
                "quantity": 15,
                "unitPrice": 140.34,
                "declaredValue": 500.55,
                "dimensions": {
                    "length": 2.55,
                    "width": 1.56,
                    "height": 1.28,
                    "breadth": 5.29,
                    "depth": 2.41,
                    "weight": 1.51
                }
            },
            {
                "name": "Sample item 3",
                "quantity": 100,
                "unitPrice": 120.23,
                "declaredValue": 500.55,
                "dimensions": {
                    "length": 2.55,
                    "width": 1.56,
                    "height": 1.28,
                    "breadth": 5.29,
                    "depth": 2.41,
                    "weight": 1.51
                }
            }
        ]
    }
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid Request Parameter. Check your dashboard documentation",
    "result": {
        "pickupDetails": {
            "customerName": "Required field.",
            "contactNumber": "Required field.",
            "province": "Required field.",
            "pickupDateTime": "Invalid data type. Must be in string",
            "pickupAddress": "Required field.",
            "pickupCity": "Required field."
        },
        "deliveryDetails": {
            "customerName": "Required field.",
            "contactNumber": "Required field.",
            "province": "Required field.",
            "deliveryDateTime": "Invalid data type. Must be in string",
            "deliveryAddress": "Required field.",
            "deliveryCity": "Required field.",
            "itemDescription": "Invalid data type. Must be in string",
            "productSize": "Invalid data type. Must be in string",
            "width": "Invalid data type. Must be in number",
            "height": "Invalid data type. Must be in number",
            "length": "Invalid data type. Must be in number",
            "weight": "Invalid data type. Must be in number",
            "metaFields": {
                "shipment": "Required field."
            }
        }
    }
}
Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid Request Parameter. Check your dashboard documentation",
    "result": {
        "pickupDetails": {
            "customerName": "Maximum length exceeded.",
            "contactNumber": "Invalid format.",
            "emailAddress": "Maximum length exceeded.",
            "remarks": "Maximum length exceeded.",
            "barangay": "Maximum length exceeded.",
            "province": "Maximum length exceeded.",
            "postalCode": "Maximum length exceeded.",
            "pickupAddress": "Maximum length exceeded.",
            "pickupCity": "Maximum length exceeded."
        },
        "deliveryDetails": {
            "customerName": "Maximum length exceeded.",
            "contactNumber": "Invalid format.",
            "emailAddress": "Maximum length exceeded.",
            "remarks": "Maximum length exceeded.",
            "barangay": "Maximum length exceeded.",
            "province": "Maximum length exceeded.",
            "postalCode": "Maximum length exceeded.",
            "deliveryAddress": "Maximum length exceeded.",
            "deliveryCity": "Maximum length exceeded.",
            "itemDescription": "Maximum length exceeded."
        }
    }
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Missing partnerId. Please check your dashboard documentation."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid partner id. Either it's not existing or you don't have rights to post to the partner."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid store ID. Check your storeId. Remove storeId to use default store."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Pickup/delivery date and time must be greater than the current time."
}
Status: 400 Bad Request
{
    "success": false,
    "message": "Delivery date and time must be greater than the pickup time."
}

{
    "success": false,
    "message": "Pickup/delivery latitude and longitude is required for on demand providers."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid pickup location."
}
Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid delivery location."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Pickup location is not serviceable by the provider."
}
Status: 400 Bad Request
{
    "success": false,
    "message": "Delivery location is not serviceable by the provider."
}
Status: 400 Bad Request
{
    "success": false,
    "message": "Pickup and delivery location is not serviceable by the provider."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid pickup location."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid delivery location."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Product size not available for the designated service area."
}

Status: 400 Bad Request
{
    "success": false,
    "message": "No auto re-attempt settings configured in your Deliveries PH Web account."
}

{
    "Auth-Token": "<Auth token acquired on api LOGIN>",
    "Content-Type": "application/json"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
    "Content-Type": "application/json"
}

To use "x-access-token" for our Login V2 successfully, “Auth-Token” must no longer be defined in the headers.

{
    "apiKey": "<apiKey will be acquired on login API>"
}

There is no need to define the apiKey in the parameters for our LoginV2.

{
      "postId": "uuNzkYoOy1VI373BoKY9",
      "status": "START_DELIVERY",
      "remarks": "Rider is on his way",
      "timeStamp": 1575890011178,
      "metaState": ""
}

Status: 200 OK!
{
    "success": true,
    "message": "Post successfully updated."
}

{
    "Auth-Token": "<Auth token acquired on api LOGIN>",
    "Content-Type": "application/json"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
    "Content-Type": "application/json"
}

To use "x-access-token" for our Login V2 successfully, “Auth-Token” must no longer be defined in the headers.

{
    "apiKey": "fb77c9653bf5e736d191b46bbfed7c2bd",
	"postId": "uuNzkYoOy1VI373BoKY9",
	"partnerId": "SANDBOX_DX",
	"isPSGC": false
}

Status: 200 OK!
{
    "success": true,
    "result": [
		{
            "postId": "uuNzkYoOy1VI373BoKY9",
            "customerName": "Christian Pick up",
            "contactNumber": "09123456789",
            "emailAddress": "a@gmail.com",
            "completionDateTime": 1583836200000,
            "pickupAddress": "Sitio barrio, Angeles Pampanga Philippines",
            "pickupCity": "Mandaluyong City",
            "province": "Metro Manila",
            "lat": 14.5776292,
            "long": 121.0463673,
            "tags": [
                "-LI4Qgef9HIHhb2AzGzW",
                "-LK5fMS1u-Qsv-G1tc9l"
            ],
            "metaTags": "{\"-LI4Qgef9HIHhb2AzGzW\":{\"colorIndex\":1,\"label\":\"API\"},\"-LK5fMS1u-Qsv-G1tc9l\":{\"colorIndex\":4,\"label\":\"Pick-up\"}}",
            "storeName": "",
            "remarks": "my remarks",
            "businessId": "SANDBOX_DEV",
            "businessName": "Sandbox_Dev",
            "businessStoreId": null,
            "storeId": null,
            "courierName": "Sandbox_DX",
            "createdAt": 1583381948826,
            "partnerId": "SANDBOX_DX",
            "refNo": "order-001",
            "status": "STARTED",
            "isAutoReattempt": true,
            "subStatus": "DONE_PICKUP",
            "meta": "{\"customerName\":\"Christian Delivery\",\"contactNumber\":\"09123456789\",\"emailAddress\":\"a@gmail.com\",\"completionDateTime\":1583928900000,\"deliveryAddress\":\"Vermont Royale, Antipolo\",\"deliveryCity\":\"Antipolo\",\"province\":\"Rizal\",\"itemPrice\":200,\"dimension\":\"fff\",\"actualShippingCost\":50,\"codAmount\":250,\"lat\":14.5776292,\"long\":121.0463673,\"tags\":[\"-LI4Qgef9HIHhb2AzGzW\",\"-LK5fK2Pq--uEhN4T9UG\"],\"details\":\"my details\",\"remarks\":\"my remarks\",\"metaTags\":\"{\\\"-LI4Qgef9HIHhb2AzGzW\\\":{\\\"colorIndex\\\":1,\\\"label\\\":\\\"API\\\"},\\\"-LK5fK2Pq--uEhN4T9UG\\\":{\\\"colorIndex\\\":3,\\\"label\\\":\\\"Delivery\\\"}}\"}",
            "metaFields": {},
            "items": [
                {
                    "name": "Sample item1",
                    "quantity": 10,
                    "unitPrice": 20,
                    "declaredValue": 5,
                    "dimensions": {
                        "length": 2.55,
                        "width": 1.56,
                        "height": 1.28,
                        "breadth": 5.29,
                        "depth": 2.41,
                        "weight": 1.51
                    }
                },
                {
                    "name": "Sample item2",
                    "quantity": 15,
                    "unitPrice": 140.34,
                    "declaredValue": 500.55,
                    "dimensions": {
                        "length": 2.55,
                        "width": 1.56,
                        "height": 1.28,
                        "breadth": 5.29,
                        "depth": 2.41,
                        "weight": 1.51
                    }
                },
                {
                    "name": "Sample item3",
                    "quantity": 100,
                    "unitPrice": 120.23,
                    "declaredValue": 500.55,
                    "dimensions": {
                        "length": 2.55,
                        "width": 1.56,
                        "height": 1.28,
                        "breadth": 5.29,
                        "depth": 2.41,
                        "weight": 1.51
                    }
                }
            ]
        }
	]
}

{
    "apiKey": "fb77c9653bf5e736d191b46bbfed7c2bd",
	"postId": "uuNzkYoOy1VI373BoKY9",
	"partnerId": "SANDBOX_DX"
	"isPSGC": true
}

Status: 200 OK!
{
    "success": true,
    "result": [
		{
            "postId": "uuNzkYoOy1VI373BoKY9",
            "customerName": "Christian Pick up",
            "contactNumber": "09123456789",
            "emailAddress": "a@gmail.com",
            "completionDateTime": 1583836200000,
            "pickupAddress": "Sitio barrio, Angeles Pampanga Philippines",
            "pickupCity": "CITY OF MANDALUYONG",
            "province": "SECOND DISTRICT",
            "lat": 14.5776292,
            "long": 121.0463673,
            "tags": [
                "-LI4Qgef9HIHhb2AzGzW",
                "-LK5fMS1u-Qsv-G1tc9l"
            ],
            "metaTags": "{\"-LI4Qgef9HIHhb2AzGzW\":{\"colorIndex\":1,\"label\":\"API\"},\"-LK5fMS1u-Qsv-G1tc9l\":{\"colorIndex\":4,\"label\":\"Pick-up\"}}",
            "storeName": "",
            "remarks": "my remarks",
            "businessId": "SANDBOX_DEV",
            "businessName": "Sandbox_Dev",
            "businessStoreId": null,
            "storeId": null,
            "courierName": "Sandbox_DX",
            "createdAt": 1583381948826,
            "partnerId": "SANDBOX_DX",
            "refNo": "order-001",
            "status": "ACCEPTED",
            "isAutoReattempt": true,
            "subStatus":,
            "meta": "{\"customerName\":\"Christian Delivery\",\"contactNumber\":\"09123456789\",\"emailAddress\":\"a@gmail.com\",\"completionDateTime\":1583928900000,\"deliveryAddress\":\"Vermont Royale, Antipolo\",\"deliveryCity\":\"CITY OF ANTIPOLO\",\"province\":\"RIZAL\",\"itemPrice\":200,\"dimension\":\"fff\",\"actualShippingCost\":50,\"codAmount\":250,\"lat\":14.5776292,\"long\":121.0463673,\"tags\":[\"-LI4Qgef9HIHhb2AzGzW\",\"-LK5fK2Pq--uEhN4T9UG\"],\"details\":\"my details\",\"remarks\":\"my remarks\",\"metaTags\":\"{\\\"-LI4Qgef9HIHhb2AzGzW\\\":{\\\"colorIndex\\\":1,\\\"label\\\":\\\"API\\\"},\\\"-LK5fK2Pq--uEhN4T9UG\\\":{\\\"colorIndex\\\":3,\\\"label\\\":\\\"Delivery\\\"}}\"}",
            "metaFields": {}
        },
	]
}

{
    "Auth-Token": "<Auth token acquired on api LOGIN>",
    "Content-Type": "application/json"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
    "Content-Type": "application/json"
}

To use "x-access-token" for our Login V2 successfully, “Auth-Token” must no longer be defined in the headers.

{
    "apiKey": "<apiKey will be acquired on login API>"
}

There is no need to define the apiKey in the parameters for our LoginV2.

• List of fees must contain at least one value with fee type of shipping or return.

• Type of fee must be unique to other fees within the list.

{
    "postId": "Wq9FPWxCYVxNgrPrn08D",
    "remarks": "Shipping fee from upon booking.",
    "fees": [
        {
            "value": 100,
            "type": "shipping"
        },
        {
            "value": 20,
            "type": "insurance"
        }
    ]
}

status: 200 OK!
{
    "success": true,
    "result": "Post successfully updated."
}

{
    "Auth-Token": "<Auth token acquired on api LOGIN>",
    "Content-Type": "application/json"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
    "Content-Type": "application/json"
}

To use "x-access-token" for our Login V2 successfully, “Auth-Token” must no longer be defined in the headers.

{
    "apiKey": "<apiKey will be acquired on login API>"
}

There is no need to define the apiKey in the parameters for our LoginV2.

• Fields under pickup/delivery requires at least one field to update.

• You may update the tracking of both or pickup/delivery only.

• Undefined tracking number/url fields will not be updated.

{
    "postId": "uuNzkYoOy1VI373BoKY9",
    "pickup": {
        "trackingNumber": "ORDER-001-PIC-ASV",
        "trackingUrl": "https://trackmyorder.com/track?id=ORDER-001-PIC-ASV"
    },
    "delivery": {
        "trackingNumber": "ORDER-001-DEL-ASV",
        "trackingUrl": "https://trackmyorder.com/track?id=ORDER-001-DEL-ASV"
    }
}

Status: 200 OK!
{
    "success": true,
    "message": "Post successfully updated."
}

• Get Available Partners is not yet available for partners with “on demand” service type.

• Inches is used as a unit of measurement for length, width and height. (Please see sample request response).

• Kg is used as a unit of measurement for weight. (Please see sample request response).

{
    "Auth-Token": "<Auth token acquired on api LOGIN>",
    "Content-Type": "application/json"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
    "Content-Type": "application/json"
}

To use "x-access-token" for our Login V2 successfully, “Auth-Token” must no longer be defined in the headers.

{
    "apiKey": "<apiKey will be acquired on login API>",
}

There is no need to define the apiKey in the parameters for our LoginV2.

{
   "serviceType": "Scheduled",
   "pickup": {
      "province": "metro manila",
      "city": "quezon city",
      "barangay": "Katipunan"
   },
   "delivery": {
      "province": "rizal",
      "city": "antipolo city",
      "barangay": "san juan"
   },
   "dimensions": {
      "length": 100,
      "width": 18,
      "height": 6
   },
   "weight": 5
}

Status: 200 OK!
{
  "success": true,
  "result": [
    {
      "id": "SANDBOX_DX",
      "serviceType": "scheduled",
      "serviceableAreas": [
        {
          "pickup": {
            "province": "METRO MANILA",
            "city": "QUEZON CITY",
            "barangay": "KATIPUNAN"
          }
        },
        {
          "delivery": {
            "province": "RIZAL",
            "city": "ANTIPOLO CITY",
            "barangay": "SAN JUAN"
          }
        }
      ],
      "estimatedDeliveryDays": 5,
      "destinations": [
        "NCR",
        "REGION 4-A"
      ],
      "products": [
        {
          "size": "L",
          "price": 200,
          "weight": 20
        }
      ]
    },
    {
      "id": "SANDBOX_PROVIDER",
      "serviceType": "scheduled",
      "serviceableAreas": [
        {
          "pickup": {
            "province": "METRO MANILA",
            "city": "QUEZON CITY",
            "barangay": "KATIPUNAN"
          }
        },
        {
          "delivery": {
            "province": "RIZAL",
            "city": "ANTIPOLO CITY",
            "barangay": "SAN JUAN"
          }
        }
      ],
      "estimatedDeliveryDays": 9,
      "destinations": [
        "REGION 4-A",
        "NCR"
      ],
      "products": [
        {
          "size": "XL",
          "price": 300,
          "weight": 6
        }
      ]
    }
  ]
}

Status: 200 OK!
{
  "success": true,
  "result": []
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid delivery location"
}

Status: 400 Bad Request
{
    "success": false,
    "message": "Invalid pickup location"
}

Status: 400 Bad Request
{
    "success": false,
    "message": ""The Service Type: On Demand is currently NOT available for this endpoint.
}

{
    "Auth-Token": "<Auth token acquired on api LOGIN>",
    "Content-Type": "application/json"
}

As an alternative, “x-access-token” for our login v2 can be used instead of using the “auth-token” for our login v1. Value for it will be “Bearer {{accessToken}}“. See below:

{
    "x-access-token": "Bearer <Access token acquired on api LOGIN V2>"
    "Content-Type": "application/json"
}

To use "x-access-token" for our Login V2 successfully, “Auth-Token” must no longer be defined in the headers.

{
    "apiKey": "<apiKey will be acquired on login API>"
}

There is no need to define the apiKey in the parameters for our LoginV2.

{
    "couriers": ["grab", "lalamove"],
    "pickup_province": "Metro Manila",
    "data": {
        "localeKey": "en_PH",
        "pickup": {
            "name": "Mariel Quibal",
            "phone": "09561441650",
            "address": "San agustine ave blk 2 lot 41 Asilo Ville Pinagbuhatan Pasig City Metro Manila",
            "lat": 14.559774,
            "long": 121.086519
        },
        "delivery": {
            "name": "Mara Quibal",
            "phone": "09561441650",
            "address": "Unit 802, EcoTower, 32nd Street corner 9th Avenue, BGC, Taguig, 1634 Metro Manila",
            "lat": 14.5528425,
            "long": 121.0518742
        },
        "remarks": "sample remarks",
        "scheduleAt": 1613566801000,
        "vehicleType": "MOTORCYCLE",
        "dimensions": {
            "height": 5,    
            "width": 5,
            "depth": 5,
            "weight": 5
        }
    }
}

{
    "success": true,
    "result": [
        {
            "courier": "GRAB",
            "error": "Bad Input"
        },
        {
            "courier": "LALAMOVE",
            "rate": 113,
            "vehicleType": "MOTORCYCLE"
        }
    ]
}

{
    "refreshToken": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnQiOiJTQU5EQk9YX0RFViIsImxtaUF1dGhLZXkiOiIyRjlCNTdGQTlDNzRGOEUwQ0YyM0NCMDUyQjJDNDM4RTBBRDhEOTUxREE5QzczQkM1QjZEQUYxOEZDMDNFMjVBIiwiZW1haWwiOiJjaHJpc0BkZXYuZmxlZXQucGgiLCJjbGllbnRBcGlLZXkiOiJiMmY1YzVhNi1hZGIwLTQ5MTktODZkMy1mMzIwNTdlN2RlZGMiLCJpYXQiOjE2NTA5NDA0MzUsImV4cCI6MTY1MzUzMjQzNX0.eKG-NTpoApJ314nQ2Vgj8mZF8QrwV7oUuEmZLif3JrI"
}

{
    "success": true,
    "results": {
        "accessTokenExpiresAt": 1650957491706,
        "refreshTokenExpiresAt": 1653548291707,
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnQiOiJTQU5EQk9YX0RFViIsImxtaUF1dGhLZXkiOiIyRjlCNTdGQTlDNzRGOEUwQ0YyM0NCMDUyQjJDNDM4RTBBRDhEOTUxREE5QzczQkM1QjZEQUYxOEZDMDNFMjVBIiwiZW1haWwiOiJjaHJpc0BkZXYuZmxlZXQucGgiLCJpYXQiOjE2NTA5NTYyOTEsImV4cCI6MTY1MDk1NzQ5MX0.ZVnswQ18zZB81qUagssdwGjiedhHwanwpaJjUlKnQmg",
        "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnQiOiJTQU5EQk9YX0RFViIsImxtaUF1dGhLZXkiOiIyRjlCNTdGQTlDNzRGOEUwQ0YyM0NCMDUyQjJDNDM4RTBBRDhEOTUxREE5QzczQkM1QjZEQUYxOEZDMDNFMjVBIiwiZW1haWwiOiJjaHJpc0BkZXYuZmxlZXQucGgiLCJjbGllbnRBcGlLZXkiOiJmZThkN2Y3Ni0xNzA0LTQ5YjQtYTUwZi1hZDRjZTI5MmY1OWEiLCJpYXQiOjE2NTA5NTYyOTEsImV4cCI6MTY1MzU0ODI5MX0.oxifGyrkJw3sk5ftukPLO_IzH2A0ttGEU1FbRVjax7o"
    }
}

Status: 401 Unauthorized
{
    "success": false,
    "results": "Invalid Refresh Token or Refresh token expired."
}

Status: 401 Unauthorized
{
    "success": false,
    "results": "Missing Refresh Token."
}

Content-Type: application/json
auth-token": "<Auth token acquired on api LOGIN>"

{
    "apiKey": "<apiKey will be acquired on login API>"
}

{
    "trackingNumber": "720664",
    "postId": "ubyhvwENm8VRbsMPDGFg",
    "courierId": "SANDBOX_QA"
}

Status: 200 OK!
{
    "message": "Success",
}