Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
minLevel1
maxLevel7

...

Code Block
languagejson
{
  "provider": "Freight Tiger",
  "event": {
    "name": "epod.submitted",
    "timestamp": 1630992878
  },
  "trip_id": "3768333",
  "unique_id": "3768333-1630992859-717126", //FeedUniqueID
  "invoice_no": "3001001371",
  "any_deliveries_pending": true, // If more submissions allowed, this is set to true
  "submitted_by": {
    "email": null,
    "username": "Raj",
    "role": "TRN", // TRN=Transporter, CEE=Consignee, CNR=Consignor, DRV=Driver
    "phone_number": "8951204620",
    "comment": "Comments from Submitter"
  },
  "submitted_at": 1630992877, //epoch in seconds
  "submission_id": "SUB-6e0de09e-e83c-4ddd-8d94-9d6df5563f05",
  "channel": "WEB", // WEB | IVR | APP | API
  "approval_url": "https://integration.freighttiger.com/v5/epod/divergence?uid=POD-438c6392-b257-420d-b8f7-efd0255d0cfc&trip_id=3768333",
  "receiver_phone_number": "9876543210",
  "submission_address_source": "DELIVERY REPORT IMAGE", // or "PING AT SUBMISSION"
  "submission_address": "DADAR, MUMBAI INDIA",
  "submission_details": {
    "delivered_with_issues": true, // One or more issues present
    "receiver_name": "Transporter Office",
    "receiver_phone_no": "9876543210",
    "additional_comments": "Comments from Submitter",
    "materials": [
      {
        "name": "cement",
        "expected_qty": 40,
        "delivered_qty": 30,
        "issues_qty": 10,
        "invoice_pending_qty": 60, //Quantity Remaining in the truck after the submission
        "custom_valuesissues": {
          "cut": 5,// made lowercase
          "clot": 5 // made lowercase
        }
      }
    ]
  }
}

...

Code Block
languagejson
{
  "type": "object",
  "properties": {
    "provider*": {
      "type": "string"
    },
    "event*": {
      "type": "object",
      "properties": {
        "name*": {
          "type": "string"
        },
        "timestamp*": {
          "type": "integer"
        }
      }
    },
    "trip_id*": {
      "type": "string"
    },
    "unique_id*": {
      "type": "string"
    },
    "invoice_no*": {
      "type": "string"
    },
    "any_deliveries_pending*": {
      "type": "boolean"
    },
    "submitted_by*": {
      "type": "object",
      "properties": {
        "email*": {
          "type": "null"
        },
        "username*": {
          "type": "string"
        },
        "role*": {
          "type": "string"
        },
        "phone_number*": {
          "type": "string"
        },
        "comment*": {
          "type": "string"
        }
      }
    },
    "submitted_at*": {
      "type": "integer"
    },
    "submission_id*": {
      "type": "string"
    },
    "channel*": {
      "type": "string"
    },
    "approval_url*": {
      "type": "string"
    },
    "receiver_phone_number*": {
      "type": "string"
    },
    "submission_address_source": {
      "type": "string"
    },
    "submission_address": {
      "type": "string"
    },
    "submission_details*": {
      "type": "object",
      "properties": {
        "delivered_with_issues*": {
          "type": "boolean"
        },
        "receiver_name*": {
          "type": "string"
        },
        "receiver_phone_no*": {
          "type": "string"
        },
        "additional_comments": {
          "type": "string"
        },
        "materials": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "name*": {
                  "type": "string"
                },
                "expected_qty*": {
                  "type": "integer"
                },
                "delivered_qty*": {
                  "type": "integer"
                },
                "issues_qty*": {
                  "type": "integer"
                },
                "invoice_pending_qty*": {
                  "type": "integer"
                },
                "custom_valuesissues": {
                  "type": "object",
                  "properties": {
                    "cut": {
                      "type": "integer"
                    },
                    "clot": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          ]
        }
      }
    }
  }
}

ePOD Approved

Endpoint:/epod_approved
Method : POST

Request Body

Code Block
languagejson
{
    "provider": "Freight Tiger",
    "event": {
        "name": "epod.approved",
        "timestamp": 1630992879
    },
    "trip_id": "3768333",
    "invoice_no": "3001001371",
    "submission_id": "SUB-6e0de09e-e83c-4ddd-8d94-9d6df5563f05",
    "approved_at": 1630992878,
    "approved_by": {
        "phone_number": "1234567890",  // Can be null or blank string sometimes
        "role": "CEE",  // TRN=Transporter, CEE=Consignee, CNR=Consignor, DRV=Driver
        "username": "Raj"  // Can be null or blank string sometimes
    },
    "submission_address_source": "DELIVERY REPORT IMAGE", // or "PING AT SUBMISSION"
    "submission_address": "DADAR, MUMBAI INDIA",
    "submission_details": {
    "delivered_with_issues": true, // One or more issues present
    "receiver_name": "Transporter Office",
    "receiver_phone_no": "9876543210",
    "additional_comments": "Comments from Submitter",
    "materials": [
      {
        "name": "cement",
        "expected_qty": 40,
        "delivered_qty": 30,
        "issues_qty": 10,
        "invoice_pending_qty": 60, //Quantity Remaining in the truck after the submission
        "custom_valuesissues": {
          "cut": 5,// made lowercase
          "clot": 5 // made lowercase
          }
        }
      ]
    },
    "remarks": "Comments by Verifier"
}

...

Code Block
languagejson
{
  "type": "object",
  "properties": {
    "provider*": {
      "type": "string"
    },
    "event*": {
      "type": "object",
      "properties": {
        "name*": {
          "type": "string"
        },
        "timestamp*": {
          "type": "integer"
        }
      }
    },
    "trip_id*": {
      "type": "string"
    },
    "invoice_no*": {
      "type": "string"
    },
    "submission_id*": {
      "type": "string"
    },
    "approved_at*": {
      "type": "integer"
    },
    "approved_by*": {
      "type": "object",
      "properties": {
        "phone_number*": {
          "type": "string"
        },
        "role*": {
          "type": "string"
        },
        "username": {
          "type": "string"
        }
      }
    },
    
    "submission_address_source": {
        "type": "string"
    },
    "submission_address": {
        "type": "string"
    },
    "submission_details*": {
        "type": "object",
        "properties": {
            "delivered_with_issues*": {
                "type": "boolean"
            },
            "receiver_name*": {
                "type": "string"
            },
            "receiver_phone_no*": {
                "type": "string"
            },
            "additional_comments": {
                "type": "string"
            },
            "materials": {
                "type": "array",
                "items": [
                    {
                        "type": "object",
                        "properties": {
                            "name*": {
                                "type": "string"
                            },
                            "expected_qty*": {
                                "type": "integer"
                            },
                            "delivered_qty*": {
                                "type": "integer"
                            },
                            "issues_qty*": {
                                "type": "integer"
                            },
                            "invoice_pending_qty*": {
                                "type": "integer"
                            },
                            "custom_valuesissues": {
                                "type": "object",
                                "properties": {
                                    "cut": {
                                        "type": "integer"
                                    },
                                    "clot": {
                                        "type": "integer"
                                    }
                                }
                            }
                        }
                    }
                ]
            }
        }
    },
    "remarks*": {
      "type": "string"
    }
  }
}

ePOD Disputed

Endpoint:/epod_disputed
Method : POST

Request Body

Code Block
languagejson
{
    "provider": "Freight Tiger",
    "event": {
        "name": "epod.disputed",
        "timestamp": 1630992921
    },
    "trip_id": "3768334",
    "invoice_no": "3001001371",
    "submission_id": "SUB-5acd91cc-4317-4a35-a4d2-d463ceb8a887",
    "disputed_at": 1630992921,
    "disputed_by": {
        "phone_number": "1234567890",  // Can be null or blank string sometimes
        "role": "CEE",  // TRN=Transporter, CEE=Consignee, CNR=Consignor, DRV=Driver
        "username": "Raj"  // Can be null or blank string sometimes
    },
    "submission_address_source": "DELIVERY REPORT IMAGE", // or "PING AT SUBMISSION"
    "submission_address": "DADAR, MUMBAI INDIA",
    "submission_details": {
    "delivered_with_issues": true, // One or more issues present
    "receiver_name": "Transporter Office",
    "receiver_phone_no": "9876543210",
    "additional_comments": "Comments from Submitter",
    "materials": [
      {
        "name": "cement",
        "expected_qty": 40,
        "delivered_qty": 30,
        "issues_qty": 10,
        "invoice_pending_qty": 60, //Quantity Remaining in the truck after the submission
        "custom_valuesissues": {
          "cut": 5,// made lowercase
          "clot": 5 // made lowercase
          }
        }
      ]
    },
    "remarks*": "Comments by Verifier"
}

...

Code Block
languagejson
{
  "type": "object",
  "properties": {
    "provider*": {
      "type": "string"
    },
    "event*": {
      "type": "object",
      "properties": {
        "name*": {
          "type": "string"
        },
        "timestamp*": {
          "type": "integer"
        }
      }
    },
    "trip_id*": {
      "type": "string"
    },
    "invoice_no*": {
      "type": "string"
    },
    "submission_id*": {
      "type": "string"
    },
    "disputed_at*": {
      "type": "integer"
    },
    "disputed_by*": {
      "type": "object",
      "properties*": {
        "phone_number": {
          "type": "string"
        },
        "role*": {
          "type": "string"
        },
        "username": {
          "type": "string"
        }
      }
    },
    
    "submission_address_source": {
        "type": "string"
    },
    "submission_address": {
        "type": "string"
    },
    "submission_details*": {
        "type": "object",
        "properties": {
            "delivered_with_issues*": {
                "type": "boolean"
            },
            "receiver_name*": {
                "type": "string"
            },
            "receiver_phone_no*": {
                "type": "string"
            },
            "additional_comments": {
                "type": "string"
            },
            "materials": {
                "type": "array",
                "items": [
                    {
                        "type": "object",
                        "properties": {
                            "name*": {
                                "type": "string"
                            },
                            "expected_qty*": {
                                "type": "integer"
                            },
                            "delivered_qty*": {
                                "type": "integer"
                            },
                            "issues_qty*": {
                                "type": "integer"
                            },
                            "invoice_pending_qty*": {
                                "type": "integer"
                            },
                            "custom_valuesissues": {
                                "type": "object",
                                "properties": {
                                    "cut": {
                                        "type": "integer"
                                    },
                                    "clot": {
                                        "type": "integer"
                                    }
                                }
                            }
                        }
                    }
                ]
            }
        }
    },
    "remarks*": {
      "type": "string"
    }
  }
}