Sign in

v1

latestOpenAPI 3.0.12026-08-061158187.8 KB
PUDO partners API

Trigger shipper drop-off for parcel

Notifies Ninja Van that a parcel is being dropped off at a Ninja Point by a shipper. Returns parcels that are successfully dropped off and a list of errors if any.

post/{countryCode}/1.0/send-orders/drop-off

Path parameters

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

Country code.

Request body

storestring required

External store ID.

received_atstring required

Date and time when the parcel is dropped off at the Ninja Point (yyyy-MM-dd HH:mm:ss in UTC).

tracking_idsstring[] required

List of tracking IDs to be dropped off.

Example request

{
  "store": "PSVKV4M16A",
  "received_at": "2022-06-01 00:00:00",
  "tracking_ids": [
    "NVSGBEDBP12345ADPL",
    "NVSGBEDBP03784ADPL"
  ]
}

Response

Parcels successfully dropped off (possibly some of them had errors).

errorstring[] required

List of tracking IDs that weren't successfully dropped off.

vendor_codestring required

Unique identifier used by the partner for integration.

storestring required

External store ID.

Example response

{
  "success": [
    {
      "tracking_id": "NVSGBEDBP03784ADPL",
      "job_number": 123,
      "pin": 239812
    }
  ],
  "error": [
    "NVSGBEDBP12345ADPL"
  ],
  "vendor_code": "NV",
  "store": "PSVKV4M16A"
}