VTEX · Schema

CreateInteractionRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
startDate string
source string This attribute defines the entity responsible for the interaction. Possible values include `seller` or `channel`.
origin string This attribute defines where the interaction originated from. Possible values include `catalog`, `price` or `inventory`. Interactions are usually used to deal with a single type of process at a time.
context string This field informs Sent Offers about an offer's lifecycle. When the integration has been recently installed, and producst are being sent for the first time, the value should be `setup`. If it's an upd
View JSON Schema on GitHub

JSON Schema

vtex-createinteractionrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateInteractionRequest",
  "title": "CreateInteractionRequest",
  "required": [
    "startDate",
    "source",
    "origin",
    "context"
  ],
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string",
      "default": "2020-10-29"
    },
    "source": {
      "type": "string",
      "description": "This attribute defines the entity responsible for the interaction. Possible values include `seller` or `channel`.",
      "default": "seller"
    },
    "origin": {
      "type": "string",
      "description": "This attribute defines where the interaction originated from. Possible values include `catalog`, `price` or `inventory`. Interactions are usually used to deal with a single type of process at a time. However, there are situations in which data about catalog, price and inventory are added in the same interaction.",
      "default": "catalog"
    },
    "context": {
      "type": "string",
      "description": "This field informs Sent Offers about an offer's lifecycle. When the integration has been recently installed, and producst are being sent for the first time, the value should be `setup`. If it's an update log, when the interaction is already up and running, the value should be `ongoing`.",
      "default": "setup"
    }
  }
}