Create Indent API

Owned by Neha Rankawat (Unlicensed)
Last updated: Jan 18, 2024 by Kulpreet Kaur
22 min read

This API can be used in the below 3 ways:

  1. Create indent with route refcode.

  2. Create indent with loading and unloading refcode. It will override the default loading and unloading point of route.

  3. Create indent with master data (display and address label/ display and lat long) of loading and unloading point. It will override the default loading and unloading point of route.

API Endpoint:

Method: POST

https://integration-api.freighttiger.com/integration/integration/indent - Integration/Sandbox Environment

https://api.freighttiger.com/api/integration/indent - Production Environment

Method: “POST“

Request Headers:

Name

Type

Location

Description

Example

Name

Type

Location

Description

Example

Authorization

string

headers

JWT token required to authenticate API call.

Authorization: Bearer eyJhbGciOiJIUzI1Ni

Request Body

Request methods for the deferent way to create indent given below

  1. Create indent with route refcode.(Click here)

  2. Create indent with loading and unloading refcode. (Click here )

  3. Create indent with master data (Click here)

Example value

{ "type": "PER_TRUCK", "feed_unique_id": "FEED160620212", "route_ref_code": "INDR001", "vehicle_types": [ { "ref_code": "VHT-0002", "quantity": 1, "min_preferred_rate": 0, "max_preferred_rate": 0 } ], "loading_point": {}, "unloading_point": {}, "payment_mode": "TO_BILL", "comments": "testing integration add indent", "drop_points": [ { "consignee": { "fteid": "COM-afb2fa0b-d388-4f52-b3cc-d7f6359ea718" }, "drop_location": { "label": "Andheri West, Mumbai, Maharashtra, India", "place_id": "PLC-e4a43efb-33b0-4667-aeb4-794a6420f4e6" }, "so_dos": [ { "so": "SO1", "do": [ { "id": "DO1", "qty": "1" } ] } ] } ], "custom_param": { "SO": "SO-1334", "DO": "DO-87676" }, "publishing_rule": { "single": {}, "l1": { "transporter_ref_code": [ "Indent Transporter 2 Company" ] "acceptance_deadline": 1626860809609 }, "l2": {}, "l3": {}, "non_contracted": { "transporter_ref_code": [ "Indent Transporter 5 Company" ] "acceptance_deadline": 1626860809609 }, "multiple": {} }, "assignment_deadline": 1626860809609, "reporting_deadline": 1626860809609, "reporting_overdue": 1626860809609, "bid_acceptance_deadline": 1626860809609, "branch_ref_code": "BRH1234" }

Schema

{ "type": "object", "properties": { "type": { "type": "string", "required":true, "example": "PER_TRUCK", "PER_TON" }, "feed_unique_id": { "type": "string", "required":true }, "route_ref_code": { "type": "string", "required":true }, "vehicle_types": { "discription":"Required when indent based on per truck", "type": "array", "items": [ { "type": "object", "required":true, "properties": { "ref_code": { "type": "string", "required":true }, "quantity": { "type": "integer", "required":true }, "min_preferred_rate": { "type": "integer", "required":true }, "max_preferred_rate": { "type": "integer", "required":true } } } ] }, "materials": { "discription":"Required when indent based on per TON", "type": "array", "items": [ { "type": "object", "required":true, "properties": { "ref_code": { "type": "string", "required":true }, "total_weight": { "type": "integer", "required":true }, "weight_unit": { "type": "string", "required":true }, "min_preferred_rate": { "type": "integer", "required":true }, "max_preferred_rate": { "type": "integer", "required":true }, "master_data": { "type": "object", "properties": { "label": { "type": "string" } } } } } ] }, "loading_point": { "type": "object", "properties": { "ref_code": { "type": "string" }, "master_data": { "type": "object", "properties": { "address": { "type": "string" }, "display_label": { "type": "string" }, "location": { "type": "object", "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } } } } } } }, "unloading_point": { "type": "object", "properties": { "ref_code": { "type": "string" }, "master_data": { "type": "object", "properties": { "address": { "type": "string" }, "display_label": { "type": "string" }, "location": { "type": "object", "properties": { "lat": { "type": "number" }, "lon": { "type": "number" } } } } } } }, "payment_mode": { "type": "string", "enum": [ "TO_PAY", "TO_BILL" ] }, "drop_points": { "type": "array", "items": [ { "type": "object", "properties": { "consignee": { "type": "object", "properties": { "fteid": { "type": "string" } }, "required": [ "fteid" ] }, "drop_location": { "type": "object", "properties": { "label": { "type": "string" }, "place_id": { "type": "string" } }, "required": [ "label", "place_id" ] }, "so_dos": { "type": "array", "items": [ { "type": "object", "properties": { "so": { "type": "string" }, "do": { "type": "array", "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "qty": { "type": "string" } }, "required": [ "id", "qty" ] } ] } } } ] } } } ] }, "comments": { "type": "string" }, "custom_param": { "type": "object", "properties": { "SO": { "type": "string" }, "DO": { "type": "string" }, "custom_param_array": { "type": "array", "items": [ { "type": "string" }, { "type": "string" } ] } } }, "publishing_rule": { "type": "object", "required":true, "properties": { "single": { "type": "object", "properties": { "transporter_ref_code": { "type": "array", "required":true, "items": [ { "type": "string" } ] }, "acceptance_deadline": { "type": "integer", "required":true }, "schedule_timestamp": { "type": "integer", "required":true } } }, "l1": { "type": "object", "properties": { "transporter_ref_code": { "type": "array", "items": [ { "type": "string" } ] } } }, "l2": { "type": "object", "properties": { "transporter_ref_code": { "type": "array", "items": [ { "type": "string" } ] }, "acceptance_deadline": { "type": "integer" }, "schedule_timestamp": { "type": "integer" } } }, "l3": { "type": "object", "properties": { "transporter_ref_code": { "type": "array", "items": [ { "type": "string" } ] }, "acceptance_deadline": { "type": "integer" }, "schedule_timestamp": { "type": "integer" } } }, "non_contracted": { "type": "object", "properties": { "transporter_ref_code": { "type": "array", "items": [ { "type": "string" } ] }, "acceptance_deadline": { "type": "integer" }, "schedule_timestamp": { "type": "integer" } } }, "multiple": { "type": "object", "properties": { "transporter_ref_code": { "type": "array", "items": [ { "type": "string" } ] }, "acceptance_deadline": { "type": "integer" }, "schedule_timestamp": { "type": "integer" } } } } }, "assignment_deadline": { "type": "integer" }, "reporting_deadline": { "type": "integer" }, "reporting_overdue": { "type": "integer" }, "bid_acceptance_deadline": { "type": "integer" }, "branch_ref_code": { "type": "string" } } }

Responses:

Success

Status code 200 (Indent created successfully)

{ "success": true, "value": "IND-ee662234-1e5e-4a8f-8d75-c999d66c1edc" }

Failure

Status code 401 (Unauthorized user)

 

 

 

 

 

Post your questions in the comment box to get answers from the experts who watch this page.

For engineering support: visit FT Support