This API is used to create a new dispatch address in the system. It allows users to submit relevant address details, including primary and secondary address lines, location identifiers (such as country, state, and city), postal codes, and entity associations.
Upon successful submission, the response will include the details of the newly created dispatch address.
Request
Authorization
Add parameter in header
ApiKey
Example:
ApiKey: ********************
Body Params multipart/form-data
address_1
stringÂ
required
Represents the primary address line, usually including the building name, street name, or a key identifier of the location.
Example:
C-330, Atlanta Shopping Mall
address_2
stringÂ
optional
An additional address line where you can provide extra details such as nearby landmarks, junctions, or other location-specific information that helps in better identification.
Example:
Nr. Sudama Chowk, Mota Varachha
country_id
integerÂ
required
A unique identifier representing the country where the dispatch address is located.
Example:
4
state_id
integerÂ
required
A unique identifier for the state within the country specified in the country id field.
Example:
2
city_id
integerÂ
required
A unique identifier for the city within the selected state.
Example:
6
pin_code
stringÂ
optional
The postal or ZIP code of the dispatch address, such as "394101," helps in precise location identification, ensuring efficient deliveries, accurate routing, and streamlined logistics operations.
Example:
394101
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request POST 'https://app.hisabkitab.co/third-party/dispatch-addresses' \
--header'ApiKey;' \
--form'address_1="C-330, Atlanta Shopping Mall"' \
--form'address_2="Nr. Sudama Chowk, Mota Varachha"' \
--form'country_id="4"' \
--form'state_id="2"' \
--form'city_id="6"' \
--form'pin_code="394101"'
Responses
🟢200Create Dispatch Address
application/json
Body
data
objectÂ
required
id
integerÂ
required
Unique identifier for the dispatch address entry.
address_1
stringÂ
required
Represents the primary address line, usually including the building name, street name, or a key identifier of the location.
address_2
stringÂ
required
An additional address line where you can provide extra details such as nearby landmarks, junctions, or other location-specific information that helps in better identification.
country_id
stringÂ
required
A unique identifier representing the country where the dispatch address is located.
state_id
stringÂ
required
A unique identifier for the state within the country specified in the country id field.
city_id
stringÂ
required
A unique identifier for the city within the selected state.
pin_code
stringÂ
required
The postal or ZIP code of the dispatch address, such as "394101," helps in precise location identification, ensuring efficient deliveries, accurate routing, and streamlined logistics operations.
model_id
integerÂ
required
The ID of the entity (e.g., company,) to which this address belongs.
model_type
stringÂ
required
The type of entity associated with this address.
address_type
integerÂ
required
Defines the type of address (e.g., 1 = shipping, 2 = dispatch).
created_at
stringÂ
required
The date and time indicating when the record was initially created in the system.
updated_at
stringÂ
required
The date and time indicating when the record was last modified or updated in the system.
success
booleanÂ
required
message
stringÂ
required
Example
{"data":{"id":3,"address_1":"C-330, Atlanta Shopping Mall","address_2":"Nr. Sudama Chowk, Mota Varachha","country_id":"4","state_id":"2","city_id":"6","pin_code":"394101","model_id":6,"model_type":"App\\Models\\Company","address_type":2,"created_at":"2025-02-13T06:25:45.000000Z","updated_at":"2025-02-13T06:25:45.000000Z"},"success":true,"message":"Dispatch Address Created Successfully."}