Set single custom field value
Your account may create apps, which contain custom fields, through the Update orderForm configuration request. The value of a specific custom field can then be updated by this request.
To do that, you need to inform in the URL the ID of the app you created with the configuration API (appId).
In the body of the request, you will inform the new value (appFieldValue, passed through the body) of the specific field created in this app (identified by the appFieldName parameter, passed through the URL).
The orderForm is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart.
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 |
|---|---|---|
| Checkout | CheckoutResources | Read Shopping Cart |
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.
Path parameters
The ID of the orderForm whose custom field's value you want to change.
ID of the app created through the Update orderForm Configuration endpoint.
Name of the app's field created through the Update orderForm Configuration endpoint.
Query parameters
Shows the product's estimated shipping date in the shippingEstimate field from the orderForm.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Request body
Response
OK