Remove all personal data from shopping cart
This call removes all user information, making a cart anonymous while leaving the items.
The orderForm is the data structure that represents a shopping cart and contains all information about it. Hence, the orderFormId is the identification code of a given cart.
This call works by creating a new orderForm, setting a new cookie, and returning a redirect 302 to the cart URL (/checkout/#/orderform).
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 | Save OrderForm Configuration |
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 corresponding to the cart whose user's personal data you want to remove.
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.
Response
OK