POST
/api/checkout/pub/gatewayCallback/{orderGroup}
Process order
orderGroup path · required — Order group. It is the part of the `orderId` that comes before the `-`. For example, the `orderGroup` of the order `123456789-01` is `123456789`.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.Cookie header · required — VTEX Chekout cookie associated with a specific order. Use the `Vtex_CHKO_Auth` and the `CheckoutDataAccess` cookies returned by the [Place order](https://developers.vtex.com/vtex-rest-api/reference/order-placement-1#placeorder) or [Place order from existing cart](https://developers.vtex.com/vtex-rest-api/reference/order-placement-1#placeorderfromexistingorderform) API requests, like a browser would.
GET
/api/checkout/pub/orderForm
Get current or create a new cart
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.forceNewCart query — Use this query parameter to create a new empty shopping cart.
GET
/api/checkout/pub/orderForm/{orderFormId}
Get cart information by ID
orderFormId path · required — ID of the orderForm corresponding to the cart whose information you want to retrieve.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.refreshOutdatedData query — It is possible to use the [Update cart items request](https://developers.vtex.com/vtex-rest-api/reference/cart-update#itemsupdate) so as to allow outdated information in the `orderForm`, which may improve performance in some cases. To guarantee that all cart information is updated, send this request with this parameter as `true`. We recommend doing this in the final stages of the shopping experience, starting from the checkout page.
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData
Add client preferences
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.orderFormId path · required — ID of the orderForm that will receive client profile information.
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData
Add client profile
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.orderFormId path · required — ID of the orderForm that will receive client profile information.
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData
Add marketing data
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.orderFormId path · required — ID of the orderForm that will receive client profile information.
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData
Add merchant context data
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.orderFormId path · required — ID of the orderForm that will receive the relevant information added by the merchant.
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData
Add payment data
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.orderFormId path · required — ID of the orderForm that will receive client profile information.
POST
/api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData
Add shipping address and select delivery option
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.orderFormId path · required — ID of the orderForm that will receive client profile information.
POST
/api/checkout/pub/orderForm/{orderFormId}/coupons
Add coupons to the cart
orderFormId path · required — ID of the orderForm that will receive coupon information.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
PUT
/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}
Set multiple custom field values
orderFormId path · required — ID of the orderForm that will receive the new custom field values.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.appId path · required — ID of the app created with the configuration API.
DELETE
/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName}
Remove single custom field value
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.orderFormId path · required — The ID of the orderForm from which you want to remove the custom field value.appId path · required — ID of the app created through the Update orderForm Configuration endpoint.appFieldName path · required — Name of the app's field created through the Update orderForm Configuration endpoint and which will be deleted.
PUT
/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName}
Set single custom field value
orderFormId path · required — The ID of the orderForm whose custom field's value you want to change.appId path · required — ID of the app created through the Update orderForm Configuration endpoint.appFieldName path · required — Name of the app's field created through the Update orderForm Configuration endpoint.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST
/api/checkout/pub/orderForm/{orderFormId}/transaction
Place order from an existing cart
orderFormId path · required — ID of the `orderForm` corresponding to the cart from which to place the order.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET
/api/checkout/pub/orderForm/{orderFormId}/installments
Cart installments
orderFormId path · required — ID of the `orderForm` to be consulted for installments.paymentSystem query · required — ID of the payment method to be consulted for installments.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST
/api/checkout/pub/orderForm/{orderFormId}/items
Add cart items
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.orderFormId path · required — ID of the orderForm corresponding to the cart in which the new item will be added.allowedOutdatedData query — In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance. This array accepts strings and currently the only possible value is `”paymentData”`.
POST
/api/checkout/pub/orderForm/{orderFormId}/items/removeAll
Remove all items
orderFormId path · required — ID of the orderForm corresponding to the cart whose items you want to remove.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST
/api/checkout/pub/orderForm/{orderFormId}/items/update
Update cart items
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.orderFormId path · required — ID of the `orderForm` corresponding to the cart whose items you want to update.allowedOutdatedData query — In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance. This array accepts strings and currently the only possible value is `”paymentData”`.
PUT
/api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price
Change price
orderFormId path · required — ID of the orderForm corresponding to the cart whose items will have the price changed.itemIndex path · required — The index of the item in the cart. Each cart item is identified by an index, starting in 0.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST
/api/checkout/pub/orderForm/{orderFormId}/messages/clear
Clear orderForm messages
orderFormId path · required — ID of the orderForm corresponding to the cart whose messages you want to remove.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
PATCH
/api/checkout/pub/orderForm/{orderFormId}/profile
Ignore profile data
orderFormId path · required — ID of the orderForm corresponding to the cart whose items will have the price changed.Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST
/api/checkout/pub/orderForms/simulation
Cart simulation
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.RnbBehavior query — This parameter defines which promotions apply to the simulation. Use `0` for simulations at cart stage, which means all promotions apply. In case of window simulation use `1`, which indicates promotions that apply nominal discounts over the total purchase value shouldn't be considered on the simulation. Note that if this not sent, the parameter is `1`.sc query — Trade Policy (Sales Channel) identification.
PUT
/api/checkout/pub/orders
Place order
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.sc query — Trade Policy (Sales Channel) identification. This query can be used to create an order for a specific sales channel.
GET
/api/checkout/pub/pickup-points
List pickup points by location
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.geoCoordinates query — Geocoordinates (first longitude, then latitude) around which to search for pickup points. If you use this type of search, do not pass postal and country codes.postalCode query — Postal code around which to search for pickup points. If you use this type of search, make sure to pass a `countryCode` and do not pass `geoCoordinates`.countryCode query — Three letter country code refering to the `postalCode` field. Pass the country code only if you are searching pickup points by postal code.
GET
/api/checkout/pub/postal-code/{countryCode}/{postalCode}
Get address by postal code
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.countryCode path · required — Three letter country code refering to the `postalCode` field.postalCode path · required — Postal code.
GET
/api/checkout/pub/profiles
Get client profile by email
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.email query · required — Client's email address to be searched.
GET
/api/checkout/pub/regions/{regionId}
Get sellers by region or address
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.regionId path · required — ID of the region corresponding to the shopper's location.country query · required — Three letter country code refering to the `postalCode` field.postalCode query — Postal code corresponding to the shopper's location.geoCoordinates query — Geocoordinates (first longitude, semicolon, then latitude) corresponding to the shopper's location.
GET
/api/checkout/pvt/configuration/orderForm
Get orderForm configuration
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST
/api/checkout/pvt/configuration/orderForm
Update orderForm configuration
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET
/api/checkout/pvt/configuration/window-to-change-seller
Get window to change seller
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST
/api/checkout/pvt/configuration/window-to-change-seller
Update window to change seller
Content-Type header · required — Type of the content being sent.Accept header · required — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
