Address

Manage and validate physical addresses used for shipping origins, destinations, and company locations.

Quick Reference

Method

Endpoint

Description

GET

/api/address/isvalid

POST

/api/address/{addressId}/validated

POST

/api/address/{addressId}/avoidValidation

GET

/api/address/propertytype

GET /api/address/isvalid

Parameters:

Query Parameters:

  • Line1 (string, query): No description available

  • City (string, query): No description available

  • State (string, query): No description available

  • Zip (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/address/isvalid"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

POST /api/address/{addressId}/validated

Parameters:

Path Parameters:

  • addressId (integer, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/address/{addressId}/validated"
,
    addressId=789e0123-e89b-12d3-a456-426614174002
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

1{
2  "id": "789e0123-e89b-12d3-a456-426614174002",
3  "status": "created",
4  "message": "Resource created successfully"
5}

POST /api/address/{addressId}/avoidValidation

Parameters:

Path Parameters:

  • addressId (integer, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/address/{addressId}/avoidValidation"
,
    addressId=789e0123-e89b-12d3-a456-426614174002

)

# Process the response
print(response)

Sample Response:

1{
2  "id": "789e0123-e89b-12d3-a456-426614174002",
3  "status": "created",
4  "message": "Resource created successfully"
5}

GET /api/address/propertytype

Parameters:

Query Parameters:

  • Address1 (string, query): No description available

  • Address2 (string, query): No description available

  • City (string, query): No description available

  • State (string, query): No description available

  • ZipCode (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/address/propertytype"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}