Content Comparison

Request Headers

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

URL Query parameters

Code Block
language json
{ "apiKey": "<apiKey will be acquired on login API>" }

Request Body Fields

Field	Data Type	Required	Description
postId	string	yes	id ID of post to update.
status	string	yes	status to update
remarks	string	no	update remarks from provider
timeStamp	number	no	timestamp in millisecond. Leave 0, null or empty string to use current time.
metaState	string	no	custom status/state from provider

Sample Request Body

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

---

Sample Response

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

 

Status Updates:

Request Headers

Code Block
language json
{ "Auth-Token": "<Auth token acquired on api LOGIN>" }

URL Parameters (Query Parameters)

Parameter	Required	Description
apiKey	yes	api API key from login Login API
postId	no	filter by post id, leave empty or remove postId parameter to query all
partnerId	no	filter by partner id, leave empty or remove partnerId parameter to query all
type	no	Post type , one which can be either of the following: post or opportunity Defaults to opportunity if empty or undefined.
status	no	filter by status. set to “DONE“ DONE to get delivered posts.

Sample URL Parameters

Code Block
language json
{ "apiKey": "fb77c9653bf5e736d191b46bbfed7c2bd", "postId": "uuNzkYoOy1VI373BoKY9", "partnerId": "SANDBOX_DX" }

---

Sample Response:

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": "ASSIGNED",
            "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": {}
        },
	]
}

Request Headers

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

Query parameters (URL)

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

Request Body Fields

Field	Data Type	Required	Description
postId	string	yes	id of post to update.
trackingNumber	string	no	tracking number
trackingUrl	string	no	tracking URL

Info
Fields under metaFields requires at least one field to update. Undefined meta fields will not be updated.

Sample Request Body

Code Block
language json
{ "postId": "uuNzkYoOy1VI373BoKY9", "metaFields": { "trackingNumber": "ORDER-001-AKS-ASV", "trackingUrl": "https://trackmyorder.com/track?id=ORDER-001-AKS-ASV" } }

---

Sample Response

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

Request Headers

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

Query parameters (URL):

Code Block
language jsjson
{ "apiKey": "<apiKey will be acquired on login API>", "partnerId": "<provider's id, can be acquired on getPartners API>" }

Info
Note: Empty partnerId url params will fetch all of your partners' metafields.

---

Sample Response with valid partnerId:

Status: 200 OK!
{
    "success": true,
    "result": {
        "goods": {
            "active": true
        }
    }
}

Sample Response for empty partnerId

Code Block
language json
Status: 200 OK! { "success": true, "result": { "SANDBOX_BA": { "goods": { "active": true } }, "SANDBOX_PROVIDER": {}, "SANDBOX_QA": { "cod": { "required": true, "active": true, "key": "cod", "fieldType": "string", "placeholder": "COD" }, "name": { "fieldType": "string", "placeholder": "Name", "required": false, "active": true, "key": "name" }, "insurance": { "required": true, "active": true, "key": "insurance", "fieldType": "string", "placeholder": "Insurance" }, "vehicleType": { "options": [ { "value": "car", "label": "Car" }, { "value": "motorcycle", "label": "Motorcycle" } ], "required": false, "active": true, "key": "vehicleType", "placeholder": "Vehicle Type", "fieldType": "dropdown" } } } }

Sample Response with invalid partnerId

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

Sample Response with no partner:

Status: 400 Bad Request
{
    "success": false,
    "message": "No preferred partners yet. Please invite a partner in Deliveries PH - My Partners"
}

Request Headers

Code Block
language json
{ "Auth-Token": "<Auth token acquired on api LOGIN>" }

URL Parameters

Field	Required	Description
apiKey	yes	api API key from login API
partnerId	yes	client Client id of desired partner’s create post template and meta fields schema. Can be acquired through getPartners API

Sample Request

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

---

Sample Response

status: 200 OK!
{
    "success": true,
    "result": {
        "requestBody": {
            "refNo": "",
            "pickupDetails": {
                "customerName": "",
                "contactNumber": "",
                "emailAddress": "",
                "completionDateTime": "",
                "lat": 0,
                "long": 0,
                "tags": [],
                "remarks": "",
                "barangay": "",
                "province": "",
                "postalCode": "",
                "pickupAddress": "",
                "pickupCity": ""
            },
            "deliveries": [
                {
                    "customerName": "",
                    "contactNumber": "",
                    "emailAddress": "",
                    "completionDateTime": "",
                    "lat": 0,
                    "long": 0,
                    "tags": [],
                    "remarks": "",
                    "barangay": "",
                    "province": "",
                    "postalCode": "",
                    "deliveryAddress": "",
                    "deliveryCity": "",
                    "details": "",
                    "dimension": "",
                    "itemPrice": 0,
                    "codAmount": 0,
                    "metaFields": {
                        "stringType": "",
                        "dropdownType": "",
                        "listType": [
                            {
                                "quantity": "",
                                "itemName": ""
                            }
                        ]
                    }
                }
            ]
        },
        "metaFieldSchema": {
            "stringType": {
                "required": false,
                "type": "string",
                "description": "Sample string type meta"
            },
            "dropdownType": {
                "required": true,
                "type": "string",
                "description": "Dropdown sample",
                "values": [
                    "car",
                    "van"
                ],
                "details": [
                    {
                        "value": "car",
                        "description": "Car"
                    },
                    {
                        "value": "van",
                        "description": "Van"
                    }
                ]
            },
            "listType": {
                "type": "object",
                "description": "List sample",
                "properties": {
                    "quantity": {
                        "description": "Quantity",
                        "required": true,
                        "type": "string"
                    },
                    "itemName": {
                        "description": "Item Name",
                        "required": true,
                        "type": "string"
                    }
                }
            }
        }
    }
}

Meta fields schema

Request Headers

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

Query parameters (URL)

Code Block
language json
{ "apiKey": "<apiKey will be acquired on login API>" }

Request Body Fields

Field	Data Type	Required	Description
postId	string	yes	id ID of post to updatebe updated.
remarks	string	no	short description or remarks of the update
fees	array	yes	breakdown of fees

Fees object fields

Field	Data Type	Required	Description
value	number	yes	amount of fee
type	string	yes	type of fee, must be of the following: shipping , return , insurance , handling or others

Info
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.

Sample Request Body

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

Sample Response

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