Sign in

v1

latestOpenAPI 3.0.12026-08-061158187.8 KB
PUDO API

List Ninja Points v2

Returns a list of Ninja Points that meet the passed query parameters.

get/{countryCode}/2.0/pudos

Path parameters

countryCode'SG' | 'MY' | 'TH' | 'ID' | 'VN' | 'PH' | 'MM' required

Country code.

Query parameters

can_customer_collectboolean

Set this to true to fetch the list of Ninja Points where the customer can collect parcels.

allow_create_postboolean

Set this to true to fetch the list of Ninja Points where the shipper can create "post" parcels.

allow_customer_returnboolean

Set this to true to fetch the list of Ninja Points where the customer can return parcels.

allow_shipper_sendboolean

Set this to true to fetch the list of Ninja Points where the shipper can drop off parcels.

allow_create_packboolean

Set this to true to fetch the list of Ninja Points where the shipper can drop off "pack" parcels.

can_sell_packsboolean

Set this to true to fetch the list of Ninja Points where the shipper can buy "pack" parcels.

Response

Ninja points successfully listed

address_1string

Unit and block of the Ninja Point's address.

address_2string

Street address of the Ninja Point.

allow_create_packboolean

Flag to indicate if the Ninja Point allows "pack" parcel creation.

allow_create_postboolean

Flag to indicate if the Ninja Point allows "post" parcel creation.

allow_customer_returnboolean

Flag to indicate if the Ninja Point allows customer returns.

allow_shipper_sendboolean

Flag to indicate if the Ninja Point allows shippers to drop-off "send" parcels.

can_customer_collectboolean

Flag to indicate if the Ninja Point allows customer collection.

directionsstring

Additional description on how to find the Ninja Point.

distancenumber

N/A

dpms_idnumber

Legacy Ninja Point identifier.

floor_numberstring

Floor number of the Ninja Point's address.

idinteger

Ninja Van's identifier for the Ninja Point.

latitudenumber

Latitude of the Ninja Point's location.

longitudenumber

Longitude of the Ninja Point's location.

max_parcel_stay_durationnumber

Maximum number of days a parcel can stay at the Ninja Point.

namestring

Descriptive names of the locations easily understood by customers, to be used in the selection dropdown list.

accepted_parcel_sizesstring[]

Accepted parcel sizes for shipper drop-offs at Ninja Points (excluding customer collection service).

packs_sold_hereboolean

Flag to indicate if Ninja Packs are available for purchase at the Ninja Point.

partner_idnumber

Ninja Point partner's identifier.

partner_namestring

Ninja Point partner's name.

postal_codestring

Postal code of the Ninja Point's address.

short_namestring

Identifier used by the order creation endpoint to map to the Ninja Point.

type'BOX' | 'SHOP'

Type of the Ninja Point.

unit_numberstring

Unit number of the Ninja Point's address.

Example response

{
  "address_1": "#01-19/20/21 Clifford Centre",
  "address_2": "24 Raffles Place",
  "can_customer_collect": true,
  "directions": "Next to Setish Boutique",
  "dpms_id": 1337,
  "floor_number": "01",
  "id": 118,
  "latitude": 3.009829,
  "longitude": 102.770408,
  "max_parcel_stay_duration": 3,
  "name": "Mr Fix at Bukit Merah Central",
  "opening_hours": [
    {
      "end_time": "22:00:00",
      "start_time": "07:00:00"
    }
  ],
  "accepted_parcel_sizes": [
    "XSMALL",
    "SMALL"
  ],
  "partner_id": 123,
  "partner_name": "Antoni's Cafe",
  "postal_code": "678265",
  "short_name": "IS_UNS",
  "unit_number": "123"
}