Custom Fields API
The Custom Fields API allows you to create, manage, and apply custom fields to contracts and orders in VTEX. Custom fields enable you to capture additional business-specific information at different levels: item, order, or address.
This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.
This API is divided into three main sections:
Custom field settings
Configure custom field definitions for contracts, including field name, type, level, and validation rules.
GETGet custom field settingsPOSTCreate custom field settingPATCHUpdate custom field settingDELETEDelete custom field setting
Custom field values
Manage the actual values assigned to custom fields for specific contracts.
Endpoints
Custom field settings
| Summary | Method | Path |
|---|---|---|
| Get custom field settings | GET | /api/dataentities/customFieldSettings/search |
| Create custom field settings | POST | /api/dataentities/customFieldSettings/documents |
| Update custom field settings | PATCH | /api/dataentities/customFieldSettings/documents/{documentId} |
| Delete custom field setting | DELETE | /api/dataentities/customFieldSettings/documents/{documentId} |
Custom field values
| Summary | Method | Path |
|---|---|---|
| Create custom field value | POST | /api/dataentities/customFieldValues/documents |
| Get custom field value | GET | /api/dataentities/customFieldValues/documents/{customFieldValueId} |
| Update custom field value | PATCH | /api/dataentities/customFieldValues/documents/{customFieldValueId} |
| Delete custom field value | DELETE | /api/dataentities/customFieldValues/documents/{customFieldValueId} |
| Search custom field values | GET | /api/dataentities/customFieldValues/search |