vtex.local – Profile-System

OpenAPI apis-guru

Create shopper profiles and manage their information.

Homepage: https://api.apis.guru/v2/specs/vtex.local:Profile-System/1.0.json
Provider: vtex.local:Profile-System / Profile-System
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/vtex.local/Profile-System/1.0/openapi.yaml

Tools (29)

Extracted live via the executor SDK.

addresses.createClientAddress

Creates new address for a given client profile.

The id field returned by this request is the addressId used to retrieve or update information of a specific address later.

Learn more about the and its other API endpoints.
addresses.deleteAddress

Deletes a client's address by profileId and addressId.

Learn more about the and its other API endpoints.
addresses.getAddress

Retrieves information of a specific address of a given client, by its respectives adderssId and profileId.

For security and privacy reasons, this request returns masked address data. For unmasked information, see Get unmasked address.

Learn more about the and its other API endpoints.
addresses.getAddressByVersion

Retrieves information of a specific version address of a given client.

For security and privacy reasons, this request returns masked address data by version. For unmasked information, see Get unmasked address by version.

Learn more about the and its other API endpoints.
addresses.getClientAddresses

Retrieves information of all addresses of a given client, by its profileId.

For security and privacy reasons, this request returns masked address data. For unmasked information, see Get unmasked client addresses.

Learn more about the and its other API endpoints.
addresses.getUnmaskedAddress

Retrieves unmasked information of a specific address of a given client, by its respectives adderssId and profileId.

Learn more about the and its other API endpoints.
addresses.getUnmaskedAddressByVersion

Retrieves unmasked information of a specific address version of a given client.

Learn more about the and its other API endpoints.
addresses.getUnmaskedClientAddresses

Retrieves unmasked information of all addresses of a given client, by its profileId.

Learn more about the and its other API endpoints.
addresses.updateClientAddress

Updates one or more fields of an existing address for a given client profile.

Learn more about the and its other API endpoints.
profiles.createClientProfile

Creates new client profile.

Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly.

The id field returned by this request is the profileId used to retrieve information on a specific profile later.

Learn more about the and its other API endpoints.
profiles.deleteClientProfile

Deletes a client profile by profileId.

Learn more about the and its other API endpoints.
profiles.getProfile

Retrieves the information of a specific client, by its profileId.

Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly.

For security and privacy reasons, this request returns masked profile data. For unmasked information, see Get unmasked profile.

Learn more about the and its other API endpoints.
profiles.getProfileByVersion

Retrieves the information of a specific version of a client profile.

Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly.

For security and privacy reasons, this request returns masked profile data. For unmasked information, see Get unmasked profile by version.

Learn more about the and its other API endpoints.
profiles.getUnmaskedProfile

Retrieves unmasked information of a specific client, by its profileId.

Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly.

Learn more about the and its other API endpoints.
profiles.getUnmaskedProfileByVersion

Retrieves unmasked information of a specific version of a client profile.

Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly.

Learn more about the and its other API endpoints.
profiles.updateClientProfile

Updates one or more fields of an existing client profile.

Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly.

Learn more about the and its other API endpoints.
prospects.createProspect

Creates new prospect.

The id field returned by this request is the prospectId used to retrieve information on a specific prospect later.

Learn more about the and its other API endpoints.
prospects.deleteProspect

Deletes a prospect by prospectId.

Learn more about the and its other API endpoints.
prospects.getProspect

Retrieves the information of a specific prospect, by its prospectId.

For security and privacy reasons, this request returns masked prospect data. For unmasked information, see Get unmasked prospect.

Learn more about the and its other API endpoints.
prospects.getUnmaskedProspect

Retrieves unmasked information of a specific prospect, by its prospectId.

Learn more about the and its other API endpoints.
prospects.updateProspect

Updates one or more fields of an existing prospect.

Learn more about the and its other API endpoints.
purchaseInformation.createPurchaseInformation

Creates purchase information for a given client profile.

Learn more about the and its other API endpoints.
purchaseInformation.deletePurchaseInformation

Deletes purchase informaiton by profileId.

Learn more about the and its other API endpoints.
purchaseInformation.getPurchaseInformation

Retrieves purchase information of a given client, by its profileId.

For security and privacy reasons, this request returns masked data. For unmasked information, see Get unmasked purchase information.

Learn more about the and its other API endpoints.
purchaseInformation.getUnmaskedPurchaseInformation

Retrieves unmasked purchase information of a given client, by its profileId.

Learn more about the and its other API endpoints.
purchaseInformation.updatePurchaseInformation

Updates one or more fields of existing purchase information for a given client profile.

Learn more about the and its other API endpoints.
schemas.createOrUpdateProfileSchema

Creates or updates profile schema.

Each account has one profile schema. Updating it with this request will substitute the previous version.

Learn more about the and its other API endpoints.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools