PUDO

Given the customer's location and courier partner (optional), fetch all the PUDO (pick-up and drop-off) locations.

Overview

This API is used to retrieve all the PUDO locations for a given customer location and courier partner ID (optional).


Use cases

Forward shipping[Pickup points]: This API will enable you to fetch certain pick-up points (for all or specific courier partners) and show them to the customer. You can choose to ship your order to any of these locations and customers can pick up these orders from that specific location.

Reverse shipping[Drop-off points]: This API will enable you to show drop-off locations to your customer for any reverse shipping. When customers want to return a shipment, they can pack and drop it off at a drop-off location shared by you. These are one of the carrier's drop-off locations, from where the carrier picks up and delivers the shipment back to your warehouse.


Geography

This is a standard API which can be used to fetch PUDO locations corresponding to the courier partner ID.


Customer flow while leveraging the PUDO API

  1. Show the PUDO locations on the checkout flow
  2. Capture them with order data and pass it in the Order creation API
  3. Status update for these shipments: “shipment reached destination warehouse”: A notification will be triggered to the customer informing them they can pick up the shipment from the pickup location.
  4. Once the customer picks up the shipment, the carrier marks the shipment delivered, and a delivery notification is triggered.

Request payload

The request payload will consist of the following fields:

Field NameData TypeFieldDescription
latFloatMandatoryLatitude of the customer location
longFloatMandatoryLongitude of the customer location
courier_partnerIntegerOptionalCourier_partner ID for which PUDO locations will be fetched
account_codeStringOptionalAccount_code of the courier partner in ClickPost system
postal_codeStringOptionalPostal_code corresponding to the customer location
country_codeStringOptionalCountry_code of the customer location in ISO 2 format
cityStringOptionalCity corresponding to the customer location
limitIntegerOptionalDefault value is 10

Request curl

curl --location 'https://www.clickpost.in/api/v1/pudo_service_points?key=*******' \
--header 'Content-Type: application/json' \
--data '{
    "lat": "50.0245819092",
    "long": "4.1584229469",
    "limit": 10
}'

Response

[
  {
    "drop_info": {
      "name": "CHIMAY",
      "phone_code": "32",
      "phone": "",
      "email": "",
      "address": "RUE ROGIER",
      "landmark": "Street number 5",
      "district": "CHIMAY",
      "city": "CHIMAY",
      "state": "CHIMAY",
      "postal_code": "6460",
      "country_code": "BE",
      "lat": "50.0493812561",
      "long": "4.3166451454",
      "distance": "11644.55"
    },
    "opening_hours": [
      {
        "day_of_week": 1,
        "slots": [
          {
            "start_time": "09:00:00",
            "end_time": "12:30:00"
          },
          {
            "start_time": "13:30:00",
            "end_time": "17:00:00"
          }
        ]
      },
      {
        "day_of_week": 2,
        "slots": [
          {
            "start_time": "09:00:00",
            "end_time": "12:30:00"
          },
          {
            "start_time": "13:30:00",
            "end_time": "18:00:00"
          }
        ]
      },
      {
        "day_of_week": 3,
        "slots": [
          {
            "start_time": "09:00:00",
            "end_time": "12:30:00"
          },
          {
            "start_time": "13:30:00",
            "end_time": "17:00:00"
          }
        ]
      },
      {
        "day_of_week": 4,
        "slots": [
          {
            "start_time": "09:00:00",
            "end_time": "12:30:00"
          },
          {
            "start_time": "13:30:00",
            "end_time": "18:00:00"
          }
        ]
      },
      {
        "day_of_week": 5,
        "slots": [
          {
            "start_time": "09:00:00",
            "end_time": "12:30:00"
          },
          {
            "start_time": "13:30:00",
            "end_time": "17:00:00"
          }
        ]
      },
      {
        "day_of_week": 6,
        "slots": [
          {
            "start_time": "09:00:00",
            "end_time": "12:30:00"
          },
          {
            "start_time": null,
            "end_time": null
          }
        ]
      },
      {
        "day_of_week": 7,
        "slots": [
          {
            "start_time": null,
            "end_time": null
          },
          {
            "start_time": null,
            "end_time": null
          }
        ]
      }
    ],
    "services": [
      {
        "code": "",
        "available": "",
        "description": ""
      }
    ],
    "courier_partner": 551,
    "account_code": "",
    "collection_point_id": "132400"
  },
  {
    "drop_info": {
      "name": "AD DELHAIZE CHIMAY",
      "phone_code": "32",
      "phone": "",
      "email": "",
      "address": "RUE DE BOURLERS",
      "landmark": "Street number 1",
      "district": "CHIMAY",
      "city": "CHIMAY",
      "state": "CHIMAY",
      "postal_code": "6460",
      "country_code": "BE",
      "lat": "50.047668457",
      "long": "4.3217144012",
      "distance": "11954.74"
    },
    "opening_hours": [
      {
        "day_of_week": 1,
        "slots": [
          {
            "start_time": "08:30:00",
            "end_time": "19:15:00"
          },
          {
            "start_time": null,
            "end_time": null
          }
        ]
      },
      {
        "day_of_week": 2,
        "slots": [
          {
            "start_time": "08:30:00",
            "end_time": "19:15:00"
          },
          {
            "start_time": null,
            "end_time": null
          }
        ]
      },
      {
        "day_of_week": 3,
        "slots": [
          {
            "start_time": "08:30:00",
            "end_time": "19:15:00"
          },
          {
            "start_time": null,
            "end_time": null
          }
        ]
      },
      {
        "day_of_week": 4,
        "slots": [
          {
            "start_time": "08:30:00",
            "end_time": "19:15:00"
          },
          {
            "start_time": null,
            "end_time": null
          }
        ]
      },
      {
        "day_of_week": 5,
        "slots": [
          {
            "start_time": "08:30:00",
            "end_time": "19:45:00"
          },
          {
            "start_time": null,
            "end_time": null
          }
        ]
      },
      {
        "day_of_week": 6,
        "slots": [
          {
            "start_time": "08:30:00",
            "end_time": "19:45:00"
          },
          {
            "start_time": null,
            "end_time": null
          }
        ]
      },
      {
        "day_of_week": 7,
        "slots": [
          {
            "start_time": null,
            "end_time": null
          },
          {
            "start_time": null,
            "end_time": null
          }
        ]
      }
    ],
    "services": [
      {
        "code": "",
        "available": "",
        "description": ""
      }
    ],
    "courier_partner": 551,
    "account_code": "",
    "collection_point_id": "812500"
  }
]

Did this page help you?