Profile System
Create shopper profiles and manage their information.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Create shopper profiles and manage their information.
Endpoints 27
Profiles
- POSTCreate client profile
/api/storage/profile-system/profiles?ttl=365Creates new client profile. > Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your… - GETGet profile
/api/storage/profile-system/profiles/:profileId?alternativeKey=emailRetrieves the information of a specific client, by its profileId. > Since your store's profile schema is customizable, the schema and examples presented below… - DELETEDelete client profile
/api/storage/profile-system/profiles/:profileIdDeletes a client profile by profileId. > Learn more about the Profile System and its other API endpoints. - PATCHUpdates client profile
/api/storage/profile-system/profiles/:profileId?alternativeKey=email&ttl=365Updates one or more fields of an existing client profile. > Since your store's profile schema is customizable, the schema and examples presented below may… - GETGet unmasked profile
/api/storage/profile-system/profiles/:profileId/unmask?reason=data-validation&alternativeKey=emailRetrieves unmasked information of a specific client, by its profileId. > Since your store's profile schema is customizable, the schema and examples presented… - GETGet profile by version
/api/storage/profile-system/profiles/:profileId/versions/:profileVersionIdRetrieves the information of a specific version of a client profile. > Since your store's profile schema is customizable, the schema and examples presented… - GETGet unmasked profile by version
/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId/unmask?reason=data-validationRetrieves unmasked information of a specific version of a client profile. > Since your store's profile schema is customizable, the schema and examples…
Addresses
- GETGet client addresses
/api/storage/profile-system/profiles/:profileId/addresses?alternativeKey=emailRetrieves information of all addresses of a given client, by its profileId. > For security and privacy reasons, this request returns masked address data. For… - POSTCreate client address
/api/storage/profile-system/profiles/:profileId/addresses?alternativeKey=emailCreates 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… - GETGet unmasked client addresses
/api/storage/profile-system/profiles/:profileId/addresses/unmask?alternativeKey=emailRetrieves unmasked information of all addresses of a given client, by its profileId. > Learn more about the Profile System and its other API endpoints. - GETGet address
/api/storage/profile-system/profiles/:profileId/addresses/:addressId?alternativeKey=emailRetrieves information of a specific address of a given client, by its respectives adderssId and profileId. > For security and privacy reasons, this request… - DELETEDelete address
/api/storage/profile-system/profiles/:profileId/addresses/:addressId?alternativeKey=emailDeletes a client's address by profileId and addressId. > Learn more about the Profile System and its other API endpoints. - PATCHUpdate client address
/api/storage/profile-system/profiles/:profileId/addresses/:addressId?alternativeKey=emailUpdates one or more fields of an existing address for a given client profile. > Learn more about the Profile System and its other API endpoints. - GETGet unmasked address
/api/storage/profile-system/profiles/:profileId/addresses/:addressId/unmask?reason=data-validation&alternativeKey=emailRetrieves unmasked information of a specific address of a given client, by its respectives adderssId and profileId. > Learn more about the Profile System and… - GETGet address by version
/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId?reason=data-validation&alternativeKey=emailRetrieves information of a specific version address of a given client. > For security and privacy reasons, this request returns masked address data by… - GETGet unmasked address by version
/api/storage/profile-system/profiles/:profileId/addresses/:addressId/versions/:addressVersionId/unmask?reason=data-validation&alternativeKey=emailRetrieves unmasked information of a specific address version of a given client. > Learn more about the Profile System and its other API endpoints.
Prospects
- POSTCreate prospect
/api/storage/profile-system/prospectsCreates new prospect. > The id field returned by this request is the prospectId used to retrieve information on a specific prospect later. > Learn more about… - GETGet prospect
/api/storage/profile-system/prospects/:prospectIdRetrieves the information of a specific prospect, by its prospectId. > For security and privacy reasons, this request returns masked prospect data. For… - DELETEDelete prospect
/api/storage/profile-system/prospects/:prospectIdDeletes a prospect by prospectId. > Learn more about the Profile System and its other API endpoints. - PATCHUpdate prospect
/api/storage/profile-system/prospects/:prospectIdUpdates one or more fields of an existing prospect. > Learn more about the Profile System and its other API endpoints. - GETGet unmasked prospect
/api/storage/profile-system/prospects/:prospectId/unmask?reason=data-validationRetrieves unmasked information of a specific prospect, by its prospectId. > Learn more about the Profile System and its other API endpoints.
Purchase information
- GETGet purchase information
/api/storage/profile-system/profiles/:profileId/purchase-info?alternativeKey=emailRetrieves purchase information of a given client, by its profileId. > For security and privacy reasons, this request returns masked data. For unmasked… - POSTCreate purchase information
/api/storage/profile-system/profiles/:profileId/purchase-info?alternativeKey=emailCreates purchase information for a given client profile. > Learn more about the Profile System and its other API endpoints. - DELETEDelete purchase information
/api/storage/profile-system/profiles/:profileId/purchase-info?alternativeKey=emailDeletes purchase informaiton by profileId. > Learn more about the Profile System and its other API endpoints. - PATCHUpdate purchase information
/api/storage/profile-system/profiles/:profileId/purchase-info?alternativeKey=emailUpdates one or more fields of existing purchase information for a given client profile. > Learn more about the Profile System and its other API endpoints. - GETGet unmasked purchase information
/api/storage/profile-system/profiles/:profileId/purchase-info/unmaskRetrieves unmasked purchase information of a given client, by its profileId. > Learn more about the Profile System and its other API endpoints.
Schemas
- PUTCreate or update profile schema
/api/storage/profile-system/profiles/schemaCreates or updates profile schema. > Each account has one profile schema. Updating it with this request will substitute the previous version. > Learn more…
API details
- Base URL
https://vtex.localhttps://{accountName}.{environment}.com.br- Authentication
- An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header - Operations
- 27 operations on 17 pathsGET 14POST 4PATCH 4DELETE 4PUT 1
- Main resources
- Addresses 9Profiles 7Prospects 5Purchase information 5Schemas 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Profile System in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Profile System collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create client profile” (POST /api/storage/profile-system/profiles?ttl=365), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Profile System?
Create shopper profiles and manage their information. It is listed under Other and has 27 endpoints.
Who publishes the Profile System?
It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Profile System?
Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Profile System?
It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.
How many endpoints does the Profile System have?
27 operations on 17 paths (14 GET, 4 POST, 4 PATCH, 4 DELETE, 1 PUT). The largest groups are Addresses, Profiles, Prospects, Purchase information.
Is forking the Profile System free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.