Create Transport

POST

https://app.hisabkitab.co/third-party/transport-masters

This endpoint makes an HTTP POST request to add a new transport master to the system. It allows users to define transport details, such as the transport provider's name, contact information, and relevant identifiers.

Request

The request body must include essential transport details, such as the transport name, GSTIN (if applicable), PAN, address, and contact information.

Response

Upon successful creation, the API will return a confirmation message along with the details of the newly created transport master.

Request

Authorization

Add parameter in header

ApiKey

Example:

ApiKey: ********************

Body Params application/json

transporter_name

string

required

Specifies the name of the transporter. This field identifies the transport company or individual responsible for transportation services.

gstin

string

optional

Holds the GST Identification Number of the transporter. This field may be left empty if the transporter is not registered for GST.

contact_name

string

optional

The name of the primary contact person at the transporter’s organization. This field is essential for identifying who to reach for communication.

region_iso

string

optional

Represents the ISO country code (e.g., "IN" for India), ensuring consistency in identifying the country.

region_code

string

optional

The international dialing code for the country (e.g., "91" for India), used to format phone numbers correctly.

contact_phone_number

string

optional

The phone number of the contact person, used for communication purposes.

contact_email

string

optional

The email address of the contact person, providing an additional means of communication.

address_1

string

optional

The primary address line of the transporter’s location, which typically includes street names or building numbers.

address_2

string

optional

The secondary address line, often used for apartment numbers, suite numbers, or landmarks. This field can also be null if not applicable.

country_id

integer

optional

Numeric identifier for the country where the transporter is located, ensuring standardized geographical classification.

state_id

integer

optional

Numeric identifier for the state in which the transporter’s address is located.

city_id

integer

optional

Numeric identifier representing the city associated with the transporter’s address.

pin_code

integer

optional

The postal code associated with the transporter’s address, ensuring precise location identification.

Example

{
    "transporter_name": "Joan",
    "gstin": "",
    // contact details
    "contact_name": "",
    "region_iso": "in",
    "region_code": "91",
    "contact_phone_number": "",
    "contact_email": "",    
    // address
    "address_1": null,
    "address_2": null,
    "country_id": 1,
    "state_id": 1,
    "city_id": 1,
    "pin_code": 1
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://app.hisabkitab.co/third-party/transport-masters' \
--header 'Content-Type: application/json' \
--header 'ApiKey;' \
--data-raw '{
    "transporter_name": "Joan",
    "gstin": "",
    // contact details
    "contact_name": "",
    "region_iso": "in",
    "region_code": "91",
    "contact_phone_number": "",
    "contact_email": "",    
    // address
    "address_1": null,
    "address_2": null,
    "country_id": 1,
    "state_id": 1,
    "city_id": 1,
    "pin_code": 1
}'

Responses

🟢200Create Transport

application/json

Body

data

object

required

integer

required

A unique identifier for the transporter in the system.

transporter_name

string

required

Specifies the name of the transporter. This field identifies the transport company or individual responsible for transportation services.

gstin

string

required

Holds the GST Identification Number of the transporter. This field may be left empty if the transporter is not registered for GST.

company_id

integer

required

The unique identifier of the company to which the transporter belongs.

contact_name

string

required

The name of the primary contact person at the transporter’s organization. This field is essential for identifying who to reach for communication.

region_iso

string

required

Represents the ISO country code (e.g., "IN" for India), ensuring consistency in identifying the country.

region_code

string

required

The international dialing code for the country (e.g., "91" for India), used to format phone numbers correctly.

contact_phone_number

string

required

The phone number of the contact person, used for communication purposes.

contact_email

string

required

The email address of the contact person, providing an additional means of communication.

via_api

boolean

required

updated_at

string

required

The date and time indicating when the record was last modified or updated in the system.

created_at

string

required

The date and time indicating when the record was initially created in the system.

success

boolean

required

message

string

required

Example

{
    "data": {
        "id": 1,
        "transporter_name": "Joan",
        "gstin": null,
        "company_id": 6,
        "contact_name": null,
        "region_iso": "in",
        "region_code": "91",
        "contact_phone_number": null,
        "contact_email": null,
        "via_api": true,
        "created_at": "2025-02-19T12:48:14.000000Z",
        "updated_at": "2025-02-19T12:48:14.000000Z"
    },
    "success": true,
    "message": "Transport Master Created Successfully."
}

Modified at 2025-04-03 09:50:19

List of Transport

Edit Transport

Create Transport

Request#

Response#

Request

Request samples

Responses

Request

Response