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.

Learn more about all Order Status and flow in VTEX OMS.

Status available to filter
order-created
on-order-completed
on-order-completed-ffm
payment-pending
waiting-for-order-authorization
approve-payment
payment-approved
request-cancel
waiting-for-seller-decision
waiting-ffmt-authorization
waiting-for-authorization
waiting-for-manual-authorization
authorize-fulfillment
order-create-error
order-creation-error
window-to-cancel
window-to-change-seller
waiting-for-mkt-authorization
waiting-seller-handling
ready-for-handling
start-handling
handling
invoice-after-cancellation-deny
order-accepted
invoice
invoiced
replaced
cancellation-requested
cancel
canceled

Response codes

200 - Success

403 - The credentials are not enabled to access the service

404 - Value not found

429 - Too many requests

The event will be removed if the message "send retry" is equal to, or greater than the maximum retention period.

Request body example

{
    "filter": {
        "type": "FromWorkflow",
        "status": [
            “order-completed”,
            "ready-for-handling",
            “start-handling”,
            “handling”,
            “waiting-ffmt-authorization”,
            “cancel”
        ]
    },
    "queue": {
        "visibilityTimeoutInSeconds": 240,
        "messageRetentionPeriodInSeconds": 345600
    },
    "quantity": 1261,
    "aproximateAgeOfOldestMessageInSeconds": 1113.349305555555
}
Language
Authentication
URL
Click Try It! to start a request and see the response here!