{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Offer Management API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Offer Management",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Create Channel",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/sent-offers/channels",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the seller's VTEX account. Used as query param."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": ">ℹ \r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integratio"
        },
        {
          "info": {
            "name": "VTex List Feeds",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/sent-offers/feeds",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the Seller's VTEX account. Used as query param."
              }
            ]
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Activate Feed",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/sent-offers/feeds",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as query param."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Get Feed by feedId",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/sent-offers/feeds/:feedId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as query param."
              },
              {
                "name": "feedId",
                "value": "",
                "type": "path",
                "description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`."
              }
            ]
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Update Feed",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{providerApiEndpoint}/api/sent-offers/feeds/:feedId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as query param."
              },
              {
                "name": "feedId",
                "value": "",
                "type": "path",
                "description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Deactivate Feed",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{providerApiEndpoint}/api/sent-offers/feeds/:feedId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as query param."
              },
              {
                "name": "feedId",
                "value": "",
                "type": "path",
                "description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`."
              }
            ]
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Open Interaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/sent-offers/feeds/:feedId/skus/:skuId/interactions",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as query param."
              },
              {
                "name": "feedId",
                "value": "",
                "type": "path",
                "description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`."
              },
              {
                "name": "skuId",
                "value": "",
                "type": "path",
                "description": "This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Get Interaction Data by interactionId",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as query param."
              },
              {
                "name": "feedId",
                "value": "",
                "type": "path",
                "description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`."
              },
              {
                "name": "skuId",
                "value": "",
                "type": "path",
                "description": "This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog."
              },
              {
                "name": "interactionId",
                "value": "",
                "type": "path",
                "description": "This attribute is the code used to identify an existing interaction."
              }
            ]
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Close Interaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId/close",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as query param."
              },
              {
                "name": "feedId",
                "value": "",
                "type": "path",
                "description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`."
              },
              {
                "name": "skuId",
                "value": "",
                "type": "path",
                "description": "This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog."
              },
              {
                "name": "interactionId",
                "value": "",
                "type": "path",
                "description": "This attribute is the code used to identify an existing interaction."
              }
            ]
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Create Log",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId/logs",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as query param."
              },
              {
                "name": "feedId",
                "value": "",
                "type": "path",
                "description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`."
              },
              {
                "name": "skuId",
                "value": "",
                "type": "path",
                "description": "This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog."
              },
              {
                "name": "interactionId",
                "value": "",
                "type": "path",
                "description": "This attribute is the code used to identify an existing interaction."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Get Log Data by logId",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId/logs/:logId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as query param."
              },
              {
                "name": "feedId",
                "value": "",
                "type": "path",
                "description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`."
              },
              {
                "name": "skuId",
                "value": "",
                "type": "path",
                "description": "This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog."
              },
              {
                "name": "interactionId",
                "value": "",
                "type": "path",
                "description": "This attribute is the code used to identify an existing interaction."
              },
              {
                "name": "logId",
                "value": "",
                "type": "path",
                "description": "A log's identifying code. This attribute is obtained from the Open Log API, or from the response of a Search Interactions API."
              }
            ]
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Search Interactions and their Logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/sent-offers/search/interactions",
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as a query param."
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Customizable field for searching interactions."
              },
              {
                "name": "channels",
                "value": "",
                "type": "query",
                "description": "Search interactions, filtering by channel."
              },
              {
                "name": "brand",
                "value": "",
                "type": "query",
                "description": "Search interactions, filtering by brand."
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "Search interactions, filtering by category."
              },
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "Search interactions, filtering by scope."
              },
              {
                "name": "result",
                "value": "",
                "type": "query",
                "description": "Search interactions, filtering by result. Results can have the following values: \n\nSuccess: When events close their lifecycle successfully, and generate updates on an offer in terms of price, inventory, or catalog. \n\nFailure: When the connector has detected processes that have failed to be made  due to an error. \n\nNotification: When there are processes with the connector that are worth mentioning, but there are no actual updates. Ex: discarded updates or sendings of an offer. \n\nProcessing:  When an open interaction has not been concluded, and should still receive more steps. This is a transitory state, considering that when an interaction is closed, it can only end with `success`, `failure` or `notification` as its result."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Search interactions filtering by sort."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Search interactions from a given point."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Search interactions until a given point."
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query",
                "description": "Search interactions from a specific date."
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query",
                "description": "Search interactions until a given date."
              }
            ]
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        },
        {
          "info": {
            "name": "VTex Search Errors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/sent-offers/search/errors",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "an",
                "value": "",
                "type": "query",
                "description": "Name of the VTEX account. Used as query param."
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Customizable field for searching error codes."
              },
              {
                "name": "channels",
                "value": "",
                "type": "query",
                "description": "Search errors filtering by channels."
              },
              {
                "name": "brand",
                "value": "",
                "type": "query",
                "description": "Search errors filtering by brand."
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "Search errors filtering by category."
              },
              {
                "name": "errorCategory",
                "value": "",
                "type": "query",
                "description": "Search errors filtering by error category."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Pagination that returns a range of ordered error codes."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Pagination that returns error codes from a given point."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Pagination that returns error codes until a given point."
              }
            ]
          },
          "docs": "> ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integr"
        },
        {
          "info": {
            "name": "VTex Get Error Code data by errorCodeId",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/sent-offers/error-codes/:errorCodeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environment",
                "value": "",
                "type": "path",
                "description": "Environment to use. Used as part of the URL."
              },
              {
                "name": "errorCodeId",
                "value": "",
                "type": "path",
                "description": "Id for the error code chosen."
              }
            ]
          },
          "docs": ">ℹ \r\n>\r\n>To evolve your experience in synchronizing and updating offers, the VTEX team is developing a new functionality that will replace the current module <b>Offer Management</b> . As a result, the Offer Management module will not receive new updates or maintenance. \r\n>\r\n>For connectors and marketplaces already integrated into the module, please contact the development team by email [taissa.araujo@vtex.com.br](taissa.araujo@vtex.com.br). \r\n>\r\n>For connectors interested in starting the integra"
        }
      ]
    }
  ],
  "bundled": true
}