v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-142616180.5 KB

Addresses

Get address by ID

This endpoint retrieves information of a specific address by its unique identifier.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
Dynamic Storage	Dynamic storage generic resources	Read only documents
Dynamic Storage	Dynamic storage generic resources	Insert or update document (not remove)
Dynamic Storage	Dynamic storage generic resources	Full access to all documents
Dynamic Storage	Dynamic storage generic resources	Master Data administrator

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/dataentities/AD/documents/{addressId}

Path parameters

addressIdstring required

ID of the address to retrieve.

Query parameters

_fieldsstring required

Specifies that all fields of the document should be included in the response.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

addressLabelstring nullable

A user-defined label to identify the address.

addressType'commercial' | 'invoice' nullable

The type of address: commercial for shipping, invoice for billing.

citystring nullable

The city of the address.

complementstring nullable

Any additional information for the address (e.g., apartment, floor).

countrystring nullable

The country of the address in three-letter code format (e.g., "USA").

countryfakestring nullable

Placeholder or optional country value.

geoCoordinatestring nullable

Geographical coordinates of the address (latitude and longitude).

neighborhoodstring nullable

The neighborhood of the address.

numberstring nullable

The street number of the address.

postalCodestring nullable

The postal code of the address. The format must be compatible with the address country postal code format. (e.g., 00000 for addresses in the USA).

receiverNamestring nullable

The name of the person or entity receiving at this address.

referencestring nullable

Optional reference point or landmark near the address.

statestring nullable

The state or province of the address.

streetstring nullable

The street name of the address.

userIdstring nullable

The ID of the user or related entity.

idstring nullable

Unique identifier for this address record.

accountIdstring nullable

ID of the account related to this address.

accountNamestring nullable

Name of the account related to this address.

dataEntityIdstring nullable

ID of the data entity this address belongs to (always "AD").

createdBystring nullable

ID of the user who created the address record.

createdInstring nullable

Timestamp of when the address record was created.

updatedBystring nullable

ID of the user who last updated the address record.

updatedInstring nullable

Timestamp of the last update to the address record.

lastInteractionBystring nullable

ID of the user who had the last interaction with the record.

lastInteractionInstring nullable

Timestamp of the last interaction with the record.

followersstring[] nullable

List of users following this address record.

tagsstring[] nullable

List of tags associated with this address.

auto_filterstring nullable

Optional field used for automatic filtering or categorization.