Sign in

v60

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01361201.5 MB
Orders

Add log in orders

Add a Log in Interactions Order Array.

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:

ProductCategoryResource
CheckoutCheckoutResourcesOrders Full Access

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.

post/api/oms/pvt/orders/{orderId}/interactions

Path parameters

orderIdstring required
Example:1172452900788-01

Unique code that identifies an order.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

sourcestring required

Source information.

messagestring required

Interactions message.

Response

OK