VTEX · Schema

Queue

Object with information about timeout and message retention.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
visibilityTimeoutInSeconds integer Period of time for which an item becomes invisible after it has been [retrieved](https://developers.vtex.com/vtex-rest-api/reference/feed-v3#getfeedorderstatus1). Measured in seconds.
MessageRetentionPeriodInSeconds integer Maximum life span of an order update in the feed. When a feed item is on the feed for this period of time, it is removed from the feed. Measured in seconds.
View JSON Schema on GitHub

JSON Schema

vtex-queue-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Queue",
  "title": "Queue",
  "description": "Object with information about timeout and message retention.",
  "required": [
    "visibilityTimeoutInSeconds",
    "MessageRetentionPeriodInSeconds"
  ],
  "type": "object",
  "properties": {
    "visibilityTimeoutInSeconds": {
      "type": "integer",
      "description": "Period of time for which an item becomes invisible after it has been [retrieved](https://developers.vtex.com/vtex-rest-api/reference/feed-v3#getfeedorderstatus1). Measured in seconds.",
      "example": 250
    },
    "MessageRetentionPeriodInSeconds": {
      "type": "integer",
      "description": "Maximum life span of an order update in the feed. When a feed item is on the feed for this period of time, it is removed from the feed. Measured in seconds.",
      "example": 3456000
    }
  }
}