---
title: "Get feed configuration"
method: GET
path: "/api/orders/feed/config"
tags: ["Feed v3"]
---

# Get feed configuration

`GET /api/orders/feed/config`

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](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration).

> Check the [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview) for a journey-based overview of the Orders documentation available in the Developer Portal.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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** |
| --------------- | ----------------- | ----------------- |
| OMS | OMS Access | **Feed v3 and Hook view only** |
| OMS | OMS Access | **Feed v3 and Hook Admin** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `filter` object — Information on how orders are filtered to show on the feed.
    - `type` string — Determines what orders appear in the feed and how they are filtered. If a feed has the `FromWorkflow` type configuration, it will receive order updates only when order's statuses change and orders can be filtered by status, using the `status` field. A feed with the `FromOrders` type configuration gets updates whenever any change is made to an order. in this case, orders can be filtered by any property, according to JSONata expressions set in the `expression` field.
    - `status` string[] — List of order statuses that should be included in the feed. This should only be used in case `type` is `FromWorkflow`.
    - `expression` string — JSONata query expression that defines what conditions must be met for an order to be included in the feed. This should only be used in case `type` is `FromOrders`.
    - `disableSingleFire` boolean — Sets a limit to how many times a specific order shows on the feed, after it first meets filtering conditions. Using the `FromOrders` type configuration with JSONata filtering expressions might cause orders to appear more than once on a feed, whenever changes are made to that order. If this field is `false` orders will appear in the feed only once.
  - `queue` object — Information that define the functioning of the queue.
    - `visibilityTimeoutInSeconds` integer — Period of time for which an item is not visible in the feed after it has been retrieved with the Get feed items request. Measured in seconds.
    - `MessageRetentionPeriodInSeconds` integer — Maximum life span of an order update after it gets to the feed. When a feed item is on the feed for this period of time, it is removed from the feed. Measured in seconds. The maximum number accepted in this field is `1209600` seconds.
  - `quantity` integer — Current number of messages in the feed, including messages that may not be visible due to time out after retrieval.
  - `approximateAgeOfOldestMessageInSeconds` number — Aproximate age of the oldest message in the feed, measured in seconds.

---

[API](https://skmtc.dev/vtex/apis/orders-api.md) · [All operations](https://skmtc.dev/vtex/apis/orders-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/orders-api/revisions/cb5fa08e400c/schema)