Process order
Order processing callback request, which is made after an order's payment is approved.
This request has to be made within five minutes after the Place order or Place order from existing cart request has been made, or else, the order will not be processed.
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 Order 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
Order group. It is the part of the orderId that comes before the -. For example, the orderGroup of the order 123456789-01 is 123456789.
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.
VTEX Chekout cookie associated with a specific order. Use the Vtex_CHKO_Auth and the CheckoutDataAccess cookies returned by the Place order or Place order from existing cart API requests, like a browser would.
Response
OK