Sign in

v60

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01361201.5 MB
Feed v3

Create or update feed configuration

The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our Feed v3 guide and our order integration guide

There are two types of filtering that can be used. The FromWorkflow type filters orders by status, whereas the FromOrders type uses JSONata expressions to filter orders according to any property in the orders JSON document. This enables stores to filter delivered orders and orders in which products have been added or removed, for example. To learn more, access the JSONata documentation and test filtering JSONata expressions with our Test JSONata expression endpoint.

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
OMSOMS AccessFeed v3 and Hook view only
OMSOMS AccessFeed v3 and Hook Admin

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/orders/feed/config

Headers

Acceptstring required

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

Content-Typestring required

Type of the content being sent.

Request body

Example request

{
  "filter": {
    "type": "FromWorkflow",
    "status": [
      "order-created",
      "on-order-completed",
      "payment-pending",
      "waiting-for-order-authorization",
      "approve-payment",
      "payment-approved",
      "request-cancel",
      "waiting-for-seller-decision",
      "authorize-fulfillment",
      "order-create-error",
      "order-creation-error",
      "window-to-cancel",
      "canceled"
    ],
    "expression": "value > 100"
  },
  "queue": {
    "visibilityTimeoutInSeconds": 250,
    "MessageRetentionPeriodInSeconds": 345600
  }
}

Response

OK