The PUDO API Documentation
Welcome to the PUDO API!
Our API is designed to provide you with robust and flexible tools to integrate PUDO’s capabilities into your applications, ensuring a smooth and reliable experience for your users.
Shipping and Rates
This section lists all the APIs related to getting rates and creating/generating, retrieving and cancelling shipments.
Getting opt-in rates Door to Door (D2D)
POST https://api-pudo.co.za/rates
The following fields are required:
- collection_address
- delivery_address
Request
{
"collection_address": {
"lat": -26.0249547,
"lng": 27.9553194,
"street_address": "Kya Sand Road",
"local_area": "Kya Sand",
"suburb": "Kya Sand",
"city": "Randburg",
"code": "",
"zone": "GP",
"country": "South Africa",
"entered_address": "Kya Sand Rd, Kya Sand, Randburg, South Africa",
"type": "residential",
"company": "The Courier Guy"
},
"delivery_address": {
"lat": -34.03532089999999,
"lng": 18.753318,
"street_address": "Johannesburg Street",
"local_area": "Croydon",
"suburb": "Croydon",
"city": "Cape Town",
"code": "7130",
"zone": "WC",
"country": "South Africa",
"entered_address": "Johannesburg St, Croydon, Cape Town, 7130, South Africa",
"type": "residential"
}
}
Response
{
"opt_in_rates": [
{
"id": 29339,
"charge_type": "percentage",
"charge_value": "10",
"name": "Chain Stores",
"vat_type": "standard"
},
{
"id": 29342,
"charge_type": "percentage",
"charge_value": "20",
"name": "Hospital",
"vat_type": "standard"
},
{
"id": 29343,
"charge_type": "flat",
"charge_value": "25",
"name": "Manual waybill charge",
"vat_type": "standard"
},
{
"id": 29344,
"charge_type": "flat",
"charge_value": "276",
"name": "Plot / Farm",
"vat_type": "standard"
},
{
"id": 29345,
"charge_type": "flat",
"charge_value": "276",
"name": "Power station",
"vat_type": "standard"
},
{
"id": 29346,
"charge_type": "flat",
"charge_value": "115",
"name": "Tender",
"vat_type": "standard"
}
],
"opt_in_time_based_rates": [
{
"id": 38201,
"charge_type": "delivery",
"charge_value": "713",
"name": "Public holidy delivery"
},
{
"id": 38202,
"charge_type": "delivery",
"charge_value": "210.25",
"name": "Earlybird"
},
{
"id": 38203,
"charge_type": "collection",
"charge_value": "517.5",
"name": "Saturday collection (on the next available Saturday)"
},
{
"id": 38204,
"charge_type": "collection",
"charge_value": "713",
"name": "Public holiday collection"
},
{
"id": 38205,
"charge_type": "delivery",
"charge_value": "713",
"name": "After hours delivery"
},
{
"id": 38206,
"charge_type": "collection",
"charge_value": "713",
"name": "After hours collection"
},
{
"id": 38207,
"charge_type": "delivery",
"charge_value": "517.5",
"name": "Saturday delivery"
}
]
}
Getting opt-in rates Door to Locker (D2L)
POST https://api-pudo.co.za/opt-in
The following fields are required:
- collection_address
Request
{
"collection_address": {
"type": "residential",
"entered_address": "123 Rivonia Rd, Sandown, Sandton, 2031, South Africa",
"company": "123 Rivonia Rd",
"street_address": "Rivonia Road",
"local_area": "Sandown",
"code": "2031",
"city": "Sandton",
"zone": "GP",
"country": "South Africa",
"lat": "-26.1042942",
"lng": "28.0599364"
}
}
Response
{
"opt_in_rates": [
{
"id": 29339,
"charge_type": "percentage",
"charge_value": "10",
"name": "Chain Stores",
"vat_type": "standard"
},
{
"id": 29342,
"charge_type": "percentage",
"charge_value": "20",
"name": "Hospital",
"vat_type": "standard"
},
{
"id": 29343,
"charge_type": "flat",
"charge_value": "25",
"name": "Manual waybill charge",
"vat_type": "standard"
},
{
"id": 29344,
"charge_type": "flat",
"charge_value": "276",
"name": "Plot / Farm",
"vat_type": "standard"
},
{
"id": 29345,
"charge_type": "flat",
"charge_value": "276",
"name": "Power station",
"vat_type": "standard"
},
{
"id": 29346,
"charge_type": "flat",
"charge_value": "115",
"name": "Tender",
"vat_type": "standard"
}
],
"opt_in_time_based_rates": [
{
"id": 38203,
"charge_type": "collection",
"charge_value": "517.5",
"name": "Saturday collection (on the next available Saturday)"
},
{
"id": 38204,
"charge_type": "collection",
"charge_value": "713",
"name": "Public holiday collection"
},
{
"id": 38206,
"charge_type": "collection",
"charge_value": "713",
"name": "After hours collection"
}
]
}
Getting opt-in rates Locker to Door (L2D)
POST https://api-pudo.co.za/opt-in
The following fields are required:
- delivery_address
Request
{
"delivery_address": {
"type": "residential",
"entered_address": "123 Rivonia Rd, Sandown, Sandton, 2031, South Africa",
"company": "123 Rivonia Rd",
"street_address": "Rivonia Road",
"local_area": "Sandown",
"code": "2031",
"city": "Sandton",
"zone": "GP",
"country": "South Africa",
"lat": "-26.1042942",
"lng": "28.0599364"
}
}
Response
{
"opt_in_rates": [
{
"id": 29339,
"charge_type": "percentage",
"charge_value": "10",
"name": "Chain Stores",
"vat_type": "standard"
},
{
"id": 29342,
"charge_type": "percentage",
"charge_value": "20",
"name": "Hospital",
"vat_type": "standard"
},
{
"id": 29343,
"charge_type": "flat",
"charge_value": "25",
"name": "Manual waybill charge",
"vat_type": "standard"
},
{
"id": 29344,
"charge_type": "flat",
"charge_value": "276",
"name": "Plot / Farm",
"vat_type": "standard"
},
{
"id": 29345,
"charge_type": "flat",
"charge_value": "276",
"name": "Power station",
"vat_type": "standard"
},
{
"id": 29346,
"charge_type": "flat",
"charge_value": "115",
"name": "Tender",
"vat_type": "standard"
}
],
"opt_in_time_based_rates": [
{
"id": 38201,
"charge_type": "delivery",
"charge_value": "713",
"name": "Public holidy delivery"
},
{
"id": 38202,
"charge_type": "delivery",
"charge_value": "210.25",
"name": "Earlybird"
},
{
"id": 38205,
"charge_type": "delivery",
"charge_value": "713",
"name": "After hours delivery"
},
{
"id": 38207,
"charge_type": "delivery",
"charge_value": "517.5",
"name": "Saturday delivery"
}
]
}
Getting rates Door to Door (D2D)
POST https://api-pudo.co.za/rates
The following fields are required:
- collection_address
- delivery_address
- parcels
Request
{
"collection_address": {
"IS_ADDRESS_BOOK": true,
"address_id": 2036335720,
"type": "residential",
"lat": "-34.0206064",
"lng": "18.6271073",
"company": "Stompie Sepei Street",
"complex": "",
"street_address": "9 Crinum Road",
"local_area": "Mandalay",
"city": "City of Cape Town Metropolitan Municipality",
"code": "Cape Town",
"zone": "WC",
"country": "South Africa",
"entered_address": "2c, 9 Crinum Rd, Mandalay, Cape Town, 7785, South Africa"
},
"delivery_address": {
"lat": -25.7463703,
"lng": 28.2238968,
"street_address": "877 Pretorius Street",
"local_area": "Arcadia",
"suburb": "Arcadia",
"city": "Pretoria",
"code": "0007",
"zone": "GP",
"country": "South Africa",
"entered_address": "877 Pretorius St, Arcadia, Pretoria, 0007, South Africa",
"address_id": null,
"IS_ADDRESS_BOOK": false,
"type": "residential"
},
"parcels": [
{
"type": {
"id": "Standard-flyer",
"name": "Standard flyer"
},
"submitted_length_cm": "40",
"submitted_width_cm": "30",
"submitted_height_cm": "8",
"submitted_weight_kg": "2",
"parcel_description": "Standard flyer",
"alternative_tracking_reference": "",
"is_default": true,
"error": false
}
],
"opt_in_rates": [],
"opt_in_time_based_rates": [],
"collection_min_date": "2024-04-20",
"delivery_min_date": "2024-04-25"
}
Response
{
"rates": [
{
"from_tags": "232,582,634,579",
"to_tags": "234,579,232,580,634,554,556",
"rate": "705.56",
"rates_explained": "",
"rate_excluding_vat": 613.53,
"base_rate": {
"charge": 149.5,
"rate_formula_type": "per_kg",
"total_calculated_weight": 2,
"vat_type": null,
"vat": 19.5
},
"charged_weight": 2,
"rate_revision_id": 942,
"service_level": {
"id": 1,
"code": "OVN",
"name": "Overnight",
"description": "Expect delivery between 1 - 2 business days.",
"vat_type": null,
"insurance_disabled": null,
"collection_date": "23 Apr, 2024 08:00 AM",
"collection_cut_off_time": "23 Jul, 2024 03:00 PM",
"delivery_date_from": "25 Apr, 2024 12:00 AM",
"delivery_date_to": "30 Apr, 2024 12:00 AM"
},
"surcharges": [
{
"id": 69053,
"name": "Embassy of the United States of America",
"group_id": 8840,
"charge": "500",
"vat": 65.22,
"type": "flat"
}
],
"rate_adjustments": null,
"time_based_rate_adjustments": null,
"mandatory_charges": [
{
"id": 29340,
"name": "Currency",
"group_id": "8840",
"charge": "12.5",
"vat": 1.63,
"type": "percentage"
},
{
"id": 29341,
"name": "Fuel Charge",
"group_id": "8840",
"charge": "25",
"vat": 3.26,
"type": "percentage"
}
]
},
{
"from_tags": "232,582,634,579",
"to_tags": "234,579,232,580,634,554,556",
"rate": "642.31",
"rates_explained": "",
"rate_excluding_vat": 558.53,
"base_rate": {
"charge": 103.5,
"rate_formula_type": "per_kg",
"total_calculated_weight": 2.4,
"vat_type": null,
"vat": 13.5
},
"charged_weight": 2.4,
"rate_revision_id": 942,
"service_level": {
"id": 2,
"code": "ECO",
"name": "Economy",
"description": "Expect delivery between 3 - 4 business days.",
"vat_type": null,
"insurance_disabled": null,
"collection_date": "23 Apr, 2024 08:00 AM",
"collection_cut_off_time": "23 Jul, 2024 03:00 PM",
"delivery_date_from": "25 Apr, 2024 12:00 AM",
"delivery_date_to": "30 Apr, 2024 12:00 AM"
},
"surcharges": [
{
"id": 69053,
"name": "Embassy of the United States of America",
"group_id": 8840,
"charge": "500",
"vat": 65.22,
"type": "flat"
}
],
"rate_adjustments": null,
"time_based_rate_adjustments": null,
"mandatory_charges": [
{
"id": 29340,
"name": "Currency",
"group_id": "8840",
"charge": "12.5",
"vat": 1.63,
"type": "percentage"
},
{
"id": 29341,
"name": "Fuel Charge",
"group_id": "8840",
"charge": "25",
"vat": 3.26,
"type": "percentage"
}
]
}
],
"service_days": {
"collection_service_days": [],
"delivery_service_days": [
"Tuesday",
"Thursday"
]
}
}
Getting rates Door to Locker (D2L)
POST https://api-pudo.co.za/rates
The following fields are required:
- collection_address
- delivery_address
Request
{
"collection_address": {
"type": "residential",
"entered_address": "123 Rivonia Rd, Sandown, Sandton, 2031, South Africa",
"company": "123 Rivonia Rd",
"street_address": "Rivonia Road",
"local_area": "Sandown",
"code": "2031",
"city": "Sandton",
"zone": "GP",
"country": "South Africa",
"lat": "-26.1042942",
"lng": "28.0599364"
},
"delivery_address": {
"terminal_id": "CG10"
},
"opt_in_rates": [],
"opt_in_time_based_rates": []
}
Response
{
"rates": [
{
"from_tags": "579,232,580,634",
"to_tags": "579,232,580,634",
"rate": "82.50",
"rates_explained": "",
"rate_excluding_vat": 71.74,
"base_rate": {
"charge": 60,
"rate_formula_type": "per_parcel",
"total_calculated_weight": 0,
"vat_type": null,
"vat": 7.83
},
"charged_weight": 0,
"rate_revision_id": 942,
"service_level": {
"id": 33,
"code": "D2LXS - ECO",
"name": "Door to Locker Extra Small",
"description": "Door to Locker Extra Small",
"vat_type": null,
"insurance_disabled": null,
"collection_date": "23 Jul, 2024 08:00 AM",
"collection_cut_off_time": "23 Jul, 2024 05:00 PM",
"delivery_date_from": "25 Jul, 2024 08:00 AM",
"delivery_date_to": "29 Jul, 2024 08:00 AM",
"box_type_name": "V4-XS",
"box_type": "10",
"dimensions": {
"width": 17,
"height": 8,
"length": 60,
"weight": 2
}
},
"surcharges": null,
"rate_adjustments": null,
"time_based_rate_adjustments": null,
"mandatory_charges": [
{
"id": 29340,
"name": "Currency",
"group_id": "8840",
"charge": "12.5",
"vat": 1.63,
"type": "percentage"
},
{
"id": 29341,
"name": "Fuel Charge",
"group_id": "8840",
"charge": "25",
"vat": 3.26,
"type": "percentage"
}
]
}
],
"service_days": {
"collection_service_days": [],
"delivery_service_days": []
}
}
Getting rates Locker to Door (L2D)
POST https://api-pudo.co.za/rates
The following fields are required:
- collection_address
- delivery_address
Request
{
"collection_address": {
"terminal_id": "CG276"
},
"delivery_address": {
"type": "residential",
"entered_address": "123 Rivonia Rd, Sandown, Sandton, 2031, South Africa",
"company": "123 Rivonia Rd",
"street_address": "Rivonia Road",
"local_area": "Sandown",
"code": "2031",
"city": "Sandton",
"zone": "GP",
"country": "South Africa",
"lat": "-26.1042942",
"lng": "28.0599364"
},
"opt_in_rates": [
],
"opt_in_time_based_rates": [
]
}
Response
{
"rates": [
{
"from_tags": "231,553,555,579,233,634,682",
"to_tags": "579,232,580,634",
"rate": "600.00",
"rates_explained": "",
"rate_excluding_vat": 521.74,
"base_rate": {
"charge": 60,
"rate_formula_type": "per_parcel",
"total_calculated_weight": 0,
"vat_type": null,
"vat": 7.83
},
"charged_weight": 0,
"rate_revision_id": 942,
"service_level": {
"id": 28,
"code": "L2DXS - ECO",
"name": "Locker to Door Extra Small",
"description": "Locker to Door Small",
"vat_type": null,
"insurance_disabled": null,
"collection_date": "23 Jul, 2024 08:00 AM",
"collection_cut_off_time": "23 Jul, 2024 05:00 PM",
"delivery_date_from": "27 Jul, 2024 12:00 AM",
"delivery_date_to": "27 Jul, 2024 12:00 AM",
"box_type_name": "V4-XS",
"box_type": "10",
"dimensions": {
"width": 17,
"height": 8,
"length": 60,
"weight": 2
}
},
"surcharges": null,
"rate_adjustments": null,
"time_based_rate_adjustments": [
{
"id": 38207,
"name": "Saturday delivery",
"group_id": 8840,
"charge": "517.5",
"vat": 67.5,
"type": "flat"
}
],
"mandatory_charges": [
{
"id": 29340,
"name": "Currency",
"group_id": "8840",
"charge": "12.5",
"vat": 1.63,
"type": "percentage"
},
{
"id": 29341,
"name": "Fuel Charge",
"group_id": "8840",
"charge": "25",
"vat": 3.26,
"type": "percentage"
}
]
}
],
"service_days": {
"collection_service_days": [],
"delivery_service_days": []
}
}
Getting rates Locker to Locker (L2L)
POST https://api-pudo.co.za/rates
The following fields are required:
- collection_address
- delivery_address
Request
{
"collection_address": {
"terminal_id": "CG107"
},
"delivery_address": {
"terminal_id": "CG10"
}
}
Response
{
"rates": [
{
"from_tags": "579",
"to_tags": "579,232,580,634",
"rate": "68.75",
"rates_explained": "",
"rate_excluding_vat": 59.78,
"base_rate": {
"charge": 50,
"rate_formula_type": "per_parcel",
"total_calculated_weight": 0,
"vat_type": null,
"vat": 6.52
},
"charged_weight": 0,
"rate_revision_id": 942,
"service_level": {
"id": 23,
"code": "L2LXS - ECO",
"name": "Locker to Locker Extra Small",
"description": "Locker to Locker Extra Small",
"vat_type": null,
"insurance_disabled": null,
"collection_date": "23 Jul, 2024 08:00 AM",
"collection_cut_off_time": "23 Jul, 2024 05:00 PM",
"delivery_date_from": "25 Jul, 2024 08:00 AM",
"delivery_date_to": "29 Jul, 2024 08:00 AM",
"box_type_name": "V4-XS",
"box_type": "10",
"dimensions": {
"width": 17,
"height": 8,
"length": 60,
"weight": 2
}
},
"surcharges": null,
"rate_adjustments": null,
"time_based_rate_adjustments": null,
"mandatory_charges": [
{
"id": 29340,
"name": "Currency",
"group_id": "8840",
"charge": "12.5",
"vat": 1.63,
"type": "percentage"
},
{
"id": 29341,
"name": "Fuel Charge",
"group_id": "8840",
"charge": "25",
"vat": 3.26,
"type": "percentage"
}
]
}
],
"service_days": {
"collection_service_days": [],
"delivery_service_days": []
}
}
Create shipment Door to Door (D2D)
POST https://api-pudo.co.za/shipments
The following fields are required:
- collection_address
- collection_contact
- delivery_address
- delivery_contact
- parcels
- service_level_code
Request
{
"collection_min_date": "2023-11-30T17:54:47.476Z",
"collection_address": {
"lat": -26.0249547,
"lng": 27.9553194,
"street_address": "Kya Sand Road",
"local_area": "Kya Sand",
"suburb": "Kya Sand",
"city": "Randburg",
"code": "",
"zone": "GP",
"country": "South Africa",
"entered_address": "Kya Sand Rd, Kya Sand, Randburg, South Africa",
"type": "residential",
"company": "The Courier Guy"
},
"special_instructions_collection": "None",
"collection_contact": {
"name": "Sender Name",
"email": "sender@gmail.com",
"mobile_number": "+27xxxxxxxxx"
},
"delivery_min_date": "2023-11-30T17:54:47.494Z",
"delivery_address": {
"lat": -34.03532089999999,
"lng": 18.753318,
"street_address": "Johannesburg Street",
"local_area": "Croydon",
"suburb": "Croydon",
"city": "Cape Town",
"code": "7130",
"zone": "WC",
"country": "South Africa",
"entered_address": "Johannesburg St, Croydon, Cape Town, 7130, South Africa",
"type": "residential"
},
"delivery_contact": {
"name": "Receiver Name",
"email": "receiver@gmail.com",
"mobile_number": "+27xxxxxxxxx"
},
"parcels": [
{
"submitted_length_cm": "40",
"submitted_width_cm": "30",
"submitted_height_cm": "8",
"submitted_weight_kg": "2",
"parcel_description": "Standard flyer",
"alternative_tracking_reference": ""
}
],
"opt_in_rates": [],
"opt_in_time_based_rates": [],
"service_level_code": "OVN"
}
Response
{
"special_instructions_collection": "None",
"opt_in_rates": "[]",
"opt_in_time_based_rates": "[]",
"service_level_code": "OVN",
"account_id": 142,
"collection_address_id": 2036341630,
"delivery_address_id": 2036341631,
"charged_weight": 2,
"collection_contact_id": 4748,
"delivery_contact_id": 4749,
"account_branch_id": 751,
"rate_group_id": 8840,
"all_charges_reversed": false,
"collection_branch_id": 751,
"collection_branch_name": "JNB",
"collection_agent_id": "danise",
"collection_agent_routing_number": "J457(WR7)",
"collection_agent_zone": "Kya sands 2",
"original_collection_agent_id": "danise",
"original_collection_min_date": "2024-07-24 08:00:00",
"collection_min_date": "2024-07-24T08:00:00.000Z",
"estimated_collection": "2024-07-24 08:00:00",
"collection_cutoff_override": false,
"collection_request_id": 0,
"created_by": "",
"current_branch_id": 751,
"current_branch_name": "JNB",
"delivery_after": "08:00",
"collection_after": "08:00",
"delivery_branch_id": 580,
"delivery_branch_name": "CPT",
"delivery_agent_id": "cptcroydon",
"delivery_agent_routing_number": "CO4/CR6",
"delivery_agent_zone": "C CROYDON",
"original_delivery_agent_id": "cptcroydon",
"original_delivery_min_date": "2024-07-25T08:00:00+02:00",
"delivery_min_date": "2024-07-25T08:00:00.000Z",
"estimated_delivery_from": "2024-07-25T08:00:00+02:00",
"estimated_delivery_to": "2024-07-26T08:00:00+02:00",
"collection_before": "17:00",
"delivery_before": "17:00",
"delivery_rescheduled": null,
"disable_new_charges": false,
"external_note_count": 0,
"has_been_invoiced": false,
"is_pending": false,
"latest_tracking_event_time": "2024-07-23T13:07:59.429019Z",
"modified_by": "Ford G",
"mute_notifications": false,
"rate": 205.5625,
"rate_revision_id": 942,
"default_special_request_id": 8840,
"original_rate": 205.5625,
"payment_intervention_status": "",
"previous_rate": 0,
"responsible_contact_id": 4748,
"service_level_cut_off_time": "2024-07-23T15:00:00+02:00",
"service_level_name": "Overnight",
"source": "api",
"pod_method": "PIN with fallback options",
"locker_provider": null,
"status": "submitted",
"base_rate_obj": {
"charge": "149.50",
"rate_formula_type": "per_kg",
"total_calculated_weight": 2,
"vat_type": null,
"vat": "19.50"
},
"service_level_obj": {
"id": 1,
"code": "OVN",
"name": "Overnight",
"description": null,
"vat_type": null,
"insurance_disabled": "0",
"collection_date": "2024-07-24 08:00:00",
"delivery_date_from": "2024-07-25T08:00:00+02:00",
"delivery_date_to": "2024-07-26T08:00:00+02:00",
"collection_cut_off_time": "2024-07-23T15:00:00+02:00"
},
"surcharge_obj": [],
"mandatory_charges_obj": [
{
"charge": "18.69",
"vat": "2.44",
"id": 29340,
"group_id": "8840",
"name": "Currency"
},
{
"charge": "37.38",
"vat": "4.88",
"id": 29341,
"group_id": "8840",
"name": "Fuel Charge"
}
],
"id": 6870623,
"custom_tracking_reference": "PUDO000500"
}
Create shipment Door to Locker (D2L)
POST https://api-pudo.co.za/shipments
The following fields are required:
- collection_address
- collection_contact
- delivery_address
- delivery_contact
- service_level_code
Request
{
"collection_address": {
"IS_ADDRESS_BOOK": true,
"address_id": 2036335720,
"lat": "-34.0206064",
"lng": "18.6271073",
"street_address": "9 Crinum Road",
"local_area": "Mandalay",
"suburb": "",
"city": "Cape Town",
"code": "Cape Town",
"zone": "WC",
"country": "South Africa",
"entered_address": "2c, 9 Crinum Rd, Mandalay, Cape Town, 7785, South Africa",
"type": "residential",
"company": "Stompie Sepei Street"
},
"delivery_address": {
"terminal_id": "CG63"
},
"collection_contact": {
"name": "Sender Name",
"email": "sender@gmail.com",
"mobile_number": "+27xxxxxxxxx"
},
"delivery_contact": {
"name": "Receiver Name",
"email": "receiver@gmail.com",
"mobile_number": "+27xxxxxxxxx"
},
"opt_in_time_based_rates": [],
"opt_in_rates": [],
"service_level_code": "D2LXS - ECO",
"collection_min_date": "2024-04-19T06:59:02.070Z",
"delivery_min_date": "2024-05-01T06:59:02.083Z"
}
Response
{
"opt_in_time_based_rates": "[]",
"opt_in_rates": "[]",
"service_level_code": "D2LXS - ECO",
"collection_min_date": "2024-04-19T14:59:02.000Z",
"delivery_min_date": "2024-04-23T14:59:02.000Z",
"account_id": 142,
"collection_address_id": 2036335720,
"delivery_address_id": 2036341632,
"charged_weight": 0,
"collection_contact_id": 4750,
"delivery_contact_id": 4751,
"account_branch_id": 751,
"rate_group_id": 8842,
"all_charges_reversed": false,
"collection_branch_id": 580,
"collection_branch_name": "CPT",
"collection_agent_id": "cptmitchellsplain",
"collection_agent_routing_number": "CO4/CR6",
"collection_agent_zone": "CPT MITCHELLS PLAIN ",
"original_collection_agent_id": "cptmitchellsplain",
"original_collection_min_date": "2024-04-19 14:59:02",
"estimated_collection": "2024-04-19 14:59:02",
"collection_cutoff_override": false,
"collection_request_id": 0,
"created_by": "",
"current_branch_id": 580,
"current_branch_name": "CPT",
"delivery_after": "08:00",
"collection_after": "08:00",
"delivery_branch_id": 580,
"delivery_branch_name": "CPT",
"delivery_agent_id": "cptairport",
"delivery_agent_routing_number": "CO4/CR6",
"delivery_agent_zone": "C AIRPORT ",
"original_delivery_agent_id": "cptairport",
"original_delivery_min_date": "2024-04-23T14:59:02+02:00",
"estimated_delivery_from": "2024-04-23T14:59:02+02:00",
"estimated_delivery_to": "2024-04-25T14:59:02+02:00",
"collection_before": "17:00",
"delivery_before": "17:00",
"delivery_rescheduled": null,
"disable_new_charges": false,
"external_note_count": 0,
"has_been_invoiced": false,
"is_pending": false,
"latest_tracking_event_time": "2024-07-23T13:13:45.514484Z",
"modified_by": "Ford G",
"mute_notifications": false,
"rate": 82.5,
"rate_revision_id": 942,
"default_special_request_id": 8840,
"original_rate": 82.5,
"payment_intervention_status": "",
"previous_rate": 0,
"responsible_contact_id": 4750,
"service_level_cut_off_time": "2024-07-23T17:00:00+02:00",
"service_level_name": "Door to Locker Extra Small",
"source": "api",
"pod_method": "PIN with fallback options",
"locker_provider": "KERN",
"status": "deposit-pending",
"base_rate_obj": {
"charge": "60.00",
"rate_formula_type": "per_parcel",
"total_calculated_weight": 0,
"vat_type": null,
"vat": "7.83"
},
"service_level_obj": {
"id": 33,
"code": "D2LXS - ECO",
"name": "Door to Locker Extra Small",
"description": null,
"vat_type": null,
"insurance_disabled": "1",
"collection_date": "2024-04-19 14:59:02",
"delivery_date_from": "2024-04-23T14:59:02+02:00",
"delivery_date_to": "2024-04-25T14:59:02+02:00",
"collection_cut_off_time": "2024-07-23T17:00:00+02:00"
},
"surcharge_obj": [],
"mandatory_charges_obj": [
{
"charge": "7.50",
"vat": "0.98",
"id": 29340,
"group_id": "8840",
"name": "Currency"
},
{
"charge": "15.00",
"vat": "1.96",
"id": 29341,
"group_id": "8840",
"name": "Fuel Charge"
}
],
"id": 6870624,
"custom_tracking_reference": "PUDO000501"
}
Create shipment Locker to Door (L2D)
POST https://api-pudo.co.za/shipments
The following fields are required:
- collection_address
- collection_contact
- delivery_address
- delivery_contact
- service_level_code
Request
{
"collection_address": {
"terminal_id": "CG63"
},
"special_instructions_collection": "None",
"collection_contact": {
"name": "Sender Name",
"email": "sender@gmail.com",
"mobile_number": "+27xxxxxxxxx"
},
"delivery_address": {
"type": "residential",
"entered_address": "123 Rivonia Rd, Sandown, Sandton, 2031, South Africa",
"company": "123 Rivonia Rd",
"street_address": "Rivonia Road",
"local_area": "Sandown",
"code": "2031",
"city": "Sandton",
"zone": "GP",
"country": "South Africa",
"lat": "-26.1042942",
"lng": "28.0599364"
},
"delivery_contact": {
"name": "Receiver Name",
"email": "receiver@gmail.com",
"mobile_number": "+27xxxxxxxxx"
},
"opt_in_rates": [],
"opt_in_time_based_rates": [],
"service_level_code": "L2DXS - ECO",
"collection_min_date": "2024-04-19T06:59:02.070Z",
"delivery_min_date": "2024-05-01T06:59:02.083Z"
}
Response
{
"special_instructions_collection": "None",
"opt_in_rates": "[]",
"opt_in_time_based_rates": "[]",
"service_level_code": "L2DXS - ECO",
"account_id": 142,
"collection_address_id": 2036341633,
"delivery_address_id": 2036341634,
"charged_weight": 0,
"collection_contact_id": 4752,
"delivery_contact_id": 4753,
"account_branch_id": 751,
"rate_group_id": 8842,
"all_charges_reversed": false,
"collection_branch_id": 580,
"collection_branch_name": "CPT",
"collection_agent_id": "cptairport",
"collection_agent_routing_number": "CO4/CR6",
"collection_agent_zone": "C AIRPORT ",
"original_collection_agent_id": "cptairport",
"original_collection_min_date": "2024-07-23T08:00:00+02:00",
"collection_min_date": "2024-07-23T08:00:00+02:00",
"estimated_collection": "2024-07-23T08:00:00+02:00",
"collection_cutoff_override": false,
"collection_request_id": 0,
"created_by": "",
"current_branch_id": 580,
"current_branch_name": "CPT",
"delivery_after": "08:00",
"collection_after": "08:00",
"delivery_branch_id": 751,
"delivery_branch_name": "JNB",
"delivery_agent_id": "tshifhiwa",
"delivery_agent_routing_number": "J340(S2)",
"delivery_agent_zone": "J Sandton",
"original_delivery_agent_id": "tshifhiwa",
"original_delivery_min_date": "2024-07-25T08:00:00+02:00",
"delivery_min_date": "2024-07-25T08:00:00+02:00",
"estimated_delivery_from": "2024-07-25T08:00:00+02:00",
"estimated_delivery_to": "2024-07-29T08:00:00+02:00",
"collection_before": "17:00",
"delivery_before": "17:00",
"delivery_rescheduled": null,
"disable_new_charges": false,
"external_note_count": 0,
"has_been_invoiced": false,
"is_pending": false,
"latest_tracking_event_time": "2024-07-23T13:15:28.670193Z",
"modified_by": "Ford G",
"mute_notifications": false,
"rate": 82.5,
"rate_revision_id": 942,
"default_special_request_id": 8840,
"original_rate": 82.5,
"payment_intervention_status": "",
"previous_rate": 0,
"responsible_contact_id": 4752,
"service_level_cut_off_time": "2024-07-23T17:00:00+02:00",
"service_level_name": "Locker to Door Extra Small",
"source": "api",
"pod_method": "PIN with fallback options",
"locker_provider": "KERN",
"status": "deposit-pending",
"base_rate_obj": {
"charge": "60.00",
"rate_formula_type": "per_parcel",
"total_calculated_weight": 0,
"vat_type": null,
"vat": "7.83"
},
"service_level_obj": {
"id": 28,
"code": "L2DXS - ECO",
"name": "Locker to Door Extra Small",
"description": null,
"vat_type": null,
"insurance_disabled": "1",
"collection_date": "2024-07-23T08:00:00+02:00",
"delivery_date_from": "2024-07-25T08:00:00+02:00",
"delivery_date_to": "2024-07-29T08:00:00+02:00",
"collection_cut_off_time": "2024-07-23T17:00:00+02:00"
},
"surcharge_obj": [],
"mandatory_charges_obj": [
{
"charge": "7.50",
"vat": "0.98",
"id": 29340,
"group_id": "8840",
"name": "Currency"
},
{
"charge": "15.00",
"vat": "1.96",
"id": 29341,
"group_id": "8840",
"name": "Fuel Charge"
}
],
"id": 6870625,
"custom_tracking_reference": "PUDO000502",
"pincode": "953360"
}
Create shipment Locker to Locker (L2L)
POST https://api-pudo.co.za/shipments
The following fields are required:
- collection_address
- collection_contact
- delivery_address
- delivery_contact
- service_level_code
Request
{
"collection_address": {
"terminal_id": "K067"
},
"special_instructions_collection": "None",
"collection_contact": {
"name": "Sender Name",
"email": "sender@gmail.com",
"mobile_number": "+27xxxxxxxxx"
},
"delivery_address": {
"terminal_id": "CG10"
},
"delivery_contact": {
"name": "Receiver Name",
"email": "receiver@gmail.com",
"mobile_number": "+27xxxxxxxxx"
},
"service_level_code": "L2LXS - ECO",
"collection_min_date": "2024-04-19T06:59:02.070Z",
"delivery_min_date": "2024-05-01T06:59:02.083Z"
}
Response
{
"special_instructions_collection": "None",
"service_level_code": "L2LXS - ECO",
"collection_min_date": "2024-07-23T08:00:00+02:00",
"delivery_min_date": "2024-07-25T08:00:00+02:00",
"account_id": 142,
"collection_address_id": 2036341635,
"delivery_address_id": 2036341636,
"charged_weight": 0,
"collection_contact_id": 4754,
"delivery_contact_id": 4755,
"account_branch_id": 751,
"rate_group_id": 8842,
"all_charges_reversed": false,
"collection_branch_id": 718,
"collection_branch_name": "CER",
"collection_agent_id": "fuadcer",
"collection_agent_routing_number": "CO4/CR6",
"collection_agent_zone": "CERES",
"original_collection_agent_id": "fuadcer",
"original_collection_min_date": "2024-07-23T08:00:00+02:00",
"estimated_collection": "2024-07-23T08:00:00+02:00",
"collection_cutoff_override": false,
"collection_request_id": 0,
"created_by": "",
"current_branch_id": 718,
"current_branch_name": "CER",
"delivery_after": "08:00",
"collection_after": "08:00",
"delivery_branch_id": 751,
"delivery_branch_name": "JNB",
"delivery_agent_id": "phodzo",
"delivery_agent_routing_number": "J226(S3)",
"delivery_agent_zone": "J Kikuyu",
"original_delivery_agent_id": "phodzo",
"original_delivery_min_date": "2024-07-25T08:00:00+02:00",
"estimated_delivery_from": "2024-07-25T08:00:00+02:00",
"estimated_delivery_to": "2024-07-29T08:00:00+02:00",
"collection_before": "17:00",
"delivery_before": "17:00",
"delivery_rescheduled": null,
"disable_new_charges": false,
"external_note_count": 0,
"has_been_invoiced": false,
"is_pending": false,
"latest_tracking_event_time": "2024-07-23T13:17:07.437310Z",
"modified_by": "Ford G",
"mute_notifications": false,
"opt_in_rates": "[]",
"rate": 68.75,
"rate_revision_id": 942,
"default_special_request_id": 8840,
"original_rate": 68.75,
"opt_in_time_based_rates": "[]",
"payment_intervention_status": "",
"previous_rate": 0,
"responsible_contact_id": 4754,
"service_level_cut_off_time": "2024-07-23T17:00:00+02:00",
"service_level_name": "Locker to Locker Extra Small",
"source": "api",
"pod_method": "PIN with fallback options",
"locker_provider": "KERN",
"status": "deposit-pending",
"base_rate_obj": {
"charge": "50.00",
"rate_formula_type": "per_parcel",
"total_calculated_weight": 0,
"vat_type": null,
"vat": "6.52"
},
"service_level_obj": {
"id": 23,
"code": "L2LXS - ECO",
"name": "Locker to Locker Extra Small",
"description": null,
"vat_type": null,
"insurance_disabled": "1",
"collection_date": "2024-07-23T08:00:00+02:00",
"delivery_date_from": "2024-07-25T08:00:00+02:00",
"delivery_date_to": "2024-07-29T08:00:00+02:00",
"collection_cut_off_time": "2024-07-23T17:00:00+02:00"
},
"surcharge_obj": [],
"mandatory_charges_obj": [
{
"charge": "6.25",
"vat": "0.82",
"id": 29340,
"group_id": "8840",
"name": "Currency"
},
{
"charge": "12.50",
"vat": "1.63",
"id": 29341,
"group_id": "8840",
"name": "Fuel Charge"
}
],
"id": 6870626,
"custom_tracking_reference": "PUDO000503",
"pincode": "633857"
}
Cancelling a shipment
PUT https://api-pudo.co.za/shipments/{id}
The following field(s) are required:
- status
Request
{
"status": "cancelled"
,
"metaData": {
"tracking_info": {
"message": "Dog too scary"
}
},
"service_level_id": 3
}
Response
{
"id": 6870619,
"account_id": 142,
"account_branch_id": 751,
"collection_address_id": 2036341622,
"collection_contact_id": 4740,
"delivery_contact_id": 4741,
"delivery_address_id": 2036341623,
"rate_group_id": 8842,
"default_special_request_id": 8840,
"all_charges_reversed": 0,
"status": "cancelled",
"charged_weight": "0.00",
"payment_intervention_status": "",
"short_tracking_reference": "8SNVSS",
"time_created": "2024-07-19 16:55:26",
"time_modified": "2024-07-19 17:41:00",
"latest_tracking_event_time": "2024-07-19 11:41:00",
"modified_by": "Ford G",
"created_by": "",
"source": "api",
"collection_min_date": "2024-07-19 14:00:00",
"collection_after": "08:00:00",
"collection_before": "17:00:00",
"delivery_min_date": "2024-07-27 00:00:00",
"delivery_after": "08:00:00",
"delivery_before": "17:00:00",
"delivery_rescheduled": null,
"collection_request_id": "0",
"delivery_agent_id": "tshifhiwa",
"collection_agent_id": "cptairport",
"original_delivery_agent_id": "tshifhiwa",
"original_collection_agent_id": "cptairport",
"collection_agent_zone": "C AIRPORT ",
"delivery_agent_zone": "J Sandton",
"delivery_read_by_driver_time": null,
"collection_read_by_driver_time": null,
"responsible_contact_id": 4740,
"proof_of_delivery_pin_hashed": null,
"collected_date": null,
"delivered_date": null,
"is_return": null,
"service_level_code": "L2DXS - ECO",
"service_level_id": 3,
"service_level_name": "Locker to Door Extra Small",
"shipment_import_id": 0,
"rate": "600.00",
"original_rate": "600.00",
"previous_rate": "0.00",
"declared_value": "0.000000",
"opt_in_rates": "[]",
"opt_in_time_based_rates": "[38207]",
"special_instructions_collection": "None",
"special_instructions_delivery": null,
"estimated_collection": "2024-07-19 14:00:00",
"estimated_delivery_from": "2024-07-27 00:00:00",
"estimated_delivery_to": "2024-07-27 00:00:00",
"is_pending": 0,
"current_branch_id": 580,
"current_branch_name": "CPT",
"collection_branch_id": 580,
"collection_branch_name": "CPT",
"delivery_branch_id": 751,
"delivery_branch_name": "JNB",
"transient_branch_ids": null,
"service_level_cut_off_time": "2024-07-19 23:00:00",
"collection_cutoff_override": "0",
"total_note_count": null,
"external_note_count": 0,
"disable_new_charges": "0",
"mute_notifications": "0",
"pod_method": "PIN with fallback options",
"has_been_invoiced": "0",
"tracking_events": null,
"custom_tracking_reference": "PUDO000496",
"customer_reference": null,
"collection_agent_routing_number": "CO4/CR6",
"delivery_agent_routing_number": "J340(S2)",
"original_collection_min_date": "2024-07-19 14:00:00",
"original_delivery_min_date": "2024-07-27 00:00:00",
"rate_revision_id": 942,
"base_rate_obj": {
"charge": "60.00",
"rate_formula_type": "per_parcel",
"total_calculated_weight": 0,
"vat_type": null,
"vat": "7.83"
},
"service_level_obj": {
"id": 28,
"code": "L2DXS - ECO",
"name": "Locker to Door Extra Small",
"description": null,
"vat_type": null,
"insurance_disabled": "1",
"collection_date": "2024-07-19T08:00:00+02:00",
"delivery_date_from": "2024-07-27",
"delivery_date_to": "2024-07-27",
"collection_cut_off_time": "2024-07-19T17:00:00+02:00"
},
"rate_adjustments_obj": null,
"time_based_rate_adjustments_obj": [
{
"charge": "517.50",
"vat": "67.50",
"id": 38207,
"group_id": 8840,
"name": "Saturday delivery"
}
],
"surcharge_obj": [],
"mandatory_charges_obj": [
{
"charge": "7.50",
"vat": "0.98",
"id": 29340,
"group_id": "8840",
"name": "Currency"
},
{
"charge": "15.00",
"vat": "1.96",
"id": 29341,
"group_id": "8840",
"name": "Fuel Charge"
}
],
"isAmazon": 0,
"amazon_ship_sort": null,
"amazon_ship_shipmethod": null,
"saved_to_shiplogic": 2,
"shiplogic_custom_tracking_reference": null,
"shiplogic_create_shipment_error": null,
"kern_status": 1,
"kern_error_message": null,
"locker_provider": "KERN"
}
Returning a shipment
POST https://api-pudo.co.za/shipments
The following field(s) are required:
- is_return
- custom_tracking_reference
Request
{
"is_return": true,
"custom_tracking_reference": "PUDOD0005144"
}
Response
{
"service_level_code": "LSF",
"rate_group_id": 8854,
"status": "submitted",
"custom_tracking_reference": "PUDOD0005159-R",
"account_id": 142,
"is_return": true,
"collection_address_id": 2036337806,
"delivery_address_id": 2036337807,
"charged_weight": 2.4,
"collection_contact_id": 2234,
"delivery_contact_id": 2235,
"account_branch_id": 751,
"all_charges_reversed": false,
"collection_branch_id": 580,
"collection_branch_name": "CPT",
"collection_agent_id": "cptmitchellsplain",
"collection_agent_routing_number": "CO4/CR6",
"collection_agent_zone": "CPT MITCHELLS PLAIN ",
"original_collection_agent_id": "cptmitchellsplain",
"original_collection_min_date": "2024-08-22 08:00:00",
"collection_min_date": "2024-08-22T08:00:00.000Z",
"estimated_collection": "2024-08-22 08:00:00",
"collection_cutoff_override": false,
"collection_request_id": 0,
"created_by": "gford123",
"current_branch_id": 580,
"current_branch_name": "CPT",
"delivery_after": "08:00",
"collection_after": "08:00",
"delivery_branch_id": 751,
"delivery_branch_name": "JNB",
"delivery_agent_id": "phodzo",
"delivery_agent_routing_number": "J226(S3)",
"delivery_agent_zone": "J Kikuyu",
"original_delivery_agent_id": "phodzo",
"original_delivery_min_date": null,
"delivery_min_date": "2024-08-21T08:06:58.872Z",
"estimated_delivery_from": null,
"estimated_delivery_to": null,
"collection_before": "17:00",
"delivery_before": "17:00",
"delivery_rescheduled": null,
"disable_new_charges": false,
"external_note_count": 0,
"has_been_invoiced": false,
"is_pending": false,
"latest_tracking_event_time": "2024-08-21T06:06:58.833138Z",
"modified_by": "Ford G",
"mute_notifications": false,
"opt_in_rates": "[]",
"rate": 75.625,
"rate_revision_id": 945,
"default_special_request_id": 8834,
"original_rate": 75.625,
"opt_in_time_based_rates": "[]",
"payment_intervention_status": "",
"previous_rate": 0,
"responsible_contact_id": 2234,
"service_level_cut_off_time": "1970-01-01T02:00:00+02:00",
"service_level_name": "Local Sameday Flyer",
"source": "api",
"pod_method": "PIN with fallback options",
"time_created": "2024-08-21T06:06:58.833176Z",
"locker_provider": null,
"base_rate_obj": {
"charge": "55.00",
"rate_formula_type": "per_kg",
"total_calculated_weight": 2.4,
"vat_type": null,
"vat": "7.17"
},
"service_level_obj": {
"id": 6,
"code": "LSF",
"name": "Local Sameday Flyer",
"description": null,
"vat_type": null,
"insurance_disabled": null,
"collection_date": "2024-08-22 08:00:00",
"delivery_date_from": null,
"delivery_date_to": null,
"collection_cut_off_time": "1970-01-01T02:00:00+02:00"
},
"surcharge_obj": [],
"mandatory_charges_obj": [
{
"charge": "6.88",
"vat": "0.90",
"id": 29306,
"group_id": "8834",
"name": "Currency"
},
{
"charge": "13.75",
"vat": "1.79",
"id": 29307,
"group_id": "8834",
"name": "Fuel Charge"
}
],
"id": 606
}
Getting all shipments
GET https://api-pudo.co.za/shipments
The following parameter(s) can be used to filter out results:
- ?filter={"short_tracking_reference": "NLEB4R"}
- ?filter={"declared_value": "false"}
- ?filter={"delivery_rescheduled": "false"}
- ?filter={"has_pod": "true"}
- ?filter={"without_rates": "true"}
- ?filter={"account_id": "91"}
When filtering out date you may use this query parameter
?filter={"account_id":"1"}
Listed here below are the following options available for the date_filter and absolute_query
Date filter: time_created, collected_date, delivered_date, estimated_collection, estimated_delivery_from, estimated_delivery_to
Absolute query: last day, last 2 days, last 5 days, last 7 days, last 14 days, last 30 days
Response
[
{
"id": 1,
"account_id": 1,
"status": "delivery-failed-attempt",
"payment_intervention_status": "",
"time_created": "2023-07-25 15:35:14",
"time_modified": "2023-07-26 09:02:44",
"delivery_agent_id": "29321",
"collection_agent_id": "29321",
"is_return": null,
"total_note_count": null,
"external_note_count": 0,
"pod_method": "PIN with fallback options",
"has_been_invoiced": "0",
"custom_tracking_reference": null,
"has_pod_files": 0,
"collection_address_id": 20363401,
"delivery_address_id": 2036335885,
"service_level_name": "Economy Regional",
"service_level_code": "ECOR",
"saved_to_shiplogic": null,
"delivery_rescheduled": null,
"collection_address": {
"id": 20363401,
"entered_address": "143 street, Durban, KZN, South Africa",
"geo_local_area": null,
"local_area": "Durban"
},
"delivery_address": {
"id": 2036335885,
"entered_address": "Boland St, Charleston Hill, Paarl, 7646, South Africa",
"geo_local_area": "Charleston Hill",
"local_area": "Charleston Hill"
},
"account_name": "Mark (maki)",
"account": {
"id": 1,
"name": "Mark (maki)",
"account_code": "TES117",
"default_collection_address": null,
"billing_address": {
"id": 1,
"account_id": 1,
"city": "CEBU CITY (CAPITAL)",
"code": "6000",
"company": "TEST",
"country": "Philippines",
"local_area": "CEBU CITY (CAPITAL)",
"street_address": "BROOKSIDE SALINAS DRIVE EXTENSION",
"zone": ""
},
"billing_contact": {
"id": 1,
"account_id": 1,
"email": "billing@gmail.com",
"mobile_number": "+27xxxxxxxxx",
"name": "Billing Name"
},
"branch": null,
"additional_info": null,
"account_tags": null
}
}
]
Getting shipment label/waybill PDF
GET https://api-pudo.co.za/generate/waybill/297
This endpoint requires parameter(s) api_key and returns a signed URL to a PDF on a AWS S3 bucket.
https://api-pudo.co.za/generate/waybill/297?api_key=1678|E18b6NLdJ22h2BxMiu3atVlMlaZUD9ZpUhi1Mw6aee43d97eGetting shipment sticker label
GET https://api-pudo.co.za/generate/sticker/297
This endpoint requires api_key and returns a signed URL to a PDF on a AWS S3 bucket.
https://api-pudo.co.za/generate/sticker/297?api_key=1678|E18b6NLdJ22h2BxMiu3atVlMlaZUD9ZpUhi1Mw6aee43d97eTracking and PODs
The PUDO API provides detailed tracking information to ensure users are always informed about the status of their shipment(s)
Tracking a shipment (By Parcel)
GET https://api-pudo.co.za/tracking/shipments
This endpoint requires parameter(s) parcel_id .
https://api-pudo.co.za/tracking/shipments?parcel_id=1287Response
{
"shipment_id": 6870622,
"custom_tracking_reference": "PUDO000499",
"status": "cancelled",
"shipment_time_created": "2024-07-19 17:02:12",
"shipment_time_modified": "2024-07-19 17:39:36",
"shipment_collected_date": null,
"shipment_delivered_date": null,
"collection_from": "Gert Venter",
"delivery_to": {
"id": 4747,
"created_at": "2024-07-19 17:02:12",
"updated_at": "2024-07-19 17:02:12",
"name": "Receiver Name",
"email": "receiver@gmail.com",
"mobile_number": "+27xxxxxxxx"
},
"collection_hub": "CER",
"delivery_hub": "JNB",
"service_level_code": "L2LXS - ECO",
"tracking_events": [
{
"id": 5920,
"date": "2024-07-19 11:02:25.210062",
"message": "",
"shipment_id": 6870622,
"parcel_id": 2172,
"source": "Ford G",
"status": "deposit-pending",
"location": ""
},
{
"id": 5919,
"date": "2024-07-19 11:02:25.209971",
"message": "",
"shipment_id": 6870622,
"parcel_id": 2172,
"source": "Ford G",
"status": "submitted",
"location": ""
}
]
}
Tracking a shipment (By Shipment)
GET https://api-pudo.co.za/tracking/shipments
This endpoint requires parameters(s) include_parcels and id .
https://api-pudo.co.za/tracking/shipments?include_parcels=false&id=983Response
{
"shipment_id": 983,
"custom_tracking_reference": "PUDO000404",
"status": "collected",
"shipment_time_created": "2024-04-19 19:11:53",
"shipment_time_modified": "2024-05-13 20:50:02",
"shipment_collected_date": null,
"shipment_delivered_date": null,
"collection_from": "Gert Venter",
"delivery_to": {
"id": 2880,
"created_at": "2024-04-19 19:11:53",
"updated_at": "2024-04-19 19:11:53",
"name": "Receiver Name",
"email": "receiver@gmail.com",
"mobile_number": "+27xxxxxxxxx"
},
"collection_hub": "CPT",
"delivery_hub": "CPT",
"service_level_code": "D2LXS - ECO",
"tracking_events": [
{
"id": 4228,
"date": "2024-04-30 05:44:37.000000",
"message": null,
"shipment_id": 983,
"parcel_id": 0,
"source": "Ford G",
"status": "cancelled",
"location": ""
}
]
}
Tracking a shipment (By Shipment Waybill)
GET https://api-pudo.co.za/tracking/shipments/public?waybill=PUDO000404
This endpoint requires parameter(s) waybill .
https://api-pudo.co.za/tracking/shipments/public?waybill=PUDO000404Response
{
"shipment_id": 984,
"custom_tracking_reference": "PUDO000405",
"status": false,
"shipment_time_created": "2024-04-23 21:18:56",
"shipment_time_modified": "2024-04-23 21:18:58",
"shipment_collected_date": null,
"shipment_delivered_date": null,
"collection_from": "Gert Venter",
"delivery_to": {
"id": 2882,
"created_at": "2024-04-23 21:18:56",
"updated_at": "2024-04-23 21:18:56",
"name": "test",
"email": "test@gmai.com",
"mobile_number": "0954215265"
},
"collection_hub": "JNB",
"delivery_hub": "CPT",
"service_level_code": "OVN",
"tracking_events": []
}
Tracking a shipment (By Shipment Status)
GET https://api-pudo.co.za/tracking/shipments?status=delivered
This endpoint requires parameter(s) status .
https://api-pudo.co.za/tracking/shipments?status=deliveredResponse
[
{
"shipment_id": 99,
"custom_tracking_reference": "allel123",
"status": "cancelled",
"shipment_time_created": "2023-11-21 16:59:12",
"shipment_time_modified": "2023-11-30 20:27:57",
"shipment_collected_date": null,
"shipment_delivered_date": null,
"collection_from": "Gert Venter",
"delivery_to": {
"id": 880,
"created_at": "2023-11-21 22:59:12",
"updated_at": "2023-11-21 22:59:12",
"name": "test",
"email": "testng.test@gmail.com",
"mobile_number": "0954215265"
},
"collection_hub": "JNB",
"delivery_hub": "JNB",
"service_level_code": "LOX",
"tracking_events": [
{
"id": 1239,
"date": "2023-12-01 00:27:56.000000",
"message": "Dog too scary",
"shipment_id": 99,
"parcel_id": 0,
"source": "test",
"status": "cancelled",
"location": ""
},
{
"id": 894,
"date": "2023-11-21 22:59:12.000000",
"message": "",
"shipment_id": 99,
"parcel_id": 0,
"source": "Greg",
"status": "collection-assigned",
"location": ""
},
{
"id": 893,
"date": "2023-11-21 22:59:12.000000",
"message": "",
"shipment_id": 99,
"parcel_id": 0,
"source": "Greg",
"status": "submitted",
"location": ""
}
]
}
]
Tracking a shipment (By Parcel Barcode)
GET https://api-pudo.co.za/tracking/shipments/public?tracking_reference=PUDO000486_001
This endpoint requires parameter(s) tracking_reference .
https://api-pudo.co.za/tracking/shipments/public?tracking_reference=PUDO000486_001Response
{
"shipment_id": 6870609,
"custom_tracking_reference": "PUDO000486",
"status": false,
"shipment_time_created": "2024-07-15 13:02:14",
"shipment_time_modified": "2024-07-15 13:02:23",
"shipment_collected_date": null,
"shipment_delivered_date": null,
"collection_from": "Gert Venter",
"delivery_to": {
"id": 4721,
"created_at": "2024-07-15 13:02:14",
"updated_at": "2024-07-15 13:02:14",
"name": "test",
"email": "test@gmai.com",
"mobile_number": "0954215265"
},
"collection_hub": "CER",
"delivery_hub": "JNB",
"service_level_code": "L2LXS - ECO",
"tracking_events": [
{
"id": 5892,
"date": "2024-07-15 07:02:23.495234",
"message": "",
"shipment_id": 6870609,
"parcel_id": 2159,
"source": "Ford G",
"status": "deposit-pending",
"location": "",
"tracking_reference": "PUDO000486_001"
},
{
"id": 5891,
"date": "2024-07-15 07:02:23.495157",
"message": "",
"shipment_id": 6870609,
"parcel_id": 2159,
"source": "Ford G",
"status": "submitted",
"location": "",
"tracking_reference": "PUDO000486_001"
}
]
}
Getting POD images for a shipment
GET https://api-pudo.co.za/shipments/pod/images?shipment_id=983
This endpoint requires parameter(s) shipment_id .
https://api-pudo.co.za/shipments/pod/images?shipment_id=983Billing
The Billing section offers comprehensive billing features to help you manage your shipping costs efficiently. By using the billing features of the PUDO API, you can simplify your financial processes.
Getting an account statement
GET https://api-pudo.co.za/billing/statements?start_date=2020-11-01&end_date=2025-12-01
This endpoint requires parameter(s) start_date and end_date .
https://api-pudo.co.za/billing/statements?start_date=2020-11-01&end_date=2025-12-01Response
{
"url": "sample-aws-s3-signed-url-here",
"filename": "1721439373.pdf",
"bucket": "tcg-users-uploads"
}
Getting credit notes
GET https://api-pudo.co.za/billing/credit-notes
Response
[
{
"id": 40,
"account_id": 708,
"credit_note_number": null,
"date": "2024-05-13 13:13:15",
"ex_vat_zero_rated": 0,
"number_of_shipments": 2,
"shipment_ids": "[null,106]",
"sub_total": "2426.07",
"time_created": "2024-05-13 21:13:15",
"time_modified": "2024-05-13 21:13:15",
"total_amount": "2589.50",
"validated": "success",
"vat": "163.43",
"deleted_at": null
}
]
Getting Invoices
GET https://api-pudo.co.za/billing/invoices
Response
[
{
"id": 1,
"account_id": 105,
"ex_vat_zero_rated": 0,
"invoice_date": "2023-03-14 22:44:51",
"invoice_number": 1000,
"number_of_shipments": 4,
"outstanding_amount": "0.00",
"payment_date": "2023-03-14 22:45:02",
"status": "paid",
"sub_total": "123.00",
"time_created": "2023-03-16 22:46:19",
"time_modified": "2023-04-20 19:20:28",
"total_amount": "141.45",
"validated": "success",
"vat": "18.45",
"deleted_at": null,
"metadata": {
"tracking_references": []
}
}
]
Getting Items for Invoice
GET https://api-pudo.co.za/billing/invoices/items
Response
[
{
"id": 2132,
"import_payment_id": null,
"account_id": 142,
"amount": "600.00",
"credit_note_id": null,
"description": "",
"doc_display_id": null,
"effective_date": "2024-07-19 11:41:00",
"ex_vat_zero_rated": "0.00",
"has_been_reversed": 0,
"imported_payment_id": null,
"invoice_id": null,
"invoiceable": 1,
"modified_by": "Ford G",
"reversal_of": 2125,
"shipment_id": 6870619,
"source": "api",
"sub_type": "",
"time_created": "2024-07-19 17:41:00",
"time_modified": "2024-07-19 17:41:00",
"transaction_date": "2024-07-19",
"type": "shipping-charge-reversal",
"vat": "90.00",
"deleted_at": null,
"allocation": "credit",
"estimated_weight": "2",
"charged_weight": "2",
"parcels": 1,
"shipment": {
"id": 6870619,
"account_id": 142,
"account_branch_id": 751,
"collection_address_id": 2036341622,
"collection_contact_id": 4740,
"delivery_contact_id": 4741,
"delivery_address_id": 2036341623,
"rate_group_id": 8842,
"default_special_request_id": 8840,
"all_charges_reversed": 0,
"status": "cancelled",
"charged_weight": "0.00",
"payment_intervention_status": "",
"short_tracking_reference": "8SNVSS",
"time_created": "2024-07-19 16:55:26",
"time_modified": "2024-07-19 17:41:00",
"latest_tracking_event_time": "2024-07-19 11:41:00",
"modified_by": "Ford G",
"created_by": "",
"source": "api",
"collection_min_date": "2024-07-19 14:00:00",
"collection_after": "08:00:00",
"collection_before": "17:00:00",
"delivery_min_date": "2024-07-27 00:00:00",
"delivery_after": "08:00:00",
"delivery_before": "17:00:00",
"delivery_rescheduled": null,
"collection_request_id": "0",
"delivery_agent_id": "tshifhiwa",
"collection_agent_id": "cptairport",
"original_delivery_agent_id": "tshifhiwa",
"original_collection_agent_id": "cptairport",
"collection_agent_zone": "C AIRPORT ",
"delivery_agent_zone": "J Sandton",
"delivery_read_by_driver_time": null,
"collection_read_by_driver_time": null,
"responsible_contact_id": 4740,
"proof_of_delivery_pin_hashed": null,
"collected_date": null,
"delivered_date": null,
"is_return": null,
"service_level_code": "L2DXS - ECO",
"service_level_id": null,
"service_level_name": "Locker to Door Extra Small",
"shipment_import_id": 0,
"rate": "600.00",
"original_rate": "600.00",
"previous_rate": "0.00",
"declared_value": "0.000000",
"opt_in_rates": "[]",
"opt_in_time_based_rates": "[38207]",
"special_instructions_collection": "None",
"special_instructions_delivery": null,
"estimated_collection": "2024-07-19 14:00:00",
"estimated_delivery_from": "2024-07-27 00:00:00",
"estimated_delivery_to": "2024-07-27 00:00:00",
"is_pending": 0,
"current_branch_id": 580,
"current_branch_name": "CPT",
"collection_branch_id": 580,
"collection_branch_name": "CPT",
"delivery_branch_id": 751,
"delivery_branch_name": "JNB",
"transient_branch_ids": null,
"service_level_cut_off_time": "2024-07-19 23:00:00",
"collection_cutoff_override": "0",
"total_note_count": null,
"external_note_count": 0,
"disable_new_charges": "0",
"mute_notifications": "0",
"pod_method": "PIN with fallback options",
"has_been_invoiced": "0",
"tracking_events": null,
"custom_tracking_reference": "PUDO000496",
"customer_reference": null,
"collection_agent_routing_number": "CO4/CR6",
"delivery_agent_routing_number": "J340(S2)",
"original_collection_min_date": "2024-07-19 14:00:00",
"original_delivery_min_date": "2024-07-27 00:00:00",
"rate_revision_id": 942,
"base_rate_obj": {
"charge": "60.00",
"rate_formula_type": "per_parcel",
"total_calculated_weight": 0,
"vat_type": null,
"vat": "7.83"
},
"service_level_obj": {
"id": 28,
"code": "L2DXS - ECO",
"name": "Locker to Door Extra Small",
"description": null,
"vat_type": null,
"insurance_disabled": "1",
"collection_date": "2024-07-19T08:00:00+02:00",
"delivery_date_from": "2024-07-27",
"delivery_date_to": "2024-07-27",
"collection_cut_off_time": "2024-07-19T17:00:00+02:00"
},
"rate_adjustments_obj": null,
"time_based_rate_adjustments_obj": [
{
"charge": "517.50",
"vat": "67.50",
"id": 38207,
"group_id": 8840,
"name": "Saturday delivery"
}
],
"surcharge_obj": [],
"mandatory_charges_obj": [
{
"charge": "7.50",
"vat": "0.98",
"id": 29340,
"group_id": "8840",
"name": "Currency"
},
{
"charge": "15.00",
"vat": "1.96",
"id": 29341,
"group_id": "8840",
"name": "Fuel Charge"
}
],
"isAmazon": 0,
"amazon_ship_sort": null,
"amazon_ship_shipmethod": null,
"saved_to_shiplogic": 2,
"shiplogic_custom_tracking_reference": null,
"shiplogic_create_shipment_error": null,
"kern_status": 1,
"kern_error_message": null,
"locker_provider": "KERN"
},
"rates": {
"base_rate": "600.00",
"surcharges": 0,
"rate_adjustments": 2105,
"time_based_rate_adjustments": 0,
"extras": 0,
"vat": 352.83,
"sub_total": 2705,
"total_amount": 3057.83
}
}
]
Getting Billing Transactions
GET https://api-pudo.co.za/billing/transactions
Response
[
{
"id": 54,
"import_payment_id": null,
"account_id": 142,
"amount": "-110.00",
"credit_note_id": null,
"description": "",
"doc_display_id": null,
"effective_date": "2023-10-12 11:44:13",
"ex_vat_zero_rated": "0.00",
"has_been_reversed": 0,
"imported_payment_id": null,
"invoice_id": null,
"invoiceable": 1,
"modified_by": "Philip Tester12",
"reversal_of": null,
"shipment_id": 74,
"source": "api",
"sub_type": "",
"time_created": "2023-10-12 13:44:13",
"time_modified": "2023-10-12 13:44:13",
"transaction_date": "2023-10-12",
"type": "shipping-charge",
"vat": "16.50",
"deleted_at": null,
"allocation": "debit",
"account_code": "GERTV160",
"shipment": {
"id": 74,
"account_id": 142,
"account_branch_id": 751,
"collection_address_id": 2036335992,
"collection_contact_id": 819,
"delivery_contact_id": 820,
"delivery_address_id": 2036335993,
"rate_group_id": 8754,
"default_special_request_id": null,
"all_charges_reversed": 0,
"status": "collection-assigned",
"charged_weight": "3.00",
"payment_intervention_status": "",
"short_tracking_reference": "P9OFJS",
"time_created": "2023-10-12 13:44:13",
"time_modified": "2023-10-12 13:44:13",
"latest_tracking_event_time": "2023-10-12 11:44:13",
"modified_by": "Philip Tester12",
"created_by": "Philip Tester12",
"source": "api",
"collection_min_date": "2023-10-13 10:00:00",
"collection_after": "08:00:00",
"collection_before": "17:00:00",
"delivery_min_date": null,
"delivery_after": "08:00:00",
"delivery_before": "17:00:00",
"delivery_rescheduled": null,
"collection_request_id": "0",
"delivery_agent_id": "jmarshalltown",
"collection_agent_id": "fashiondistrict",
"original_delivery_agent_id": "jmarshalltown",
"original_collection_agent_id": "fashiondistrict",
"collection_agent_zone": "J Fashion District",
"delivery_agent_zone": "J Marshalltown",
"delivery_read_by_driver_time": null,
"collection_read_by_driver_time": null,
"responsible_contact_id": 819,
"proof_of_delivery_pin_hashed": null,
"collected_date": null,
"delivered_date": null,
"is_return": null,
"service_level_code": "OVN",
"service_level_id": 1,
"service_level_name": "Overnight",
"shipment_import_id": 0,
"rate": "110.00",
"original_rate": "110.00",
"previous_rate": "0.00",
"declared_value": "0.000000",
"opt_in_rates": "[]",
"opt_in_time_based_rates": "[]",
"special_instructions_collection": "None",
"special_instructions_delivery": null,
"estimated_collection": "2023-10-13 10:00:00",
"estimated_delivery_from": null,
"estimated_delivery_to": null,
"is_pending": 0,
"current_branch_id": 751,
"current_branch_name": "JNB",
"collection_branch_id": 751,
"collection_branch_name": "JNB",
"delivery_branch_id": 751,
"delivery_branch_name": "JNB",
"transient_branch_ids": null,
"service_level_cut_off_time": "1970-01-01 02:00:00",
"collection_cutoff_override": "0",
"total_note_count": null,
"external_note_count": 0,
"disable_new_charges": "0",
"mute_notifications": "0",
"pod_method": "PIN with fallback options",
"has_been_invoiced": "0",
"tracking_events": null,
"custom_tracking_reference": null,
"customer_reference": null,
"collection_agent_routing_number": "J166(J9)",
"delivery_agent_routing_number": "J257(J9)",
"original_collection_min_date": "2023-10-13 10:00:00",
"original_delivery_min_date": null,
"rate_revision_id": 913,
"base_rate_obj": {
"charge": "110.00",
"rate_formula_type": "per_kg",
"total_calculated_weight": 3,
"vat_type": null,
"vat": "14.35"
},
"service_level_obj": {
"id": 1,
"code": "OVN",
"name": "Overnight",
"description": null,
"vat_type": null,
"insurance_disabled": null,
"collection_date": "2023-10-13T08:00:00+00:00",
"delivery_date_from": null,
"delivery_date_to": null,
"collection_cut_off_time": "1970-01-01T00:00:00+00:00"
},
"rate_adjustments_obj": null,
"time_based_rate_adjustments_obj": null,
"surcharge_obj": [],
"mandatory_charges_obj": null,
"isAmazon": 0,
"amazon_ship_sort": null,
"amazon_ship_shipmethod": null,
"saved_to_shiplogic": null,
"shiplogic_custom_tracking_reference": null,
"shiplogic_create_shipment_error": null,
"kern_status": null,
"kern_error_message": null,
"locker_provider": null
}
}
]
Lockers
Integrating smart lockers into your delivery network is a straightforward process with the PUDO API.
Getting lockers
GET https://api-pudo.co.za/lockers-data
Response
[
{
"code": "CG54",
"name": "Sasol Rivonia Uplifted",
"latitude": "-26.049703",
"longitude": "28.059084",
"openinghours": [
{
"day": "Monday",
"open_time": "08:00:00",
"close_time": "17:00:00"
},
{
"day": "Tuesday",
"open_time": "08:00:00",
"close_time": "17:00:00"
},
{
"day": "Wednesday",
"open_time": "08:00:00",
"close_time": "17:00:00"
},
{
"day": "Thursday",
"open_time": "08:00:00",
"close_time": "17:00:00"
},
{
"day": "Friday",
"open_time": "08:00:00",
"close_time": "17:00:00"
},
{
"day": "Saturday",
"open_time": "08:00:00",
"close_time": "13:00:00"
},
{
"day": "Sunday",
"open_time": "08:00:00",
"close_time": "13:00:00"
},
{
"day": " Public Holidays",
"open_time": "08:00:00",
"close_time": "13:00:00"
}
],
"address": "375 Rivonia Rd, Rivonia, Sandton, 2191, South Africa",
"type": {
"id": 2,
"name": "Locker"
},
"place": {
"placeNumber": "",
"town": "Sandton",
"postalCode": "2191"
},
"lstTypesBoxes": [
{
"id": 3,
"name": "V4-L",
"type": "13",
"width": 41,
"height": 41,
"length": 60,
"weight": 15
},
{
"id": 4,
"name": "V4-S",
"type": "11",
"width": 41,
"height": 8,
"length": 60,
"weight": 5
},
{
"id": 5,
"name": "V4-XS",
"type": "10",
"width": 17,
"height": 8,
"length": 60,
"weight": 2
},
{
"id": 6,
"name": "V4-M",
"type": "12",
"width": 41,
"height": 19,
"length": 60,
"weight": 10
},
{
"id": 7,
"name": "V4-XL",
"type": "14",
"width": 41,
"height": 69,
"length": 60,
"weight": 20
}
]
}
]