ePOD APIs

1 Introduction
2 Description
3 Base URLs
4 Submit ePOD
5 Update ePOD
6 Approve ePOD
7 Dispute ePOD

Introduction

ePOD (Electronic Proof Of Delivery) is use to insure that the shipment is delivered successfully or not.
It help to get the payment process faster than the manual method.

Description

1	Primary atributes	Data type	description
2	successfully_delivered	Boolean	status of the EPOD
3	receiver	Object	receiver details
4	name	String	name of receiver
5	phone_no	String	phone no. of receiver
6	received_at	Integer	time epoch in seconds
7	submitter	Object	submitter details
8	name	String	name of submitter
9	type	String	type of submitter TRN=Transporter, CEE=Consignee, CNR=Consignor, DRV=Driver
10	phone_no	String	phone no of submitter
11	materials	Array	material details
12	name	String	material name same as trip creation material name
13	expected_quantity	Integer	expected no. of quantity deliver
14	successfully_delivered_quantity	integer	successful deliver quantity
15	quantity_unit	String	unit of the items same as given when trip is created BAG, KG, TON
16	issues	Array	describe the issue of material
17	type	String	issue type based on config data CUT, CLOT
18	quantity	Integer	quantity if material in unit which has issues
19	issue_quantity_unit	String	unit of the items same as given when trip is created BAG, KG, TON

Base URLs

Integration/Sandbox: https://integration-api.freighttiger.com/integration/epod-service/v1/integration

Production: https://api.freighttiger.com/api/epod-service/v1/integration

Submit ePOD

Note: Unique Id should be the same as invoice number (current version)

URL : <BASE_URL>/trips/unique_id/<UNIQUE_ID>/submit-pod
Method: “POST“
Headers: {“token“:”<access token for the company>”}

{
  "successfully_delivered": false,
  "receiver": {
    "name": "Raj",
    "phone_no": "1234567890",
    "received_at": 1628139271
  },
  "submitter": {
    "name": "Prakash A.",
    "type": "CEE",
    "phone_no": "1234567890"
  },
  "materials": [
    {
      "name": "Cement",
      "expected_quantity": 20,
      "successfully_delivered_quantity": 8,
      "quantity_unit": "BAG",
      "issues": [
        {
          "type": "CUT",
          "quantity": 2,
          "issue_quantity_unit": "BAG"
        }
      ]
    }
  ]
}

Update ePOD

Can update all the value

URL: <BASE_URL>/trips/unique_id/<UNIQUE_ID>/pod-submissions/<SUBMISSION_ID>
Method: “PUT“
Headers: {“token“:”<access token for the company>”}
Request Body: same as the submit EPOD payload

Approve ePOD

URL: <BASE_URL>/trips/unique_id/<UNIQUE_ID>/pod-submissions/<SUBMISSION_ID>/approve
Method: “PUT“
Headers: {“token“:”<access token for the company>”}

{
   "verifier_name": "Raj", // null or blank allowed
   "verifier_phone_no": "1234567890", // null or blank allowed
   "verifier_email": "raj@example.com", // null or blank allowed
   "verifier_comment": "this is a comment", // null or blank allowed
    “verifier_type”: “CEE” // null or blank allowed
}

{
  "type": "object",
  "properties": {
    "verifier_name": {
      "type": "string"
    },
    "verifier_phone_no": {
      "type": "string"
    },
    "verifier_email": {
      "type": "string"
    },
    "verifier_comment": {
      "type": "string"
    },
    "verifier_type": {
      "type": "string"
    }
  }
}

Dispute ePOD

URL: <BASE_URL>/trips/unique_id/<UNIQUE_ID>/pod-submissions/<SUBMISSION_ID>/dispute
Method: “PUT“
Headers: {“token“:”<access token for the company>”}
Request Body: same as the approve EPOD payload