Change price of an SKU in a cart
This request changes the price of an SKU in a cart.
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.
You need to inform which cart you are referring to, by sending its orderFormId and what is the item whose price you want to change, by sending its itemIndex.
You also need to pass the new price value in the body.
Remember that, to use this endpoint, the feature of manual price must be active. To check if it's active, use the Get orderForm configuration endpoint. To make it active, use the Update orderForm configuration endpoint, making the allowManualPrice field true.
Whenever you use this request to change the price of an item, all items in that cart with the same SKU are affected by this change. This applies even to items that share the SKU but have been separated into different objects in the items array due to customizations or attachments, for example.
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 corresponding to the cart whose items will have the price changed.
The index of the item in the cart. Each cart item is identified by an index, starting in 0.
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
{
"price": 10000
}Response
OK