Add merchant context data
This endpoint is used for the merchant to add to the cart any relevant information that is related to the context of a specific order.
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.
This request has a timeout of 12 seconds.
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
ID of the orderForm that will receive the relevant information added by the merchant.
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
Example request
{
"salesAssociateData": {
"salesAssociateId": "seller123"
}
}Response
OK