Get a business address

{
  "success": true,
  "message": "Address retrieved successfully",
  "traceId": "0HNOF89NNTM7O:00000058",
  "data": {
    "_links": {
      "self": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55/addresses/019fed1a-84a6-7043-a6c0-e8aa2d4bec36",
      "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "businessAddressReference": "019fed1a-84a6-7043-a6c0-e8aa2d4bec36",
    "type": "shipping",
    "location": "warehouse",
    "addressLine1": "201 Warehouse Ln",
    "addressLine2": null,
    "cityLocality": "Austin",
    "stateProvince": "TX",
    "postalCode": "73302",
    "country": "US",
    "floor": null,
    "suiteApartNumber": null
  }
}

Retrieves a single business address by its businessAddressReference.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

businessReferencestringRequired

The business reference (businessUuid).

businessAddressReferencestringRequired

The business address reference.

Response

The business address.

successboolean

Whether the request succeeded.

messagestring or null

A human-readable result message.

traceIdstring or null

The trace identifier for the request, useful for support.

dataobject or null

The business address.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error