HisabKitab
  1. Shipping Address
HisabKitab
  • Third Party APIs
    • How to Generate ApiKey ?
    • Account Master
      • Ledger Groups
        • List of All Groups
        • Create Group
        • Create Batch Groups
        • Edit Group
        • Update Group
        • Delete Group
      • Ledgers
        • Create Ledger
          • Customer Ledger
          • Supplier Ledger
          • Bank Ledger
          • Capital Ledger
          • Cash Ledger
          • Income Ledger
          • Expense Ledger
          • Fixed Asset Ledger
          • Investment Ledger
          • Loan and Advance (Asset) Ledger
          • Misc Assets Ledger
          • Other Current Assets Ledger
          • Taxes - GST Ledger
          • Taxes - TDS Ledger
          • Taxes - TCS Ledger
          • Provisions Ledger
          • Reserve and Surplus Ledger
          • Secured Loan Ledger
          • Unsecured Loan Ledger
          • Stock In Hand Ledger
          • Other Current Liabilities Ledger
          • TDS Receivable Ledger
          • TCS Receivable Ledger
        • Ledger Detail
        • List of all Ledgers
        • Edit Ledger
        • Update Ledger
        • Delete Ledger
        • Delete Ledger Media
        • Add Location(Fixed Asset )
        • Check Unique GST Number
        • Check Unique GST Number with Ledger
        • Holding & Profit Ratio
        • Ledger TDS tax Data
        • Ledger TCS tax Data
    • Item Master
      • Item Groups
        • List of all groups
        • Create Group
        • Create Batch Groups
        • Edit Group
        • Update Group
        • Delete Group
      • Items
        • Item Form Details
        • List of items
        • Create Good Item
        • Create Service Item
        • Edit Item
        • Update Item
        • Delete Item
      • Unit of Measurement
        • List of Unit of Measurement
        • Create Unit of Measurement
        • Edit Unit of Measurement
        • Update Unit of Measurement
        • Delete Unit of Measurement
    • Broker Master
      • List of Brokers
      • Create Broker
      • Edit Broker
      • Update Broker
      • Delete Broker
    • Transport Master
      • List of Transport
      • Create Transport
      • Edit Transport
      • Update Transport
      • Delete Transport
    • Cess Rate
      • List of Cess Rate
      • Create Cess Rate
      • Edit Cess Rate
      • Update Cess Rate
      • Delete Cess Rate
    • Dispatch Address
      • List of Dispatch Address
      • Create Dispatch Address
      • Edit Dispatch Address
      • Update Dispatch Address
      • Delete Dispatch Address
    • Shipping Address
      • List of Shipping Addresses
        GET
      • Create Shipping Address
        POST
      • Edit Shipping Address
        GET
      • Update Shipping Address
        POST
      • Delete Shipping Address
        DELETE
    • Comman APIs
      • Company Details
      • Countries
      • States
      • Cities
      • Gst Rates
      • Classification-nature-type
    • Configuration
      • Sale
        • Sale Configuration
        • Update Configuration
        • Update Configuration with Type
      • Sale Return
        • Sale Return Configuration
        • Update Configuration
        • Update Configuration with Type
      • Income Debit Note
        • Debit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Income Credit Note
        • Credit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Estimate Quote
        • Estimate Configuration
        • Update Configuration with Type
        • Update Configuration
      • Delivery Challan
        • Delivery Challan Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase
        • Purchase Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase Return
        • Purchase Return Configuration
        • Update Configuration
        • Update Configuration with Type
      • Expense Credit Note
        • Expense Credit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Expense Debit Note
        • Expense Debit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase Order
        • Purchase Order Configuration
        • Update Configuration
        • Update Configuration with Type
    • Sale Transactions
      • List of Transactions
      • Next Invoice Number
      • Create Item Sale
      • Create Accounting Sale
      • Edit Sale
      • Update Sale
      • Duplicate Sale
      • Delete Sale
      • Get Sale For Sale Return
      • Create Challan From Sale Invoice
    • Sale Return Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Sale Return
      • Create Accounting Sale Return
      • Edit Sale Return
      • Update Sale Return
      • Duplicate Sale Return
      • Delete Sale Return
    • Income Debit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Debit Note
      • Create Accounting Debit Note
      • Edit Debit Note
      • Update Debit Note
      • Duplicate Debit Note
      • Delete Debit Note
    • Income Credit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Credit Note
      • Create Accounting Credit Note
      • Edit Credit Note
      • Update Credit Note
      • Duplicate Credit Note
      • Delete Credit Note
    • Estimate Quote Transaction
      • List of Transactions
      • Next Estimate Number
      • Create Item Estimate
      • Create Accounting Estimate
      • Edit Estimate
      • Update Estimate
      • Duplicate Estimate
      • Create Sale From Estimate
      • Delete Estimate
    • Delivery Challan Transaction
      • List of Transactions
      • Next Challan Number
      • Create Delivery Challan
      • Edit Delivery Challan
      • Update Delivery Challan
      • Duplicate Delivery Challan
      • Create Sale From Delivery Challan
      • Delete Delivery Challan
    • Purchase Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase
      • Create Accounting Purchase
      • Edit purchase
      • Update purchase
      • Duplicate purchase
      • Get purchase For purchase Return
      • Delete purchase
    • Purchase Return Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase Return
      • Create Accounting Purchase Return
      • Edit purchase Return
      • Update purchase Return
      • Duplicate purchase Return
      • Delete purchase Return
    • Expense Credit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Expense Credit Note
      • Create Accounting Expense Credit Note
      • Edit Expense Credit Note
      • Update Expense Credit Note
      • Duplicate Expense Credit Note
      • Delete Expense Credit Note
    • Expense Debit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Expense Debit Note
      • Create Accounting Expense Debit Note
      • Edit Expense Debit Note
      • Update Expense Debit Note
      • Duplicate Expense Debit Note
      • Delete Expense Debit Note
    • Purchase Order Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase Order
      • Create Accounting Purchase Order
      • Edit purchase Order
      • Update Purchase Order
      • Duplicate purchase Order
      • Delete purchase Order
      • Book Purchase Order
    • Receipt Transaction
      • List of Receipts
      • Next invoice number
      • Create Receipt
      • Edit Receipt
      • Update Receipt
      • Delete Receipt
    • Payment Transaction
      • List of Payments
      • Next invoice number
      • Create Payment
      • Edit Payment
      • Update Payment
      • Delete Payment
    • Journal Transaction
      • List of Journals
      • Next invoice number
      • Create Journal
      • Edit Journal
      • Update Journal
      • Delete Journal
  1. Shipping Address

List of Shipping Addresses

GET
https://app.hisabkitab.co/third-party/shipping-addresses
This API retrieves a list of shipping addresses stored in the system. It requires a ledger ID to be passed as a query parameter to fetch the shipping addresses associated with a specific ledger party. The response includes details such as address lines, location identifiers (country, state, city), postal codes, associated entities (such as suppliers or customers), and additional shipping-related details like shipping name and GSTIN. This helps in managing shipping addresses efficiently for logistics, invoicing, and order fulfillment.

Request#

The request is a GET method and does not require any request body. Additionally, by passing a ledger ID as a query parameter, users can filter the shipping addresses specific to a particular ledger party.

Response#

Upon a successful request, the API returns a list of shipping addresses filtered by ledger ID, each containing details necessary for accurate shipment handling and documentation.

Request

Authorization
Add parameter in header
ApiKey
Example:
ApiKey: ********************
Query Params
ledgerId
integer 
required
It represents the ID of the ledger associated with the shipping address you want to retrieve.
Example:
1

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 GET 'https://app.hisabkitab.co/third-party/shipping-addresses?ledgerId=1' \
--header 'ApiKey;'

Responses

🟢200List of Shipping Addresses
application/json
Body
data
array [object {12}] 
required
id
integer 
required
Unique identifier for the shipping address entry.
address_1
string  | null 
required
The primary address line, which typically includes the building number, street name, or any key location identifier.
address_2
string  | null 
required
An additional address line for extra details like nearby landmarks or other location identifiers that help with precise delivery.
country_id
integer 
required
A unique identifier representing the country where the shipping address is located.
state_id
integer  | null 
required
A unique identifier for the state within the selected country (country_id).
city_id
integer  | null 
required
A unique identifier for the city within the selected state (state_id).
pin_code
string  | null 
required
The postal or ZIP code of the shipping address. "533005" helps in precise location identification, ensuring efficient deliveries, optimized routing, and seamless logistics.
shipping_name
string 
required
The name associated with the shipping address, which can be the recipient's name, company name, or business entity.
shipping_gstin
string 
required
The GST Identification Number (GSTIN) of the recipient, which is mandatory for tax compliance used for invoicing and tax purposes.
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).
success
boolean 
required
message
string 
required
Example
{
    "data": [
        {
            "id": 1,
            "address_1": "OFFICE NO. 211, SECOND FLOOR, EMPIRE STATE BUILDING",
            "address_2": "RING ROAD",
            "country_id": 2,
            "state_id": 1,
            "city_id": 5,
            "pin_code": "395002",
            "model_id": 5,
            "model_type": "App\\Models\\Master\\Supplier",
            "address_type": 2,
            "shipping_name": null,
            "shipping_gstin": null
        },
        {
            "id": 2,
            "address_1": "c-01 Blue Dart Centre",
            "address_2": "Sahar Airport Road",
            "country_id": 1,
            "state_id": 1,
            "city_id": 5,
            "pin_code": "394101",
            "model_id": 8,
            "model_type": "App\\Models\\Master\\Supplier",
            "address_type": 2,
            "shipping_name": null,
            "shipping_gstin": null
        }
    ],
    "success": true,
    "message": "Shipping Address list Retrieved Successfully."
}
Modified at 2025-04-03 09:52:40
Previous
Delete Dispatch Address
Next
Create Shipping Address
Built with