Skip to content

Get Addresses Bulk by GSTINs#

Get Addresses bulk by GSTINs API is used to get Addresses using the given list of GSTIN.

Route

invxb/apis/{banners-version}/orgs/{org-id}/addresses/addressbygstin

- active 'banners-version': v1
- method: POST

URL Parameters#

Name Description Type
banners-version version of the API
for example, v1		 string
org-id theodore organisation id string
GSTIN GSTIN linked with Address
for example, 27AABBB1122CZ10		 string

Request#

Please refer the following request body for reference-

Sample request body

[
  "27AABBB1222CZ1O", "27AABBB1224CZ1O", "27AABBB1223CZ1O"
]

Response#

Successful response will have the response in “data” attribute as a json.

200#

Sample response body

{
  "data": {
    "status": "1",
    "data": [
      {
        "itemStatus": "0",
        "itemData": null,
        "itemErrors": [
          {
            "code": "err-reading-from-db",
            "msg": "err-address-not-defined"
          }
        ],
        "itemInfoDetails": "GSTIN >> 38AABBB110CZ1O"
      },
      {
        "itemStatus": "1",
        "itemData": {
          "id": "f392b679-4397-47a1-805e-6fbe74b997ff",
          "identifier": "38AABBB1120CZ2O",
          "gstService": "einvoice",
          "emailEndpoints": "abc@def.com",
          "restEndpoint": null,
          "registeredByOrg": {
            "id": "0d1c5ac7-3fdd-495c-ac19-196d7337d491",
            "name": "Organisation A LLP",
            "taxIdentifier": "ORGAA1234K",
            "taxIdentifierType": "PAN",
            "country": "India",
            "tz": "Asia/Kolkata",
            "locale": "en_US"
          },
          "publicKey": null,
          "createdOn": 1662801222357,
          "lastUpdated": 1662801222357
        },
        "itemErrors": null,
        "itemInfoDetails": null
      },
      {
        "itemStatus": "1",
        "itemData": {
          "id": "8e2388ab-7117-4173-99ca-59da8a8510fc",
          "identifier": "38AABBB1121CZ1O",
          "gstService": "ewaybill",
          "emailEndpoints": "abc@def.com",
          "restEndpoint": null,
          "registeredByOrg": {
            "id": "0d1c5ac7-3fdd-495c-ac19-196d7337d491",
            "name": "Organisation A LLP",
            "taxIdentifier": "ORGAA1234K",
            "taxIdentifierType": "PAN",
            "country": "India",
            "tz": "Asia/Kolkata",
            "locale": "en_US"
          },
          "publicKey": null,
          "createdOn": 1662801222365,
          "lastUpdated": 1662801222365
        },
        "itemErrors": null,
        "itemInfoDetails": null
      }
    ],
    "errors": null,
    "infoDetails": null
  }
}
Last update: September 10, 2022