From 50e22ba1ba96457b449fe0c219825e5325342961 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Patr=C3=ADcia=20F=2E=20Barbosa?= Date: Tue, 27 Aug 2024 15:33:10 -0300 Subject: [PATCH 1/3] Deprecatioin Offer management Inclusion of callout on deprecation. --- VTEX - Marketplace APIs - Sent Offers.json | 28 +++++++++++----------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/VTEX - Marketplace APIs - Sent Offers.json b/VTEX - Marketplace APIs - Sent Offers.json index 644e7e135..ed4633c95 100644 --- a/VTEX - Marketplace APIs - Sent Offers.json +++ b/VTEX - Marketplace APIs - Sent Offers.json @@ -28,7 +28,7 @@ "Offer Management" ], "summary": "Create Channel", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n The first step for connectors to integrate with [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) is to create a channel, that represents the marketplace to where sellers will send their offers. \n\nThis endpoint creates a channel and the integration developers should call it once for each marketplace. The information about the marketplace sent in the request will be shown to sellers in their [Offer Management UI](https://help.vtex.com/en/tutorial/offers-listing--7MRb9S78aBdZjFGpbuffpE). \n\nThe `feedId` created by this call will apply to all sellers connected to the given channel, and will be necessary for the next step of the integration flow, which is to [activate feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds). \n\n>\u2139\r\n> Offer Management is available for integrations with [Mercado Livre (Classic and Premium)](https://help.vtex.com/pt/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq), [Netshoes](https://help.vtex.com/pt/tracks/configurar-integracao-da-netshoes--5Ua87lhFg4m0kEcuyqmcCm), and VTEX marketplaces. For more information, see [Offer Management Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors).", + "description": "❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\nThe first step for connectors to integrate with [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) is to create a channel, that represents the marketplace to where sellers will send their offers. \n\nThis endpoint creates a channel and the integration developers should call it once for each marketplace. The information about the marketplace sent in the request will be shown to sellers in their [Offer Management UI](https://help.vtex.com/en/tutorial/offers-listing--7MRb9S78aBdZjFGpbuffpE). \n\nThe `feedId` created by this call will apply to all sellers connected to the given channel, and will be necessary for the next step of the integration flow, which is to [activate feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds). \n\n>\u2139\r\n> Offer Management is available for integrations with [Mercado Livre (Classic and Premium)](https://help.vtex.com/pt/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq), [Netshoes](https://help.vtex.com/pt/tracks/configurar-integracao-da-netshoes--5Ua87lhFg4m0kEcuyqmcCm), and VTEX marketplaces. For more information, see [Offer Management Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors).", "operationId": "CreateChannel", "parameters": [ { @@ -141,7 +141,7 @@ ], "summary": "Activate Feed", "operationId": "CreateFeed", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\nIn [Offer Management](https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors), after [creating the channel](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), the next step is to create a feed, which is a list updated nearly in real time with information about the seller's offers sent to the marketplace. \n\nThis endpoint allows the creation of a feed so that the seller's sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) is connected to the marketplace. Feeds are nearly real time updated with content provided by the marketplace and VTEX modules. \n\nThis endpoint should only be used once, to activate the channel and establish the connection. However, after a [feed is deactivated](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#delete-/api/sent-offers/feeds/-feedId-), in order to activate it again it will be necessary another call to this endpoint.The integration starts with the creation of the Feed. This endpoint is used to establish the connection between connector and seller through the Sent Offers. \n\nThe `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when calling this endpoint. It follows the pattern `vendor.channel`.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\nIn [Offer Management](https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors), after [creating the channel](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), the next step is to create a feed, which is a list updated nearly in real time with information about the seller's offers sent to the marketplace. \n\nThis endpoint allows the creation of a feed so that the seller's sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) is connected to the marketplace. Feeds are nearly real time updated with content provided by the marketplace and VTEX modules. \n\nThis endpoint should only be used once, to activate the channel and establish the connection. However, after a [feed is deactivated](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#delete-/api/sent-offers/feeds/-feedId-), in order to activate it again it will be necessary another call to this endpoint.The integration starts with the creation of the Feed. This endpoint is used to establish the connection between connector and seller through the Sent Offers. \n\nThe `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when calling this endpoint. It follows the pattern `vendor.channel`.", "parameters": [ { "name": "environment", @@ -256,7 +256,7 @@ "Offer Management" ], "summary": "List Feeds", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace, and it is updated in real-time with content provided by the marketplace and VTEX modules. \n\nSince a seller can have integrations with multiple marketplaces, numerous feeds can be associated with an account. This endpoint retrieves a list with all the feeds related to an account.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace, and it is updated in real-time with content provided by the marketplace and VTEX modules. \n\nSince a seller can have integrations with multiple marketplaces, numerous feeds can be associated with an account. This endpoint retrieves a list with all the feeds related to an account.", "operationId": "ListFeeds", "parameters": [ { @@ -415,7 +415,7 @@ ], "summary": "Update Feed", "operationId": "UpdateFeed", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. \n\nOnce you have [created a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), this endpoint allows the seller to update the sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) and [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) ID used in the integration with the marketplace.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. \n\nOnce you have [created a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), this endpoint allows the seller to update the sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) and [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) ID used in the integration with the marketplace.", "parameters": [ { "name": "environment", @@ -502,7 +502,7 @@ ], "summary": "Get Feed by feedId", "operationId": "RetrieveFeed", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), after you have [created the channel](https://developers.vtex.com/vtex-rest-api/reference/createchannel), the next step is to create a feed, which is a list of information about the seller's offers sent to the marketplace. \n\nThis endpoint retrieves information about a specific feed by searching through its `feedId`.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), after you have [created the channel](https://developers.vtex.com/vtex-rest-api/reference/createchannel), the next step is to create a feed, which is a list of information about the seller's offers sent to the marketplace. \n\nThis endpoint retrieves information about a specific feed by searching through its `feedId`.", "parameters": [ { "name": "environment", @@ -616,7 +616,7 @@ ], "summary": "Deactivate Feed", "operationId": "DeleteFeed", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. After [creating a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds), it will be activated; and through this endpoint the seller can deactivate the feed. \n\nWhen a feed is deactivated, all data related to the marketplace is removed from Offer Management UI. That includes the channels, offers, interactions, and errors. \n\nDeactivating a feed does not mean deleting information, and the seller can restore the data by [activating the feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds) again.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. After [creating a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds), it will be activated; and through this endpoint the seller can deactivate the feed. \n\nWhen a feed is deactivated, all data related to the marketplace is removed from Offer Management UI. That includes the channels, offers, interactions, and errors. \n\nDeactivating a feed does not mean deleting information, and the seller can restore the data by [activating the feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds) again.", "parameters": [ { "name": "environment", @@ -690,7 +690,7 @@ ], "summary": "Open Interaction", "operationId": "CreateInteraction", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called Interaction. For every action that happens to an offer, whether it is a status notification or a price update, the connector creates an Interaction about it. \n\nThis endpoint creates a new interaction for an SKU so that changes can be applied to an offer. The changes informed by interactions are related to: price, inventory, catalog and status. \n\nUsually, interactions process a single type of change at a time, but it is possible to add data about catalog, price, and inventory simultaneously in the same interaction.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called Interaction. For every action that happens to an offer, whether it is a status notification or a price update, the connector creates an Interaction about it. \n\nThis endpoint creates a new interaction for an SKU so that changes can be applied to an offer. The changes informed by interactions are related to: price, inventory, catalog and status. \n\nUsually, interactions process a single type of change at a time, but it is possible to add data about catalog, price, and inventory simultaneously in the same interaction.", "parameters": [ { "name": "environment", @@ -869,7 +869,7 @@ ], "summary": "Get Interaction Data by interactionId", "operationId": "RetrieveInteraction", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nA unique code called `interactionId` is used to identify each interaction. This endpoint retrieves information about an interaction, searching by its `interactionId`. \n\nIt also retrieves existing logs through the `log` field.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nA unique code called `interactionId` is used to identify each interaction. This endpoint retrieves information about an interaction, searching by its `interactionId`. \n\nIt also retrieves existing logs through the `log` field.", "parameters": [ { "name": "environment", @@ -1042,7 +1042,7 @@ ], "summary": "Close Interaction", "operationId": "CloseInteraction", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nOnce an interaction has fulfilled its initial goal and there are no more actions (or [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs)) taking place within it, this endpoint closes an interaction.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nOnce an interaction has fulfilled its initial goal and there are no more actions (or [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs)) taking place within it, this endpoint closes an interaction.", "parameters": [ { "name": "environment", @@ -1138,7 +1138,7 @@ ], "summary": "Create Log", "operationId": "CreateLog", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), and they are organized in a timeline. All of the micro-steps of an interaction are represented through logs; they are how interactions become visible in Offer Management UI. \n\nThis endpoint adds logs that take place within an interaction, which can be done after [creating an interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions) so that there will be an `interactionId`. \n\n`Errors`: When Offer Management, or the connectors, find an error that prevents sending or updating an offer to a channel, they should open a type failure log, and fill in its details through the `errors` attribute. The information provided should enable sellers to identify and fix errors on their offers. \n\nThe connectors should go through every possible validation, identify all errors, and only after that create the failure log, with the information in a single request.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), and they are organized in a timeline. All of the micro-steps of an interaction are represented through logs; they are how interactions become visible in Offer Management UI. \n\nThis endpoint adds logs that take place within an interaction, which can be done after [creating an interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions) so that there will be an `interactionId`. \n\n`Errors`: When Offer Management, or the connectors, find an error that prevents sending or updating an offer to a channel, they should open a type failure log, and fill in its details through the `errors` attribute. The information provided should enable sellers to identify and fix errors on their offers. \n\nThe connectors should go through every possible validation, identify all errors, and only after that create the failure log, with the information in a single request.", "parameters": [ { "name": "environment", @@ -1324,7 +1324,7 @@ ], "summary": "Get Log Data by logId", "operationId": "RetrieveLog", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), organized in a timeline. All interaction's micro-steps will be represented through logs; they are how interactions become visible in Offer Management UI. \n\nA unique code called `logId` is used to identify every log created. This endpoint enables the retrieval of information about a log by searching through its `logId`.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), organized in a timeline. All interaction's micro-steps will be represented through logs; they are how interactions become visible in Offer Management UI. \n\nA unique code called `logId` is used to identify every log created. This endpoint enables the retrieval of information about a log by searching through its `logId`.", "parameters": [ { "name": "environment", @@ -1512,7 +1512,7 @@ ], "summary": "Search Interactions and their Logs", "operationId": "SearchInteractions", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). The granular details of actions and micro-steps that happen within an interaction's are called [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs). \n\nThis endpoint retrieves information about interactions and all logs within it. It allows filtering interactions by using the following query params: `channel`, `brand`, `category`, `scope`, `result`, `fromDate`, `toDate`. This endpoint also counts with the following pagination query params: `sort`, `from`, `to`.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). The granular details of actions and micro-steps that happen within an interaction's are called [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs). \n\nThis endpoint retrieves information about interactions and all logs within it. It allows filtering interactions by using the following query params: `channel`, `brand`, `category`, `scope`, `result`, `fromDate`, `toDate`. This endpoint also counts with the following pagination query params: `sort`, `from`, `to`.", "parameters": [ { "name": "environment", @@ -1685,7 +1685,7 @@ ], "summary": "Search Errors", "operationId": "SearchErrors", - "description": "> \u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n This endpoint provides the single source of truth of updated error codes in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It retrieves a list of all the error codes available at that moment. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system. \n\nThis endpoint allows filtering errors by using the following query params: `channel`, `brand`, `category`, `errorCategory`. It also counts with the following pagination query params: `sort`, `from`, `to`, `q`.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n This endpoint provides the single source of truth of updated error codes in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It retrieves a list of all the error codes available at that moment. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system. \n\nThis endpoint allows filtering errors by using the following query params: `channel`, `brand`, `category`, `errorCategory`. It also counts with the following pagination query params: `sort`, `from`, `to`, `q`.", "parameters": [ { "name": "environment", @@ -1844,7 +1844,7 @@ ], "summary": "Get Error Code data by errorCodeId", "operationId": "RetrieveErrorCode", - "description": ">\u2139 \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n This endpoint retrieves specific information about an error code in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It provides the single source of truth of updated information about an error code through the `errorCodeId`. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n This endpoint retrieves specific information about an error code in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It provides the single source of truth of updated information about an error code through the `errorCodeId`. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system.", "parameters": [ { "name": "environment", From 3fcf46fb6d34e89eb714259021b137b9669c4b70 Mon Sep 17 00:00:00 2001 From: anabaarbosa <> Date: Tue, 27 Aug 2024 18:35:01 +0000 Subject: [PATCH 2/3] Update generated files by portman --- ...VTEX - Marketplace APIs - Sent Offers.json | 1371 +++++++++-------- 1 file changed, 716 insertions(+), 655 deletions(-) diff --git a/PostmanCollections/VTEX - Marketplace APIs - Sent Offers.json b/PostmanCollections/VTEX - Marketplace APIs - Sent Offers.json index 5e650119b..c9ec35cf1 100644 --- a/PostmanCollections/VTEX - Marketplace APIs - Sent Offers.json +++ b/PostmanCollections/VTEX - Marketplace APIs - Sent Offers.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "e2b7a584-e4ff-4770-8235-66ece8ab660a" + "postman_id": "d62b9d70-ade8-4f16-a758-3634ab3c6319" }, "item": [ { - "id": "8ac4c4cc-114c-4813-aa01-ccaca1708f94", + "id": "8b8f39aa-8fce-428a-b14d-8d00ff989feb", "name": "Offer Management", "description": { "content": "", @@ -12,12 +12,12 @@ }, "item": [ { - "id": "bbe54281-930e-4149-8765-29f68e1403eb", + "id": "990fc398-f2ed-4d1f-8bb0-1a1ec5ff13aa", "name": "Create Channel", "request": { "name": "Create Channel", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n The first step for connectors to integrate with [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) is to create a channel, that represents the marketplace to where sellers will send their offers. \n\nThis endpoint creates a channel and the integration developers should call it once for each marketplace. The information about the marketplace sent in the request will be shown to sellers in their [Offer Management UI](https://help.vtex.com/en/tutorial/offers-listing--7MRb9S78aBdZjFGpbuffpE). \n\nThe `feedId` created by this call will apply to all sellers connected to the given channel, and will be necessary for the next step of the integration flow, which is to [activate feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds). \n\n>ℹ\r\n> Offer Management is available for integrations with [Mercado Livre (Classic and Premium)](https://help.vtex.com/pt/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq), [Netshoes](https://help.vtex.com/pt/tracks/configurar-integracao-da-netshoes--5Ua87lhFg4m0kEcuyqmcCm), and VTEX marketplaces. For more information, see [Offer Management Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors).", + "content": "❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\nThe first step for connectors to integrate with [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) is to create a channel, that represents the marketplace to where sellers will send their offers. \n\nThis endpoint creates a channel and the integration developers should call it once for each marketplace. The information about the marketplace sent in the request will be shown to sellers in their [Offer Management UI](https://help.vtex.com/en/tutorial/offers-listing--7MRb9S78aBdZjFGpbuffpE). \n\nThe `feedId` created by this call will apply to all sellers connected to the given channel, and will be necessary for the next step of the integration flow, which is to [activate feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds). \n\n>ℹ\r\n> Offer Management is available for integrations with [Mercado Livre (Classic and Premium)](https://help.vtex.com/pt/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq), [Netshoes](https://help.vtex.com/pt/tracks/configurar-integracao-da-netshoes--5Ua87lhFg4m0kEcuyqmcCm), and VTEX marketplaces. For more information, see [Offer Management Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors).", "type": "text/plain" }, "url": { @@ -44,16 +44,34 @@ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Environment to use. Used as part of the URL.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", + "value": "vtexcommercestable", "key": "environment" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, { "key": "Content-Type", "value": "application/json" @@ -69,6 +87,7 @@ "raw": "{\n \"vendor\": \"vtex\",\n \"name\": \"Amazon\",\n \"logo\": \"https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/madeiramadeira.png\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -79,7 +98,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "589b328c-653d-4ab4-910a-be1c00bb4075", + "id": "f5eddb59-6025-4a4a-8d0d-b62f3b90e163", "name": "Created", "originalRequest": { "url": { @@ -92,33 +111,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "accountName" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Name of the seller's VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "an", + "value": "accountName" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -137,9 +142,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -148,6 +165,7 @@ "raw": "{\n \"vendor\": \"vtex\",\n \"name\": \"Amazon\",\n \"logo\": \"https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/madeiramadeira.png\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -161,7 +179,7 @@ "value": "application/json" } ], - "body": "{\n \"vendor\": \"vtex\",\n \"name\": \"Amazon\",\n \"logo\": \"https://marketplace.com/logos/logo.png\"\n}", + "body": "{\n \"id\": \"vtex.amazon\",\n \"vendor\": \"vtex\",\n \"name\": \"Amazon\",\n \"logo\": \"https://marketplace.com/logos/logo.png\"\n}", "cookie": [] } ], @@ -169,7 +187,7 @@ { "listen": "test", "script": { - "id": "206ce55f-a744-4926-83c1-3360fea84dbe", + "id": "2aa61a6e-c94b-44c6-8a7b-1c8f52a12327", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/sent-offers/channels - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -185,12 +203,12 @@ } }, { - "id": "51f214e8-a7d4-4ea2-81c5-f4ac38e000a2", + "id": "dc4d84e3-09ee-4305-9df6-0f5f1e634891", "name": "Activate Feed", "request": { "name": "Activate Feed", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\nIn [Offer Management](https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors), after [creating the channel](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), the next step is to create a feed, which is a list updated nearly in real time with information about the seller's offers sent to the marketplace. \n\nThis endpoint allows the creation of a feed so that the seller's sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) is connected to the marketplace. Feeds are nearly real time updated with content provided by the marketplace and VTEX modules. \n\nThis endpoint should only be used once, to activate the channel and establish the connection. However, after a [feed is deactivated](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#delete-/api/sent-offers/feeds/-feedId-), in order to activate it again it will be necessary another call to this endpoint.The integration starts with the creation of the Feed. This endpoint is used to establish the connection between connector and seller through the Sent Offers. \n\nThe `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when calling this endpoint. It follows the pattern `vendor.channel`.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\nIn [Offer Management](https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors), after [creating the channel](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), the next step is to create a feed, which is a list updated nearly in real time with information about the seller's offers sent to the marketplace. \n\nThis endpoint allows the creation of a feed so that the seller's sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) is connected to the marketplace. Feeds are nearly real time updated with content provided by the marketplace and VTEX modules. \n\nThis endpoint should only be used once, to activate the channel and establish the connection. However, after a [feed is deactivated](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#delete-/api/sent-offers/feeds/-feedId-), in order to activate it again it will be necessary another call to this endpoint.The integration starts with the creation of the Feed. This endpoint is used to establish the connection between connector and seller through the Sent Offers. \n\nThe `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when calling this endpoint. It follows the pattern `vendor.channel`.", "type": "text/plain" }, "url": { @@ -217,16 +235,34 @@ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Environment to use. Used as part of the URL.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", + "value": "vtexcommercestable", "key": "environment" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, { "key": "Content-Type", "value": "application/json" @@ -242,6 +278,7 @@ "raw": "{\n \"id\": \"{{feedId}}\",\n \"affiliateId\": \"MKP\",\n \"salesChannels\": \"5\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -252,7 +289,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7e167927-4817-40dd-af69-3cc301e4dd46", + "id": "cc8c9eba-c0d1-4033-ab05-032068752004", "name": "Created", "originalRequest": { "url": { @@ -265,33 +302,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Name of the VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -310,9 +333,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -321,6 +356,7 @@ "raw": "{\n \"id\": \"{{feedId}}\",\n \"affiliateId\": \"MKP\",\n \"salesChannels\": \"5\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -342,7 +378,7 @@ { "listen": "test", "script": { - "id": "817c618b-2a6d-44a1-9079-9490a7790088", + "id": "b2ab90c7-7130-42d4-8c7c-9ae1f4bba0b6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/sent-offers/feeds - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -358,12 +394,12 @@ } }, { - "id": "5be9800a-680d-446f-a784-859497523443", + "id": "350a5d35-28b2-47c2-b5d2-afbe5e243100", "name": "List Feeds", "request": { "name": "List Feeds", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace, and it is updated in real-time with content provided by the marketplace and VTEX modules. \n\nSince a seller can have integrations with multiple marketplaces, numerous feeds can be associated with an account. This endpoint retrieves a list with all the feeds related to an account.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace, and it is updated in real-time with content provided by the marketplace and VTEX modules. \n\nSince a seller can have integrations with multiple marketplaces, numerous feeds can be associated with an account. This endpoint retrieves a list with all the feeds related to an account.", "type": "text/plain" }, "url": { @@ -390,29 +426,48 @@ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Environment to use. Used as part of the URL.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", + "value": "vtexcommercestable", "key": "environment" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "998b2691-3e66-4f21-bdf5-80099d00faa6", + "id": "4529ac9e-5c72-4343-b284-d49495ca9b81", "name": "OK", "originalRequest": { "url": { @@ -425,33 +480,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Name of the Seller's VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -473,6 +514,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -494,7 +543,7 @@ { "listen": "test", "script": { - "id": "1cb0773d-6315-4feb-b452-30194d1d8bc2", + "id": "f9b116d5-2582-4ad3-a5fa-3cbcf7bd8b8d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/sent-offers/feeds - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -510,12 +559,12 @@ } }, { - "id": "1386459e-6510-4fad-80f1-21c4cbbdc5c2", + "id": "7065874d-1897-424d-abb1-2885bcc1ed05", "name": "Update Feed", "request": { "name": "Update Feed", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. \n\nOnce you have [created a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), this endpoint allows the seller to update the sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) and [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) ID used in the integration with the marketplace.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. \n\nOnce you have [created a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), this endpoint allows the seller to update the sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) and [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) ID used in the integration with the marketplace.", "type": "text/plain" }, "url": { @@ -543,26 +592,44 @@ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) 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`.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", - "key": "environment" + "value": "vtex.amazon", + "key": "feedId" }, { "disabled": false, "description": { - "content": "(Required) 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`.", + "content": "(Required) Environment to use. Used as part of the URL.", "type": "text/plain" }, "type": "any", - "value": "vtex.amazon", - "key": "feedId" + "value": "vtexcommercestable", + "key": "environment" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, { "key": "Content-Type", "value": "application/json" @@ -574,6 +641,7 @@ "raw": "{\n \"affiliateId\": \"MKP\",\n \"salesChannels\": \"5\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -584,7 +652,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "6daa695c-a595-4fb0-8bbf-036ce6e1b34a", + "id": "73414691-65ef-42eb-bf3d-a0ea055ef9d2", "name": "No Content", "originalRequest": { "url": { @@ -598,43 +666,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, { "disabled": false, "description": { - "content": "(Required) 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`.", + "content": "(Required) Name of the VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "vtex.amazon", - "key": "feedId" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -652,6 +696,18 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -660,6 +716,7 @@ "raw": "{\n \"affiliateId\": \"MKP\",\n \"salesChannels\": \"5\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -667,13 +724,7 @@ }, "status": "No Content", "code": 204, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -681,7 +732,7 @@ { "listen": "test", "script": { - "id": "b688cae6-3194-4623-ab29-ec5d5cb825fa", + "id": "8474aa0b-2d45-40a1-8e63-f540e1cfcaf5", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/sent-offers/feeds/:feedId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -695,12 +746,12 @@ } }, { - "id": "bfd21735-22b0-401a-b1f4-dd3d0c25eccc", + "id": "76701d02-256b-4cf4-aae6-75b55da6434b", "name": "Get Feed by feedId", "request": { "name": "Get Feed by feedId", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), after you have [created the channel](https://developers.vtex.com/vtex-rest-api/reference/createchannel), the next step is to create a feed, which is a list of information about the seller's offers sent to the marketplace. \n\nThis endpoint retrieves information about a specific feed by searching through its `feedId`.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), after you have [created the channel](https://developers.vtex.com/vtex-rest-api/reference/createchannel), the next step is to create a feed, which is a list of information about the seller's offers sent to the marketplace. \n\nThis endpoint retrieves information about a specific feed by searching through its `feedId`.", "type": "text/plain" }, "url": { @@ -728,39 +779,58 @@ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) 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`.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", - "key": "environment" + "value": "vtex.amazon", + "key": "feedId" }, { "disabled": false, "description": { - "content": "(Required) 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`.", + "content": "(Required) Environment to use. Used as part of the URL.", "type": "text/plain" }, "type": "any", - "value": "vtex.amazon", - "key": "feedId" + "value": "vtexcommercestable", + "key": "environment" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "7b8301b1-7dcf-4a79-be35-22a50b1cd0fb", + "id": "4eef6edf-57fe-4667-a369-ea5cea5f4a80", "name": "OK", "originalRequest": { "url": { @@ -774,43 +844,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, { "disabled": false, "description": { - "content": "(Required) 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`.", + "content": "(Required) Name of the VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "vtex.amazon", - "key": "feedId" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -832,6 +878,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -845,7 +899,7 @@ "value": "application/json" } ], - "body": "{\n \"account\": \"grocery1\",\n \"affiliateId\": \"vtex.meli-classic\",\n \"salesChannel\": \"5\",\n \"channelName\": \"Mercadolivre Classic\",\n \"channelLogo\": \"https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/mercadolivre.png\"\n}", + "body": "{\n \"account\": \"grocery1\",\n \"id\": \"vtex.meli-classic\",\n \"affiliateId\": \"vtex.meli-classic\",\n \"salesChannel\": \"5\",\n \"channelName\": \"Mercadolivre Classic\",\n \"channelLogo\": \"https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/mercadolivre.png\"\n}", "cookie": [] } ], @@ -853,7 +907,7 @@ { "listen": "test", "script": { - "id": "2eb70701-8b05-462a-818d-e474fddec0bc", + "id": "c32056b8-570e-48ac-9d6f-515e5f0c96b1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/sent-offers/feeds/:feedId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -869,12 +923,12 @@ } }, { - "id": "d62befd2-f57f-408f-846a-fed3bfaf81e5", + "id": "d3dfd73d-5025-4a04-ac6b-9bb1b8021da8", "name": "Deactivate Feed", "request": { "name": "Deactivate Feed", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. After [creating a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds), it will be activated; and through this endpoint the seller can deactivate the feed. \n\nWhen a feed is deactivated, all data related to the marketplace is removed from Offer Management UI. That includes the channels, offers, interactions, and errors. \n\nDeactivating a feed does not mean deleting information, and the seller can restore the data by [activating the feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds) again.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. After [creating a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds), it will be activated; and through this endpoint the seller can deactivate the feed. \n\nWhen a feed is deactivated, all data related to the marketplace is removed from Offer Management UI. That includes the channels, offers, interactions, and errors. \n\nDeactivating a feed does not mean deleting information, and the seller can restore the data by [activating the feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds) again.", "type": "text/plain" }, "url": { @@ -902,33 +956,54 @@ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) 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`.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", - "key": "environment" + "value": "vtex.amazon", + "key": "feedId" }, { "disabled": false, "description": { - "content": "(Required) 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`.", + "content": "(Required) Environment to use. Used as part of the URL.", "type": "text/plain" }, "type": "any", - "value": "vtex.amazon", - "key": "feedId" + "value": "vtexcommercestable", + "key": "environment" } ] }, - "method": "DELETE" + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "b78a4437-9e91-4d5f-be02-41863b31bddf", + "id": "5ee9fd05-3d5f-45c3-b9eb-3d309af75d0e", "name": "No Content", "originalRequest": { "url": { @@ -942,60 +1017,44 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Name of the VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, - { - "disabled": false, - "description": { - "content": "(Required) 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`.", - "type": "text/plain" - }, - "type": "any", - "value": "vtex.amazon", - "key": "feedId" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ { + "disabled": false, "description": { - "content": "Added as a part of security scheme: apikey", + "content": "(Required) Describes the type of the content being sent.", "type": "text/plain" }, - "key": "X-VTEX-API-AppKey", - "value": "" + "key": "Content-Type", + "value": "application/json" }, { "disabled": false, "description": { - "content": "(Required) Describes the type of the content being sent.", + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", "type": "text/plain" }, - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "disabled": false, "description": { - "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, - "key": "Accept", - "value": "application/json" + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "DELETE", @@ -1003,13 +1062,7 @@ }, "status": "No Content", "code": 204, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -1017,7 +1070,7 @@ { "listen": "test", "script": { - "id": "361c3e7b-d4c1-4575-8eea-cfae5f75a768", + "id": "8130508e-10f7-437c-ab91-819b20f29147", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/sent-offers/feeds/:feedId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1031,12 +1084,12 @@ } }, { - "id": "87496b9b-bbc7-49b4-a794-02b17ecfae7b", + "id": "3b21cbdb-25de-4dc2-a04b-e7544a25a785", "name": "Open Interaction", "request": { "name": "Open Interaction", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called Interaction. For every action that happens to an offer, whether it is a status notification or a price update, the connector creates an Interaction about it. \n\nThis endpoint creates a new interaction for an SKU so that changes can be applied to an offer. The changes informed by interactions are related to: price, inventory, catalog and status. \n\nUsually, interactions process a single type of change at a time, but it is possible to add data about catalog, price, and inventory simultaneously in the same interaction.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called Interaction. For every action that happens to an offer, whether it is a status notification or a price update, the connector creates an Interaction about it. \n\nThis endpoint creates a new interaction for an SKU so that changes can be applied to an offer. The changes informed by interactions are related to: price, inventory, catalog and status. \n\nUsually, interactions process a single type of change at a time, but it is possible to add data about catalog, price, and inventory simultaneously in the same interaction.", "type": "text/plain" }, "url": { @@ -1067,36 +1120,54 @@ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) 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`.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", - "key": "environment" + "value": "vtex.amazon", + "key": "feedId" }, { "disabled": false, "description": { - "content": "(Required) 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`.", + "content": "(Required) This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog.", "type": "text/plain" }, "type": "any", - "value": "vtex.amazon", - "key": "feedId" + "value": "1234", + "key": "skuId" }, { "disabled": false, "description": { - "content": "(Required) This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog.", + "content": "(Required) Environment to use. Used as part of the URL.", "type": "text/plain" }, "type": "any", - "value": "1234", - "key": "skuId" + "value": "vtexcommercestable", + "key": "environment" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, { "key": "Content-Type", "value": "application/json" @@ -1112,6 +1183,7 @@ "raw": "{\n \"startDate\": \"2020-10-29\",\n \"source\": \"seller\",\n \"origin\": \"catalog\",\n \"context\": \"setup\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1122,7 +1194,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "0b637048-3d6c-44b8-b35b-2655f658cdbf", + "id": "260f92db-ce36-4cfe-b031-068e7f6f11e0", "name": "Created", "originalRequest": { "url": { @@ -1139,53 +1211,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Name of the VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, - { - "disabled": false, - "description": { - "content": "(Required) 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`.", - "type": "text/plain" - }, - "type": "any", - "value": "vtex.amazon", - "key": "feedId" - }, - { - "disabled": false, - "description": { - "content": "(Required) This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog.", - "type": "text/plain" - }, - "type": "any", - "value": "1234", - "key": "skuId" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1204,9 +1242,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -1215,6 +1265,7 @@ "raw": "{\n \"startDate\": \"2020-10-29\",\n \"source\": \"seller\",\n \"origin\": \"catalog\",\n \"context\": \"setup\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1228,7 +1279,7 @@ "value": "application/json" } ], - "body": "{\n \"account\": \"anim Ut\",\n \"feedId\": \"ullamco Ut\",\n \"skuId\": \"aliquip anim\",\n \"id\": \"Excepteur magna\",\n \"startDate\": \"do laborum\",\n \"result\": \"\",\n \"state\": \"consequat nostrud dolore\",\n \"source\": \"ex eu Duis\",\n \"origin\": \"fugiat nostrud irure ad\",\n \"context\": \"non dolor\",\n \"logs\": {\n \"type\": \"consectetur do cillum\"\n }\n}", + "body": "{\n \"account\": \"grocery1\",\n \"feedId\": \"vtex.madeiramadeira\",\n \"skuId\": \"1\",\n \"id\": \"3D585672B15A418EBDFC4BC0E85120A5\",\n \"startDate\": \"2022-03-07T09:15:00Z\",\n \"result\": \"processing\",\n \"state\": \"open\",\n \"source\": \"seller\",\n \"origin\": \"inventory\",\n \"context\": \"setup\",\n \"logs\": []\n}", "cookie": [] } ], @@ -1236,13 +1287,13 @@ { "listen": "test", "script": { - "id": "f1a2342d-6159-49d8-b7a6-ff667db9d4b6", + "id": "e714f4a3-0079-42b5-aed2-f01a114c7292", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"CreateInteraction\",\"type\":\"object\",\"example\":{\"account\":\"grocery1\",\"feedId\":\"vtex.madeiramadeira\",\"skuId\":\"1\",\"id\":\"3D585672B15A418EBDFC4BC0E85120A5\",\"startDate\":\"2022-03-07T09:15:00Z\",\"result\":\"processing\",\"state\":\"open\",\"source\":\"seller\",\"origin\":\"inventory\",\"context\":\"setup\",\"logs\":[]},\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"Seller's account name.\"},\"feedId\":{\"type\":\"string\",\"description\":\"Attribute that identifies a feed between a seller and a channel. It follows a standardized pattern that will be used by connectors when establishing the connection between the two.\"},\"skuId\":{\"type\":\"string\",\"description\":\"SKU's unique identifier number.\"},\"id\":{\"type\":\"string\",\"description\":\"Connectors must extend the Sent Offers' codes by adding their own code IDs for mapping specific scenarios that apply to their own system. They can send those codes through a suffix ID added in an existing code.\"},\"startDate\":{\"type\":\"string\",\"description\":\"The day the interaction was created.\"},\"result\":{\"type\":\"string\",\"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.\"},\"state\":{\"type\":\"string\",\"description\":\"State, from the seller's address.\"},\"source\":{\"type\":\"string\",\"description\":\"This attribute defines the entity responsible for the interaction.\"},\"origin\":{\"type\":\"string\",\"description\":\"where the interaction originated from. Possible values include `catalog`, `price` or `inventory`.\"},\"context\":{\"type\":\"string\",\"description\":\"This field informs Sent Offers about an offer's lifecycle.\"},\"logs\":{\"type\":\"object\",\"description\":\"History of events related to interactions.\",\"items\":{\"type\":\"string\"},\"properties\":{\"type\":{\"type\":\"string\",\"title\":\"type\",\"description\":\"Type of logs.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"CreateInteraction\",\"type\":\"object\",\"example\":{\"account\":\"grocery1\",\"feedId\":\"vtex.madeiramadeira\",\"skuId\":\"1\",\"id\":\"3D585672B15A418EBDFC4BC0E85120A5\",\"startDate\":\"2022-03-07T09:15:00Z\",\"result\":\"processing\",\"state\":\"open\",\"source\":\"seller\",\"origin\":\"inventory\",\"context\":\"setup\",\"logs\":[]},\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"Seller's account name.\"},\"feedId\":{\"type\":\"string\",\"description\":\"Attribute that identifies a feed between a seller and a channel. It follows a standardized pattern that will be used by connectors when establishing the connection between the two.\"},\"skuId\":{\"type\":\"string\",\"description\":\"SKU's unique identifier number.\"},\"id\":{\"type\":\"string\",\"description\":\"Connectors must extend the Sent Offers' codes by adding their own code IDs for mapping specific scenarios that apply to their own system. They can send those codes through a suffix ID added in an existing code.\"},\"startDate\":{\"type\":\"string\",\"description\":\"The day the interaction was created.\"},\"result\":{\"type\":\"string\",\"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.\"},\"state\":{\"type\":\"string\",\"description\":\"State, from the seller's address.\"},\"source\":{\"type\":\"string\",\"description\":\"This attribute defines the entity responsible for the interaction.\"},\"origin\":{\"type\":\"string\",\"description\":\"where the interaction originated from. Possible values include `catalog`, `price` or `inventory`.\"},\"context\":{\"type\":\"string\",\"description\":\"This field informs Sent Offers about an offer's lifecycle.\"},\"logs\":{\"type\":\"array\",\"description\":\"History of events related to interactions.\",\"items\":{\"type\":\"string\"},\"properties\":{\"type\":{\"type\":\"string\",\"title\":\"type\",\"description\":\"Type of logs.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1252,12 +1303,12 @@ } }, { - "id": "2aefb74c-337a-491c-b0dd-ab21e1dfe577", + "id": "bd82e7d7-96c8-4b2c-a73f-e9db3890211c", "name": "Get Interaction Data by interactionId", "request": { "name": "Get Interaction Data by interactionId", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nA unique code called `interactionId` is used to identify each interaction. This endpoint retrieves information about an interaction, searching by its `interactionId`. \n\nIt also retrieves existing logs through the `log` field.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nA unique code called `interactionId` is used to identify each interaction. This endpoint retrieves information about an interaction, searching by its `interactionId`. \n\nIt also retrieves existing logs through the `log` field.", "type": "text/plain" }, "url": { @@ -1286,16 +1337,6 @@ } ], "variable": [ - { - "disabled": false, - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, { "disabled": false, "description": { @@ -1325,23 +1366,52 @@ "type": "any", "value": "d3rdjjf094ma0do", "key": "interactionId" + }, + { + "disabled": false, + "description": { + "content": "(Required) Environment to use. Used as part of the URL.", + "type": "text/plain" + }, + "type": "any", + "value": "vtexcommercestable", + "key": "environment" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "9f6743be-e2c2-4243-ab57-759dd2f2d17c", + "id": "69ab1530-3a44-45e8-b8de-7224f83b65ab", "name": "OK", "originalRequest": { "url": { @@ -1359,63 +1429,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Name of the VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, - { - "disabled": false, - "description": { - "content": "(Required) 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`.", - "type": "text/plain" - }, - "type": "any", - "value": "vtex.amazon", - "key": "feedId" - }, - { - "disabled": false, - "description": { - "content": "(Required) This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog.", - "type": "text/plain" - }, - "type": "any", - "value": "1234", - "key": "skuId" - }, - { - "disabled": false, - "description": { - "content": "(Required) This attribute is the code used to identify an existing interaction.", - "type": "text/plain" - }, - "type": "any", - "value": "d3rdjjf094ma0do", - "key": "interactionId" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1437,6 +1463,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1450,7 +1484,7 @@ "value": "application/json" } ], - "body": "{\n \"account\": \"velit voluptate fugiat et\",\n \"feedId\": \"et dolor id amet\",\n \"skuId\": \"sed dolore\",\n \"id\": \"pariatur quis es\",\n \"startDate\": \"est dolore\",\n \"result\": \"in\",\n \"state\": \"labore ea proident\",\n \"source\": \"consectetur ad anim elit aute\",\n \"origin\": \"do ea\",\n \"context\": \"quis ut tempor veniam\",\n \"logs\": {\n \"type\": \"mollit voluptate cillum repr\"\n }\n}", + "body": "{\n \"account\": \"grocery1\",\n \"feedId\": \"vtex.madeiramadeira\",\n \"skuId\": \"1\",\n \"id\": \"7FC112C52F8F43E6A096E29B04AC63F6\",\n \"startDate\": \"2022-03-07T09:15:00Z\",\n \"result\": \"processing\",\n \"state\": \"open\",\n \"source\": \"seller\",\n \"origin\": \"inventory\",\n \"context\": \"setup\",\n \"logs\": []\n}", "cookie": [] } ], @@ -1458,13 +1492,13 @@ { "listen": "test", "script": { - "id": "6c8009dc-e922-400d-99ba-5033a358da5e", + "id": "222b9e07-5367-4a83-90bb-b8c261507eb3", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"title\":\"RetrieveInteraction\",\"type\":\"object\",\"example\":{\"account\":\"grocery1\",\"feedId\":\"vtex.madeiramadeira\",\"skuId\":\"1\",\"id\":\"7FC112C52F8F43E6A096E29B04AC63F6\",\"startDate\":\"2022-03-07T09:15:00Z\",\"result\":\"processing\",\"state\":\"open\",\"source\":\"seller\",\"origin\":\"inventory\",\"context\":\"setup\",\"logs\":[]},\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"Seller's account name.\"},\"feedId\":{\"type\":\"string\",\"description\":\"Attribute that identifies a feed between a seller and a channel. It follows a standardized pattern that will be used by connectors when establishing the connection between the two.\"},\"skuId\":{\"type\":\"string\",\"description\":\"SKU's unique identifier number.\"},\"id\":{\"type\":\"string\",\"description\":\"Connectors must extend the Sent Offers' codes by adding their own code IDs for mapping specific scenarios that apply to their own system. They can send those codes through a suffix ID added in an existing code.\"},\"startDate\":{\"type\":\"string\",\"description\":\"The day the interaction was created.\"},\"result\":{\"type\":\"string\",\"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.\"},\"state\":{\"type\":\"string\",\"description\":\"State, from the seller's address.\"},\"source\":{\"type\":\"string\",\"description\":\"This attribute defines the entity responsible for the interaction.\"},\"origin\":{\"type\":\"string\",\"description\":\"where the interaction originated from. Possible values include `catalog`, `price` or `inventory`.\"},\"context\":{\"type\":\"string\",\"description\":\"This field informs Sent Offers about an offer's lifecycle.\"},\"logs\":{\"type\":\"object\",\"description\":\"History of events related to interactions.\",\"items\":{\"type\":\"string\"},\"properties\":{\"type\":{\"type\":\"string\",\"title\":\"type\",\"description\":\"Type of logs.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"title\":\"RetrieveInteraction\",\"type\":\"object\",\"example\":{\"account\":\"grocery1\",\"feedId\":\"vtex.madeiramadeira\",\"skuId\":\"1\",\"id\":\"7FC112C52F8F43E6A096E29B04AC63F6\",\"startDate\":\"2022-03-07T09:15:00Z\",\"result\":\"processing\",\"state\":\"open\",\"source\":\"seller\",\"origin\":\"inventory\",\"context\":\"setup\",\"logs\":[]},\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"Seller's account name.\"},\"feedId\":{\"type\":\"string\",\"description\":\"Attribute that identifies a feed between a seller and a channel. It follows a standardized pattern that will be used by connectors when establishing the connection between the two.\"},\"skuId\":{\"type\":\"string\",\"description\":\"SKU's unique identifier number.\"},\"id\":{\"type\":\"string\",\"description\":\"Connectors must extend the Sent Offers' codes by adding their own code IDs for mapping specific scenarios that apply to their own system. They can send those codes through a suffix ID added in an existing code.\"},\"startDate\":{\"type\":\"string\",\"description\":\"The day the interaction was created.\"},\"result\":{\"type\":\"string\",\"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.\"},\"state\":{\"type\":\"string\",\"description\":\"State, from the seller's address.\"},\"source\":{\"type\":\"string\",\"description\":\"This attribute defines the entity responsible for the interaction.\"},\"origin\":{\"type\":\"string\",\"description\":\"where the interaction originated from. Possible values include `catalog`, `price` or `inventory`.\"},\"context\":{\"type\":\"string\",\"description\":\"This field informs Sent Offers about an offer's lifecycle.\"},\"logs\":{\"type\":\"array\",\"description\":\"History of events related to interactions.\",\"items\":{\"type\":\"string\"},\"properties\":{\"type\":{\"type\":\"string\",\"title\":\"type\",\"description\":\"Type of logs.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1474,12 +1508,12 @@ } }, { - "id": "bb9205a3-04f5-4fbe-849e-59a57e2dc49a", + "id": "2d59dac9-e72b-4096-ad7c-e2a343468a56", "name": "Close Interaction", "request": { "name": "Close Interaction", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nOnce an interaction has fulfilled its initial goal and there are no more actions (or [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs)) taking place within it, this endpoint closes an interaction.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nOnce an interaction has fulfilled its initial goal and there are no more actions (or [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs)) taking place within it, this endpoint closes an interaction.", "type": "text/plain" }, "url": { @@ -1509,16 +1543,6 @@ } ], "variable": [ - { - "disabled": false, - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, { "disabled": false, "description": { @@ -1548,17 +1572,48 @@ "type": "any", "value": "d3rdjjf094ma0do", "key": "interactionId" + }, + { + "disabled": false, + "description": { + "content": "(Required) Environment to use. Used as part of the URL.", + "type": "text/plain" + }, + "type": "any", + "value": "vtexcommercestable", + "key": "environment" } ] }, - "method": "POST" + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "6519c4bd-825b-4fb9-baa6-aed4454c32f5", + "id": "d883b1fb-6ad4-44a7-b74b-b10203297613", "name": "No Content", "originalRequest": { "url": { @@ -1577,63 +1632,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, - { - "disabled": false, - "description": { - "content": "(Required) 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`.", - "type": "text/plain" - }, - "type": "any", - "value": "vtex.amazon", - "key": "feedId" - }, { "disabled": false, "description": { - "content": "(Required) This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog.", + "content": "(Required) Name of the VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "1234", - "key": "skuId" - }, - { - "disabled": false, - "description": { - "content": "(Required) This attribute is the code used to identify an existing interaction.", - "type": "text/plain" - }, - "type": "any", - "value": "d3rdjjf094ma0do", - "key": "interactionId" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1651,6 +1662,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -1658,13 +1677,7 @@ }, "status": "No Content", "code": 204, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -1672,7 +1685,7 @@ { "listen": "test", "script": { - "id": "a0ec245c-fb66-456e-a869-8a1430d13346", + "id": "348b618c-f40c-4ec3-a65c-068d81fa3523", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId/close - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1686,12 +1699,12 @@ } }, { - "id": "1de169b0-805a-4062-aad4-7a570c07d72c", + "id": "c277920b-e0c7-43c7-b414-ca2c3fff5834", "name": "Create Log", "request": { "name": "Create Log", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), and they are organized in a timeline. All of the micro-steps of an interaction are represented through logs; they are how interactions become visible in Offer Management UI. \n\nThis endpoint adds logs that take place within an interaction, which can be done after [creating an interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions) so that there will be an `interactionId`. \n\n`Errors`: When Offer Management, or the connectors, find an error that prevents sending or updating an offer to a channel, they should open a type failure log, and fill in its details through the `errors` attribute. The information provided should enable sellers to identify and fix errors on their offers. \n\nThe connectors should go through every possible validation, identify all errors, and only after that create the failure log, with the information in a single request.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), and they are organized in a timeline. All of the micro-steps of an interaction are represented through logs; they are how interactions become visible in Offer Management UI. \n\nThis endpoint adds logs that take place within an interaction, which can be done after [creating an interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions) so that there will be an `interactionId`. \n\n`Errors`: When Offer Management, or the connectors, find an error that prevents sending or updating an offer to a channel, they should open a type failure log, and fill in its details through the `errors` attribute. The information provided should enable sellers to identify and fix errors on their offers. \n\nThe connectors should go through every possible validation, identify all errors, and only after that create the failure log, with the information in a single request.", "type": "text/plain" }, "url": { @@ -1721,16 +1734,6 @@ } ], "variable": [ - { - "disabled": false, - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, { "disabled": false, "description": { @@ -1760,10 +1763,38 @@ "type": "any", "value": "d3rdjjf094ma0do", "key": "interactionId" + }, + { + "disabled": false, + "description": { + "content": "(Required) Environment to use. Used as part of the URL.", + "type": "text/plain" + }, + "type": "any", + "value": "vtexcommercestable", + "key": "environment" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, { "key": "Content-Type", "value": "application/json" @@ -1779,6 +1810,7 @@ "raw": "{\n \"description\": \"Another log message with some information that is going to be relevant to our users\",\n \"date\": \"2020-03-22\",\n \"type\": \"information\",\n \"agent\": \"broadcaster\",\n \"evidence\": {\n \"request\": \"Explanation 1\",\n \"response\": \"Explanation 2\"\n },\n \"data\": {\n \"externalOfferId\": \"123456\",\n \"inventory\": \"33\",\n \"salesPrice\": \"79.99\",\n \"currency\": \"BRL\",\n \"status\": \"disabled\"\n },\n \"errors\": {\n \"code\": \"CTLG-001\",\n \"externalCode\": \"284692\",\n \"title\": \"Description includes HTML\",\n \"description\": \"Netshoes does not allow HTML tags in an offer's description. Access the product in your Catalog to remove the HTML tag.\",\n \"closableOrigins\": [\n \"catalog\",\n \"price\"\n ]\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1789,7 +1821,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8d74e7eb-09a9-4e6d-89b8-9a60c62c1f85", + "id": "88bc1771-a966-4ec1-9749-471df3c8805a", "name": "Created", "originalRequest": { "url": { @@ -1808,63 +1840,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Name of the VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, - { - "disabled": false, - "description": { - "content": "(Required) 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`.", - "type": "text/plain" - }, - "type": "any", - "value": "vtex.amazon", - "key": "feedId" - }, - { - "disabled": false, - "description": { - "content": "(Required) This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog.", - "type": "text/plain" - }, - "type": "any", - "value": "1234", - "key": "skuId" - }, - { - "disabled": false, - "description": { - "content": "(Required) This attribute is the code used to identify an existing interaction.", - "type": "text/plain" - }, - "type": "any", - "value": "d3rdjjf094ma0do", - "key": "interactionId" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1883,9 +1871,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json; charset=utf-8" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -1894,6 +1894,7 @@ "raw": "{\n \"description\": \"Another log message with some information that is going to be relevant to our users\",\n \"date\": \"2020-03-22\",\n \"type\": \"information\",\n \"agent\": \"broadcaster\",\n \"evidence\": {\n \"request\": \"Explanation 1\",\n \"response\": \"Explanation 2\"\n },\n \"data\": {\n \"externalOfferId\": \"123456\",\n \"inventory\": \"33\",\n \"salesPrice\": \"79.99\",\n \"currency\": \"BRL\",\n \"status\": \"disabled\"\n },\n \"errors\": {\n \"code\": \"CTLG-001\",\n \"externalCode\": \"284692\",\n \"title\": \"Description includes HTML\",\n \"description\": \"Netshoes does not allow HTML tags in an offer's description. Access the product in your Catalog to remove the HTML tag.\",\n \"closableOrigins\": [\n \"catalog\",\n \"price\"\n ]\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1907,7 +1908,7 @@ "value": "application/json; charset=utf-8" } ], - "body": "{\n \"description\": \"Log description\",\n \"date\": \"2022-05-16T09:16:00Z\",\n \"agent\": \"MARKETPLACE\",\n \"evidence\": {},\n \"type\": \"info\"\n}", + "body": "{\n \"id\": \"438B39EF43A24425B6BF35343095DE04\",\n \"description\": \"Log description\",\n \"date\": \"2022-05-16T09:16:00Z\",\n \"agent\": \"MARKETPLACE\",\n \"evidence\": {},\n \"type\": \"info\"\n}", "cookie": [] } ], @@ -1915,7 +1916,7 @@ { "listen": "test", "script": { - "id": "6b90a951-d5e5-40cd-8575-cfee8a9a9b37", + "id": "10ece867-22ec-49b9-bc84-09f9d8fda41a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId/logs - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1931,12 +1932,12 @@ } }, { - "id": "a4e7e064-1b2e-462a-9230-f936aefa4f3e", + "id": "70ec985a-d31c-42a1-b200-942f040b0de7", "name": "Get Log Data by logId", "request": { "name": "Get Log Data by logId", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), organized in a timeline. All interaction's micro-steps will be represented through logs; they are how interactions become visible in Offer Management UI. \n\nA unique code called `logId` is used to identify every log created. This endpoint enables the retrieval of information about a log by searching through its `logId`.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), organized in a timeline. All interaction's micro-steps will be represented through logs; they are how interactions become visible in Offer Management UI. \n\nA unique code called `logId` is used to identify every log created. This endpoint enables the retrieval of information about a log by searching through its `logId`.", "type": "text/plain" }, "url": { @@ -1967,16 +1968,6 @@ } ], "variable": [ - { - "disabled": false, - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, { "disabled": false, "description": { @@ -2016,23 +2007,52 @@ "type": "any", "value": "123456", "key": "logId" + }, + { + "disabled": false, + "description": { + "content": "(Required) Environment to use. Used as part of the URL.", + "type": "text/plain" + }, + "type": "any", + "value": "vtexcommercestable", + "key": "environment" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "710a1f10-6af4-4eec-bfbc-ffd503aa81c3", + "id": "ebc1daff-e245-407d-b2c0-101d0c2c1e55", "name": "OK", "originalRequest": { "url": { @@ -2052,73 +2072,19 @@ "{{baseUrl}}" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, - { - "disabled": false, - "description": { - "content": "(Required) 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`.", - "type": "text/plain" - }, - "type": "any", - "value": "vtex.amazon", - "key": "feedId" - }, - { - "disabled": false, - "description": { - "content": "(Required) This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog.", - "type": "text/plain" - }, - "type": "any", - "value": "1234", - "key": "skuId" - }, - { - "disabled": false, - "description": { - "content": "(Required) This attribute is the code used to identify an existing interaction.", - "type": "text/plain" - }, - "type": "any", - "value": "d3rdjjf094ma0do", - "key": "interactionId" - }, { "disabled": false, "description": { - "content": "(Required) A log's identifying code. This attribute is obtained from the Open Log API, or from the response of a Search Interactions API.", + "content": "(Required) Name of the VTEX account. Used as query param.", "type": "text/plain" }, - "type": "any", - "value": "123456", - "key": "logId" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2140,6 +2106,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -2153,7 +2127,7 @@ "value": "application/json" } ], - "body": "{\n \"description\": \"Log description\",\n \"date\": \"2022-05-16T09:16:00Z\",\n \"agent\": \"MARKETPLACE\",\n \"evidence\": {},\n \"errors\": [\n {\n \"code\": \"AUTH-001\",\n \"externalCode\": \"MYCODE-01\",\n \"title\": \"Error ao autenticar no marketplace\",\n \"description\": \"Token inválido\",\n \"closableOrigins\": [\n \"inventory\"\n ]\n }\n ],\n \"type\": \"failure\"\n}", + "body": "{\n \"id\": \"91957CA041E343D8B921CECFBF9D8443\",\n \"description\": \"Log description\",\n \"date\": \"2022-05-16T09:16:00Z\",\n \"agent\": \"MARKETPLACE\",\n \"evidence\": {},\n \"errors\": [\n {\n \"code\": \"AUTH-001\",\n \"externalCode\": \"MYCODE-01\",\n \"title\": \"Error ao autenticar no marketplace\",\n \"description\": \"Token inválido\",\n \"closableOrigins\": [\n \"inventory\"\n ]\n }\n ],\n \"type\": \"failure\"\n}", "cookie": [] } ], @@ -2161,7 +2135,7 @@ { "listen": "test", "script": { - "id": "f5dfb6f0-11be-4acc-9295-c83cdae54b7e", + "id": "b7b047c7-5afe-4467-afe6-0bfbf37e59cc", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/sent-offers/feeds/:feedId/skus/:skuId/interactions/:interactionId/logs/:logId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2177,12 +2151,12 @@ } }, { - "id": "12bd5fbf-a0e1-454a-9664-408ad183674e", + "id": "ac3277ae-d022-47a6-b733-3b3cb23701d1", "name": "Search Interactions and their Logs", "request": { "name": "Search Interactions and their Logs", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). The granular details of actions and micro-steps that happen within an interaction's are called [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs). \n\nThis endpoint retrieves information about interactions and all logs within it. It allows filtering interactions by using the following query params: `channel`, `brand`, `category`, `scope`, `result`, `fromDate`, `toDate`. This endpoint also counts with the following pagination query params: `sort`, `from`, `to`.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). The granular details of actions and micro-steps that happen within an interaction's are called [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs). \n\nThis endpoint retrieves information about interactions and all logs within it. It allows filtering interactions by using the following query params: `channel`, `brand`, `category`, `scope`, `result`, `fromDate`, `toDate`. This endpoint also counts with the following pagination query params: `sort`, `from`, `to`.", "type": "text/plain" }, "url": { @@ -2215,7 +2189,7 @@ "value": "{{query}}" }, { - "disabled": false, + "disabled": true, "description": { "content": "Search interactions, filtering by channel.", "type": "text/plain" @@ -2224,7 +2198,7 @@ "value": "{{channelName}}" }, { - "disabled": false, + "disabled": true, "description": { "content": "Search interactions, filtering by brand.", "type": "text/plain" @@ -2233,7 +2207,7 @@ "value": "{{brand}}" }, { - "disabled": false, + "disabled": true, "description": { "content": "Search interactions, filtering by category.", "type": "text/plain" @@ -2242,7 +2216,7 @@ "value": "{{category}}" }, { - "disabled": false, + "disabled": true, "description": { "content": "Search interactions, filtering by scope.", "type": "text/plain" @@ -2251,7 +2225,7 @@ "value": "{{scope}}" }, { - "disabled": false, + "disabled": true, "description": { "content": "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.", "type": "text/plain" @@ -2309,23 +2283,24 @@ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Environment to use. Used as part of the URL.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", + "value": "vtexcommercestable", "key": "environment" } ] }, - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "8a6d407b-5159-4a67-9965-dd633cccea76", + "id": "933af321-2859-4d8a-b8af-feac405f06c7", "name": "OK", "originalRequest": { "url": { @@ -2340,66 +2315,115 @@ ], "query": [ { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account. Used as a query param.", + "type": "text/plain" + }, "key": "an", "value": "{{accountName}}" }, { + "disabled": false, + "description": { + "content": "(Required) Customizable field for searching interactions.", + "type": "text/plain" + }, "key": "q", "value": "{{query}}" }, { + "disabled": true, + "description": { + "content": "Search interactions, filtering by channel.", + "type": "text/plain" + }, "key": "channels", "value": "{{channelName}}" }, { + "disabled": true, + "description": { + "content": "Search interactions, filtering by brand.", + "type": "text/plain" + }, "key": "brand", "value": "{{brand}}" }, { + "disabled": true, + "description": { + "content": "Search interactions, filtering by category.", + "type": "text/plain" + }, "key": "category", "value": "{{category}}" }, { + "disabled": true, + "description": { + "content": "Search interactions, filtering by scope.", + "type": "text/plain" + }, "key": "scope", "value": "{{scope}}" }, { + "disabled": true, + "description": { + "content": "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.", + "type": "text/plain" + }, "key": "result", "value": "{{result}}" }, { + "disabled": false, + "description": { + "content": "(Required) Search interactions filtering by sort.", + "type": "text/plain" + }, "key": "sort", "value": "{{sort}}" }, { + "disabled": false, + "description": { + "content": "(Required) Search interactions from a given point.", + "type": "text/plain" + }, "key": "from", "value": "{{from}}" }, { + "disabled": false, + "description": { + "content": "(Required) Search interactions until a given point.", + "type": "text/plain" + }, "key": "to", "value": "{{to}}" }, { + "disabled": false, + "description": { + "content": "(Required) Search interactions from a specific date.", + "type": "text/plain" + }, "key": "fromDate", "value": "{{fromDate}}" }, - { - "key": "toDate", - "value": "{{toDate}}" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Search interactions until a given date.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "toDate", + "value": "{{toDate}}" } - ] + ], + "variable": [] }, "header": [ { @@ -2416,13 +2440,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -2430,7 +2448,7 @@ { "listen": "test", "script": { - "id": "c93ec804-45bc-4077-806b-c1b909e4c661", + "id": "8b10ff42-8a96-44c8-b1d2-3e1ad74704c1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/sent-offers/search/interactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -2443,12 +2461,12 @@ } }, { - "id": "f0d062a7-0d87-40fe-86dd-10956f4f4ac7", + "id": "db8f607c-d96c-44ee-959d-58a6a9eb8e9b", "name": "Search Errors", "request": { "name": "Search Errors", "description": { - "content": "> ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n This endpoint provides the single source of truth of updated error codes in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It retrieves a list of all the error codes available at that moment. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system. \n\nThis endpoint allows filtering errors by using the following query params: `channel`, `brand`, `category`, `errorCategory`. It also counts with the following pagination query params: `sort`, `from`, `to`, `q`.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n This endpoint provides the single source of truth of updated error codes in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It retrieves a list of all the error codes available at that moment. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system. \n\nThis endpoint allows filtering errors by using the following query params: `channel`, `brand`, `category`, `errorCategory`. It also counts with the following pagination query params: `sort`, `from`, `to`, `q`.", "type": "text/plain" }, "url": { @@ -2548,23 +2566,44 @@ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Environment to use. Used as part of the URL.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", + "value": "vtexcommercestable", "key": "environment" } ] }, - "method": "GET" + "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "145ea21c-2ed5-4a7f-9c82-7f38062ee54a", + "id": "129bf836-183b-4b4b-bbf4-5fa16439bb6c", "name": "OK", "originalRequest": { "url": { @@ -2579,64 +2618,90 @@ ], "query": [ { + "disabled": false, + "description": { + "content": "(Required) Name of the VTEX account. Used as query param.", + "type": "text/plain" + }, "key": "an", "value": "{{accountName}}" }, { + "disabled": false, + "description": { + "content": "(Required) Customizable field for searching error codes.", + "type": "text/plain" + }, "key": "q", "value": "{{query}}" }, { + "disabled": false, + "description": { + "content": "(Required) Search errors filtering by channels.", + "type": "text/plain" + }, "key": "channels", "value": "{{channels}}" }, { + "disabled": false, + "description": { + "content": "(Required) Search errors filtering by brand.", + "type": "text/plain" + }, "key": "brand", "value": "{{brand}}" }, { + "disabled": false, + "description": { + "content": "(Required) Search errors filtering by category.", + "type": "text/plain" + }, "key": "category", "value": "{{category}}" }, { + "disabled": false, + "description": { + "content": "(Required) Search errors filtering by error category.", + "type": "text/plain" + }, "key": "errorCategory", "value": "{{errorCategory}}" }, { + "disabled": false, + "description": { + "content": "(Required) Pagination that returns a range of ordered error codes.", + "type": "text/plain" + }, "key": "sort", "value": "{{sort}}" }, { + "disabled": false, + "description": { + "content": "(Required) Pagination that returns error codes from a given point.", + "type": "text/plain" + }, "key": "from", "value": "{{from}}" }, - { - "key": "to", - "value": "{{to}}" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Pagination that returns error codes until a given point.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "to", + "value": "{{to}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2654,6 +2719,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -2661,13 +2734,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -2675,7 +2742,7 @@ { "listen": "test", "script": { - "id": "27472ec2-9fa8-414b-bf90-d1aa7e9c56ff", + "id": "b990964e-f3c7-4be5-ba54-3718c3b19e54", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/sent-offers/search/errors - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -2688,12 +2755,12 @@ } }, { - "id": "52f49eef-0835-42da-824b-8dbab9039970", + "id": "78fbab6d-8c02-40bc-94a7-60f035402463", "name": "Get Error Code data by errorCodeId", "request": { "name": "Get Error Code data by errorCodeId", "description": { - "content": ">ℹ \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 Offer Management . 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 integration, we ask you to wait for the release of the new module, as soon as it is available we will announce it to all customers through the [dev portal](https://developers.vtex.com/updates/release-notes) and [help VTEX](https://help.vtex.com/pt/en/announcements). \r\n\r\n This endpoint retrieves specific information about an error code in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It provides the single source of truth of updated information about an error code through the `errorCodeId`. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system.", + "content": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n This endpoint retrieves specific information about an error code in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It provides the single source of truth of updated information about an error code through the `errorCodeId`. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system.", "type": "text/plain" }, "url": { @@ -2711,39 +2778,58 @@ { "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Id for the error code chosen.", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", - "key": "environment" + "value": "errorId", + "key": "errorCodeId" }, { "disabled": false, "description": { - "content": "(Required) Id for the error code chosen.", + "content": "(Required) Environment to use. Used as part of the URL.", "type": "text/plain" }, "type": "any", - "value": "errorId", - "key": "errorCodeId" + "value": "vtexcommercestable", + "key": "environment" } ] }, "header": [ + { + "disabled": false, + "description": { + "content": "(Required) Describes the type of the content being sent.", + "type": "text/plain" + }, + "key": "Content-Type", + "value": "application/json" + }, + { + "disabled": false, + "description": { + "content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "type": "text/plain" + }, + "key": "Accept", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "fe25e6fc-d2d7-4216-b06a-bc2ea67efa56", + "id": "c622c9d5-6ade-4d99-b049-2c2d89216190", "name": "OK", "originalRequest": { "url": { @@ -2757,38 +2843,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - }, - { - "disabled": false, - "description": { - "content": "(Required) Id for the error code chosen.", - "type": "text/plain" - }, - "type": "any", - "value": "errorId", - "key": "errorCodeId" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2810,6 +2867,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -2823,7 +2888,7 @@ "value": "application/json" } ], - "body": "[\n {\n \"type\": \"Authorization\",\n \"description\": \"Authorization errors where the user can solve by himself just fixing something on the settings. For example, when the user/password is invalid, or a register field is missing...\",\n \"solutionText\": \"Check connector settings\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/bridge/#/settings\"\n },\n {\n \"type\": \"Authorization\",\n \"description\": \"Authorization errors where the user can't solve by himself and depends on someone else to solve. For example, when the user has no access to a specific resource\"\n },\n {\n \"type\": \"Generic mapping\",\n \"description\": \"Catalog mapping errors different from variation, attribute or category errors. For example, brand mapping or a specific field of that channel.\",\n \"solutionText\": \"Check mapping spreadsheet\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/bridge/#/settings\"\n },\n {\n \"type\": \"Variation mapping\",\n \"description\": \"Errors of variation mapping (SKU specifications). For example, when a color field/value is not mapped correctly.\",\n \"solutionText\": \"Check mapping spreadsheet\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/bridge/#/settings\"\n },\n {\n \"type\": \"Attribute mapping\",\n \"description\": \"Errors of attribute mapping (product specifications). For example, when product specifications are not mapped correctly.\",\n \"solutionText\": \"Check mapping spreadsheet\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/bridge/#/settings\"\n },\n {\n \"type\": \"Category mapping\",\n \"description\": \"Errors of category mapping. For example, when a category ID is not correct; when the user has mapped the parent-category instead of the child-category.\",\n \"solutionText\": \"Check mapping spreadsheet\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/bridge/#/settings\"\n },\n {\n \"type\": \"Product info\",\n \"description\": \"Generic errors of product information sending. For any case different that the other product information error codes don't support\",\n \"solutionText\": \"Check item on catalog\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/ProdutoForm.aspx\"\n },\n {\n \"type\": \"Description\",\n \"description\": \"Description is not according as expected by the channel. For example, when the description is too long; when has HTML; when there is no description and is a mandatory field...\",\n \"solutionText\": \"Fix description\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/ProdutoForm.aspx?id={productId}\"\n },\n {\n \"type\": \"Images\",\n \"description\": \"Images are not according as expected by the channel. For example, when the image must have white background; when has no images and is mandatory to have at least one...\",\n \"solutionText\": \"Fix images\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/SkuForm.aspx?idSku={skuId}\"\n },\n {\n \"type\": \"Dimensions\",\n \"description\": \"Dimensions are not according as expected by the channel. For example, when the weight is below the minimum required; when the dimensions are not filled and is a mandatory field...\",\n \"solutionText\": \"Check dimensions\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/SkuForm.aspx?idSku={skuId}\"\n },\n {\n \"type\": \"Title\",\n \"description\": \"Title is not according as expected by the channel. For example, when the title is too long; when the title doesn't meet the channel taxonomy...\",\n \"solutionText\": \"Check title\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/ProdutoForm.aspx?id={productId}\"\n },\n {\n \"type\": \"Identifiers\",\n \"description\": \"Identifier is not according as expected by the channel. For example, when a EAN, ISBN or UPC is invalid; when a identifier is required but is not filled...\",\n \"solutionText\": \"Fix item's identifier\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/SkuForm.aspx?idSku={skuId}\"\n },\n {\n \"type\": \"Channels' rules\",\n \"description\": \"Errors due channel's business rules that cannot be solved by the user. For example, when the product category is not supported by the channel; when a currency is not supported by the channel...\"\n },\n {\n \"type\": \"Moderation\",\n \"description\": \"Ad moderated, it does not comply with Mercado Livre policies\",\n \"solutionText\": \"Apply the actions in the moderation section\"\n },\n {\n \"type\": \"Variation mapping\",\n \"description\": \"Errors of variation mapping (SKU specifications)\",\n \"solutionText\": \"Download mapping spreadsheet\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/dummy-invalid-link/catalog/skus/{skuId}\"\n },\n {\n \"type\": \"Variation mapping YYY\",\n \"description\": \"Errors of variation mapping (SKU specifications) YYY\",\n \"solutionText\": \"Download mapping spreadsheet YYY\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/dummyyy-invalid-link/catalog/skus/{skuId}\"\n },\n {\n \"type\": \"Inventory\",\n \"description\": \"Errors directly related to all inventory scenarios. This scenarios are for every issue that blocks an inventory from being updated. For example, when the channel has a rule of minimum quantity of inventory for all SKUs of a product.\",\n \"solutionText\": \"Check inventory levels\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/inventory/?skuId={skuId}\"\n },\n {\n \"type\": \"Not mapped\",\n \"description\": \"Errors not mapped by the connector. Commonly, it occurs when the channel's API starts to validate new things without communicating to the connector.\"\n },\n {\n \"type\": \"Price\",\n \"description\": \"Errors directly related to all price scenarios. This scenarios are for every issue that blocks a price from being updated. For example, when a price changes on rate that is not allowed by the marketplace.\",\n \"solutionText\": \"Fix price\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/pricing/#/prices/?page=1&qtd=10&productId={productId}&productName=%22%22\"\n }\n]", + "body": "[\n {\n \"id\": \"AUTH-001\",\n \"type\": \"Authorization\",\n \"description\": \"Authorization errors where the user can solve by himself just fixing something on the settings. For example, when the user/password is invalid, or a register field is missing...\",\n \"solutionText\": \"Check connector settings\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/bridge/#/settings\"\n },\n {\n \"id\": \"AUTH-002\",\n \"type\": \"Authorization\",\n \"description\": \"Authorization errors where the user can't solve by himself and depends on someone else to solve. For example, when the user has no access to a specific resource\"\n },\n {\n \"id\": \"CTLG-001\",\n \"type\": \"Generic mapping\",\n \"description\": \"Catalog mapping errors different from variation, attribute or category errors. For example, brand mapping or a specific field of that channel.\",\n \"solutionText\": \"Check mapping spreadsheet\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/bridge/#/settings\"\n },\n {\n \"id\": \"CTLG-002\",\n \"type\": \"Variation mapping\",\n \"description\": \"Errors of variation mapping (SKU specifications). For example, when a color field/value is not mapped correctly.\",\n \"solutionText\": \"Check mapping spreadsheet\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/bridge/#/settings\"\n },\n {\n \"id\": \"CTLG-003\",\n \"type\": \"Attribute mapping\",\n \"description\": \"Errors of attribute mapping (product specifications). For example, when product specifications are not mapped correctly.\",\n \"solutionText\": \"Check mapping spreadsheet\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/bridge/#/settings\"\n },\n {\n \"id\": \"CTLG-004\",\n \"type\": \"Category mapping\",\n \"description\": \"Errors of category mapping. For example, when a category ID is not correct; when the user has mapped the parent-category instead of the child-category.\",\n \"solutionText\": \"Check mapping spreadsheet\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/bridge/#/settings\"\n },\n {\n \"id\": \"CTLG-005\",\n \"type\": \"Product info\",\n \"description\": \"Generic errors of product information sending. For any case different that the other product information error codes don't support\",\n \"solutionText\": \"Check item on catalog\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/ProdutoForm.aspx\"\n },\n {\n \"id\": \"CTLG-006\",\n \"type\": \"Description\",\n \"description\": \"Description is not according as expected by the channel. For example, when the description is too long; when has HTML; when there is no description and is a mandatory field...\",\n \"solutionText\": \"Fix description\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/ProdutoForm.aspx?id={productId}\"\n },\n {\n \"id\": \"CTLG-007\",\n \"type\": \"Images\",\n \"description\": \"Images are not according as expected by the channel. For example, when the image must have white background; when has no images and is mandatory to have at least one...\",\n \"solutionText\": \"Fix images\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/SkuForm.aspx?idSku={skuId}\"\n },\n {\n \"id\": \"CTLG-008\",\n \"type\": \"Dimensions\",\n \"description\": \"Dimensions are not according as expected by the channel. For example, when the weight is below the minimum required; when the dimensions are not filled and is a mandatory field...\",\n \"solutionText\": \"Check dimensions\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/SkuForm.aspx?idSku={skuId}\"\n },\n {\n \"id\": \"CTLG-009\",\n \"type\": \"Title\",\n \"description\": \"Title is not according as expected by the channel. For example, when the title is too long; when the title doesn't meet the channel taxonomy...\",\n \"solutionText\": \"Check title\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/ProdutoForm.aspx?id={productId}\"\n },\n {\n \"id\": \"CTLG-010\",\n \"type\": \"Identifiers\",\n \"description\": \"Identifier is not according as expected by the channel. For example, when a EAN, ISBN or UPC is invalid; when a identifier is required but is not filled...\",\n \"solutionText\": \"Fix item's identifier\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/Site/SkuForm.aspx?idSku={skuId}\"\n },\n {\n \"id\": \"CTLG-011\",\n \"type\": \"Channels' rules\",\n \"description\": \"Errors due channel's business rules that cannot be solved by the user. For example, when the product category is not supported by the channel; when a currency is not supported by the channel...\"\n },\n {\n \"id\": \"CTLG-012\",\n \"type\": \"Moderation\",\n \"description\": \"Ad moderated, it does not comply with Mercado Livre policies\",\n \"solutionText\": \"Apply the actions in the moderation section\"\n },\n {\n \"id\": \"CTLG-XXX\",\n \"type\": \"Variation mapping\",\n \"description\": \"Errors of variation mapping (SKU specifications)\",\n \"solutionText\": \"Download mapping spreadsheet\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/dummy-invalid-link/catalog/skus/{skuId}\"\n },\n {\n \"id\": \"CTLG-YYY\",\n \"type\": \"Variation mapping YYY\",\n \"description\": \"Errors of variation mapping (SKU specifications) YYY\",\n \"solutionText\": \"Download mapping spreadsheet YYY\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/dummyyy-invalid-link/catalog/skus/{skuId}\"\n },\n {\n \"id\": \"INVNT-001\",\n \"type\": \"Inventory\",\n \"description\": \"Errors directly related to all inventory scenarios. This scenarios are for every issue that blocks an inventory from being updated. For example, when the channel has a rule of minimum quantity of inventory for all SKUs of a product.\",\n \"solutionText\": \"Check inventory levels\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/inventory/?skuId={skuId}\"\n },\n {\n \"id\": \"NTMAP-001\",\n \"type\": \"Not mapped\",\n \"description\": \"Errors not mapped by the connector. Commonly, it occurs when the channel's API starts to validate new things without communicating to the connector.\"\n },\n {\n \"id\": \"PRICE-001\",\n \"type\": \"Price\",\n \"description\": \"Errors directly related to all price scenarios. This scenarios are for every issue that blocks a price from being updated. For example, when a price changes on rate that is not allowed by the marketplace.\",\n \"solutionText\": \"Fix price\",\n \"solutionLink\": \"http://{accountName}.myvtex.com/admin/pricing/#/prices/?page=1&qtd=10&productId={productId}&productName=%22%22\"\n }\n]", "cookie": [] } ], @@ -2831,7 +2896,7 @@ { "listen": "test", "script": { - "id": "ad69e648-590a-4e1d-b000-5bf4401bb342", + "id": "2a227560-b0fc-4380-ba8d-f909f6196258", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/sent-offers/error-codes/:errorCodeId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2873,22 +2938,18 @@ "event": [], "variable": [ { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, "type": "any", "value": "vtexcommercestable", "key": "environment" }, { - "type": "string", + "type": "any", "value": "https://portal.{{environment}}.com.br", "key": "baseUrl" } ], "info": { - "_postman_id": "e2b7a584-e4ff-4770-8235-66ece8ab660a", + "_postman_id": "d62b9d70-ade8-4f16-a758-3634ab3c6319", "name": "Sent Offers", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { From 1b83d28940918b54efc486661ab7943e721e82f4 Mon Sep 17 00:00:00 2001 From: Ana Barbosa Date: Thu, 17 Oct 2024 10:28:28 -0300 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Karen Krieger --- VTEX - Marketplace APIs - Sent Offers.json | 28 +++++++++++----------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/VTEX - Marketplace APIs - Sent Offers.json b/VTEX - Marketplace APIs - Sent Offers.json index ed4633c95..896b7477c 100644 --- a/VTEX - Marketplace APIs - Sent Offers.json +++ b/VTEX - Marketplace APIs - Sent Offers.json @@ -28,7 +28,7 @@ "Offer Management" ], "summary": "Create Channel", - "description": "❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\nThe first step for connectors to integrate with [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) is to create a channel, that represents the marketplace to where sellers will send their offers. \n\nThis endpoint creates a channel and the integration developers should call it once for each marketplace. The information about the marketplace sent in the request will be shown to sellers in their [Offer Management UI](https://help.vtex.com/en/tutorial/offers-listing--7MRb9S78aBdZjFGpbuffpE). \n\nThe `feedId` created by this call will apply to all sellers connected to the given channel, and will be necessary for the next step of the integration flow, which is to [activate feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds). \n\n>\u2139\r\n> Offer Management is available for integrations with [Mercado Livre (Classic and Premium)](https://help.vtex.com/pt/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq), [Netshoes](https://help.vtex.com/pt/tracks/configurar-integracao-da-netshoes--5Ua87lhFg4m0kEcuyqmcCm), and VTEX marketplaces. For more information, see [Offer Management Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors).", + "description": "❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\nThe first step for connectors to integrate with [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) is to create a channel, that represents the marketplace to where sellers will send their offers. \n\nThis endpoint creates a channel and the integration developers should call it once for each marketplace. The information about the marketplace sent in the request will be shown to sellers in their [Offer Management UI](https://help.vtex.com/en/tutorial/offers-listing--7MRb9S78aBdZjFGpbuffpE). \n\nThe `feedId` created by this call will apply to all sellers connected to the given channel, and will be necessary for the next step of the integration flow, which is to [activate feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds). \n\n>\u2139\r\n> Offer Management is available for integrations with [Mercado Livre (Classic and Premium)](https://help.vtex.com/en/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq), [Netshoes](https://help.vtex.com/en/tracks/configurar-integracao-da-netshoes--5Ua87lhFg4m0kEcuyqmcCm), and VTEX marketplaces. For more information, see [Offer Management Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors).", "operationId": "CreateChannel", "parameters": [ { @@ -141,7 +141,7 @@ ], "summary": "Activate Feed", "operationId": "CreateFeed", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\nIn [Offer Management](https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors), after [creating the channel](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), the next step is to create a feed, which is a list updated nearly in real time with information about the seller's offers sent to the marketplace. \n\nThis endpoint allows the creation of a feed so that the seller's sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) is connected to the marketplace. Feeds are nearly real time updated with content provided by the marketplace and VTEX modules. \n\nThis endpoint should only be used once, to activate the channel and establish the connection. However, after a [feed is deactivated](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#delete-/api/sent-offers/feeds/-feedId-), in order to activate it again it will be necessary another call to this endpoint.The integration starts with the creation of the Feed. This endpoint is used to establish the connection between connector and seller through the Sent Offers. \n\nThe `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when calling this endpoint. It follows the pattern `vendor.channel`.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\nIn [Offer Management](https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors), after [creating the channel](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), the next step is to create a feed, which is a list updated nearly in real time with information about the seller's offers sent to the marketplace. \n\nThis endpoint allows the creation of a feed so that the seller's sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) is connected to the marketplace. Feeds are nearly real time updated with content provided by the marketplace and VTEX modules. \n\nThis endpoint should only be used once, to activate the channel and establish the connection. However, after a [feed is deactivated](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#delete-/api/sent-offers/feeds/-feedId-), in order to activate it again it will be necessary another call to this endpoint.The integration starts with the creation of the Feed. This endpoint is used to establish the connection between connector and seller through the Sent Offers. \n\nThe `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when calling this endpoint. It follows the pattern `vendor.channel`.", "parameters": [ { "name": "environment", @@ -256,7 +256,7 @@ "Offer Management" ], "summary": "List Feeds", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace, and it is updated in real-time with content provided by the marketplace and VTEX modules. \n\nSince a seller can have integrations with multiple marketplaces, numerous feeds can be associated with an account. This endpoint retrieves a list with all the feeds related to an account.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace, and it is updated in real-time with content provided by the marketplace and VTEX modules. \n\nSince a seller can have integrations with multiple marketplaces, numerous feeds can be associated with an account. This endpoint retrieves a list with all the feeds related to an account.", "operationId": "ListFeeds", "parameters": [ { @@ -415,7 +415,7 @@ ], "summary": "Update Feed", "operationId": "UpdateFeed", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. \n\nOnce you have [created a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), this endpoint allows the seller to update the sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) and [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) ID used in the integration with the marketplace.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. \n\nOnce you have [created a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), this endpoint allows the seller to update the sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) and [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) ID used in the integration with the marketplace.", "parameters": [ { "name": "environment", @@ -502,7 +502,7 @@ ], "summary": "Get Feed by feedId", "operationId": "RetrieveFeed", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), after you have [created the channel](https://developers.vtex.com/vtex-rest-api/reference/createchannel), the next step is to create a feed, which is a list of information about the seller's offers sent to the marketplace. \n\nThis endpoint retrieves information about a specific feed by searching through its `feedId`.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), after you have [created the channel](https://developers.vtex.com/vtex-rest-api/reference/createchannel), the next step is to create a feed, which is a list of information about the seller's offers sent to the marketplace. \n\nThis endpoint retrieves information about a specific feed by searching through its `feedId`.", "parameters": [ { "name": "environment", @@ -616,7 +616,7 @@ ], "summary": "Deactivate Feed", "operationId": "DeleteFeed", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. After [creating a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds), it will be activated; and through this endpoint the seller can deactivate the feed. \n\nWhen a feed is deactivated, all data related to the marketplace is removed from Offer Management UI. That includes the channels, offers, interactions, and errors. \n\nDeactivating a feed does not mean deleting information, and the seller can restore the data by [activating the feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds) again.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. After [creating a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds), it will be activated; and through this endpoint the seller can deactivate the feed. \n\nWhen a feed is deactivated, all data related to the marketplace is removed from Offer Management UI. That includes the channels, offers, interactions, and errors. \n\nDeactivating a feed does not mean deleting information, and the seller can restore the data by [activating the feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds) again.", "parameters": [ { "name": "environment", @@ -690,7 +690,7 @@ ], "summary": "Open Interaction", "operationId": "CreateInteraction", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called Interaction. For every action that happens to an offer, whether it is a status notification or a price update, the connector creates an Interaction about it. \n\nThis endpoint creates a new interaction for an SKU so that changes can be applied to an offer. The changes informed by interactions are related to: price, inventory, catalog and status. \n\nUsually, interactions process a single type of change at a time, but it is possible to add data about catalog, price, and inventory simultaneously in the same interaction.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called Interaction. For every action that happens to an offer, whether it is a status notification or a price update, the connector creates an Interaction about it. \n\nThis endpoint creates a new interaction for an SKU so that changes can be applied to an offer. The changes informed by interactions are related to: price, inventory, catalog and status. \n\nUsually, interactions process a single type of change at a time, but it is possible to add data about catalog, price, and inventory simultaneously in the same interaction.", "parameters": [ { "name": "environment", @@ -869,7 +869,7 @@ ], "summary": "Get Interaction Data by interactionId", "operationId": "RetrieveInteraction", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nA unique code called `interactionId` is used to identify each interaction. This endpoint retrieves information about an interaction, searching by its `interactionId`. \n\nIt also retrieves existing logs through the `log` field.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nA unique code called `interactionId` is used to identify each interaction. This endpoint retrieves information about an interaction, searching by its `interactionId`. \n\nIt also retrieves existing logs through the `log` field.", "parameters": [ { "name": "environment", @@ -1042,7 +1042,7 @@ ], "summary": "Close Interaction", "operationId": "CloseInteraction", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nOnce an interaction has fulfilled its initial goal and there are no more actions (or [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs)) taking place within it, this endpoint closes an interaction.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nOnce an interaction has fulfilled its initial goal and there are no more actions (or [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs)) taking place within it, this endpoint closes an interaction.", "parameters": [ { "name": "environment", @@ -1138,7 +1138,7 @@ ], "summary": "Create Log", "operationId": "CreateLog", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), and they are organized in a timeline. All of the micro-steps of an interaction are represented through logs; they are how interactions become visible in Offer Management UI. \n\nThis endpoint adds logs that take place within an interaction, which can be done after [creating an interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions) so that there will be an `interactionId`. \n\n`Errors`: When Offer Management, or the connectors, find an error that prevents sending or updating an offer to a channel, they should open a type failure log, and fill in its details through the `errors` attribute. The information provided should enable sellers to identify and fix errors on their offers. \n\nThe connectors should go through every possible validation, identify all errors, and only after that create the failure log, with the information in a single request.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), and they are organized in a timeline. All of the micro-steps of an interaction are represented through logs; they are how interactions become visible in Offer Management UI. \n\nThis endpoint adds logs that take place within an interaction, which can be done after [creating an interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions) so that there will be an `interactionId`. \n\n`Errors`: When Offer Management, or the connectors, find an error that prevents sending or updating an offer to a channel, they should open a type failure log, and fill in its details through the `errors` attribute. The information provided should enable sellers to identify and fix errors on their offers. \n\nThe connectors should go through every possible validation, identify all errors, and only after that create the failure log, with the information in a single request.", "parameters": [ { "name": "environment", @@ -1324,7 +1324,7 @@ ], "summary": "Get Log Data by logId", "operationId": "RetrieveLog", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), organized in a timeline. All interaction's micro-steps will be represented through logs; they are how interactions become visible in Offer Management UI. \n\nA unique code called `logId` is used to identify every log created. This endpoint enables the retrieval of information about a log by searching through its `logId`.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), logs are the granular details of actions that happen within an [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions), organized in a timeline. All interaction's micro-steps will be represented through logs; they are how interactions become visible in Offer Management UI. \n\nA unique code called `logId` is used to identify every log created. This endpoint enables the retrieval of information about a log by searching through its `logId`.", "parameters": [ { "name": "environment", @@ -1512,7 +1512,7 @@ ], "summary": "Search Interactions and their Logs", "operationId": "SearchInteractions", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). The granular details of actions and micro-steps that happen within an interaction's are called [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs). \n\nThis endpoint retrieves information about interactions and all logs within it. It allows filtering interactions by using the following query params: `channel`, `brand`, `category`, `scope`, `result`, `fromDate`, `toDate`. This endpoint also counts with the following pagination query params: `sort`, `from`, `to`.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). The granular details of actions and micro-steps that happen within an interaction's are called [logs](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions/-interactionId-/logs). \n\nThis endpoint retrieves information about interactions and all logs within it. It allows filtering interactions by using the following query params: `channel`, `brand`, `category`, `scope`, `result`, `fromDate`, `toDate`. This endpoint also counts with the following pagination query params: `sort`, `from`, `to`.", "parameters": [ { "name": "environment", @@ -1685,7 +1685,7 @@ ], "summary": "Search Errors", "operationId": "SearchErrors", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n This endpoint provides the single source of truth of updated error codes in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It retrieves a list of all the error codes available at that moment. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system. \n\nThis endpoint allows filtering errors by using the following query params: `channel`, `brand`, `category`, `errorCategory`. It also counts with the following pagination query params: `sort`, `from`, `to`, `q`.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n This endpoint provides the single source of truth of updated error codes in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It retrieves a list of all the error codes available at that moment. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system. \n\nThis endpoint allows filtering errors by using the following query params: `channel`, `brand`, `category`, `errorCategory`. It also counts with the following pagination query params: `sort`, `from`, `to`, `q`.", "parameters": [ { "name": "environment", @@ -1844,7 +1844,7 @@ ], "summary": "Get Error Code data by errorCodeId", "operationId": "RetrieveErrorCode", - "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/pt/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n This endpoint retrieves specific information about an error code in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It provides the single source of truth of updated information about an error code through the `errorCodeId`. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system.", + "description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n This endpoint retrieves specific information about an error code in [Offer Management's](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) configuration. It provides the single source of truth of updated information about an error code through the `errorCodeId`. \n\nThe connector will retrieve all the error codes available directly on this API and use the codes that apply the most to their error scenarios. Then, the connector will implement these codes into every validation error inside their system.", "parameters": [ { "name": "environment",