Default Values API
Default values are purchase details, such as addresses and credit cards, that you can configure for an organizational unit to be automatically pre-filled at checkout.
This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.
Authentication
You can authenticate requests to these APIs by sending a VTEX user token in a header named VtexIdclientAutCookie. Learn more in API authentication using user tokens.
Common parameters in the documentation
| Parameter name | Description |
|---|---|
{{accountName}} |
Name of the VTEX account. Used as part of the URL. |
{{environment}} |
Environment to use. The default value is vtexcommercestable. Used in the URL. |
{{X-VTEX-API-AppKey}} |
Unique identifier of the API key. |
{{X-VTEX-API-AppToken}} |
Secret token of the API key. |
Endpoints
Default values
| Summary | Method | Path |
|---|---|---|
| Create default values | POST | /api/dataentities/defaultValues/documents |
| Get default values | GET | /api/dataentities/defaultValues/documents/{unitId} |
| Update default values | PATCH | /api/dataentities/defaultValues/documents/{unitId} |
| Delete default values | DELETE | /api/dataentities/defaultValues/documents/{unitId} |