Home

|

Documentation

|

Partners API

|

Integration Guides

|

Address Validation Errors

Address Validation Errors

How to resolve address validation error messages when creating or updating an address resource.

By default, we validate all addresses sent to ensure we are able to ship to them. If an address validation yields a higher likelihood of having a courier-related issue, our API will respond with error codes 42221 - 42230.

An example request against the Create New Order API endpoint, and subsequent response body where an address is determined to be unshippable:

{
    "shipping": { "method_id":1 },
    "patient": {
          "first_name": "Mick",
          "last_name": "Mouse",
          "dob": "1940-01-01",
          "gender": "M",
          "email": "mickmouse@honeybeehealth.com",
          "phone": "1231231234",
          "patient_id": "m1ck3y",
          "patient_safety":{
              "medications":[],
              "health_conditions":[],
              "allergies":[]
          }
    },
    "address": {
        "first_name": "Mick",
        "last_name": "Mouse",
        "street1": "1000 House Dr",
        "city": "Fresno",
        "state": "CA",
        "zip": "90021",
        "phone": "1231231234",
        "accept_suggested": false,
        "ignore_warnings": false
    },
    "items": [
        {
            "sku": "packaging-pouch",
            "package_size":1
        },
        {
            "quantity":1,
            "package_size":90,
            "prescription_id":1111111
        }
    ]
}

{
    "errors": [
        {
            "code": 42230,
            "message": "Invalid Address Not Found",
            "error_detail": [
                {
                    "field": "address.not_found",
                    "message": "address could not be found, please check entered address"
                }
            ]
        }
    ]
}

If you are certain that the address you sent is a valid address, you can optionally use the ignore_warnings address boolean flag to denote that we should accept this address anyway.

For example:

{
    "shipping": { "method_id":1 },
    "patient": {
          "first_name": "Mick",
          "last_name": "Mouse",
          "dob": "1940-01-01",
          "gender": "M",
          "email": "mickmouse@honeybeehealth.com",
          "phone": "1231231234",
          "patient_id": "m1ck3y",
          "patient_safety":{
              "medications":[],
              "health_conditions":[],
              "allergies":[]
          }
    },
    "address": {
        "first_name": "Mick",
        "last_name": "Mouse",
        "street1": "1000 House Dr",
        "city": "Fresno",
        "state": "CA",
        "zip": "90021",
        "phone": "1231231234",
        "accept_suggested": false,
        "ignore_warnings": true
    },
    "items": [
        {
            "sku": "packaging-pouch",
            "package_size":1
        },
        {
            "quantity":1,
            "package_size":90,
            "prescription_id":1111111
        }
    ]
}