Deliveries Ph API Documentation

Deliveries Ph API Documentation

This Troubleshooting Guide contains the topics and links to Deliveries Ph's API Documentation for usage of both Deliveries Ph's Business and/or Provider Users in configuring their API.

For a full view of Deliveries Ph's API Documentation, click here.

Deliveries Ph API Documentation Content (links):

A. Endpoint URL
      - Beta
      - Staging
      - Production

B. Postman Collection

C. Login and Get Session Token (Business & Provider)
      - Request Headers
      - Request Body
      - Sample Request Body
      - Sample Response
      - Error Messages

D. Login V2 (Business & Provider)
      - Request Headers
      - Request Body
      - Sample Response

E. Get Partners (Business & Provider)
      - Request Headers
      - URL Query Parameters
      - Sample Response

F. Get List of Areas (Business)
      - Request Headers
      - Query Parameters (URL)
      - Sample Response

G. Get List of Stores/Hubs (Business)
      - Request Headers
      - Query Parameters (URL)
      - Sample URL
      - Sample Response

H. Get Provider's Create Post V3 Template (Business)
      - Request Headers
      - URL Parameters
      - Sample Request
      - Sample Response
      - Meta Fields Schema

I. Get Quotation (Business)
      - Request Headers
      - Request Params
      - Request Body
      - Fields of Pickup and Delivery
      - Sample Request Body
      - Sample Response (Serviceable Area)
      - Sample Response (Non-Serviceable Area)
      - Error Messages (Missing Partner ID , Invalid Partner ID, & Service Type On-Demand)

J. Create Post V3 (Business)
      - Request Headers
      - Query parameters (URL)
      - Request Body Fields
      - Fields of pickupDetails
      - Fields of deliveryDetails
      - Sample Request Body
      - Sample Response
    - Error Messages (Invalid Request Parameter, Missing Partner ID, Invalid Partner ID, Invalid Business Store ID, Invalid Pickup/Delivery Date & Time, Missing Coordinates for On-Demand Providers, Invalid Pickup/Delivery Location, Not Serviceable, Product, Auto Reattempt, & If PSGC is false and field pickup/delivery address is in PSGC format)

K. Update Post Status (Provider)
      - Request Headers
      - URL Query Parameters
      - Request Body Fields
      - Sample Request Body
      - Sample Response
      - Status Updates

L. Get Post (Business & Provider)
      - Request Headers
      - URL Parameters (Query Parameters)
      - Sample URL Parameters
      - Sample Response

M. Update Fee (Provider)
      - Request Headers
      - Query Parameters (URL)
      - Request Body Fields
      - Fees Object Fields
      - Sample Request Body
      - Sample Response

N. Update Meta fields V2 (Provider)
      - Request Headers
      - Query Parameters (URL)
      - Request Body Fields
      - Sample Request Body
      - Sample Response

O. Get On Demand Quotation (Business & Provider)
      - Request Headers
      - Query Parameters (URL)
      - Request Body Fields
      - Sample Request Body
      - Sample Response

P. Refresh Token (Business & Provider)
      - Request Headers
      - Request Body
      - Sample Response

    • Related Articles

    • How to receive status updates from Deliveries PH, to your system's API

      HTTP Post Trigger Overview Learn how to SETUP HTTP POST TRIGGERS to get updates from your Deliveries PH account, to your connected Third-Party app. A PDF version for this guide is available below. Setup Trigger 1. Click Settings. 2. Click Triggers. ...

    • How to receive status updates from Deliveries PH, to your system's API

      HTTP Post Trigger Overview Learn how to SETUP HTTP POST TRIGGERS to get updates from your Deliveries PH account, to your connected Third-Party app. A PDF version for this guide is available below. Setup Trigger 1. Click Settings. 2. Click Triggers. ...

    • Deliveries PH Shopify Installation Setup

      This module provides instructions on how to connect your Shopify store to Deliveries PH. 1. Login to your Shopify Account. 2. Create your Shopify store. 3. On your Shopify store, go to “Settings” menu which can be seen at the lower left side bar. ...

    • How to connect a Shopify Store to Deliveries PH

      Store Integration: Shopify Overview Learn how to CONNECT AND SETUP A SHOPIFY STORE to a Deliveries PH account. A PDF version of this guide is available below. Installation Store Authentication 1. Click Settings. 2. Click Store Integration. 3. Click ...

    • How to connect a Shopify Store to Deliveries PH

      Store Integration: Shopify Overview Learn how to CONNECT AND SETUP A SHOPIFY STORE to a Deliveries PH account. A PDF version of this guide is available below. Installation Store Authentication 1. Click Settings. 2. Click Store Integration. 3. Click ...