Validate Address

GET /api/3pl/{company}/address

Validate the customer address before requesting rates. The endpoint returns the accepted address or a recommended correction.

curl --get "https://www.dyli.io/api/3pl/$DYLI_3PL_COMPANY/address" \
  -H "x-api-key: $DYLI_3PL_API_KEY" \
  --data-urlencode "name=Jamie Doe" \
  --data-urlencode "email=jamie@example.com" \
  --data-urlencode "phone=+1 212 555 0100" \
  --data-urlencode "address_line_1=123 Main Street" \
  --data-urlencode "address_line_2=Suite 4" \
  --data-urlencode "city_locality=New York" \
  --data-urlencode "state_province=NY" \
  --data-urlencode "postal_code=10001" \
  --data-urlencode "country_code=US"

Query Parameters

Name	Required	Description
name	Yes	Recipient name.
email	Yes	Valid recipient email.
phone	Yes	Recipient phone number, including country code when applicable.
address_line_1	Yes	Street address.
address_line_2	No	Apartment, suite, or unit.
city_locality	Yes	City or locality.
state_province	Yes	State, province, or region. Use a two-letter code for US addresses.
postal_code	Yes	Postal or ZIP code.
country_code	Yes	Two-letter country code.

Valid Address

{
  "valid": true,
  "address": {
    "address_line_1": "123 Main St",
    "address_line_2": "Suite 4",
    "city_locality": "New York",
    "state_province": "NY",
    "postal_code": "10001",
    "country_code": "US"
  },
  "original_address": {
    "address_line_1": "123 Main St",
    "address_line_2": "Suite 4",
    "city_locality": "New York",
    "state_province": "NY",
    "postal_code": "10001",
    "country_code": "US"
  }
}

Suggested Correction

An address that can be corrected returns 200 with valid: false and corrected: true.

{
  "valid": false,
  "corrected": true,
  "recommended_address": {
    "address_line_1": "123 MAIN ST",
    "address_line_2": "SUITE 4",
    "city_locality": "NEW YORK",
    "state_province": "NY",
    "postal_code": "10001-0001",
    "country_code": "US"
  },
  "errors": []
}

Show the recommendation to the customer and use the confirmed address in /rates and /order. Shipping to Russia is not available.