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 01/16] 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 02/16] 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 5d8d68653633658eb1d8171cda0eed5eca4ea394 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Patr=C3=ADcia=20F=2E=20Barbosa?= Date: Wed, 16 Oct 2024 12:14:11 -0300 Subject: [PATCH 03/16] Send Invoice API Fix broken link and path params of Send invoice API. --- ...- Marketplace Protocol - External Seller Marketplace.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/VTEX - Marketplace Protocol - External Seller Marketplace.json b/VTEX - Marketplace Protocol - External Seller Marketplace.json index 91516a87e..5e36c153a 100644 --- a/VTEX - Marketplace Protocol - External Seller Marketplace.json +++ b/VTEX - Marketplace Protocol - External Seller Marketplace.json @@ -38,6 +38,9 @@ }, { "$ref": "#/components/parameters/marketplaceServicesEndpoint" + }, + { + "$ref":"#/components/parameters/invoiceNumber" } ], "requestBody": { @@ -295,7 +298,7 @@ "marketplaceServicesEndpoint": { "name": "marketplaceServicesEndpoint", "in": "path", - "description": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", + "description": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders).", "required": true, "style": "simple", "schema": { From 2372c7f70ad1db6372249d162bd491d725985dfe Mon Sep 17 00:00:00 2001 From: anabaarbosa <> Date: Wed, 16 Oct 2024 15:20:34 +0000 Subject: [PATCH 04/16] Update generated files by portman --- ...rotocol - External Seller Marketplace.json | 332 ++++++++---------- 1 file changed, 145 insertions(+), 187 deletions(-) diff --git a/PostmanCollections/VTEX - Marketplace Protocol - External Seller Marketplace.json b/PostmanCollections/VTEX - Marketplace Protocol - External Seller Marketplace.json index 4a0994f04..c19341926 100644 --- a/PostmanCollections/VTEX - Marketplace Protocol - External Seller Marketplace.json +++ b/PostmanCollections/VTEX - Marketplace Protocol - External Seller Marketplace.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "3f81a02b-2bf0-4f75-9003-da51b86902d8" + "postman_id": "fd8bc55f-a5c4-49ce-be70-c412c2e85c7d" }, "item": [ { - "id": "2117a3ba-1127-437e-b92e-89a1484207b9", + "id": "f8071939-ed34-4088-82ff-cb2fd3762504", "name": "External Seller", "description": { "content": "", @@ -12,12 +12,12 @@ }, "item": [ { - "id": "43743a95-7b19-4932-8cb6-d215eb414b44", + "id": "bf16c1b7-c083-44d6-a52b-eb14255c9992", "name": "Send invoice", "request": { "name": "Send invoice", "description": { - "content": "This request is sent by the external seller to the VTEX marketplace to send invoice information.\n\nThis can be necessary in a regular order or in the case of a return. The `type` field is used to indicate which of these is the case.3\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", + "content": "This request is sent by the external seller to the VTEX marketplace to send invoice information.\n\nThis can be necessary in a regular order or in the case of a return. The `type` field is used to indicate which of these is the case.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", "type": "text/plain" }, "url": { @@ -45,12 +45,22 @@ { "disabled": false, "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", + "content": "(Required) This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders).", "type": "text/plain" }, "type": "any", - "value": "{{marketplaceServicesEndpoint}}", + "value": "marketplaceservicesendpoint.myvtex.com", "key": "marketplaceServicesEndpoint" + }, + { + "disabled": false, + "description": { + "content": "(Required) Invoice number.", + "type": "text/plain" + }, + "type": "any", + "value": "NFe-00002", + "key": "invoiceNumber" } ] }, @@ -72,6 +82,14 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -80,6 +98,7 @@ "raw": "{\n \"type\": \"Output\",\n \"invoiceNumber\": \"NFe-00002\",\n \"items\": [\n {\n \"id\": \"6\",\n \"quantity\": 1,\n \"price\": 5500\n },\n {\n \"id\": \"6\",\n \"quantity\": 1,\n \"price\": 5500\n }\n ],\n \"courier\": \"courier-example\",\n \"trackingNumber\": \"12345678abc\",\n \"trackingUrl\": \"https://courier-example.com/tracking\",\n \"issuanceDate\": \"2021-05-21T10:00:00\",\n \"invoiceValue\": 6000\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -90,7 +109,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2feca0b0-7f79-445c-aabd-fb5c505ce962", + "id": "2ed4c0ee-769a-4b59-a77d-beaa67eca8cd", "name": "OK", "originalRequest": { "url": { @@ -104,38 +123,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Identifies the order in the marketplace.", - "type": "text/plain" - }, - "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" - }, - { - "disabled": false, - "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", - "type": "text/plain" - }, - "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -154,9 +144,21 @@ "key": "Content-Type", "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", @@ -165,6 +167,7 @@ "raw": "{\n \"type\": \"Output\",\n \"invoiceNumber\": \"NFe-00002\",\n \"items\": [\n {\n \"id\": \"6\",\n \"quantity\": 1,\n \"price\": 5500\n },\n {\n \"id\": \"6\",\n \"quantity\": 1,\n \"price\": 5500\n }\n ],\n \"courier\": \"courier-example\",\n \"trackingNumber\": \"12345678abc\",\n \"trackingUrl\": \"https://courier-example.com/tracking\",\n \"issuanceDate\": \"2021-05-21T10:00:00\",\n \"invoiceValue\": 6000\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -186,7 +189,7 @@ { "listen": "test", "script": { - "id": "624e41fc-0302-46a8-9ab4-71ead6b5e641", + "id": "729c201e-21c8-45e9-a648-96a98f206593", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/pvt/orders/:marketplaceOrderId/invoice - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -202,7 +205,7 @@ } }, { - "id": "0b8986ad-7aac-4d47-89fd-1fe2ca823559", + "id": "16de9620-e464-4f8b-a53c-6a2ad5a6441c", "name": "Send tracking information", "request": { "name": "Send tracking information", @@ -226,32 +229,32 @@ { "disabled": false, "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", + "content": "(Required) Identifies the order in the marketplace.", "type": "text/plain" }, "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" + "value": "1138342255777-01", + "key": "marketplaceOrderId" }, { "disabled": false, "description": { - "content": "(Required) Identifies the order in the marketplace.", + "content": "(Required) Invoice number.", "type": "text/plain" }, "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" + "value": "NFe-00002", + "key": "invoiceNumber" }, { "disabled": false, "description": { - "content": "(Required) Invoice number.", + "content": "(Required) This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders).", "type": "text/plain" }, "type": "any", - "value": "NFe-00002", - "key": "invoiceNumber" + "value": "marketplaceservicesendpoint.myvtex.com", + "key": "marketplaceServicesEndpoint" } ] }, @@ -273,6 +276,14 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -281,6 +292,7 @@ "raw": "{\n \"courier\": \"courier-example\",\n \"trackingNumber\": \"12345678abc\",\n \"trackingUrl\": \"https://courier-example.com/tracking\",\n \"dispatchedDate\": \"2021-06-09\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -291,7 +303,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3f46805c-1982-4a04-ac12-650da87b49bc", + "id": "ce4a334b-ae0b-4d11-b44b-85ce1d9e0f9d", "name": "OK", "originalRequest": { "url": { @@ -306,48 +318,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", - "type": "text/plain" - }, - "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" - }, - { - "disabled": false, - "description": { - "content": "(Required) Identifies the order in the marketplace.", - "type": "text/plain" - }, - "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Invoice number.", - "type": "text/plain" - }, - "type": "any", - "value": "NFe-00002", - "key": "invoiceNumber" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -366,9 +339,21 @@ "key": "Content-Type", "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", @@ -377,6 +362,7 @@ "raw": "{\n \"courier\": \"courier-example\",\n \"trackingNumber\": \"12345678abc\",\n \"trackingUrl\": \"https://courier-example.com/tracking\",\n \"dispatchedDate\": \"2021-06-09\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -398,7 +384,7 @@ { "listen": "test", "script": { - "id": "ad1b5ee0-68b9-4c80-806b-5d1bfe019078", + "id": "dbea5e32-a956-447f-b478-8ccc081fe6ac", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/pvt/orders/:marketplaceOrderId/invoice/:invoiceNumber - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -414,7 +400,7 @@ } }, { - "id": "e9852bb6-3524-4e2d-b6fd-0a21c7978a26", + "id": "80a60a27-aa07-4964-a737-9c6238f0588e", "name": "Update tracking status", "request": { "name": "Update tracking status", @@ -439,32 +425,32 @@ { "disabled": false, "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", + "content": "(Required) Identifies the order in the marketplace.", "type": "text/plain" }, "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" + "value": "1138342255777-01", + "key": "marketplaceOrderId" }, { "disabled": false, "description": { - "content": "(Required) Identifies the order in the marketplace.", + "content": "(Required) Invoice number.", "type": "text/plain" }, "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" + "value": "NFe-00002", + "key": "invoiceNumber" }, { "disabled": false, "description": { - "content": "(Required) Invoice number.", + "content": "(Required) This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders).", "type": "text/plain" }, "type": "any", - "value": "NFe-00002", - "key": "invoiceNumber" + "value": "marketplaceservicesendpoint.myvtex.com", + "key": "marketplaceServicesEndpoint" } ] }, @@ -486,6 +472,14 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -494,6 +488,7 @@ "raw": "{\n \"isDelivered\": true,\n \"events\": [\n {\n \"city\": \"Rio de Janeiro\",\n \"state\": \"Rio de Janeiro\",\n \"description\": \"Order delivered.\",\n \"date\": \"2021-03-16\"\n },\n {\n \"city\": \"Rio de Janeiro\",\n \"state\": \"Rio de Janeiro\",\n \"description\": \"Order delivered.\",\n \"date\": \"2021-03-16\"\n }\n ]\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -504,7 +499,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "cccc0f31-148b-488b-96e3-8c0b8e705397", + "id": "5a87dfb9-e0b8-49bd-ad03-03be4249724c", "name": "OK", "originalRequest": { "url": { @@ -520,48 +515,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", - "type": "text/plain" - }, - "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" - }, - { - "disabled": false, - "description": { - "content": "(Required) Identifies the order in the marketplace.", - "type": "text/plain" - }, - "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Invoice number.", - "type": "text/plain" - }, - "type": "any", - "value": "NFe-00002", - "key": "invoiceNumber" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -580,9 +536,21 @@ "key": "Content-Type", "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", @@ -591,6 +559,7 @@ "raw": "{\n \"isDelivered\": true,\n \"events\": [\n {\n \"city\": \"Rio de Janeiro\",\n \"state\": \"Rio de Janeiro\",\n \"description\": \"Order delivered.\",\n \"date\": \"2021-03-16\"\n },\n {\n \"city\": \"Rio de Janeiro\",\n \"state\": \"Rio de Janeiro\",\n \"description\": \"Order delivered.\",\n \"date\": \"2021-03-16\"\n }\n ]\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -612,7 +581,7 @@ { "listen": "test", "script": { - "id": "73e8d859-fd3e-4b03-be87-a91a384a60c3", + "id": "c74055b1-8ced-4349-ab96-2afcb18b9b96", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/pvt/orders/:marketplaceOrderId/invoice/:invoiceNumber/tracking - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -628,7 +597,7 @@ } }, { - "id": "5c6dd9ff-d83b-4d9d-a882-0a1bf376e73c", + "id": "ccf41879-5598-4655-b7e7-ef4b7a6fa8ce", "name": "Cancel order in marketplace", "request": { "name": "Cancel order in marketplace", @@ -651,22 +620,22 @@ { "disabled": false, "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", + "content": "(Required) Identifies the order in the marketplace.", "type": "text/plain" }, "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" + "value": "1138342255777-01", + "key": "marketplaceOrderId" }, { "disabled": false, "description": { - "content": "(Required) Identifies the order in the marketplace.", + "content": "(Required) This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders).", "type": "text/plain" }, "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" + "value": "marketplaceservicesendpoint.myvtex.com", + "key": "marketplaceServicesEndpoint" } ] }, @@ -688,6 +657,14 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -696,6 +673,7 @@ "raw": "{\n \"reason\": \"Product is unavailable.\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -706,7 +684,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8a79ae45-ea9c-4a18-8069-39fecbb53218", + "id": "afeb7bd9-d42b-4ee4-bae2-00002c87ab6d", "name": "OK", "originalRequest": { "url": { @@ -720,38 +698,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", - "type": "text/plain" - }, - "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" - }, - { - "disabled": false, - "description": { - "content": "(Required) Identifies the order in the marketplace.", - "type": "text/plain" - }, - "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -770,9 +719,21 @@ "key": "Content-Type", "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", @@ -781,6 +742,7 @@ "raw": "{\n \"reason\": \"Product is unavailable.\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -802,7 +764,7 @@ { "listen": "test", "script": { - "id": "2af88274-0392-46c4-a8e6-b2deaad89df0", + "id": "a3c272c5-ab0e-4161-8bdd-29bec727ee36", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/pvt/orders/:marketplaceOrderId/cancel - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -844,22 +806,18 @@ "event": [], "variable": [ { - "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", - "type": "text/plain" - }, "type": "any", "value": "{marketplaceServicesEndpoint}", "key": "marketplaceServicesEndpoint" }, { - "type": "string", + "type": "any", "value": "https://{{marketplaceServicesEndpoint}}", "key": "baseUrl" } ], "info": { - "_postman_id": "3f81a02b-2bf0-4f75-9003-da51b86902d8", + "_postman_id": "fd8bc55f-a5c4-49ce-be70-c412c2e85c7d", "name": "Marketplace Protocol", "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 05/16] 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", From cbc076a82ad5749c96058392e085295a14c4066a Mon Sep 17 00:00:00 2001 From: Geise Costa <136460310+geisecosta@users.noreply.github.com> Date: Fri, 18 Oct 2024 08:59:37 -0300 Subject: [PATCH 06/16] Updated the id and name fields (#1347) --- VTEX - Promotions & Taxes API.json | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/VTEX - Promotions & Taxes API.json b/VTEX - Promotions & Taxes API.json index 3627ce93b..160f77bce 100644 --- a/VTEX - Promotions & Taxes API.json +++ b/VTEX - Promotions & Taxes API.json @@ -2735,15 +2735,21 @@ "description": "Object composed by the SKUs that will activate or deactivate the promotion.", "items": { "type": "object", + "required": [ + "id", + "name" + ], "description": "Object with information of the SKU.", "properties": { "id": { "type": "string", - "description": "SKU ID." + "description": "SKU ID.", + "nullable": false }, "name": { "type": "string", - "description": "SKU Name." + "description": "SKU Name.", + "nullable": false } } } From 01729e5bac60e0edae50cf87c70b079fa9e48f30 Mon Sep 17 00:00:00 2001 From: Geise Costa <136460310+geisecosta@users.noreply.github.com> Date: Tue, 22 Oct 2024 13:47:59 -0300 Subject: [PATCH 07/16] EDU-11062 New endpoint (#1348) --- PostmanCollections/VTEX - Pricing API.json | 218 ++++++++++++++++----- VTEX - Pricing API.json | 70 +++++-- 2 files changed, 232 insertions(+), 56 deletions(-) diff --git a/PostmanCollections/VTEX - Pricing API.json b/PostmanCollections/VTEX - Pricing API.json index e874d0e24..738ef5f70 100644 --- a/PostmanCollections/VTEX - Pricing API.json +++ b/PostmanCollections/VTEX - Pricing API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "0d48e5a5-50a6-4f6b-8168-22f78dec1e6d" + "postman_id": "bec2846c-cee3-47ec-84d5-07e02dc71de3" }, "item": [ { - "id": "57994901-af84-43f8-89b0-324bce16e349", + "id": "39442af1-72fd-4795-a088-0733a978e468", "name": "Price Tables", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "94a9cc19-30b7-48f7-8126-f0df01e0e402", + "id": "9dd2cfbb-0388-4647-95d6-4d0f2d65d36e", "name": "Get rules for a price table", "request": { "name": "Get rules for a price table", @@ -86,7 +86,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "54f8ca61-2536-46a9-b5c9-4d3a260fd439", + "id": "4d5fe92c-02a3-4722-8c7a-fd837427e8e5", "name": "OK", "originalRequest": { "url": { @@ -157,7 +157,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "705de5bb-f70e-49f9-89ab-d8cda0c6c079", + "id": "b10a77c2-b355-496b-b0f1-fab9b5689d71", "name": "Unauthorized", "originalRequest": { "url": { @@ -218,7 +218,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "a23498da-6e58-46f3-891f-2e909c1318b3", + "id": "b7ca8e3a-3ce2-4f86-9a02-c92fa813aea1", "name": "Forbidden", "originalRequest": { "url": { @@ -279,7 +279,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "2455f85b-20c3-4bfa-a27d-fbdee0fba475", + "id": "483b8ee9-dc78-447c-81bd-3e34fcf2db7b", "name": "Too many requests", "originalRequest": { "url": { @@ -343,7 +343,7 @@ } }, { - "id": "3ec816c2-2ada-47cb-9566-d3873bd6627e", + "id": "0edb421d-9391-4ded-9ab6-491b28dad05e", "name": "Update rules for a price table", "request": { "name": "Update rules for a price table", @@ -370,7 +370,7 @@ "type": "text/plain" }, "type": "any", - "value": "ut", + "value": "dolore cupidatat aute ea", "key": "priceTableId" } ] @@ -416,7 +416,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "4882064d-ff64-4a06-8d1f-cb179a230029", + "id": "b8a6eba4-ff84-459b-b5e6-8f87dff3191c", "name": "Created", "originalRequest": { "url": { @@ -486,7 +486,7 @@ { "listen": "test", "script": { - "id": "b6b36a19-eb0c-484e-a07d-aaa0da60fc3d", + "id": "bdd68cd1-5f14-41b1-b9e0-e635f7001ad6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/pricing/pipeline/catalog/:priceTableId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -499,7 +499,135 @@ } }, { - "id": "76df6424-45ed-401b-aba4-83933ac1f5d6", + "id": "d4532ab0-732b-4c3a-820f-f1063acb762d", + "name": "Create price table", + "request": { + "name": "Create price table", + "description": { + "content": "Create a new price table.\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Pricing | Price List | **Modify prices** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "type": "text/plain" + }, + "url": { + "path": [ + "pricing", + "tables", + ":priceTableId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "disabled": false, + "description": { + "content": "(Required) Price Table Name.", + "type": "text/plain" + }, + "type": "any", + "value": "dolore cupidatat aute ea", + "key": "priceTableId" + } + ] + }, + "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": "PUT", + "body": {} + }, + "response": [ + { + "_": { + "postman_previewlanguage": "text" + }, + "id": "3fe45c0d-aedf-41cd-b2e7-62bdaa47683d", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "pricing", + "tables", + ":priceTableId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "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" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" + } + ], + "method": "PUT", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [], + "cookie": [] + } + ], + "event": [ + { + "listen": "test", + "script": { + "id": "c0580988-8f68-49ee-8491-0175fc4a3500", + "type": "text/javascript", + "exec": [ + "// Validate status 2xx \npm.test(\"[PUT]::/pricing/tables/:priceTableId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" + ] + } + } + ], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "72d99832-485b-40b9-9a9f-26d4477013ba", "name": "Get all price tables and their rules", "request": { "name": "Get all price tables and their rules", @@ -562,7 +690,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ac060469-0c2f-4ad1-b4aa-88e5bcf64608", + "id": "17ae6908-8e15-4a4a-b4be-b951299db75f", "name": "OK", "originalRequest": { "url": { @@ -635,7 +763,7 @@ } }, { - "id": "16fc331d-eaad-41ff-aa79-26cbacda93ac", + "id": "b13ae268-9b53-4cec-9d3e-4480fc8205e3", "name": "List price tables", "request": { "name": "List price tables", @@ -697,7 +825,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1da7817d-c5b0-46ad-8231-0eaa7270908e", + "id": "2069f7d1-f41b-41f4-95fa-cdb4cec239f6", "name": "OK", "originalRequest": { "url": { @@ -772,7 +900,7 @@ "event": [] }, { - "id": "713dcd44-2249-4d82-8d47-957f9131c7a0", + "id": "1380ccd1-37a4-4a10-8bac-233d6b38533a", "name": "Prices and Fixed Prices", "description": { "content": "", @@ -780,7 +908,7 @@ }, "item": [ { - "id": "dbc7b62d-e472-49fd-852b-770bf27c2cbd", + "id": "855205ac-c279-4699-ab02-640a5882551f", "name": "Get price by SKU ID", "request": { "name": "Get price by SKU ID", @@ -843,7 +971,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e836d4fb-3fb6-4cf0-8480-47d05911220b", + "id": "20793cac-aa7e-4ce7-8dca-e9f7bd98458f", "name": "OK", "originalRequest": { "url": { @@ -909,7 +1037,7 @@ { "listen": "test", "script": { - "id": "f7ccb9e2-b37f-4417-84a8-91a37429ceaa", + "id": "7f47f1a8-b06d-427f-80ed-1a709fb073db", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/pricing/prices/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -925,7 +1053,7 @@ } }, { - "id": "1285b09e-ac84-4947-8903-17e9d326e72b", + "id": "455d1045-fb8d-403a-a5d3-70e5478b764d", "name": "Delete price all base and fixed prices of an SKU", "request": { "name": "Delete price all base and fixed prices of an SKU", @@ -984,7 +1112,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "b9a82ec7-b0b4-4067-b5e4-c7f04bab5d49", + "id": "73d23757-fbcd-4586-9f3a-aa9240c83f20", "name": "OK", "originalRequest": { "url": { @@ -1040,7 +1168,7 @@ { "listen": "test", "script": { - "id": "e07c92e7-8c8c-474d-b22c-44f4aacd0316", + "id": "ff4442a4-1eb5-42e3-b4b3-f547e0c74ab2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/pricing/prices/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1053,7 +1181,7 @@ } }, { - "id": "3771b7e6-439d-470a-a7c3-88e85f1daf08", + "id": "9127dbee-0e42-4468-a38e-d79f2ad13c02", "name": "Create or update base price or fixed prices", "request": { "name": "Create or update base price or fixed prices", @@ -1125,7 +1253,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "84dec8fe-453d-4234-833c-4ebd54a50a9e", + "id": "20f2a618-3612-4c56-a570-cb14bb4cc6cd", "name": "OK", "originalRequest": { "url": { @@ -1194,7 +1322,7 @@ { "listen": "test", "script": { - "id": "f577780d-a336-4b82-b59e-af13516d7a07", + "id": "a3102b7a-c9a0-4aa1-9c2c-4ae1d100e927", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/pricing/prices/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1207,7 +1335,7 @@ } }, { - "id": "fe3793ab-f794-4ec1-ae83-e99644150909", + "id": "69d0f41a-0c27-4a45-b3bd-1e80c96158da", "name": "Get fixed prices", "request": { "name": "Get fixed prices", @@ -1271,7 +1399,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "50e5e3bd-39a9-4d3f-ac0e-9d28036a3bf3", + "id": "792d8240-bab5-4c6d-b566-fdf5e7787f32", "name": "OK", "originalRequest": { "url": { @@ -1338,7 +1466,7 @@ { "listen": "test", "script": { - "id": "a52792c0-b87c-4c91-86b9-d94289c42d94", + "id": "9abd875d-81ff-469a-90bd-91007551ade3", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/pricing/prices/:itemId/fixed - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1354,7 +1482,7 @@ } }, { - "id": "8c185d15-d095-41c7-8668-659be5e9cef2", + "id": "af6234aa-8bb6-492a-a311-f1d3a4fa8850", "name": "Create or update fixed prices on a price table or trade policy", "request": { "name": "Create or update fixed prices on a price table or trade policy", @@ -1438,7 +1566,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "50f70ffb-406c-4585-9f84-c281aaaf6a7a", + "id": "a6248e26-247f-42b2-bac0-4d8b9f7aa7ed", "name": "OK", "originalRequest": { "url": { @@ -1509,7 +1637,7 @@ { "listen": "test", "script": { - "id": "b73c8c40-c368-456a-a2d0-326565c3f9ab", + "id": "82a1d6f1-aa24-4b9a-9df1-904b125d56f7", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/pricing/prices/:itemId/fixed/:priceTableId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1522,7 +1650,7 @@ } }, { - "id": "8b45c633-0375-4e58-9033-539099353f31", + "id": "cdcb3b23-289b-41e9-a655-e9353a1b9eba", "name": "Get fixed prices on a price table or trade policy", "request": { "name": "Get fixed prices on a price table or trade policy", @@ -1597,7 +1725,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6406e2af-579d-4fda-b495-4cad6f2ae187", + "id": "49f190ef-14dd-4aa1-b964-d0ca265802f1", "name": "OK", "originalRequest": { "url": { @@ -1665,7 +1793,7 @@ { "listen": "test", "script": { - "id": "f0e0afd2-54d2-44c5-85a4-e4142544706c", + "id": "1a89de28-bd06-4e25-bb14-2d0051dc50eb", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/pricing/prices/:itemId/fixed/:priceTableId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1681,7 +1809,7 @@ } }, { - "id": "c9882aa6-d8e7-4538-a33d-2aefbeb127f8", + "id": "05e83b88-b398-4df1-915e-e8cecc096ce2", "name": "Delete fixed prices on a price table or trade policy", "request": { "name": "Delete fixed prices on a price table or trade policy", @@ -1752,7 +1880,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "c75ac537-ee2e-4531-a3c7-482928cf9ea4", + "id": "a2bc7e19-2e3a-433e-8e34-3a4e1a9b613f", "name": "OK", "originalRequest": { "url": { @@ -1810,7 +1938,7 @@ { "listen": "test", "script": { - "id": "49108817-f51b-4c7c-9791-45cbc78a169c", + "id": "808dc12e-9850-4c29-a753-b39e60e36766", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/pricing/prices/:itemId/fixed/:priceTableId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1823,7 +1951,7 @@ } }, { - "id": "e56dc5c9-ade8-43d1-94ab-daf8ff48dfb1", + "id": "3ec02ee4-1f46-4a97-8fe5-5097b526e84e", "name": "Get computed price by price table or trade policy", "request": { "name": "Get computed price by price table or trade policy", @@ -1936,7 +2064,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8acb1f56-ec2a-44cf-a571-e637d58fdeea", + "id": "6d69d019-c460-4aec-9dd5-91c376a68236", "name": "OK", "originalRequest": { "url": { @@ -2042,7 +2170,7 @@ "event": [] }, { - "id": "1e1f93cf-ee2a-4824-963b-871099ff3b7c", + "id": "a88aa963-07f9-48ff-af02-ec3e2faf336c", "name": "Pricing Configuration", "description": { "content": "", @@ -2050,7 +2178,7 @@ }, "item": [ { - "id": "bf61ecf6-6580-4358-a5a0-e06ac5f802b2", + "id": "f40d2c80-e872-450d-90e7-be3b5457ba88", "name": "Get pricing configuration", "request": { "name": "Get pricing configuration", @@ -2112,7 +2240,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f7948206-c897-4ead-a80f-c5446f891f34", + "id": "40aec1d8-fbe9-4452-a046-50e104d041d2", "name": "OK", "originalRequest": { "url": { @@ -2283,7 +2411,7 @@ } }, { - "id": "a69af407-f351-4753-80e5-fd500160641e", + "id": "79495d4c-53fb-4623-aee5-b68ada8e89b7", "name": "Get pricing v2 status", "request": { "name": "Get pricing v2 status", @@ -2345,7 +2473,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c725e3c1-5ffd-4110-b8f6-c75521debd92", + "id": "a3c2225c-9cec-40b9-b0e0-fcf3f583362e", "name": "OK", "originalRequest": { "url": { @@ -2553,7 +2681,7 @@ } ], "info": { - "_postman_id": "0d48e5a5-50a6-4f6b-8168-22f78dec1e6d", + "_postman_id": "bec2846c-cee3-47ec-84d5-07e02dc71de3", "name": "Pricing API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/VTEX - Pricing API.json b/VTEX - Pricing API.json index 5192f25db..05ab9c912 100644 --- a/VTEX - Pricing API.json +++ b/VTEX - Pricing API.json @@ -318,22 +318,22 @@ } } }, - "example" : { + "example": { "markup": 30, "listPrice": 50.00, "basePrice": 100.00, "costPrice": 35.00, "fixedPrices": [ - { - "tradePolicyId": "1", - "value": 50.50, - "listPrice": 50.50, - "minQuantity": 2, - "dateRange": { - "from": "2021-12-30T22:00:00-03:00", - "to": "2021-12-30T22:00:00-03:00" + { + "tradePolicyId": "1", + "value": 50.50, + "listPrice": 50.50, + "minQuantity": 2, + "dateRange": { + "from": "2021-12-30T22:00:00-03:00", + "to": "2021-12-30T22:00:00-03:00" + } } - } ] } } @@ -1584,6 +1584,54 @@ } } }, + "/pricing/tables/{priceTableId}": { + "put": { + "tags": [ + "Price Tables" + ], + "summary": "Create price table", + "description": "Create a new price table.\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Pricing | Price List | **Modify prices** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Describes the type of the content being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "default": "application/json" + } + }, + { + "name": "Accept", + "in": "header", + "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "application/json" + } + }, + { + "name": "priceTableId", + "in": "path", + "description": "Price Table Name.", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, "/pricing/pipeline/catalog": { "get": { "tags": [ @@ -2101,7 +2149,7 @@ "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppKey", - "description":"Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." + "description": "Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, "appToken": { "type": "apiKey", From 4955ae577afac63a66b482d9c638e67a8756dfcd Mon Sep 17 00:00:00 2001 From: Ricardo Correia <87548049+ricardoaerobr@users.noreply.github.com> Date: Tue, 22 Oct 2024 15:25:24 -0300 Subject: [PATCH 08/16] Update status description field Change invoice endpoint --- VTEX - Customer Credit API.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/VTEX - Customer Credit API.json b/VTEX - Customer Credit API.json index 5bf2c87bc..8ce1bf5c4 100644 --- a/VTEX - Customer Credit API.json +++ b/VTEX - Customer Credit API.json @@ -127,7 +127,7 @@ "style": "form", "schema": { "type": "string", - "enum": ["Open", "Paid", "Cancelled"], + "enum": ["Opened", "Paid", "Cancelled"], "example": "Paid" } }, @@ -541,7 +541,7 @@ "status": { "type": "string", "description": "Invoice status.", - "enum": ["Open", "Paid", "Cancelled"], + "enum": ["Opened", "Paid", "Cancelled"], "example": "Paid" }, "observation": { @@ -854,7 +854,7 @@ "status": { "type": "string", "description": "Invoice status.", - "enum": ["Open", "Paid", "Cancelled"] + "enum": ["Opened", "Paid", "Cancelled"] }, "value": { "type": "number", @@ -1025,7 +1025,7 @@ "style": "form", "schema": { "type": "string", - "enum": ["Open", "Paid", "Cancelled"], + "enum": ["Opened", "Paid", "Cancelled"], "example": "Paid" } }, From 57d0dbe2c0781c1dd9bec78b007ffc45337d3b58 Mon Sep 17 00:00:00 2001 From: ricardoaerobr <> Date: Tue, 22 Oct 2024 18:31:36 +0000 Subject: [PATCH 09/16] Update generated files by portman --- .../VTEX - Customer Credit API.json | 2296 +++++------------ 1 file changed, 669 insertions(+), 1627 deletions(-) diff --git a/PostmanCollections/VTEX - Customer Credit API.json b/PostmanCollections/VTEX - Customer Credit API.json index c2d3a1fdd..c777bdbd0 100644 --- a/PostmanCollections/VTEX - Customer Credit API.json +++ b/PostmanCollections/VTEX - Customer Credit API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "f81d30fa-cb1e-4092-b37e-4e106131f6b1" + "postman_id": "ca090c7e-4bcc-4f1e-9d87-87af93b0d62c" }, "item": [ { - "id": "d9cd5a3c-b8aa-4c2e-8f7d-ff19e53f4fcf", + "id": "bc596111-479a-46a4-8173-5b8a7fb0da34", "name": "Invoices", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "6c5e82b5-ec38-411b-87ee-012b3c06ee7b", + "id": "365ad576-c304-4d1c-959e-3e7db2b28d7f", "name": "Search all invoices", "request": { "name": "Search all invoices", @@ -130,26 +130,7 @@ "value": "01bce461-9g03-12ds-8217-b3d39271e15b" } ], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ { @@ -169,16 +150,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "d3ef05b5-21a3-4070-b241-389817c66b0d", + "id": "d4041fac-0a45-47b4-acfa-2bd3fb1669d7", "name": "OK", "originalRequest": { "url": { @@ -192,80 +178,108 @@ ], "query": [ { + "disabled": true, + "description": { + "content": "Indicates the starting position of the invoice to be searched in the invoice list. For example, the value `1` indicates that the first invoice in the list will be returned.", + "type": "text/plain" + }, "key": "from", "value": "1" }, { + "disabled": true, + "description": { + "content": "Indicates the final position of the invoice to be searched in the invoice list. For example, if the value of `from` is equal to `1` and `to` is `300`, information from 300 invoices will be displayed in the response body of the request.", + "type": "text/plain" + }, "key": "to", "value": "300" }, { + "disabled": true, + "description": { + "content": "Indicates the initial creation date of invoices that should be searched in the invoice list based on their creation date. The dates should be in ISO8601 format.", + "type": "text/plain" + }, "key": "createdDateFrom", "value": "2023-01-20" }, { + "disabled": true, + "description": { + "content": "Indicates the final creation date of invoices that should be searched in the invoice list based on their creation date. The dates should be in ISO8601 format.", + "type": "text/plain" + }, "key": "createdDateTo", "value": "2023-01-25" }, { + "disabled": true, + "description": { + "content": "Indicates the initial due date of invoices that should be searched in the invoice list based on their creation date. The dates should be in ISO8601 format.", + "type": "text/plain" + }, "key": "dueDateFrom", "value": "2023-01-20" }, { + "disabled": true, + "description": { + "content": "Indicates the final due date of invoices that should be searched in the invoice list based on their creation date. The dates should be in ISO8601 format.", + "type": "text/plain" + }, "key": "dueDateTo", "value": "2023-01-25" }, { + "disabled": true, + "description": { + "content": "Indicates the value of the invoices to be searched for. It must be completed with a decimal value.", + "type": "text/plain" + }, "key": "value", "value": "101.22" }, { + "disabled": true, + "description": { + "content": "Indicates the status of the invoices to be searched for.", + "type": "text/plain" + }, "key": "status", "value": "Paid" }, { + "disabled": true, + "description": { + "content": "Simplified identification of an invoice. This code is created automatically, always associated with an existing invoice. It consists of an 8-digit random ID (of numbers and letters) and the installment.", + "type": "text/plain" + }, "key": "friendlyId", "value": "u8KFsGDk-1" }, { - "key": "observation", - "value": "Some observation about the invoice" - }, - { - "key": "creditAccountId", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b" - } - ], - "variable": [ - { + "disabled": true, "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Observation notes about the invoice.", "type": "text/plain" }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" + "key": "observation", + "value": "Some observation about the invoice" }, { + "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Credit account identification.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "creditAccountId", + "value": "01bce461-9g03-12ds-8217-b3d39271e15b" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -287,6 +301,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", @@ -308,7 +330,7 @@ { "listen": "test", "script": { - "id": "8af1c83c-f40f-4e32-a39c-499b35fe8f47", + "id": "f6fee054-fc99-424a-8d0f-34ad612bc0e2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/creditcontrol/invoices - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -324,7 +346,7 @@ } }, { - "id": "1b2e6195-df0e-486b-8d04-852a0e0c845d", + "id": "09b6cbcf-0aa8-476d-9f5f-3f2b12eeb1d0", "name": "Retrieve invoice by ID", "request": { "name": "Retrieve invoice by ID", @@ -365,24 +387,6 @@ "type": "any", "value": "A424887D0F2D45028FE5C96E9B0E1A2D-01", "key": "invoiceId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -404,16 +408,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "cce4717f-7a9b-4bb0-8f54-d5b8ea6e8f10", + "id": "afa10665-1ada-4649-b8a4-50810506f08c", "name": "OK", "originalRequest": { "url": { @@ -429,56 +438,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Invoice identification.", - "type": "text/plain" - }, - "type": "any", - "value": "A424887D0F2D45028FE5C96E9B0E1A2D-01", - "key": "invoiceId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -500,6 +462,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", @@ -521,7 +491,7 @@ { "listen": "test", "script": { - "id": "bb7670e8-65d8-4c21-bcff-d97541d5a049", + "id": "9437f0ca-2937-4418-a97d-ae0ad72a0a57", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/creditcontrol/accounts/:creditAccountId/invoices/:invoiceId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -537,7 +507,7 @@ } }, { - "id": "5948b987-18b2-4378-a344-f548a89ab5af", + "id": "d4d0d6eb-1a6c-463a-ae50-df4c5e011d99", "name": "Change invoice", "request": { "name": "Change invoice", @@ -588,24 +558,6 @@ "type": "any", "value": "A424887D0F2D45028FE5C96E9B0E1A2D-01", "key": "invoiceId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -627,6 +579,10 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "PUT", @@ -635,6 +591,7 @@ "raw": "{\n \"status\": \"Paid\",\n \"observation\": \"BF 2023 customer invoice.\",\n \"paymentLink\": \"https://paymentlink.com\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -645,7 +602,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f4a15419-5ad9-4bb4-b918-c9594089a8a8", + "id": "74387063-ef13-417c-9349-e696f1886454", "name": "OK. This endpoint does not return any data in the response body.", "originalRequest": { "url": { @@ -662,60 +619,18 @@ ], "query": [ { - "key": "friendlyId", - "value": "u8KFsGDk-1" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Invoice identification.", - "type": "text/plain" - }, - "type": "any", - "value": "A424887D0F2D45028FE5C96E9B0E1A2D-01", - "key": "invoiceId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "Simplified identification of an invoice. This code is created automatically, always associated with an existing invoice. It consists of an 8-digit random ID (of numbers and letters) and the installment.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "friendlyId", + "value": "u8KFsGDk-1" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -733,6 +648,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", @@ -741,6 +668,7 @@ "raw": "{\n \"status\": \"Paid\",\n \"observation\": \"BF 2023 customer invoice.\",\n \"paymentLink\": \"https://paymentlink.com\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -748,13 +676,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -762,7 +684,7 @@ { "listen": "test", "script": { - "id": "d5010e87-c0f0-4e7e-888c-ceed5910e32f", + "id": "a1eef963-72a3-4c3d-b4ef-5a45bb9dfd91", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/invoices/:invoiceId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -775,7 +697,7 @@ } }, { - "id": "a37ca574-d48b-4929-aacc-e528e29c87fd", + "id": "287f69fc-5dea-4388-bfd4-fe8b4c48e358", "name": "Cancel invoice", "request": { "name": "Cancel invoice", @@ -816,24 +738,6 @@ "type": "any", "value": "A424887D0F2D45028FE5C96E9B0E1A2D-01", "key": "invoiceId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -857,14 +761,15 @@ "value": "application/json" } ], - "method": "DELETE" + "method": "DELETE", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "508c66d9-5dce-4802-bf4f-0f2da8bf4139", + "id": "d4bfd906-0aec-47ce-b81d-167e61dc71a9", "name": "OK. This endpoint does not return any data in the response body.", "originalRequest": { "url": { @@ -880,56 +785,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Invoice identification.", - "type": "text/plain" - }, - "type": "any", - "value": "A424887D0F2D45028FE5C96E9B0E1A2D-01", - "key": "invoiceId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -947,6 +805,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": "DELETE", @@ -954,13 +820,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -968,7 +828,7 @@ { "listen": "test", "script": { - "id": "3cae7447-bfbe-4279-be82-0be46515c33f", + "id": "6abfc6a4-9f0b-452e-911a-fcd5bdd9a390", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/creditcontrol/accounts/:creditAccountId/invoices/:invoiceId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -981,7 +841,7 @@ } }, { - "id": "823ac385-4e80-4043-8a45-71bec530f6a3", + "id": "e7fee1ce-a9af-475f-abeb-98e3da4d002e", "name": "Retrieve invoices by Customer Credit account ID", "request": { "name": "Retrieve invoices by Customer Credit account ID", @@ -1011,24 +871,6 @@ "type": "any", "value": "01bce461-9g03-12ds-8217-b3d39271e15b", "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -1050,16 +892,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "2fb64b58-a706-4f3c-8247-b9f8b51f2a77", + "id": "4dae1538-9cea-401e-aadc-bb7561018f11", "name": "OK", "originalRequest": { "url": { @@ -1074,46 +921,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1135,6 +945,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", @@ -1156,7 +974,7 @@ { "listen": "test", "script": { - "id": "ebbab4fa-1967-4cd7-8db7-f585c500f8c1", + "id": "aac79ddd-bb46-4303-8727-908e8db15c11", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/creditcontrol/accounts/:creditAccountId/invoices - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1172,7 +990,7 @@ } }, { - "id": "63b52ca8-e80e-4a7a-abc5-3005f19b4a30", + "id": "81c11137-3767-4b76-88d0-e3d502f0eff0", "name": "Mark an invoice as paid", "request": { "name": "Mark an invoice as paid", @@ -1214,24 +1032,6 @@ "type": "any", "value": "A424887D0F2D45028FE5C96E9B0E1A2D-01", "key": "invoiceId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -1253,16 +1053,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST" + "method": "POST", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "56cb3bef-61a8-48e9-8ffe-9dacff76ca54", + "id": "06837a4b-ac72-4ecb-9870-c3da31100e7f", "name": "OK", "originalRequest": { "url": { @@ -1279,56 +1084,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Invoice identification.", - "type": "text/plain" - }, - "type": "any", - "value": "A424887D0F2D45028FE5C96E9B0E1A2D-01", - "key": "invoiceId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1350,6 +1108,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", @@ -1371,13 +1137,13 @@ { "listen": "test", "script": { - "id": "b06f0f82-aa90-4f40-b3a6-32005b5307aa", + "id": "c1881865-035a-4f94-8e8b-326acd221714", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/creditcontrol/accounts/:creditAccountId/invoices/:invoiceId/payments - 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/creditcontrol/accounts/:creditAccountId/invoices/:invoiceId/payments - 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/creditcontrol/accounts/:creditAccountId/invoices/:invoiceId/payments - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"required\":[\"id\",\"friendlyId\",\"status\",\"value\",\"accountId\",\"creditValue\",\"createdAt\",\"updatedAt\",\"originalDueDate\",\"dueDate\",\"installment\",\"orderId\",\"transactionId\",\"numberOfInstallments\",\"creditAccountId\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Invoice identification.\"},\"friendlyId\":{\"type\":\"string\",\"description\":\"Simplified identification of an invoice. This code is created automatically, always associated with an existing invoice. It consists of an 8-digit random ID (of numbers and letters) and the installment.\"},\"status\":{\"type\":\"string\",\"description\":\"Invoice status.\",\"enum\":[\"Open\",\"Paid\",\"Cancelled\"]},\"value\":{\"type\":\"number\",\"description\":\"Invoice value.\"},\"accountId\":{\"type\":\"string\",\"description\":\"Account identification. It is the same `checkingAccountId` parameter used in other Customer Credit API endpoints.\"},\"creditValue\":{\"type\":\"number\",\"description\":\"Credit value.\"},\"createdAt\":{\"type\":\"string\",\"description\":\"Invoice creation date.\"},\"updatedAt\":{\"type\":\"string\",\"description\":\"Date of the last update made to the invoice.\"},\"originalDueDate\":{\"type\":\"string\",\"description\":\"Original invoice expiration date.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Modified invoice expiration date.\"},\"installment\":{\"type\":\"number\",\"description\":\"Identification of installment number.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Identification of the order that generated the invoice.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Identification of the invoice transaction. This is the same number as the `id` field, removing the last three characters.\"},\"numberOfInstallments\":{\"type\":\"number\",\"description\":\"Number of installments.\"},\"creditAccountId\":{\"type\":\"string\",\"description\":\"Credit account identification. It is the same `accountId` parameter used in other Customer Credit API endpoints.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/creditcontrol/accounts/:creditAccountId/invoices/:invoiceId/payments - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"required\":[\"id\",\"friendlyId\",\"status\",\"value\",\"accountId\",\"creditValue\",\"createdAt\",\"updatedAt\",\"originalDueDate\",\"dueDate\",\"installment\",\"orderId\",\"transactionId\",\"numberOfInstallments\",\"creditAccountId\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Invoice identification.\"},\"friendlyId\":{\"type\":\"string\",\"description\":\"Simplified identification of an invoice. This code is created automatically, always associated with an existing invoice. It consists of an 8-digit random ID (of numbers and letters) and the installment.\"},\"status\":{\"type\":\"string\",\"description\":\"Invoice status.\",\"enum\":[\"Opened\",\"Paid\",\"Cancelled\"]},\"value\":{\"type\":\"number\",\"description\":\"Invoice value.\"},\"accountId\":{\"type\":\"string\",\"description\":\"Account identification. It is the same `checkingAccountId` parameter used in other Customer Credit API endpoints.\"},\"creditValue\":{\"type\":\"number\",\"description\":\"Credit value.\"},\"createdAt\":{\"type\":\"string\",\"description\":\"Invoice creation date.\"},\"updatedAt\":{\"type\":\"string\",\"description\":\"Date of the last update made to the invoice.\"},\"originalDueDate\":{\"type\":\"string\",\"description\":\"Original invoice expiration date.\"},\"dueDate\":{\"type\":\"string\",\"description\":\"Modified invoice expiration date.\"},\"installment\":{\"type\":\"number\",\"description\":\"Identification of installment number.\"},\"orderId\":{\"type\":\"string\",\"description\":\"Identification of the order that generated the invoice.\"},\"transactionId\":{\"type\":\"string\",\"description\":\"Identification of the invoice transaction. This is the same number as the `id` field, removing the last three characters.\"},\"numberOfInstallments\":{\"type\":\"number\",\"description\":\"Number of installments.\"},\"creditAccountId\":{\"type\":\"string\",\"description\":\"Credit account identification. It is the same `accountId` parameter used in other Customer Credit API endpoints.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/creditcontrol/accounts/:creditAccountId/invoices/:invoiceId/payments - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1387,7 +1153,7 @@ } }, { - "id": "f3eb1747-bdaf-4ff0-8266-edd3f6d4a53b", + "id": "ccea68f9-9c72-45e5-8f3b-c8ab9753c151", "name": "Postpone an invoice", "request": { "name": "Postpone an invoice", @@ -1429,24 +1195,6 @@ "type": "any", "value": "A424887D0F2D45028FE5C96E9B0E1A2D-01", "key": "invoiceId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -1468,6 +1216,10 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "PUT", @@ -1476,6 +1228,7 @@ "raw": "{\n \"dueDays\": 10\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1486,7 +1239,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "7bac68b3-ceca-46e7-8967-e6827c56adbc", + "id": "cd0c9100-79db-4bbb-b5b0-a9cd18a2d203", "name": "OK. This endpoint does not return any data in the response body.", "originalRequest": { "url": { @@ -1503,56 +1256,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Invoice identification.", - "type": "text/plain" - }, - "type": "any", - "value": "A424887D0F2D45028FE5C96E9B0E1A2D-01", - "key": "invoiceId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1570,6 +1276,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", @@ -1578,6 +1296,7 @@ "raw": "{\n \"dueDays\": 10\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1585,13 +1304,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -1599,7 +1312,7 @@ { "listen": "test", "script": { - "id": "5c8aa95f-ef34-4319-9974-6550e64e8c36", + "id": "ac89514f-1a55-441c-a91a-54fea11ac5e1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/invoices/:invoiceId/postponement - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1615,7 +1328,7 @@ "event": [] }, { - "id": "3e2dcac0-6e55-497b-9dc2-9cfa5bd9ffbf", + "id": "7efaa703-e0e6-4aaf-b6fc-ea4413a9f13b", "name": "Account", "description": { "content": "", @@ -1623,7 +1336,7 @@ }, "item": [ { - "id": "17a4bf3d-d467-485c-a13b-c9f6e72edb0a", + "id": "4f1716e5-8796-4b33-b5ab-f10ede1b2f54", "name": "Search all accounts", "request": { "name": "Search all accounts", @@ -1678,26 +1391,7 @@ "value": "test@test.com" } ], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ { @@ -1717,16 +1411,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "228fcc0b-0da3-4b9f-b5bb-cdc44537b790", + "id": "80149a00-ee30-44aa-9440-1f1d27513a15", "name": "OK", "originalRequest": { "url": { @@ -1740,52 +1439,45 @@ ], "query": [ { + "disabled": true, + "description": { + "content": "Indicates the starting position of the credit customer account to be searched in the account list. Example, value `1` indicates that the first account in the list will be returned.", + "type": "text/plain" + }, "key": "from", "value": "1" }, { + "disabled": true, + "description": { + "content": "Indicates the final position of the credit customer account to be searched in the account list. Example, if the value of `from` is equal to `1` and `to` is `40`, information from 40 accounts will be displayed in the response body of the request.", + "type": "text/plain" + }, "key": "to", "value": "40" }, { - "key": "status", - "value": "Paid" - }, - { - "key": "email", - "value": "test@test.com" - } - ], - "variable": [ - { + "disabled": true, "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Indicates the status of the accounts to be searched for.", "type": "text/plain" }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" + "key": "status", + "value": "Paid" }, { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "Indicates the email registered to the account to be searched.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "email", + "value": "test@test.com" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1807,6 +1499,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", @@ -1820,7 +1520,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"39f5f920-149f-11ha-b5b0-2vb896d3212f\",\n \"balance\": 0,\n \"document\": \"4354353453454\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 2000,\n \"updatedAt\": \"2020-01-02T15:26:40.3425717Z\",\n \"createdAt\": \"2019-12-04T14:06:02.7905117Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 2000,\n \"preAuthorizedCredit\": 0,\n \"email\": \"wtest@gmail.com\",\n \"tolerance\": 20,\n \"availableBalance\": 2000\n },\n {\n \"id\": \"71d3f4e5-9164-11ea-918f-93b2a93cb9ba\",\n \"balance\": 0,\n \"document\": \"10120312\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 1,\n \"updatedAt\": \"2020-05-08T19:16:40.7202156Z\",\n \"createdAt\": \"2020-05-08T19:16:40.5951631Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 1,\n \"preAuthorizedCredit\": 0,\n \"email\": \"etest@yahoo.com\",\n \"tolerance\": 0,\n \"availableBalance\": 1\n },\n {\n \"id\": \"111111111_CPF\",\n \"balance\": 0,\n \"document\": \"111111111\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 500,\n \"updatedAt\": \"2020-06-30T18:35:25.5793275Z\",\n \"createdAt\": \"2020-06-30T18:35:25.5011788Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 500,\n \"preAuthorizedCredit\": 0,\n \"email\": \"atest@test.com\",\n \"tolerance\": 1,\n \"availableBalance\": 500\n },\n {\n \"id\": \"2222222222_CPF\",\n \"balance\": 0,\n \"document\": \"2222222222\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 100,\n \"updatedAt\": \"2020-07-07T21:08:07.1796362Z\",\n \"createdAt\": \"2020-06-30T19:57:50.4832597Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 100,\n \"preAuthorizedCredit\": 0,\n \"email\": \"dtest@hotmail.com\",\n \"tolerance\": 0,\n \"availableBalance\": 100\n },\n {\n \"id\": \"91d1f2e5-8169-11ea-728f-53b2a03cb8bc\",\n \"balance\": 0,\n \"document\": \"0000000000\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 5000,\n \"updatedAt\": \"2020-07-28T18:50:46.7315579Z\",\n \"createdAt\": \"2020-06-30T18:49:35.424369Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 5000,\n \"preAuthorizedCredit\": 0,\n \"email\": \"test@test.com\",\n \"tolerance\": 0,\n \"availableBalance\": 5000\n }\n ],\n \"summary\": {\n \"count\": 5\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"39f5f920-149f-11ha-b5b0-2vb896d3212f\",\n \"balance\": 0,\n \"document\": \"4354353453454\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 2000,\n \"updatedAt\": \"2020-01-02T15:26:40.3425717Z\",\n \"createdAt\": \"2019-12-04T14:06:02.7905117Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 2000,\n \"preAuthorizedCredit\": 0,\n \"email\": \"wtest@gmail.com\",\n \"tolerance\": 20,\n \"availableBalance\": 2000\n },\n {\n \"id\": \"71d3f4e5-9164-11ea-918f-93b2a93cb9ba\",\n \"balance\": 0,\n \"document\": \"10120312\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 1,\n \"updatedAt\": \"2020-05-08T19:16:40.7202156Z\",\n \"createdAt\": \"2020-05-08T19:16:40.5951631Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 1,\n \"preAuthorizedCredit\": 0,\n \"email\": \"etest@yahoo.com\",\n \"tolerance\": 0,\n \"availableBalance\": 1\n },\n {\n \"id\": \"111111111_CPF\",\n \"balance\": 0,\n \"document\": \"111111111\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 500,\n \"updatedAt\": \"2020-06-30T18:35:25.5793275Z\",\n \"createdAt\": \"2020-06-30T18:35:25.5011788Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 500,\n \"preAuthorizedCredit\": 0,\n \"email\": \"atest@test.com\",\n \"tolerance\": 1,\n \"availableBalance\": 500\n },\n {\n \"id\": \"2222222222_CPF\",\n \"balance\": 0,\n \"document\": \"2222222222\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 100,\n \"updatedAt\": \"2020-07-07T21:08:07.1796362Z\",\n \"createdAt\": \"2020-06-30T19:57:50.4832597Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 100,\n \"preAuthorizedCredit\": 0,\n \"email\": \"dtest@hotmail.com\",\n \"tolerance\": 0,\n \"availableBalance\": 100\n },\n {\n \"id\": \"91d1f2e5-8169-11ea-728f-53b2a03cb8bc\",\n \"balance\": 0,\n \"document\": \"0000000000\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 5000,\n \"updatedAt\": \"2020-07-28T18:50:46.7315579Z\",\n \"createdAt\": \"2020-06-30T18:49:35.424369Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 5000,\n \"preAuthorizedCredit\": 0,\n \"email\": \"test@test.com\",\n \"tolerance\": 0,\n \"availableBalance\": 5000\n }\n ],\n \"summary\": {\n \"count\": 5\n }\n}", "cookie": [] } ], @@ -1828,7 +1528,7 @@ { "listen": "test", "script": { - "id": "ea86a33f-64cd-48c5-a4ca-a0573c0c4b4e", + "id": "237c0539-c713-4f6f-9833-bb97c0dff15a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/creditcontrol/accounts - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1844,7 +1544,7 @@ } }, { - "id": "b3c802a5-91a5-4bb5-8962-91a72a5224f3", + "id": "159a343a-5867-4bb5-aa94-dfbb6df86d32", "name": "Open an account", "request": { "name": "Open an account", @@ -1862,26 +1562,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ { @@ -1901,6 +1582,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -1909,6 +1598,7 @@ "raw": "{\n \"document\": \"11111111111\",\n \"documentType\": \"CPF\",\n \"email\": \"test@test.com\",\n \"creditLimit\": \"1100\",\n \"description\": \"Not applicable.\",\n \"tolerance\": \"0.2\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1919,7 +1609,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "92d7cbd5-46a0-4d7e-ad1c-2f249ad216bf", + "id": "1c8f6439-8ead-407e-aef2-9f22dd47201c", "name": "OK", "originalRequest": { "url": { @@ -1932,38 +1622,11 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, - { - "disabled": false, + "disabled": false, "description": { "content": "(Required) Type of the content being sent.", "type": "text/plain" @@ -1980,9 +1643,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", @@ -1991,6 +1666,7 @@ "raw": "{\n \"document\": \"11111111111\",\n \"documentType\": \"CPF\",\n \"email\": \"test@test.com\",\n \"creditLimit\": \"1100\",\n \"description\": \"Not applicable.\",\n \"tolerance\": \"0.2\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2004,7 +1680,7 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"11111111111_CPF\",\n \"balance\": 0,\n \"document\": \"11111111111\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 1100,\n \"updatedAt\": \"2023-11-09T13:29:01.2505088Z\",\n \"createdAt\": \"2023-11-09T13:29:01.1567887Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 1100,\n \"preAuthorizedCredit\": 0,\n \"email\": \"ricardo@teste.com.br\",\n \"tolerance\": 0.2,\n \"availableBalance\": 1100\n}", + "body": "{\n \"id\": \"11111111111_CPF\",\n \"balance\": 0,\n \"document\": \"11111111111\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 1100,\n \"updatedAt\": \"2023-11-09T13:29:01.2505088Z\",\n \"createdAt\": \"2023-11-09T13:29:01.1567887Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 1100,\n \"preAuthorizedCredit\": 0,\n \"email\": \"ricardo@teste.com.br\",\n \"tolerance\": 0.2,\n \"availableBalance\": 1100\n}", "cookie": [] } ], @@ -2012,7 +1688,7 @@ { "listen": "test", "script": { - "id": "4a0fc76a-294d-48f5-b618-269d1e23b262", + "id": "2245c64f-1fe0-4777-9aba-4ca2220600f6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/creditcontrol/accounts - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2028,7 +1704,7 @@ } }, { - "id": "8993ab9c-2680-4178-ab79-d59486aad30c", + "id": "750f559d-1dbb-4c83-8a8f-ed640912e1df", "name": "Retrieve an account by ID", "request": { "name": "Retrieve an account by ID", @@ -2057,24 +1733,6 @@ "type": "any", "value": "01bce461-9g03-12ds-8217-b3d39271e15b", "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -2096,16 +1754,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "540d6ca2-6e7b-4870-8b5f-fb11f3bdadbc", + "id": "d3bd7545-fa9d-42fd-8775-9ac751f5ec75", "name": "OK", "originalRequest": { "url": { @@ -2119,46 +1782,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2180,6 +1806,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", @@ -2193,7 +1827,7 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"11111111111_CPF\",\n \"balance\": 0,\n \"document\": \"11111111111\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 1100,\n \"updatedAt\": \"2023-11-09T13:29:01.2505088Z\",\n \"createdAt\": \"2023-11-09T13:29:01.1567887Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 1100,\n \"preAuthorizedCredit\": 0,\n \"email\": \"ricardo@teste.com.br\",\n \"tolerance\": 0.2,\n \"availableBalance\": 1100\n}", + "body": "{\n \"id\": \"11111111111_CPF\",\n \"balance\": 0,\n \"document\": \"11111111111\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 1100,\n \"updatedAt\": \"2023-11-09T13:29:01.2505088Z\",\n \"createdAt\": \"2023-11-09T13:29:01.1567887Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 1100,\n \"preAuthorizedCredit\": 0,\n \"email\": \"ricardo@teste.com.br\",\n \"tolerance\": 0.2,\n \"availableBalance\": 1100\n}", "cookie": [] } ], @@ -2201,7 +1835,7 @@ { "listen": "test", "script": { - "id": "ce1d4869-cf8d-4517-9b01-fd36b0f4d282", + "id": "39b04a01-22ad-4236-88f8-83850bae201a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/creditcontrol/accounts/:creditAccountId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2217,7 +1851,7 @@ } }, { - "id": "015f60bd-768f-4e1e-8d0b-f2d48cdc6775", + "id": "198a8eb5-a6e6-44a5-b0b3-3a3490842cc0", "name": "Close an account", "request": { "name": "Close an account", @@ -2246,24 +1880,6 @@ "type": "any", "value": "01bce461-9g03-12ds-8217-b3d39271e15b", "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -2285,6 +1901,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "DELETE", @@ -2293,6 +1917,7 @@ "raw": "{\n \"document\": \"32222222222\",\n \"documentType\": \"CPF\",\n \"email\": \"email@domain.com\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2303,7 +1928,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "59a6f456-937c-47b1-b0a2-965633f8f5a5", + "id": "6cb5a0e9-4f8c-4907-9f34-b21118c68197", "name": "OK", "originalRequest": { "url": { @@ -2317,46 +1942,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2375,9 +1963,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": "DELETE", @@ -2386,6 +1986,7 @@ "raw": "{\n \"document\": \"32222222222\",\n \"documentType\": \"CPF\",\n \"email\": \"email@domain.com\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2399,7 +2000,7 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"32222222222_CPF\",\n \"balance\": 0,\n \"document\": \"32222222222\",\n \"status\": \"Closed\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 500,\n \"updatedAt\": \"2023-11-09T14:36:09.0201326Z\",\n \"createdAt\": \"2023-11-09T14:31:27.0775349Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 500,\n \"preAuthorizedCredit\": 0,\n \"email\": \"test3@teste.com\",\n \"tolerance\": 1,\n \"availableBalance\": 500\n}", + "body": "{\n \"id\": \"32222222222_CPF\",\n \"balance\": 0,\n \"document\": \"32222222222\",\n \"status\": \"Closed\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 500,\n \"updatedAt\": \"2023-11-09T14:36:09.0201326Z\",\n \"createdAt\": \"2023-11-09T14:31:27.0775349Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 500,\n \"preAuthorizedCredit\": 0,\n \"email\": \"test3@teste.com\",\n \"tolerance\": 1,\n \"availableBalance\": 500\n}", "cookie": [] } ], @@ -2407,13 +2008,13 @@ { "listen": "test", "script": { - "id": "b5a907d4-1c4a-4da6-bfd0-15121c13bec0", + "id": "9250b74a-7af4-48b7-a4b8-c62243849ca1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/creditcontrol/accounts/:creditAccountId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[DELETE]::/api/creditcontrol/accounts/:creditAccountId - 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(\"[DELETE]::/api/creditcontrol/accounts/:creditAccountId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"required\":[\"id\",\"balance\",\"document\",\"status\",\"documentType\",\"creditLimit\",\"updatedAt\",\"createdAt\",\"availableCredit\",\"preAuthorizedCredit\",\"email\",\"tolerance\",\"availableBalance\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Credit customer account identification.\"},\"balance\":{\"type\":\"number\",\"description\":\"Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.\"},\"document\":{\"type\":\"string\",\"description\":\"Account owner document.\"},\"status\":{\"type\":\"string\",\"description\":\"Credit customer account status.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Document type.\",\"enum\":[\"CPF\",\"CNPJ\",\"Other\"]},\"creditLimit\":{\"type\":\"number\",\"description\":\"Maximum credit amount on the account.\"},\"updatedAt\":{\"type\":\"string\",\"description\":\"Date of the last update made to the account.\"},\"createdAt\":{\"type\":\"string\",\"description\":\"Account creation date.\"},\"description\":{\"type\":\"string\",\"description\":\"This field is deprecated.\",\"deprecated\":true},\"availableCredit\":{\"type\":\"number\",\"description\":\"Credit amount available on the account.\"},\"preAuthorizedCredit\":{\"type\":\"number\",\"description\":\"Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.\"},\"email\":{\"type\":\"string\",\"description\":\"Account owner email.\"},\"tolerance\":{\"type\":\"number\",\"description\":\"Account credit tolerance (in decimals). This value represents the increase in credit on an account. For example, a value of `0.30` indicates that the account owner can use up to 30% above the account's original maximum credit amount.\"},\"availableBalance\":{\"type\":\"number\",\"description\":\"Balance available for use on the account.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[DELETE]::/api/creditcontrol/accounts/:creditAccountId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"required\":[\"id\",\"balance\",\"document\",\"status\",\"documentType\",\"creditLimit\",\"updatedAt\",\"createdAt\",\"availableCredit\",\"preAuthorizedCredit\",\"email\",\"tolerance\",\"availableBalance\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Credit customer account identification.\"},\"balance\":{\"type\":\"number\",\"description\":\"Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.\"},\"document\":{\"type\":\"string\",\"description\":\"Account owner document.\"},\"status\":{\"type\":\"string\",\"description\":\"Credit customer account status.\"},\"documentType\":{\"type\":\"string\",\"description\":\"Document type.\",\"enum\":[\"CPF\",\"CNPJ\",\"Other\"]},\"creditLimit\":{\"type\":\"number\",\"description\":\"Maximum credit amount on the account.\"},\"updatedAt\":{\"type\":\"string\",\"description\":\"Date of the last update made to the account.\"},\"createdAt\":{\"type\":\"string\",\"description\":\"Account creation date.\"},\"description\":{\"type\":\"string\",\"description\":\"This field is deprecated.\"},\"availableCredit\":{\"type\":\"number\",\"description\":\"Credit amount available on the account.\"},\"preAuthorizedCredit\":{\"type\":\"number\",\"description\":\"Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.\"},\"email\":{\"type\":\"string\",\"description\":\"Account owner email.\"},\"tolerance\":{\"type\":\"number\",\"description\":\"Account credit tolerance (in decimals). This value represents the increase in credit on an account. For example, a value of `0.30` indicates that the account owner can use up to 30% above the account's original maximum credit amount.\"},\"availableBalance\":{\"type\":\"number\",\"description\":\"Balance available for use on the account.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[DELETE]::/api/creditcontrol/accounts/:creditAccountId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2423,7 +2024,7 @@ } }, { - "id": "96ec93fa-ec1b-4399-ad6e-67ca0e93052b", + "id": "c2e3e450-c635-40fe-9d49-bcff24c14057", "name": "Update account information", "request": { "name": "Update account information", @@ -2452,24 +2053,6 @@ "type": "any", "value": "01bce461-9g03-12ds-8217-b3d39271e15b", "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -2491,6 +2074,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PUT", @@ -2499,6 +2090,7 @@ "raw": "{\n \"email\": \"test1@test.com\",\n \"document\": \"111111111111\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 3400,\n \"tolerance\": 0.25\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2509,7 +2101,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5b5e5353-79b6-48ac-b5ed-20f0d9199864", + "id": "6a45f775-dcdc-4805-b2fb-7f039781a0f4", "name": "OK", "originalRequest": { "url": { @@ -2523,46 +2115,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2581,9 +2136,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": "PUT", @@ -2592,6 +2159,7 @@ "raw": "{\n \"email\": \"test1@test.com\",\n \"document\": \"111111111111\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 3400,\n \"tolerance\": 0.25\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2605,7 +2173,7 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"30c59e60-895f-11ee-917a-1117db360d00\",\n \"balance\": 0,\n \"document\": \"111111111111\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 3400,\n \"updatedAt\": \"2023-11-22T19:06:07.4014762Z\",\n \"createdAt\": \"2023-11-22T17:47:22.9450309Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 3400,\n \"preAuthorizedCredit\": 0,\n \"email\": \"test1@test.com\",\n \"tolerance\": 0.25,\n \"availableBalance\": 3400\n}", + "body": "{\n \"id\": \"30c59e60-895f-11ee-917a-1117db360d00\",\n \"balance\": 0,\n \"document\": \"111111111111\",\n \"status\": \"Open\",\n \"documentType\": \"CPF\",\n \"creditLimit\": 3400,\n \"updatedAt\": \"2023-11-22T19:06:07.4014762Z\",\n \"createdAt\": \"2023-11-22T17:47:22.9450309Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 3400,\n \"preAuthorizedCredit\": 0,\n \"email\": \"test1@test.com\",\n \"tolerance\": 0.25,\n \"availableBalance\": 3400\n}", "cookie": [] } ], @@ -2613,7 +2181,7 @@ { "listen": "test", "script": { - "id": "6bbe8bbb-09e3-42c1-998f-6a9b9ff2ac1b", + "id": "88565a84-9b76-4299-a306-101176fba8b8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2629,7 +2197,7 @@ } }, { - "id": "1b6d90b4-b161-4351-9be6-c9e0d699666e", + "id": "ee9ab9ea-d269-4643-a442-d1463cab195a", "name": "Get account statements", "request": { "name": "Get account statements", @@ -2659,24 +2227,6 @@ "type": "any", "value": "01bce461-9g03-12ds-8217-b3d39271e15b", "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -2698,16 +2248,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "49af9935-ba64-48e5-a203-3bba0b2d716e", + "id": "46bc764d-505e-4527-af82-162f10d09477", "name": "OK", "originalRequest": { "url": { @@ -2722,46 +2277,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2783,6 +2301,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", @@ -2804,7 +2330,7 @@ { "listen": "test", "script": { - "id": "0e32665d-6111-4855-85c2-8d60fe379430", + "id": "d2e5bbf8-b6d3-4d08-b258-885306cfffae", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/creditcontrol/accounts/:creditAccountId/statements - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2820,7 +2346,7 @@ } }, { - "id": "76825d17-9c6b-43c2-9d39-98c53b710906", + "id": "7a696a74-42f6-4700-ae7b-4720d7aa88b6", "name": "Change credit limit of an account", "request": { "name": "Change credit limit of an account", @@ -2850,24 +2376,6 @@ "type": "any", "value": "01bce461-9g03-12ds-8217-b3d39271e15b", "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -2889,6 +2397,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PUT", @@ -2897,6 +2413,7 @@ "raw": "{\n \"value\": 5500\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2907,7 +2424,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5dab49eb-f4a7-490b-900d-da529c01cdeb", + "id": "de4f881b-24d7-4a83-b006-06f7ab5e5461", "name": "OK", "originalRequest": { "url": { @@ -2922,46 +2439,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2980,9 +2460,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": "PUT", @@ -2991,6 +2483,7 @@ "raw": "{\n \"value\": 5500\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3004,7 +2497,7 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"fcba59e0-7f26-11ee-ba3c-511336e1518b\",\n \"balance\": -15,\n \"status\": \"Open\",\n \"creditLimit\": 5500,\n \"updatedAt\": \"2023-11-22T19:35:40.0047136Z\",\n \"createdAt\": \"2023-11-09T17:39:52.151897Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 5500,\n \"preAuthorizedCredit\": 0,\n \"email\": \"test@test.com\",\n \"tolerance\": 0.3,\n \"availableBalance\": 5500\n}", + "body": "{\n \"id\": \"fcba59e0-7f26-11ee-ba3c-511336e1518b\",\n \"balance\": -15,\n \"status\": \"Open\",\n \"creditLimit\": 5500,\n \"updatedAt\": \"2023-11-22T19:35:40.0047136Z\",\n \"createdAt\": \"2023-11-09T17:39:52.151897Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 5500,\n \"preAuthorizedCredit\": 0,\n \"email\": \"test@test.com\",\n \"tolerance\": 0.3,\n \"availableBalance\": 5500\n}", "cookie": [] } ], @@ -3012,7 +2505,7 @@ { "listen": "test", "script": { - "id": "b2f4fb33-dac3-4c25-a488-33b2ae6bb862", + "id": "0e2953c1-f03a-4df0-8777-b7a111857cf1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/creditlimit - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3028,7 +2521,7 @@ } }, { - "id": "3ffd9316-e9bc-43ec-9a59-c46e5ade9863", + "id": "386c7791-ef2d-47d5-b3fe-0b1f6028556d", "name": "Decrease balance of an account", "request": { "name": "Decrease balance of an account", @@ -3069,24 +2562,6 @@ "type": "any", "value": "451924c579a6759cf6e112a", "key": "statementId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -3108,6 +2583,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PUT", @@ -3116,6 +2599,7 @@ "raw": "{\n \"value\": \"-15\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3126,7 +2610,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "52e05f08-3780-4a73-8e30-f13d8aea61ae", + "id": "ffdefdcb-614a-4eaa-b101-ac3d5a66a15c", "name": "OK", "originalRequest": { "url": { @@ -3142,56 +2626,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Statement identification. This is the same `transactionId` value obtained from the [Account statements](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-) endpoint response body.", - "type": "text/plain" - }, - "type": "any", - "value": "451924c579a6759cf6e112a", - "key": "statementId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3210,9 +2647,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": "PUT", @@ -3221,6 +2670,7 @@ "raw": "{\n \"value\": \"-15\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3234,7 +2684,7 @@ "value": "application/json" } ], - "body": "{\n \"value\": \"-15.0\"\n}", + "body": "-15.0", "cookie": [] } ], @@ -3242,7 +2692,7 @@ { "listen": "test", "script": { - "id": "70989e8b-9a2c-496e-beff-c59dac25a417", + "id": "42bb8613-f883-49c9-ba06-3b283aa093de", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/statements/:statementId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3258,7 +2708,7 @@ } }, { - "id": "ed15e6c2-f7c4-477b-a78e-21f8bf2f182f", + "id": "62b6dbed-ee84-4e9c-af1b-f76025e2af20", "name": "Create or update settlement", "request": { "name": "Create or update settlement", @@ -3300,24 +2750,6 @@ "type": "any", "value": "B2E754DCD7304D22866CB6F221CF0FEB", "key": "transactionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -3339,6 +2771,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PUT", @@ -3347,6 +2787,7 @@ "raw": "{\n \"value\": 49.95\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3357,7 +2798,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b5e0b1d3-e13c-4671-ae0b-e1d4c809dd22", + "id": "23f7bcf0-9f32-4f0e-81bd-0d44cd785aff", "name": "OK", "originalRequest": { "url": { @@ -3374,56 +2815,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Pre-authorization identification.", - "type": "text/plain" - }, - "type": "any", - "value": "B2E754DCD7304D22866CB6F221CF0FEB", - "key": "transactionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3442,9 +2836,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": "PUT", @@ -3453,6 +2859,7 @@ "raw": "{\n \"value\": 49.95\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3474,7 +2881,7 @@ { "listen": "test", "script": { - "id": "3752a2c8-d300-471a-828f-57fbe19ddda7", + "id": "cbc493a8-d4a9-4a9e-b056-df280dad758e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/transactions/:transactionId/settlement - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3490,7 +2897,7 @@ } }, { - "id": "d4937a8a-492b-4696-9cf3-713d45ac157a", + "id": "70951a4e-fedb-4466-8ed5-ea918b015edf", "name": "Create a pre-authorization", "request": { "name": "Create a pre-authorization", @@ -3520,24 +2927,6 @@ "type": "any", "value": "01bce461-9g03-12ds-8217-b3d39271e15b", "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -3559,6 +2948,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -3567,6 +2964,7 @@ "raw": "{\n \"value\": 49.7,\n \"settle\": true,\n \"installments\": 1,\n \"expirationDate\": \"2023-11-25\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3577,7 +2975,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7d1d845c-2bc1-4dc6-8c01-a72486b12de4", + "id": "c0070623-4245-49fd-84aa-86ebb45a8d3c", "name": "OK", "originalRequest": { "url": { @@ -3592,46 +2990,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3650,9 +3011,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", @@ -3661,6 +3034,7 @@ "raw": "{\n \"value\": 49.7,\n \"settle\": true,\n \"installments\": 1,\n \"expirationDate\": \"2023-11-25\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3682,7 +3056,7 @@ { "listen": "test", "script": { - "id": "eadc2134-6077-4d31-8742-8e5935adc13d", + "id": "7144b829-f93c-4c3a-acc4-c9800061ed7e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/creditcontrol/accounts/:creditAccountId/transactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3698,7 +3072,7 @@ } }, { - "id": "708dc3f4-c918-4b2e-9be4-c6f49a44907b", + "id": "99d0cfb4-210e-4746-af08-d9475b1f4222", "name": "Update a pre-authorization", "request": { "name": "Update a pre-authorization", @@ -3739,24 +3113,6 @@ "type": "any", "value": "B2E754DCD7304D22866CB6F221CF0FEB", "key": "transactionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -3778,6 +3134,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PUT", @@ -3786,6 +3150,7 @@ "raw": "{\n \"value\": 55,\n \"settle\": true,\n \"installments\": 1\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3796,7 +3161,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6dca7999-4ca9-4d55-8181-e7194b04e32a", + "id": "836b756a-7080-4799-87b5-7b21a85736ac", "name": "OK", "originalRequest": { "url": { @@ -3812,56 +3177,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Pre-authorization identification.", - "type": "text/plain" - }, - "type": "any", - "value": "B2E754DCD7304D22866CB6F221CF0FEB", - "key": "transactionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3880,9 +3198,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": "PUT", @@ -3891,6 +3221,7 @@ "raw": "{\n \"value\": 55,\n \"settle\": true,\n \"installments\": 1\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3912,7 +3243,7 @@ { "listen": "test", "script": { - "id": "aef25c25-4182-4053-b1a8-d4db2aa24106", + "id": "e1024d21-7a02-4730-986d-eae357cad31a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/transactions/:transactionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3928,7 +3259,7 @@ } }, { - "id": "cace4bb2-70c2-4cb6-b9c2-767bb6e2574f", + "id": "cd016899-5fb1-4765-aca0-e321d986070d", "name": "Cancel a pre-authorization", "request": { "name": "Cancel a pre-authorization", @@ -3969,24 +3300,6 @@ "type": "any", "value": "B2E754DCD7304D22866CB6F221CF0FEB", "key": "transactionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -4010,14 +3323,15 @@ "value": "application/json" } ], - "method": "DELETE" + "method": "DELETE", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "05946141-f6cb-46fa-b494-75a772b66cea", + "id": "bb342ae8-af84-4ade-971f-72457ebef751", "name": "OK. This endpoint does not return any data in the response body.", "originalRequest": { "url": { @@ -4033,56 +3347,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Pre-authorization identification.", - "type": "text/plain" - }, - "type": "any", - "value": "B2E754DCD7304D22866CB6F221CF0FEB", - "key": "transactionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4100,6 +3367,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": "DELETE", @@ -4107,13 +3382,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -4121,7 +3390,7 @@ { "listen": "test", "script": { - "id": "06939afe-fe18-4df3-8981-db88667f0e59", + "id": "d081dfa6-ec73-43b1-b400-d6ad295d850c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/creditcontrol/accounts/:creditAccountId/transactions/:transactionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -4134,7 +3403,7 @@ } }, { - "id": "92f7b711-a9e7-41c7-814a-6bb6c3ac3a2c", + "id": "ebf350b1-e907-495c-961d-6cc193087181", "name": "Add an account holder", "request": { "name": "Add an account holder", @@ -4164,24 +3433,6 @@ "type": "any", "value": "01bce461-9g03-12ds-8217-b3d39271e15b", "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -4203,6 +3454,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -4211,6 +3470,7 @@ "raw": "{\n \"claims\": {\n \"email\": \"email@domain.com\"\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4221,7 +3481,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4acdf681-8366-4b61-a56a-3ce1bc9db2b6", + "id": "1fd82ed3-628d-4f97-969b-8c092609ce1d", "name": "OK", "originalRequest": { "url": { @@ -4236,46 +3496,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4294,9 +3517,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", @@ -4305,6 +3540,7 @@ "raw": "{\n \"claims\": {\n \"email\": \"email@domain.com\"\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4326,7 +3562,7 @@ { "listen": "test", "script": { - "id": "cac091cb-21f1-4921-ac63-a31cff454a6e", + "id": "1dd81ebc-8470-452a-8bee-537abbdbd8cd", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/creditcontrol/accounts/:creditAccountId/holders - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4342,7 +3578,7 @@ } }, { - "id": "4d7ca3a7-0238-4fe3-8c5a-8c5d43905562", + "id": "27cab8fb-26a1-4243-95e0-7ad8b68cbdf1", "name": "Delete an account holder", "request": { "name": "Delete an account holder", @@ -4383,24 +3619,6 @@ "type": "any", "value": "524bc947d2b37a1a759ba3d174b58f9b", "key": "holderId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -4422,81 +3640,39 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "DELETE" + "method": "DELETE", + "body": {} }, "response": [ { "_": { - "postman_previewlanguage": "json" - }, - "id": "286e2544-0ce9-4839-bc66-04954c069f8a", - "name": "OK", - "originalRequest": { - "url": { - "path": [ - "api", - "creditcontrol", - "accounts", - ":creditAccountId", - "holders", - ":holderId" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Holder identification.", - "type": "text/plain" - }, - "type": "any", - "value": "524bc947d2b37a1a759ba3d174b58f9b", - "key": "holderId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "postman_previewlanguage": "json" + }, + "id": "1215bd80-ce25-42f2-b6e4-51101466fa25", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "api", + "creditcontrol", + "accounts", + ":creditAccountId", + "holders", + ":holderId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4518,6 +3694,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": "DELETE", @@ -4539,7 +3723,7 @@ { "listen": "test", "script": { - "id": "0c662332-5600-40a6-b228-e41b7ca4dd93", + "id": "c5ee97dd-8b19-4986-882f-5da70faf7048", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/creditcontrol/accounts/:creditAccountId/holders/:holderId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4555,7 +3739,7 @@ } }, { - "id": "872959bd-9199-418d-b1ce-15484896b318", + "id": "8960b464-aa2a-41de-91f0-d99f905e62d9", "name": "Change tolerance of an account", "request": { "name": "Change tolerance of an account", @@ -4585,24 +3769,6 @@ "type": "any", "value": "01bce461-9g03-12ds-8217-b3d39271e15b", "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -4624,6 +3790,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PUT", @@ -4632,6 +3806,7 @@ "raw": "{\n \"value\": 0.3\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4642,7 +3817,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "748cd805-53a1-4d6a-ba9d-38a0676dcf84", + "id": "b6aec99e-225b-4d41-9950-cca064249436", "name": "OK", "originalRequest": { "url": { @@ -4657,46 +3832,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4715,9 +3853,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": "PUT", @@ -4726,6 +3876,7 @@ "raw": "{\n \"value\": 0.3\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4739,7 +3890,7 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"fcba59e0-7f26-11ee-ba3c-511336e1518b\",\n \"balance\": -15,\n \"status\": \"Open\",\n \"creditLimit\": 12500,\n \"updatedAt\": \"2023-11-10T18:49:50.8074778Z\",\n \"createdAt\": \"2023-11-09T17:39:52.151897Z\",\n \"description\": \"This field is deprecated and is returned as an empty string\",\n \"availableCredit\": 12444.99,\n \"preAuthorizedCredit\": 55.92,\n \"email\": \"test@test.com.br\",\n \"tolerance\": 0.3,\n \"availableBalance\": 12444.99\n}", + "body": "{\n \"id\": \"fcba59e0-7f26-11ee-ba3c-511336e1518b\",\n \"balance\": -15,\n \"status\": \"Open\",\n \"creditLimit\": 12500,\n \"updatedAt\": \"2023-11-10T18:49:50.8074778Z\",\n \"createdAt\": \"2023-11-09T17:39:52.151897Z\",\n \"description\": \"This field is deprecated and is returned as an empty string.\",\n \"availableCredit\": 12444.99,\n \"preAuthorizedCredit\": 55.92,\n \"email\": \"test@test.com.br\",\n \"tolerance\": 0.3,\n \"availableBalance\": 12444.99\n}", "cookie": [] } ], @@ -4747,13 +3898,13 @@ { "listen": "test", "script": { - "id": "dd7d50ba-e716-4e71-8032-6c7ea7adc106", + "id": "4df2e700-f921-4bc3-a8db-86eba9934e4b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/tolerance - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/tolerance - 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(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/tolerance - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"required\":[\"id\",\"balance\",\"status\",\"creditLimit\",\"updatedAt\",\"createdAt\",\"availableCredit\",\"preAuthorizedCredit\",\"email\",\"tolerance\",\"availableBalance\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Credit customer account identification.\"},\"balance\":{\"type\":\"number\",\"description\":\"Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.\"},\"status\":{\"type\":\"string\",\"description\":\"Credit customer account status.\"},\"creditLimit\":{\"type\":\"number\",\"description\":\"Maximum credit amount on the account.\"},\"updatedAt\":{\"type\":\"string\",\"description\":\"Date of the last update made to the account.\"},\"createdAt\":{\"type\":\"string\",\"description\":\"Account creation date.\"},\"description\":{\"type\":\"string\",\"description\":\"This field is deprecated.\",\"deprecated\":true},\"availableCredit\":{\"type\":\"number\",\"description\":\"Credit amount available on the account.\"},\"preAuthorizedCredit\":{\"type\":\"number\",\"description\":\"Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.\"},\"email\":{\"type\":\"string\",\"description\":\"Account owner email.\"},\"tolerance\":{\"type\":\"number\",\"description\":\"Account credit tolerance (in decimals). This value represents the increase in credit on an account. For example, a value of `0.30` indicates that the account owner can use up to 30% above the account's original maximum credit amount.\"},\"availableBalance\":{\"type\":\"number\",\"description\":\"Balance available for use on the account.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/tolerance - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"required\":[\"id\",\"balance\",\"status\",\"creditLimit\",\"updatedAt\",\"createdAt\",\"availableCredit\",\"preAuthorizedCredit\",\"email\",\"tolerance\",\"availableBalance\"],\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Credit customer account identification.\"},\"balance\":{\"type\":\"number\",\"description\":\"Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.\"},\"status\":{\"type\":\"string\",\"description\":\"Credit customer account status.\"},\"creditLimit\":{\"type\":\"number\",\"description\":\"Maximum credit amount on the account.\"},\"updatedAt\":{\"type\":\"string\",\"description\":\"Date of the last update made to the account.\"},\"createdAt\":{\"type\":\"string\",\"description\":\"Account creation date.\"},\"description\":{\"type\":\"string\",\"description\":\"This field is deprecated.\"},\"availableCredit\":{\"type\":\"number\",\"description\":\"Credit amount available on the account.\"},\"preAuthorizedCredit\":{\"type\":\"number\",\"description\":\"Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.\"},\"email\":{\"type\":\"string\",\"description\":\"Account owner email.\"},\"tolerance\":{\"type\":\"number\",\"description\":\"Account credit tolerance (in decimals). This value represents the increase in credit on an account. For example, a value of `0.30` indicates that the account owner can use up to 30% above the account's original maximum credit amount.\"},\"availableBalance\":{\"type\":\"number\",\"description\":\"Balance available for use on the account.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[PUT]::/api/creditcontrol/accounts/:creditAccountId/tolerance - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4763,7 +3914,7 @@ } }, { - "id": "e3776eea-9898-47b3-88e4-262d8fdff8a0", + "id": "bc4b3afc-0338-44a0-85f1-1421317ec671", "name": "Partially or totally refund a settlement", "request": { "name": "Partially or totally refund a settlement", @@ -4805,24 +3956,6 @@ "type": "any", "value": "B2E754DCD7304D22866CB6F221CF0FEB", "key": "transactionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" } ] }, @@ -4844,6 +3977,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -4852,6 +3993,7 @@ "raw": "{\n \"value\": 30\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4862,7 +4004,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "bf4c3886-ced2-4fc1-b937-46196f6e1280", + "id": "1e5d0ca1-9121-463a-8ee2-5e7723900a4e", "name": "OK", "originalRequest": { "url": { @@ -4879,56 +4021,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Credit account identification.", - "type": "text/plain" - }, - "type": "any", - "value": "01bce461-9g03-12ds-8217-b3d39271e15b", - "key": "creditAccountId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Pre-authorization identification.", - "type": "text/plain" - }, - "type": "any", - "value": "B2E754DCD7304D22866CB6F221CF0FEB", - "key": "transactionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4947,9 +4042,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", @@ -4958,6 +4065,7 @@ "raw": "{\n \"value\": 30\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4971,7 +4079,7 @@ "value": "application/json" } ], - "body": "{\n \"value\": 30\n}", + "body": "30", "cookie": [] } ], @@ -4979,7 +4087,7 @@ { "listen": "test", "script": { - "id": "c8019cb7-1578-4e7e-bac4-a4db4d2f2cec", + "id": "42350fd9-6b30-483a-9f20-ce83b640ac0a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/creditcontrol/accounts/:creditAccountId/transactions/:transactionId/refunds - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4998,7 +4106,7 @@ "event": [] }, { - "id": "d356d9d9-7ae9-4e69-a13e-2b41a295dd51", + "id": "98dcd879-72ca-4602-8b1d-e88033664d7f", "name": "Store Configuration", "description": { "content": "", @@ -5006,7 +4114,7 @@ }, "item": [ { - "id": "1cb4dbea-d60d-4433-942e-ecb68702d1e9", + "id": "125cef36-0520-4b15-be1d-8659cf3ef325", "name": "Retrieve store configuration", "request": { "name": "Retrieve store configuration", @@ -5024,26 +4132,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ { @@ -5063,16 +4152,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "d4262388-7885-46d0-b7d7-80afce944cea", + "id": "16396363-fc61-4b84-892b-a78d1002a1f1", "name": "OK", "originalRequest": { "url": { @@ -5085,36 +4179,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5136,6 +4203,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", @@ -5157,7 +4232,7 @@ { "listen": "test", "script": { - "id": "85657acf-a7b2-485a-acb2-79e87a37fadd", + "id": "791826a6-d8de-4289-8b1a-48d43f60979a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/creditcontrol/storeconfig - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5173,7 +4248,7 @@ } }, { - "id": "02adc63c-de64-4bd4-8875-bbfa451a2f30", + "id": "568b5c4b-9780-4e6a-893c-cc888b9c71bf", "name": "Create or change store configuration", "request": { "name": "Create or change store configuration", @@ -5191,26 +4266,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ { @@ -5230,6 +4286,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PUT", @@ -5238,6 +4302,7 @@ "raw": "{\n \"dailyInterestRate\": 0.01,\n \"invoicePostponementLimit\": 2,\n \"taxRate\": 0.4,\n \"maxPostponementDays\": 3,\n \"defaultCreditValue\": 150,\n \"maxPreAuthorizationGrowthRate\": 0.1,\n \"myCreditsEnabled\": true,\n \"toleranceEnabled\": true,\n \"automaticCheckingAccountCreationEnabled\": true,\n \"postponementEnabled\": true,\n \"notificationsSettings\": {\n \"daysPrior\": [\n {\n \"days\": 1,\n \"timeOfDay\": \"16:00:00\"\n },\n {\n \"days\": 1,\n \"timeOfDay\": \"16:00:00\"\n }\n ],\n \"daysAfter\": [\n {\n \"days\": 0,\n \"timeOfDay\": \"12:00:00\"\n },\n {\n \"days\": 0,\n \"timeOfDay\": \"12:00:00\"\n }\n ]\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -5248,7 +4313,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a9200a5e-3c06-48b3-8807-82314dac7371", + "id": "4360720c-7e9f-42e5-915b-b27e184ab0cf", "name": "OK", "originalRequest": { "url": { @@ -5261,36 +4326,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "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" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5309,9 +4347,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": "PUT", @@ -5320,6 +4370,7 @@ "raw": "{\n \"dailyInterestRate\": 0.01,\n \"invoicePostponementLimit\": 2,\n \"taxRate\": 0.4,\n \"maxPostponementDays\": 3,\n \"defaultCreditValue\": 150,\n \"maxPreAuthorizationGrowthRate\": 0.1,\n \"myCreditsEnabled\": true,\n \"toleranceEnabled\": true,\n \"automaticCheckingAccountCreationEnabled\": true,\n \"postponementEnabled\": true,\n \"notificationsSettings\": {\n \"daysPrior\": [\n {\n \"days\": 1,\n \"timeOfDay\": \"16:00:00\"\n },\n {\n \"days\": 1,\n \"timeOfDay\": \"16:00:00\"\n }\n ],\n \"daysAfter\": [\n {\n \"days\": 0,\n \"timeOfDay\": \"12:00:00\"\n },\n {\n \"days\": 0,\n \"timeOfDay\": \"12:00:00\"\n }\n ]\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -5341,7 +4392,7 @@ { "listen": "test", "script": { - "id": "c4b240ab-083e-40a1-829b-01aab8e8e3ff", + "id": "ed848cb5-47e8-4cb9-bd03-69333496f7e0", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/creditcontrol/storeconfig - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5383,33 +4434,24 @@ "event": [], "variable": [ { - "description": { - "content": "Name of the VTEX account. Used as part of the URL", - "type": "text/plain" - }, "type": "any", "value": "apiexamples", "key": "accountName" }, { - "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://{{accountName}}.{{environment}}.com.br", "key": "baseUrl" } ], "info": { - "_postman_id": "f81d30fa-cb1e-4092-b37e-4e106131f6b1", + "_postman_id": "ca090c7e-4bcc-4f1e-9d87-87af93b0d62c", "name": "Customer Credit API", - "version": {}, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "With Customer Credit your store can enable **credit payments** through the checkout. You can also control **invoices** and the **credit limits** of your clients.\r\n\r\nLearn more about Customer Credit in our [Help Center article](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/36grlQ69NK6OCuioeekyCs).\r\n\r\nAdditionally, you can find more information on installment payments for an order in the `customData` field found in the [Get Order](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-) endpoint of the Orders API. This includes the number of installments, amount and due dates.\r\n\r\nAll requests need an authorization header. This API allows two kinds of authorization:\r\n\r\n1. Authorization header containing the VTEX ID authentication token.\r\n2. VTEX Appkey and Apptoken headers.\r\n\r\nRead [Authentication](https://developers.vtex.com/docs/guides/authentication) for more information about authentication options.\r\n\r\n## Customer Credit API Index\r\n\r\n### Invoices\r\n\r\n- `GET` [Search all invoices](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/invoices)\r\n- `GET` [Retrieve Invoice by Id](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-)\r\n- `PUT` [Change Invoice](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-)\r\n- `DELETE` [Cancel Invoice](https://developers.vtex.com/docs/api-reference/customer-credit-api#delete-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-)\r\n- `GET` [Retrieve invoices by Customer Credit account ID](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-/invoices)\r\n- `POST` [Mark an invoice as Paid](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-/payments)\r\n- `PUT` [Postpone an invoice](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-/postponement)\r\n\r\n### Account\r\n\r\n- `GET` [Search all accounts](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts)\r\n- `POST` [Open an account](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts)\r\n- `GET` [Retrieve an account by Id](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-)\r\n- `DELETE` [Close an account](https://developers.vtex.com/docs/api-reference/customer-credit-api#delete-/api/creditcontrol/accounts/-creditAccountId-)\r\n- `PUT` [Update account information](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-)\r\n- `GET` [Account statements](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-/statements)\r\n- `PUT` [Change credit limit of an account](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/creditlimit)\r\n- `PUT` [Decrease balance of an account](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/statements/-statementId-)\r\n- `PUT` [Create or Update Settlement](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/transactions/-transactionId-/settlement)\r\n- `POST` [Create a Pre-Authorization](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts/-creditAccountId-/transactions)\r\n- `PUT` [Update a Pre-Authorization](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/transactions/-transactionId-)\r\n- `DELETE` [Cancel a Pre-Authorization](https://developers.vtex.com/docs/api-reference/customer-credit-api#delete-/api/creditcontrol/accounts/-creditAccountId-/transactions/-transactionId-)\r\n- `POST` [Add an account Holder](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts/-creditAccountId-/holders)\r\n- `DELETE` [Delete an account holder](https://developers.vtex.com/docs/api-reference/customer-credit-api#delete-/api/creditcontrol/accounts/-creditAccountId-/holders/-holderId-)\r\n- `PUT` [Change tolerance of an account](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/tolerance)\r\n- `POST` [Partial or Total Refund a Settlement](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts/-creditAccountId-/transactions/-transactionId-/refunds)\r\n\r\n### Store Configuration\r\n\r\n- `GET` [Retrieve store configuration](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/storeconfig)\r\n- `PUT` [Create or change store configuration](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/storeconfig)\r\n", From 429611142349909898e8efbf8942014a21eb3421 Mon Sep 17 00:00:00 2001 From: julia-rabello <77292838+julia-rabello@users.noreply.github.com> Date: Tue, 22 Oct 2024 15:49:53 -0300 Subject: [PATCH 10/16] fix scroll examples - master data api v2 --- VTEX - Master Data API - v2.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Master Data API - v2.json b/VTEX - Master Data API - v2.json index e7d6de7cb..9a64bd034 100644 --- a/VTEX - Master Data API - v2.json +++ b/VTEX - Master Data API - v2.json @@ -479,7 +479,7 @@ "Scroll" ], "summary": "Scroll documents", - "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\nFirst request:\r\n```\r\n/dataentities/Newsletter/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nRetrieve the token in the header `X-VTEX-MD-TOKEN` from the first request's response and use it to make the following requests.\r\n\r\nSubsequent requests:\r\n```\r\n/dataentities/Newsletter/scroll?_token={tokenValue}\r\n```\n\r\n\rLearn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or using the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `429`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/Newsletter\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/Newsletter\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/Newsletter\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `\/dataentities\/Newsletter\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/Newsletter\/search?firstName=*Maria*` |\r\n| **Filter for null values** | `\/dataentities\/Newsletter\/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `\/dataentities\/Newsletter\/search?_where=firstName is not null` |\r\n| **Filter for difference** | `\/dataentities\/Newsletter\/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `\/dataentities\/Newsletter\/search?_where=number>5` |\r\n| **Filter less than** | `\/dataentities\/Newsletter\/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\nFirst request:\r\n```\r\n/dataentities/Newsletter/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nRetrieve the token in the header `X-VTEX-MD-TOKEN` from the first request's response and use it to make the following requests.\r\n\r\nSubsequent requests:\r\n```\r\n/dataentities/Newsletter/scroll?_token={tokenValue}\r\n```\n\r\n\rLearn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or using the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `429`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/Newsletter\/scroll?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/Newsletter\/scroll?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/Newsletter\/scroll?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `\/dataentities\/Newsletter\/scroll?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/Newsletter\/scroll?firstName=*Maria*` |\r\n| **Filter for null values** | `\/dataentities\/Newsletter\/scroll?_where=firstName is null` |\r\n| **Filter for non-null values** | `\/dataentities\/Newsletter\/scroll?_where=firstName is not null` |\r\n| **Filter for difference** | `\/dataentities\/Newsletter\/scroll?_where=firstName<>maria` |\r\n| **Filter greater than** | `\/dataentities\/Newsletter\/scroll?_where=number>5` |\r\n| **Filter less than** | `\/dataentities\/Newsletter\/scroll?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Scrolldocuments", "parameters": [ { From 54df0321b7d2a34f78c0655ac64157194e69938a Mon Sep 17 00:00:00 2001 From: julia-rabello <77292838+julia-rabello@users.noreply.github.com> Date: Tue, 22 Oct 2024 15:49:58 -0300 Subject: [PATCH 11/16] fix scroll examples - master data api v1 --- VTEX - MasterData API - v10.2.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - MasterData API - v10.2.json b/VTEX - MasterData API - v10.2.json index 8b7db70dc..c08cb7135 100644 --- a/VTEX - MasterData API - v10.2.json +++ b/VTEX - MasterData API - v10.2.json @@ -977,7 +977,7 @@ "Scroll" ], "summary": "Scroll documents", - "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nTo inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\r\n\r\n>ℹ️ Learn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/CL\/search?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/CL\/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/CL\/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `\/dataentities\/CL\/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/CL\/search?firstName=*Maria*` |\r\n| **Null values** | `\/dataentities\/CL\/search?_where=firstName is null` |\r\n| **Non-null values** | `\/dataentities\/CL\/search?_where=firstName is not null` |\r\n| **Difference** | `\/dataentities\/CL\/search?_where=firstName<>maria` |\r\n| **Greater than** | `\/dataentities\/CL\/search?_where=number>5` |\r\n| **Less than** | `\/dataentities\/CL\/search?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nTo inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\r\n\r\n>ℹ️ Learn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `\/dataentities\/CL\/scroll?email=my@email.com` |\r\n| **Complex filter** | `\/dataentities\/CL\/scroll?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `\/dataentities\/CL\/scroll?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `\/dataentities\/CL\/scroll?_where=age between 18 AND 25` |\r\n| **Partial filter** | `\/dataentities\/CL\/scroll?firstName=*Maria*` |\r\n| **Null values** | `\/dataentities\/CL\/scroll?_where=firstName is null` |\r\n| **Non-null values** | `\/dataentities\/CL\/scroll?_where=firstName is not null` |\r\n| **Difference** | `\/dataentities\/CL\/scroll?_where=firstName<>maria` |\r\n| **Greater than** | `\/dataentities\/CL\/scroll?_where=number>5` |\r\n| **Less than** | `\/dataentities\/CL\/scroll?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Scrolldocuments", "parameters": [ { From c9b99d45beaa6c2d521ae6f56c95027c5d681811 Mon Sep 17 00:00:00 2001 From: julia-rabello <> Date: Tue, 22 Oct 2024 18:51:42 +0000 Subject: [PATCH 12/16] Update generated files by portman --- .../VTEX - Master Data API - v2.json | 164 +++++++-------- .../VTEX - MasterData API - v10.2.json | 196 +++++++++--------- 2 files changed, 180 insertions(+), 180 deletions(-) diff --git a/PostmanCollections/VTEX - Master Data API - v2.json b/PostmanCollections/VTEX - Master Data API - v2.json index d98a00dc9..751e8ba68 100644 --- a/PostmanCollections/VTEX - Master Data API - v2.json +++ b/PostmanCollections/VTEX - Master Data API - v2.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "09424348-10e2-463c-9020-f339396ea78f" + "postman_id": "cba2ddf5-7ee7-4d31-8cc0-90d19519efd9" }, "item": [ { - "id": "034c3695-395c-4eb5-89d9-77bc5db04de0", + "id": "ea280a04-bde3-4750-917e-f521cb748792", "name": "Documents", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "682a47b5-c14f-453e-811e-d01a314a8be6", + "id": "5f8ad824-0b30-44fa-b3ec-a0740aa975ff", "name": "Create new document", "request": { "name": "Create new document", @@ -99,7 +99,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7894c971-b73e-4ff4-be2c-c1a900a0b306", + "id": "4e891f66-19ff-443b-9a11-4946bee169d1", "name": "OK", "originalRequest": { "url": { @@ -189,7 +189,7 @@ { "listen": "test", "script": { - "id": "18687b33-8933-429b-8e52-e1d5550ff0e6", + "id": "543b7f3a-6ef4-4d44-97c0-c254acf45c57", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/:dataEntityName/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -205,7 +205,7 @@ } }, { - "id": "a98949d0-fc2c-4001-9a50-d86dc2b080dd", + "id": "3d68fe53-539c-48bb-8904-b38a33fa473c", "name": "Create partial document", "request": { "name": "Create partial document", @@ -292,7 +292,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1cc5b7e7-a6b6-4a7b-bf95-c49d5f68811b", + "id": "a0773bf8-646a-4d45-a00f-76256953e82a", "name": "OK", "originalRequest": { "url": { @@ -382,7 +382,7 @@ { "listen": "test", "script": { - "id": "f340c616-7135-471b-a525-c6be9a9de439", + "id": "b84eb4c8-850b-4c17-be9d-bf49d1625dc4", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/:dataEntityName/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -398,7 +398,7 @@ } }, { - "id": "9d6c37ed-fa5c-4963-b8f1-a2d7f0f47186", + "id": "0cebe4e7-ce80-44b4-942c-0a9d03b4545d", "name": "Get document", "request": { "name": "Get document", @@ -492,7 +492,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9d3af8e8-605c-463a-9c78-b295c7d5c0d4", + "id": "1772537c-fd5d-44d7-ba33-431126c26008", "name": "OK", "originalRequest": { "url": { @@ -579,7 +579,7 @@ { "listen": "test", "script": { - "id": "40dab239-e487-4d34-b76b-00691fe01f5e", + "id": "eccc8bc6-2c37-49ed-9849-77effadfe89b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -595,7 +595,7 @@ } }, { - "id": "7917e1f5-048b-446a-b096-210d0eb967d7", + "id": "3f84b762-9417-49d2-85d3-d070dfcf2648", "name": "Create document with custom ID or update entire document", "request": { "name": "Create document with custom ID or update entire document", @@ -693,7 +693,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c14f396d-91cd-49a1-930a-363b923f385e", + "id": "0365ef80-121f-44e5-b04a-869287d18241", "name": "OK. Document changed successfully.", "originalRequest": { "url": { @@ -783,7 +783,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "4f0ef9a2-87f7-440b-aa88-4232404c7c13", + "id": "d1be52e2-954a-46cd-815f-bbace69b9ad2", "name": "Created. Document created successfully.", "originalRequest": { "url": { @@ -863,7 +863,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "da027511-ba7e-43f9-b438-18a50bd25cf5", + "id": "11df2246-0d5c-4eb2-b3ab-e1181f1cccb8", "name": "Not Modified. There were no changes to the document.", "originalRequest": { "url": { @@ -943,7 +943,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "318218c8-f9a5-470f-b7b4-9d1fb35de295", + "id": "6a9ae550-82ba-4f0a-891c-0aa5cbd8d472", "name": "Bad Request. Invalid information in JSON.", "originalRequest": { "url": { @@ -1023,7 +1023,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "03b20124-0ae9-48b1-858d-ac08a6504444", + "id": "372047bd-bb3a-410e-8835-ea101a468e92", "name": "Forbidden. Unauthorized access.", "originalRequest": { "url": { @@ -1104,7 +1104,7 @@ { "listen": "test", "script": { - "id": "09926103-5d3c-4cdb-9172-ba225309f800", + "id": "ea6df5e7-4650-4b9b-87f3-6893dc045518", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:dataEntityName/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1120,7 +1120,7 @@ } }, { - "id": "5206949e-5e0b-425a-a6f2-a082adc36824", + "id": "b0eeb299-4219-43b9-88af-ba9d5ed7e774", "name": "Update partial document", "request": { "name": "Update partial document", @@ -1218,7 +1218,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "bd0f8a6a-e834-48aa-9406-1180e503579e", + "id": "258dc2c0-1e61-492d-9419-7737ad85a20a", "name": "OK", "originalRequest": { "url": { @@ -1309,7 +1309,7 @@ { "listen": "test", "script": { - "id": "7c5ce5b7-ac3a-4106-b946-7499a6fa1716", + "id": "c380fb16-7f2a-4ee0-ba0e-dd02aeb8fcdd", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/:dataEntityName/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1325,7 +1325,7 @@ } }, { - "id": "e43a8443-7d09-4561-bd38-d3fcc575e5bd", + "id": "61339013-86c9-4c65-90bd-25d388576776", "name": "Delete document", "request": { "name": "Delete document", @@ -1396,7 +1396,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "e2a7a3f3-a88f-4883-9742-29f3c85c969e", + "id": "e0634020-22dd-4693-893b-0468b9eb01e7", "name": "OK", "originalRequest": { "url": { @@ -1454,7 +1454,7 @@ { "listen": "test", "script": { - "id": "dec703ee-f84f-4a80-b6fc-b13cb817a63c", + "id": "4b810af3-3651-4693-9c8f-2d26563f31a1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/:dataEntityName/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1470,7 +1470,7 @@ "event": [] }, { - "id": "cc507f76-468a-489a-a0b2-3b0b15558d73", + "id": "bc072060-30b8-40a0-a32f-8fdd98fcf9f1", "name": "Search", "description": { "content": "", @@ -1478,7 +1478,7 @@ }, "item": [ { - "id": "64a41106-7b26-4112-ba6e-bb6d6371750d", + "id": "5d027dd2-2df2-4a38-9a58-d62e0583e05d", "name": "Search documents", "request": { "name": "Search documents", @@ -1588,7 +1588,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c988b5ef-5152-4de6-9312-143a156a1d8f", + "id": "37e3d862-ba76-4459-80df-185a2cbf85c1", "name": "OK", "originalRequest": { "url": { @@ -1709,7 +1709,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "696d9851-0b08-4239-bcde-27d9172a2a52", + "id": "3844373e-014e-4c39-9fdb-146ad8fb3faf", "name": "Bad Request", "originalRequest": { "url": { @@ -1821,7 +1821,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e8ddce18-960a-4fde-87f7-6c8b846624ec", + "id": "d75fec7e-a1d9-42c2-b0f6-ea9990bbe9fd", "name": "Forbidden", "originalRequest": { "url": { @@ -1933,7 +1933,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "216606f7-8ccc-4ff2-a51f-2e7b9c947c31", + "id": "80f06504-1f56-482a-973c-efe69433cd1e", "name": "Service Unavailable. Wildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`.", "originalRequest": { "url": { @@ -2036,7 +2036,7 @@ { "listen": "test", "script": { - "id": "132db4de-c25c-4787-a473-b69959353f79", + "id": "a5a6830b-0aac-46a5-b190-00e94d02f8fa", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2055,7 +2055,7 @@ "event": [] }, { - "id": "2ff13c35-63c2-4c39-bc06-8f2a85f6a0ca", + "id": "efefd5c4-9fe3-4609-9b69-f5e3a38b07b6", "name": "Scroll", "description": { "content": "", @@ -2063,12 +2063,12 @@ }, "item": [ { - "id": "26318c7e-b2ca-4e09-901d-836b5a1a335f", + "id": "2cad7fd0-0f3c-4953-b50c-5940d4f9db02", "name": "Scroll documents", "request": { "name": "Scroll documents", "description": { - "content": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\nFirst request:\r\n```\r\n/dataentities/Newsletter/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nRetrieve the token in the header `X-VTEX-MD-TOKEN` from the first request's response and use it to make the following requests.\r\n\r\nSubsequent requests:\r\n```\r\n/dataentities/Newsletter/scroll?_token={tokenValue}\r\n```\n\r\n\rLearn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or using the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `429`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/Newsletter/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/Newsletter/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/Newsletter/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `/dataentities/Newsletter/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/Newsletter/search?firstName=*Maria*` |\r\n| **Filter for null values** | `/dataentities/Newsletter/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `/dataentities/Newsletter/search?_where=firstName is not null` |\r\n| **Filter for difference** | `/dataentities/Newsletter/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `/dataentities/Newsletter/search?_where=number>5` |\r\n| **Filter less than** | `/dataentities/Newsletter/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\nFirst request:\r\n```\r\n/dataentities/Newsletter/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nRetrieve the token in the header `X-VTEX-MD-TOKEN` from the first request's response and use it to make the following requests.\r\n\r\nSubsequent requests:\r\n```\r\n/dataentities/Newsletter/scroll?_token={tokenValue}\r\n```\n\r\n\rLearn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or using the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `429`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/Newsletter/scroll?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/Newsletter/scroll?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/Newsletter/scroll?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `/dataentities/Newsletter/scroll?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/Newsletter/scroll?firstName=*Maria*` |\r\n| **Filter for null values** | `/dataentities/Newsletter/scroll?_where=firstName is null` |\r\n| **Filter for non-null values** | `/dataentities/Newsletter/scroll?_where=firstName is not null` |\r\n| **Filter for difference** | `/dataentities/Newsletter/scroll?_where=firstName<>maria` |\r\n| **Filter greater than** | `/dataentities/Newsletter/scroll?_where=number>5` |\r\n| **Filter less than** | `/dataentities/Newsletter/scroll?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -2191,7 +2191,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "29217db9-1810-4f85-be0a-0d3692216669", + "id": "b8eb82f8-5ffd-4394-9a40-d6833cf3a102", "name": "OK", "originalRequest": { "url": { @@ -2320,7 +2320,7 @@ "type": "text/plain" }, "key": "X-VTEX-MD-TOKEN", - "value": "esse dolo" + "value": "eu cupidatat" }, { "disabled": true, @@ -2329,7 +2329,7 @@ "type": "text/plain" }, "key": "REST-Content-Total", - "value": "dolore anim dolor" + "value": "esse sint ipsum" } ], "body": "[\n {\n \"id\": \"b818cbda-e489-11e6-94f4-0ac138d2d42e\",\n \"accountId\": \"14af940d-9300-4279-9355-61d44c2ff879\",\n \"accountName\": \"apiexamples\",\n \"dataEntityId\": \"Newsletter\"\n }\n]", @@ -2339,7 +2339,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4b9da702-2038-4e56-8774-27cfe31b9660", + "id": "4660a78b-a9e1-4ef4-af04-c311fb394d7a", "name": "Bad Request", "originalRequest": { "url": { @@ -2469,7 +2469,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "0e47c177-28c6-45e2-8ea7-f97bcd91e33f", + "id": "c527c7ab-33ab-4cea-bb9e-b349542c0267", "name": "Too Many Requests. Wildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`.", "originalRequest": { "url": { @@ -2590,7 +2590,7 @@ { "listen": "test", "script": { - "id": "fa7bc069-2606-4204-9d76-69e0eb2d7615", + "id": "ef7d17d8-57c0-4b81-9434-440a0590c4b8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/scroll - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2609,7 +2609,7 @@ "event": [] }, { - "id": "3eaf9a7f-016a-4d56-8f27-04b11a392ebb", + "id": "4cdbefac-59b4-4ac9-9a8b-2bdde0cb6431", "name": "Schemas", "description": { "content": "", @@ -2617,7 +2617,7 @@ }, "item": [ { - "id": "340b65d6-0e97-4fa7-83e1-3f3ebe536bfa", + "id": "7da96aaa-1683-4870-9f88-516a4b4ded38", "name": "Get schemas", "request": { "name": "Get schemas", @@ -2672,7 +2672,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "35de989b-6dba-4caa-8236-737b20a4088d", + "id": "d2cbd159-8abf-4d53-a1fa-5f028109c845", "name": "OK", "originalRequest": { "url": { @@ -2730,7 +2730,7 @@ { "listen": "test", "script": { - "id": "3dcca71f-df3a-4033-a781-63102fb01724", + "id": "841100be-418e-4ae8-a941-e04b02ab8598", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/schemas - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2746,7 +2746,7 @@ } }, { - "id": "b0b15195-1621-4e9c-b203-bd6601778f89", + "id": "4d5d6e11-2278-4823-bc18-0e82277b5b24", "name": "Get schema by name", "request": { "name": "Get schema by name", @@ -2812,7 +2812,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3c69aee9-abaa-47aa-a57a-528536bf3631", + "id": "d964c28d-e74e-4699-bd4e-8c42f4b14cde", "name": "OK", "originalRequest": { "url": { @@ -2871,7 +2871,7 @@ { "listen": "test", "script": { - "id": "4f8ebdf5-40c7-4a91-a29e-fd16875f4bc8", + "id": "da96f25e-18fa-43f6-b872-5d2f7245982d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/schemas/:schemaName - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2887,7 +2887,7 @@ } }, { - "id": "526ec273-65f3-4e3a-80d3-c8c4780479c7", + "id": "dbe3c775-e1b0-49f2-9398-fdea474ecdfd", "name": "Save schema by name", "request": { "name": "Save schema by name", @@ -2957,7 +2957,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8ebf794b-4ee4-4106-bd66-fba0e35bc6ec", + "id": "b6becaaa-6608-4ba6-9caf-84daa374c391", "name": "OK", "originalRequest": { "url": { @@ -3020,7 +3020,7 @@ { "listen": "test", "script": { - "id": "93859074-80aa-48d9-b060-1647bdb7be3a", + "id": "e2d66007-754d-4593-900d-319c966a3e5b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:dataEntityName/schemas/:schemaName - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3036,7 +3036,7 @@ } }, { - "id": "fed76ec4-83fa-46ee-9187-c37c6637c932", + "id": "c8ef2f3c-107b-43a9-bdeb-777a7310c31c", "name": "Delete schema by name", "request": { "name": "Delete schema by name", @@ -3098,7 +3098,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f4f1b366-0fd1-425b-a5c6-1c229e600672", + "id": "ac783d8d-aa24-4445-b185-4b8c88d9a197", "name": "No Content", "originalRequest": { "url": { @@ -3147,7 +3147,7 @@ { "listen": "test", "script": { - "id": "d3aa6644-c77e-452f-920d-60872de7c7f9", + "id": "e6c3fffd-bf8b-4161-9b97-02d7e1ee1825", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/:dataEntityName/schemas/:schemaName - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3164,7 +3164,7 @@ "event": [] }, { - "id": "d0817205-b633-4815-b402-18c19c24771d", + "id": "aaff6046-f43e-4590-8472-891df19ec6d4", "name": "Indices", "description": { "content": "", @@ -3172,7 +3172,7 @@ }, "item": [ { - "id": "3eb35633-73b8-4940-826f-263bcb6e8e43", + "id": "1d4918d1-5887-4990-8f33-9bacf4db3298", "name": "Get indices", "request": { "name": "Get indices", @@ -3227,7 +3227,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "09d524ac-7274-4de7-94ce-957bbd3887ac", + "id": "8b11264e-9643-462f-987d-11eb3a07f7ea", "name": "OK", "originalRequest": { "url": { @@ -3285,7 +3285,7 @@ { "listen": "test", "script": { - "id": "6b102ab2-e6a5-4895-a7e1-52d811690a89", + "id": "4fe0f862-7584-401f-be46-adae175823fa", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/indices - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3301,7 +3301,7 @@ } }, { - "id": "29e47984-b9df-410b-b8a7-7337e5118d62", + "id": "0e34dca6-d65e-4144-a39b-fee3420aca9a", "name": "Create index", "request": { "name": "Create index", @@ -3356,7 +3356,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d7b735e2-18fb-4a7a-b4aa-79bb8481235a", + "id": "d127d507-b7ac-4659-9646-10e76cad7a9b", "name": "OK", "originalRequest": { "url": { @@ -3408,7 +3408,7 @@ { "listen": "test", "script": { - "id": "af763a95-5b6d-41c5-a8fa-014eaa405889", + "id": "15914652-45cd-409f-a7c5-8a57e8430262", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:dataEntityName/indices - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -3421,7 +3421,7 @@ } }, { - "id": "dfec5fb3-d61f-4ad8-9acf-8e507c1e100e", + "id": "2abd168e-177b-432b-8880-6f5430007c5e", "name": "Get index by name", "request": { "name": "Get index by name", @@ -3487,7 +3487,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "294804b6-29a9-433b-a0b1-cf8a6dcec303", + "id": "a1de981f-c8ba-4c13-b13e-f678afc8566a", "name": "OK", "originalRequest": { "url": { @@ -3546,7 +3546,7 @@ { "listen": "test", "script": { - "id": "bd6cc9dc-8f53-46e5-a06f-e72f15804a3e", + "id": "1ba9c7c2-fdd5-4f50-8500-d10c40813f68", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/indices/:index_name - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3562,7 +3562,7 @@ } }, { - "id": "10a70a54-bf28-44fc-b42c-1dd43e18b0a4", + "id": "9ac822df-bf62-42cb-af6b-50340cf6d143", "name": "Delete index by name", "request": { "name": "Delete index by name", @@ -3624,7 +3624,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "9591fb12-0ee0-4ff7-afa7-50c7c931a38f", + "id": "7a411bb9-970b-4d7c-94b3-cefab9ed32f9", "name": "No Content", "originalRequest": { "url": { @@ -3673,7 +3673,7 @@ { "listen": "test", "script": { - "id": "c61bc917-8ee5-4f48-be3c-b46f5c2c4826", + "id": "1efe8035-c6d4-442a-8417-51bbd2126595", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/:dataEntityName/indices/:index_name - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3690,7 +3690,7 @@ "event": [] }, { - "id": "a4bce0c3-6835-4e52-b306-95f144c72a96", + "id": "2064e552-617b-47de-9006-64c40512db39", "name": "Clusters", "description": { "content": "", @@ -3698,7 +3698,7 @@ }, "item": [ { - "id": "f339f920-0cd9-4921-a296-f93553c99f76", + "id": "c3de8ffb-b72d-49ca-8e53-ebac7bd5afa2", "name": "Validate document by clusters", "request": { "name": "Validate document by clusters", @@ -3778,7 +3778,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c9300d9d-f4ca-4678-9420-52e6fec7dc44", + "id": "2b28a582-c952-4d28-a793-27ba50879652", "name": "OK", "originalRequest": { "url": { @@ -3851,7 +3851,7 @@ { "listen": "test", "script": { - "id": "1c6bc96c-9f4b-4259-916c-1dab1bed5c9d", + "id": "fa62b4f9-26c5-4511-bdf3-ad29fe03d02e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/:dataEntityName/documents/:id/clusters - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3870,7 +3870,7 @@ "event": [] }, { - "id": "42935904-b6a9-4bbd-b89f-387bc6f38d25", + "id": "9f60a1ce-75ca-44e1-87b1-c94e4c172c40", "name": "Versions", "description": { "content": "", @@ -3878,7 +3878,7 @@ }, "item": [ { - "id": "e9d7ae9e-66ea-40a2-b107-5e83354ef2b7", + "id": "491e0c19-91fb-4f2d-9383-3422e2a62f21", "name": "List versions", "request": { "name": "List versions", @@ -3973,7 +3973,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a2d44694-5c51-4e7f-bd96-b25f18fb74ea", + "id": "d157b31f-b539-4bff-a570-bf18aab692e6", "name": "OK", "originalRequest": { "url": { @@ -4061,7 +4061,7 @@ { "listen": "test", "script": { - "id": "1635d500-7340-4f08-b319-b9f14324d247", + "id": "bbf1212d-a6bb-4ee5-876a-00d5852be6a8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/documents/:id/versions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4077,7 +4077,7 @@ } }, { - "id": "258baa55-d27c-45ee-8e62-df8674631f4f", + "id": "2cedcfd3-c0db-4387-a725-233898ea6402", "name": "Get version", "request": { "name": "Get version", @@ -4164,7 +4164,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a0e509e1-f062-4f19-97de-2b971f04570d", + "id": "7762f2c6-89a9-47f7-a50c-1793be8cf559", "name": "OK", "originalRequest": { "url": { @@ -4234,7 +4234,7 @@ { "listen": "test", "script": { - "id": "351c9ffa-8264-4b87-a6e5-18d89fabc3be", + "id": "b08b5f04-afe6-402b-b606-853b5e2be42d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:dataEntityName/documents/:id/versions/:versionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4250,7 +4250,7 @@ } }, { - "id": "78803f20-ce04-4d0b-af6f-d935ad8b8c51", + "id": "adc0de49-779a-44e1-9a1a-0143c2845716", "name": "Update version", "request": { "name": "Update version", @@ -4337,7 +4337,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9932b6de-992b-46bf-a02b-458d8a157ec5", + "id": "3798241c-7abc-4a65-8c13-3b77a1d73dd8", "name": "OK", "originalRequest": { "url": { @@ -4406,7 +4406,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "ceaad177-52f8-4ec2-b711-8374a3b75a26", + "id": "9ddce30e-6006-4b24-b2f5-d05d33f472c6", "name": "Not Modified", "originalRequest": { "url": { @@ -4466,7 +4466,7 @@ { "listen": "test", "script": { - "id": "de29b0dc-3842-41d6-bec4-5b6583d68ffc", + "id": "4bea96b9-3b83-4ceb-81ce-bb02c9d0d8ea", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:dataEntityName/documents/:id/versions/:versionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4524,7 +4524,7 @@ } ], "info": { - "_postman_id": "09424348-10e2-463c-9020-f339396ea78f", + "_postman_id": "cba2ddf5-7ee7-4d31-8cc0-90d19519efd9", "name": "Master Data API - v2", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/PostmanCollections/VTEX - MasterData API - v10.2.json b/PostmanCollections/VTEX - MasterData API - v10.2.json index 95b35c604..c7f61012a 100644 --- a/PostmanCollections/VTEX - MasterData API - v10.2.json +++ b/PostmanCollections/VTEX - MasterData API - v10.2.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "d25941b8-055a-4e9d-b67e-27f7d64f1fcc" + "postman_id": "55a594d8-7077-4f76-8352-85a3166e955c" }, "item": [ { - "id": "1fcc42f9-bc76-459f-aeec-9ee6b66c7a78", + "id": "f2f1407d-5368-4dc2-8907-c16ee6fa0446", "name": "Data Entities", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "9bb9d1b0-281a-447b-9b4b-169ec3da8fb9", + "id": "483d3c51-90bd-405d-be87-1f691eb919f7", "name": "List data entities", "request": { "name": "List data entities", @@ -63,7 +63,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "90ce3153-29b4-41b8-b8b6-2b86e3761e73", + "id": "31724373-a6c0-4a33-98f0-6fc99f59e462", "name": "OK", "originalRequest": { "url": { @@ -127,7 +127,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a71a1edc-e09a-412b-a623-f27e5c436ecc", + "id": "0c8a6635-d683-49f1-9ace-6059b49ab878", "name": "Forbidden", "originalRequest": { "url": { @@ -192,7 +192,7 @@ { "listen": "test", "script": { - "id": "98ad2192-5c87-4e88-a25c-127222d40e78", + "id": "368ce93b-23ba-4fba-9b75-c41038c55a3c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -208,7 +208,7 @@ } }, { - "id": "3076e74d-8322-4ec2-89ea-4a681d638f00", + "id": "28ff8ed8-2a0a-4a79-9f8b-70fbb47fb0e8", "name": "Get data entity structure", "request": { "name": "Get data entity structure", @@ -271,7 +271,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4537222a-a988-42f9-8963-0851c190c2d9", + "id": "01815bc0-a57c-4a5b-b77e-cfdb5d7acf0f", "name": "OK", "originalRequest": { "url": { @@ -336,7 +336,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "207a494d-e82d-4778-bc2e-ed4ac8cf3fb4", + "id": "da4c8988-dcef-4f29-a19d-cdff9c121d7c", "name": "Forbidden", "originalRequest": { "url": { @@ -402,7 +402,7 @@ { "listen": "test", "script": { - "id": "2e8839a2-0b6a-4f68-9a61-0be012715bb8", + "id": "e4f261d6-bdb9-4326-b925-087cddf08ff9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -421,7 +421,7 @@ "event": [] }, { - "id": "546041db-36b4-4272-b2db-43a0e7a3abb7", + "id": "cbabcc1c-36ed-4666-9f25-f8e38804c7e6", "name": "Documents", "description": { "content": "", @@ -429,7 +429,7 @@ }, "item": [ { - "id": "11e9e13d-032d-41e4-aba0-48434dc89334", + "id": "4e8a060e-dc94-42c8-9ea5-df49752bd9a0", "name": "Create new document", "request": { "name": "Create new document", @@ -506,7 +506,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d295b30e-86ec-45b2-92e0-d5c61a2699fb", + "id": "98d362e9-221d-42e9-96ce-b1676c9bfe22", "name": "Created", "originalRequest": { "url": { @@ -586,7 +586,7 @@ { "listen": "test", "script": { - "id": "50259b35-a07e-4fbc-978a-6801e5cd639c", + "id": "ab63468c-b13a-4005-a1ed-3ee0d334f3bd", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/:acronym/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -602,7 +602,7 @@ } }, { - "id": "10bada96-53e0-400f-8622-7b0e54c7e2c2", + "id": "463b22f1-f8ce-487e-a68a-4201f150b142", "name": "Create partial document", "request": { "name": "Create partial document", @@ -679,7 +679,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3c153bb4-7c93-4987-8c17-943e464bf997", + "id": "42a40509-da89-4569-89d2-8f98ee8c5db2", "name": "Created", "originalRequest": { "url": { @@ -759,7 +759,7 @@ { "listen": "test", "script": { - "id": "1f36fb8d-857f-4422-9986-01af7d32f77d", + "id": "de9dba7a-7325-4479-bfd9-ebd52b062a88", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/:acronym/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -775,7 +775,7 @@ } }, { - "id": "d2d7f300-2a04-4009-9f62-e33a64b4c0e1", + "id": "77bdcaf2-0ba4-452c-afac-96847c09641e", "name": "Get document", "request": { "name": "Get document", @@ -860,7 +860,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f3224231-03e6-4b91-b3b7-390f4b588646", + "id": "6ab882c1-c6a6-4131-99e0-09c345f72295", "name": "OK", "originalRequest": { "url": { @@ -937,7 +937,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "db50ec23-35d9-4b06-9907-aca64a15ab57", + "id": "908d0278-8e36-4c44-acb4-d798d0c86131", "name": "Forbidden", "originalRequest": { "url": { @@ -1015,7 +1015,7 @@ { "listen": "test", "script": { - "id": "2e63b95b-f353-415a-afe1-1080cd53d9eb", + "id": "b8f45a4c-f431-4f4b-88be-a0d8ce7afc9c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1031,7 +1031,7 @@ } }, { - "id": "8b03a387-bc0c-4a93-bc21-0624f124ce0c", + "id": "1e71d672-3dfa-4b56-8840-949f28b5b0de", "name": "Create document with custom ID or update entire document", "request": { "name": "Create document with custom ID or update entire document", @@ -1115,7 +1115,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "bbed9855-68e5-404b-8f97-771119cd7114", + "id": "4d30adf0-aeb0-4f2c-92b5-c540da1004a3", "name": "No Content", "originalRequest": { "url": { @@ -1186,7 +1186,7 @@ { "listen": "test", "script": { - "id": "d72997aa-2fbc-43dd-b66e-0a4b5907be27", + "id": "3d8d0509-1ad2-40bb-b80c-81d5294d8935", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:acronym/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1200,7 +1200,7 @@ } }, { - "id": "5c7e8aa8-864c-4e4e-ba2e-e29ff4051ac5", + "id": "bf564853-c32a-4625-b949-80d5711a9f8c", "name": "Update partial document", "request": { "name": "Update partial document", @@ -1284,7 +1284,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "27e04e31-edcf-4ce7-abfb-a374fa1d90ae", + "id": "20b0e74b-0d2d-4ec3-93ed-953917d362da", "name": "No Content", "originalRequest": { "url": { @@ -1355,7 +1355,7 @@ { "listen": "test", "script": { - "id": "8949452b-1b5f-48e4-a46a-aeb790a73fb3", + "id": "562718ae-2cfd-4ed4-89ea-15fa994d7d39", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/:acronym/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1369,7 +1369,7 @@ } }, { - "id": "f66ebde0-7066-4a74-97b2-02ac352bc335", + "id": "7b92b33c-ebd3-4643-8c31-382e1cf1ea37", "name": "Delete document", "request": { "name": "Delete document", @@ -1440,7 +1440,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "39855bd6-ea33-4da6-b76b-c7967da516c6", + "id": "05af68e0-72f0-450e-9283-66dd24522a81", "name": "No Content", "originalRequest": { "url": { @@ -1498,7 +1498,7 @@ { "listen": "test", "script": { - "id": "019d314d-53d4-405e-a73d-ce307b3557d2", + "id": "4501254b-e07e-4557-b1e2-7a75b994e9e1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/:acronym/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1515,7 +1515,7 @@ "event": [] }, { - "id": "8c8ef754-4cc6-417d-9edb-711a9da3acca", + "id": "611d14e1-1fa0-4edb-9381-91e286c39320", "name": "Customer profiles", "description": { "content": "", @@ -1523,7 +1523,7 @@ }, "item": [ { - "id": "1c78568b-34d4-4a1e-baa2-7e77705b6185", + "id": "9b518420-5308-4b9b-b9f3-3013a392704b", "name": "Create new customer profile", "request": { "name": "Create new customer profile", @@ -1599,7 +1599,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "fc814588-0f6c-43f3-bfb2-1bafce610a7f", + "id": "7396b51e-7430-41b7-a45a-66a6d1214cab", "name": "OK", "originalRequest": { "url": { @@ -1689,7 +1689,7 @@ { "listen": "test", "script": { - "id": "5e511635-5fd2-4031-bdbc-03978a95ca6c", + "id": "48fe50e2-8d36-4843-9680-77ba693bf772", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/CL/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1705,7 +1705,7 @@ } }, { - "id": "c096e5ac-5a1c-4c5a-928a-71d7a0e75246", + "id": "7a8251dc-7a5d-40f5-9df2-f312cb973645", "name": "Update customer profile", "request": { "name": "Update customer profile", @@ -1793,7 +1793,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3420e2f8-96fe-4794-8662-0d63a0c041fa", + "id": "524b696c-27b2-4452-ae2c-c09e54b3d83c", "name": "OK", "originalRequest": { "url": { @@ -1884,7 +1884,7 @@ { "listen": "test", "script": { - "id": "0d8c8d0f-2a65-4d84-8c0c-4aedd8bec86e", + "id": "d7949813-0ea6-45c7-b820-fe6f7dbd5a55", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/CL/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1900,7 +1900,7 @@ } }, { - "id": "cbdda61e-dcc4-41d8-82bd-e874dda60a6a", + "id": "172f1556-6a83-4f02-ad73-b84df4aa28f6", "name": "Delete customer profile", "request": { "name": "Delete customer profile", @@ -1961,7 +1961,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "83542bd8-12dc-4bf5-b9d3-66b1bfbe3be3", + "id": "cdb35280-05d7-42ec-ad29-c255ef496eaa", "name": "No Content", "originalRequest": { "url": { @@ -2019,7 +2019,7 @@ { "listen": "test", "script": { - "id": "b4b17331-3f00-4ccc-8a8d-167a9a35478f", + "id": "bae07c0d-b073-4a5a-8a69-34d27f582c45", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/CL/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2036,7 +2036,7 @@ "event": [] }, { - "id": "4a8d2bf9-a585-4c2c-a337-c18dba2bb0de", + "id": "8ca77238-9963-4b01-b937-71738949a1e3", "name": "Addresses", "description": { "content": "", @@ -2044,7 +2044,7 @@ }, "item": [ { - "id": "3381dc2c-9f05-4e83-86ef-8883b8773b43", + "id": "7a2842c2-652f-4a53-9e0e-c6e4b8cc64a8", "name": "Create new customer address", "request": { "name": "Create new customer address", @@ -2120,7 +2120,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "666f6b4f-5917-4c68-a6aa-1480112c6293", + "id": "6ada3a17-09c3-404c-850c-d041d7df2fa3", "name": "OK", "originalRequest": { "url": { @@ -2210,7 +2210,7 @@ { "listen": "test", "script": { - "id": "5fdfe8d8-24b7-4fa9-bb0d-24b7d35dc9da", + "id": "0c92e0f3-8bf9-4828-85b2-31798fda9adc", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/AD/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2226,7 +2226,7 @@ } }, { - "id": "1da011ce-1693-4e60-8d5a-0a1ee5d57fb9", + "id": "d52ba550-dc8d-43e0-b499-fd2d02878df5", "name": "Update customer address", "request": { "name": "Update customer address", @@ -2314,7 +2314,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "de199385-c292-4762-816b-80860d2cdfb0", + "id": "51c248eb-2c93-41f4-9add-881e4d3e08ca", "name": "OK", "originalRequest": { "url": { @@ -2405,7 +2405,7 @@ { "listen": "test", "script": { - "id": "887e112d-95e4-4e75-9bbe-22e3008133e4", + "id": "14fd9743-6fce-409d-8505-2cfe841b84c1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/dataentities/AD/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2421,7 +2421,7 @@ } }, { - "id": "9eef762c-9bc3-4e23-a0c5-d7b44b11d9cc", + "id": "d5aa91f1-fae0-481f-81b9-9fa174709c11", "name": "Delete customer address", "request": { "name": "Delete customer address", @@ -2482,7 +2482,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "03090b01-c675-48e4-b352-a657311e3fab", + "id": "8c09648b-f3d1-4ed1-a434-061d1487c60d", "name": "No Content", "originalRequest": { "url": { @@ -2540,7 +2540,7 @@ { "listen": "test", "script": { - "id": "70c7de8f-4266-41a6-8448-8807dbc8307c", + "id": "66661923-2058-4c2c-8c78-e0c9aaed4f9a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/AD/documents/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2557,7 +2557,7 @@ "event": [] }, { - "id": "cb9952c0-990a-4629-8b91-cd318d3b2298", + "id": "df4f0a7f-e16e-4c79-b0c5-4b4f085cdb44", "name": "Versions", "description": { "content": "", @@ -2565,7 +2565,7 @@ }, "item": [ { - "id": "922c6adf-70f1-4f9b-8c5b-ba103227b30e", + "id": "06283b73-bba7-4452-966a-5ee0ea6bdf53", "name": "List versions", "request": { "name": "List versions", @@ -2641,7 +2641,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a3427759-0929-43eb-9ca3-43f0fb9efbe5", + "id": "dcb0e586-10d9-4a5a-818a-e3ceaa288925", "name": "OK", "originalRequest": { "url": { @@ -2710,7 +2710,7 @@ { "listen": "test", "script": { - "id": "6d7337ca-3d56-4cb3-9326-37fa37fccd9f", + "id": "4e5a10c7-5509-46f9-b37c-e615b8014912", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/documents/:id/versions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2726,7 +2726,7 @@ } }, { - "id": "38f72c95-208f-4892-a33e-aea2d6dca3f0", + "id": "7e0e87a3-4e09-4cb4-8ed4-d70719abb4ba", "name": "Get version", "request": { "name": "Get version", @@ -2813,7 +2813,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "fb039119-f00d-4662-947a-482f17ec33be", + "id": "6c978a63-328a-4370-a963-8f344e3c0570", "name": "OK", "originalRequest": { "url": { @@ -2883,7 +2883,7 @@ { "listen": "test", "script": { - "id": "ed046a9a-8fcc-416a-9d72-972de05fdabd", + "id": "383c37c0-735a-4864-a00f-7f387c577500", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/documents/:id/versions/:versionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2899,7 +2899,7 @@ } }, { - "id": "fe5a607c-dc32-4a17-b67e-b8740730c4a9", + "id": "2cfdb704-6b9e-47b5-b55c-6f4e20aad456", "name": "Update version", "request": { "name": "Update version", @@ -2986,7 +2986,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2e77ae4f-b6c9-4e18-8dcb-e0fbaa4daae7", + "id": "8fa60f48-f5bc-4809-bb26-8e1f37dba031", "name": "OK", "originalRequest": { "url": { @@ -3055,7 +3055,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "28d6eff0-a0f3-4c74-8779-1499fbd1237d", + "id": "07bca68d-8f99-43ef-ad92-624829bd956f", "name": "Not modified. This response happens when the `versionId` informed in the path already corresponds to the current version of the document.", "originalRequest": { "url": { @@ -3115,7 +3115,7 @@ { "listen": "test", "script": { - "id": "2cff82a4-c343-4176-874f-6b48a764a3ad", + "id": "a7b17f75-0d23-4e56-92f4-e04fd67a230e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:acronym/documents/:id/versions/:versionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3134,7 +3134,7 @@ "event": [] }, { - "id": "bdfb7674-a199-464c-9657-0d48aef9f632", + "id": "076f5d02-2b73-4e91-a57c-54fd087f7440", "name": "Scroll", "description": { "content": "", @@ -3142,12 +3142,12 @@ }, "item": [ { - "id": "9e369821-96a1-41e6-82df-53957125f4be", + "id": "c1186f85-3791-40da-8d0d-a19191ea983b", "name": "Scroll documents", "request": { "name": "Scroll documents", "description": { - "content": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nTo inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\r\n\r\n>ℹ️ Learn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/CL/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/CL/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/CL/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `/dataentities/CL/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/CL/search?firstName=*Maria*` |\r\n| **Null values** | `/dataentities/CL/search?_where=firstName is null` |\r\n| **Non-null values** | `/dataentities/CL/search?_where=firstName is not null` |\r\n| **Difference** | `/dataentities/CL/search?_where=firstName<>maria` |\r\n| **Greater than** | `/dataentities/CL/search?_where=number>5` |\r\n| **Less than** | `/dataentities/CL/search?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nTo inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\r\n\r\n>ℹ️ Learn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/CL/scroll?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/CL/scroll?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/CL/scroll?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `/dataentities/CL/scroll?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/CL/scroll?firstName=*Maria*` |\r\n| **Null values** | `/dataentities/CL/scroll?_where=firstName is null` |\r\n| **Non-null values** | `/dataentities/CL/scroll?_where=firstName is not null` |\r\n| **Difference** | `/dataentities/CL/scroll?_where=firstName<>maria` |\r\n| **Greater than** | `/dataentities/CL/scroll?_where=number>5` |\r\n| **Less than** | `/dataentities/CL/scroll?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -3261,7 +3261,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b4de8c36-59ba-42ac-a434-5769c2cab22d", + "id": "39680341-d6f3-45e6-be1d-83568ef5c6fb", "name": "OK", "originalRequest": { "url": { @@ -3381,7 +3381,7 @@ "type": "text/plain" }, "key": "X-VTEX-MD-TOKEN", - "value": "incididunt sunt Exc" + "value": "occaecat dolor" }, { "disabled": true, @@ -3390,7 +3390,7 @@ "type": "text/plain" }, "key": "REST-Content-Total", - "value": "sed " + "value": "cupidatat" } ], "body": "[\n {\n \"id\": \"2f5dde81-1613-11ea-82ee-12f868feb457\",\n \"accountId\": \"a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2\",\n \"accountName\": \"apiexamples\",\n \"dataEntityId\": \"AS\"\n },\n {\n \"id\": \"3b3a3fc9-164b-11ea-82ee-121449f60ecb\",\n \"accountId\": \"a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2\",\n \"accountName\": \"apiexamples\",\n \"dataEntityId\": \"AS\"\n }\n]", @@ -3400,7 +3400,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7885ae6e-5b90-4dab-bb0d-ad1d93e12234", + "id": "52838c59-330e-422b-a354-fb29abb5257a", "name": "Bad Request", "originalRequest": { "url": { @@ -3521,7 +3521,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f25a4634-0a79-4412-9492-84200f0ce804", + "id": "f7ef37db-6b48-405b-ba36-b1f50741c992", "name": "Too Many Requests. Wildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`.", "originalRequest": { "url": { @@ -3633,7 +3633,7 @@ { "listen": "test", "script": { - "id": "a66f0411-8929-4d02-ad0a-9233438d9895", + "id": "b9f1edce-e1bb-49bc-95ea-e31c04bbaa4a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/scroll - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3652,7 +3652,7 @@ "event": [] }, { - "id": "e0b6cae1-0520-460a-bba2-44cde07fb8f2", + "id": "2beac72f-afb8-4705-bb66-ec6cdd1cddfa", "name": "Search", "description": { "content": "", @@ -3660,7 +3660,7 @@ }, "item": [ { - "id": "4c602c51-0167-471b-9695-5873fcd8abeb", + "id": "0f10f108-7cac-439d-b173-055a3e0384d1", "name": "Search documents", "request": { "name": "Search documents", @@ -3761,7 +3761,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ae28e0bc-c3f0-4e66-8d48-a8f487efd6d4", + "id": "e1255902-0eed-46f4-9bbf-ce3a2092a4dc", "name": "OK", "originalRequest": { "url": { @@ -3873,7 +3873,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "34e00371-65ab-4e24-8f0b-009566d3daa3", + "id": "b329db75-4b62-412e-821a-bc195be347d5", "name": "Service Unavailable. Wildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`.", "originalRequest": { "url": { @@ -3967,7 +3967,7 @@ { "listen": "test", "script": { - "id": "c70c2fe1-0795-494a-a8e8-74122e2c6d12", + "id": "d7168425-1356-431c-8abb-7502607a2477", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3986,7 +3986,7 @@ "event": [] }, { - "id": "ce824cf5-8af7-4669-99ac-679759fb653e", + "id": "3b6f8b04-0cba-457f-90cd-1211d5ae178f", "name": "Attachments", "description": { "content": "", @@ -3994,7 +3994,7 @@ }, "item": [ { - "id": "3ee33734-1f7d-489d-9835-7d9f7b5b5992", + "id": "c2e0b19a-b8a8-4144-87dd-01b4b1f3b123", "name": "Retrieve attachment", "request": { "name": "Retrieve attachment", @@ -4092,7 +4092,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "284d03e8-2c2f-47a6-8e73-9be9472f5415", + "id": "2aa028ba-5d49-4835-a620-086f0d24310d", "name": "OK", "originalRequest": { "url": { @@ -4155,7 +4155,7 @@ "value": "image/jpg" } ], - "body": "nulla incididunt deserunt id", + "body": "officia dolore et deserunt", "cookie": [] } ], @@ -4163,7 +4163,7 @@ { "listen": "test", "script": { - "id": "ceb5d327-f752-429f-8dc4-2d2f63c39f7a", + "id": "7905f31b-4413-4e96-9481-81eea56d05ec", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/dataentities/:acronym/documents/:id/:field/attachments/:file-name - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4177,7 +4177,7 @@ } }, { - "id": "658b6ce3-2792-45ab-962c-48367a0fd663", + "id": "ac9815ef-309d-474a-bc60-b9d34537a13d", "name": "Save attachment", "request": { "name": "Save attachment", @@ -4277,7 +4277,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "079c7965-4047-4575-ab7b-135f75daeee4", + "id": "89c37706-13d4-4d12-9ce8-717c650add22", "name": "No Content", "originalRequest": { "url": { @@ -4354,7 +4354,7 @@ { "listen": "test", "script": { - "id": "898a4ff1-e075-49b4-8da6-25f8cca48c51", + "id": "85af025a-920c-4c97-a1ea-0612316fd1bf", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/:acronym/documents/:id/:field/attachments - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4371,7 +4371,7 @@ "event": [] }, { - "id": "e10308da-428a-488f-b3a1-7a54e563c15b", + "id": "ab3092d6-e711-4696-80e0-9317facaf596", "name": "Clusters", "description": { "content": "", @@ -4379,7 +4379,7 @@ }, "item": [ { - "id": "31f02821-eae1-4dfa-9929-9c1a63a72fa5", + "id": "7fe78532-5959-49d5-980a-eeb2a6c706e8", "name": "Validate document by clusters", "request": { "name": "Validate document by clusters", @@ -4464,7 +4464,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "a7e0e65d-c06b-41d2-85c8-17278efa0395", + "id": "34bc5155-a32d-456c-a555-aa8b0b1cfbba", "name": "OK", "originalRequest": { "url": { @@ -4536,7 +4536,7 @@ { "listen": "test", "script": { - "id": "025a839b-a907-4870-91bb-52abf7fe0ec4", + "id": "be836f1a-8c22-4ed2-98e0-e9e94879ab10", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/dataentities/:acronym/documents/:id/clusters - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -4552,7 +4552,7 @@ "event": [] }, { - "id": "5a4c07b1-f7e0-4291-8021-17b5c093e3fc", + "id": "6cda5c7d-df5d-4c3f-a376-d69402f7c4b9", "name": "Score", "description": { "content": "", @@ -4560,7 +4560,7 @@ }, "item": [ { - "id": "ffc35a76-63f6-49be-b994-ca79eab92c97", + "id": "c0e73db5-a52d-47ca-a97f-92a2eb0d2481", "name": "Update scores", "request": { "name": "Update scores", @@ -4645,7 +4645,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "345c9d97-d2b1-44fb-a216-1958c59bac48", + "id": "428956e5-a822-4e1f-8b2f-60e7bb5e2f69", "name": "No Content", "originalRequest": { "url": { @@ -4717,7 +4717,7 @@ { "listen": "test", "script": { - "id": "3d37bc10-ced6-488a-96fe-2f026eb0456a", + "id": "6dac06ee-85d3-4333-bb7e-97e636ed3c06", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:acronym/documents/:id/score - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4731,7 +4731,7 @@ } }, { - "id": "999d2f6d-9ac4-475d-9ec1-e3b3cd0b1710", + "id": "07f076fd-6bee-48b5-bd12-a56873c2b056", "name": "Update score by field", "request": { "name": "Update score by field", @@ -4827,7 +4827,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "63af720e-b94a-4b31-ab6f-d5ed9318b290", + "id": "b89fa36e-ebf0-488f-9edd-2f80e7f3e120", "name": "No Content", "originalRequest": { "url": { @@ -4900,7 +4900,7 @@ { "listen": "test", "script": { - "id": "2318e4f3-2b1a-4c74-8261-cd8313b98efa", + "id": "c45bcbe6-8c8e-4976-9eab-dbe1f014e6fa", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/dataentities/:acronym/documents/:id/score/:field-name - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4914,7 +4914,7 @@ } }, { - "id": "a873647a-3b64-4c5e-a292-dcd202a057d8", + "id": "0ad28d4a-09e1-4558-b3a1-f968e152401f", "name": "Delete score by field", "request": { "name": "Delete score by field", @@ -5010,7 +5010,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "c286f18d-b652-49d0-b70e-dda51fccff28", + "id": "7688bd46-9ab0-4f97-9bcf-4ae9d818c41c", "name": "No Content", "originalRequest": { "url": { @@ -5083,7 +5083,7 @@ { "listen": "test", "script": { - "id": "c92c3331-4497-49a8-8a78-492185fd5082", + "id": "6eadc266-a127-4364-ab1f-d0ac80c962d1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/dataentities/:acronym/documents/:id/score/:field-name - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5139,7 +5139,7 @@ } ], "info": { - "_postman_id": "d25941b8-055a-4e9d-b67e-27f7d64f1fcc", + "_postman_id": "55a594d8-7077-4f76-8352-85a3166e955c", "name": "Master Data API - v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { From 17c1c82157349739168f8733ffdfee4d1057d062 Mon Sep 17 00:00:00 2001 From: Ricardo Correia <87548049+ricardoaerobr@users.noreply.github.com> Date: Thu, 24 Oct 2024 11:22:17 -0300 Subject: [PATCH 13/16] Update List all gift cards endpoint description --- VTEX - Giftcard Provider Protocol.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Giftcard Provider Protocol.json b/VTEX - Giftcard Provider Protocol.json index 772b6d8ff..e15f3a5da 100644 --- a/VTEX - Giftcard Provider Protocol.json +++ b/VTEX - Giftcard Provider Protocol.json @@ -25,7 +25,7 @@ "Gift Cards" ], "summary": "List all gift cards", - "description": "Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", + "description": " Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\nFor scenarios in which there is a gift card with no balance associated with the customer, the payment provider must choose one of the options below to display the information in the response body and implement it on the endpoint:\n\r\n\r1. **Response body returns the complete gift card data mentioning the balance field equal to 0** (`\"balance\": 0`): In this option, whenever the customer has associated a gift card without a balance, they will need to log in to the store to access the balance information.\n\r2. **The response body only returns an empty array** (`[]`): The customer does not need to log in to the store to access balance information when they have a gift card with no balance associated with it.\n\r\n\r> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", "operationId": "ListAllGiftCards", "parameters": [ { From db971172262cfc6e039e0fabee0e9e69b8f04e04 Mon Sep 17 00:00:00 2001 From: ricardoaerobr <> Date: Thu, 24 Oct 2024 14:25:43 +0000 Subject: [PATCH 14/16] Update generated files by portman --- .../VTEX - Giftcard Provider Protocol.json | 76 +++++++++---------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/PostmanCollections/VTEX - Giftcard Provider Protocol.json b/PostmanCollections/VTEX - Giftcard Provider Protocol.json index 3db23d4f4..c3647070d 100644 --- a/PostmanCollections/VTEX - Giftcard Provider Protocol.json +++ b/PostmanCollections/VTEX - Giftcard Provider Protocol.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "e618919e-bebf-446f-a80c-79ea6d4eafce" + "postman_id": "878cf2c5-924c-4225-917d-c8a4a49cc47f" }, "item": [ { - "id": "ef4341d1-91b3-4cc1-af78-6e7e7de85b1f", + "id": "045d328d-9661-4e3b-822b-f3676e99bf82", "name": "Gift Cards", "description": { "content": "", @@ -12,12 +12,12 @@ }, "item": [ { - "id": "fdc78d82-e361-4e01-954d-2c671d4f35ed", + "id": "8f55a60d-43bd-44f6-b612-5a85db837118", "name": "List all gift cards", "request": { "name": "List all gift cards", "description": { - "content": "Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", + "content": " Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\nFor scenarios in which there is a gift card with no balance associated with the customer, the payment provider must choose one of the options below to display the information in the response body and implement it on the endpoint:\n\r\n\r1. **Response body returns the complete gift card data mentioning the balance field equal to 0** (`\"balance\": 0`): In this option, whenever the customer has associated a gift card without a balance, they will need to log in to the store to access the balance information.\n\r2. **The response body only returns an empty array** (`[]`): The customer does not need to log in to the store to access balance information when they have a gift card with no balance associated with it.\n\r\n\r> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", "type": "text/plain" }, "url": { @@ -85,7 +85,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4fde8129-3c53-443b-a73b-eb4d842b666b", + "id": "b6bea191-d7cb-4cc7-908d-009990592fbc", "name": "OK", "originalRequest": { "url": { @@ -172,7 +172,7 @@ { "listen": "test", "script": { - "id": "b8d7ad27-3e6f-4eb4-a5df-4204a55fa849", + "id": "552f0979-8c46-4453-8ce2-33347606c040", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/giftcards/_search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -188,7 +188,7 @@ } }, { - "id": "1db8ceee-fb12-432c-964c-d7986197634f", + "id": "ff2368fe-f0c0-4704-b156-099f55079943", "name": "Get a gift card by ID", "request": { "name": "Get a gift card by ID", @@ -250,7 +250,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f5b6e125-f1a0-4169-b67b-01fbbefe4ca4", + "id": "d7a77904-6c0f-471a-a935-ee8c94061e6f", "name": "OK", "originalRequest": { "url": { @@ -315,7 +315,7 @@ { "listen": "test", "script": { - "id": "0926a62b-691c-493e-a274-21077d24d411", + "id": "43fd065f-bbc6-4a06-ab0a-ca71707e58c6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -331,7 +331,7 @@ } }, { - "id": "0207b12f-399d-42f2-8779-d3640f705e07", + "id": "0acb23a0-7c68-4331-bdf4-ac2b97844b80", "name": "Create a gift card", "request": { "name": "Create a gift card", @@ -394,7 +394,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8b3fa1fd-4448-4bea-8fef-9a7fe21f2c9b", + "id": "1dda3ba9-2d28-4006-9776-8897703d2d26", "name": "OK", "originalRequest": { "url": { @@ -471,7 +471,7 @@ { "listen": "test", "script": { - "id": "2ae05f5c-1ca7-4786-b64e-7d2f26543c87", + "id": "b676c530-a21a-4d56-ad40-7cf02ae52390", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/giftcards - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -490,7 +490,7 @@ "event": [] }, { - "id": "b3878978-6691-4608-b892-05356c7224b3", + "id": "fee4d6f4-de9a-4217-bef6-c81503324da5", "name": "Transactions", "description": { "content": "", @@ -498,7 +498,7 @@ }, "item": [ { - "id": "94dbf175-c074-4612-91ed-7c4d7c6b79d4", + "id": "77182f44-2b0b-4d0b-bffd-f1e00d3a0c05", "name": "Create a gift card transaction", "request": { "name": "Create a gift card transaction", @@ -574,7 +574,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a52340a8-1727-4833-bcc6-f17058482c42", + "id": "8cdf2e88-9538-4caa-a343-ea4eefb9a17b", "name": "OK", "originalRequest": { "url": { @@ -653,7 +653,7 @@ { "listen": "test", "script": { - "id": "e5c01a3d-48e7-4c03-9d78-29cfd50b6837", + "id": "68e9397e-8e46-4558-a91c-aa82bd6e1d77", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/giftcards/:giftCardId/transactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -669,7 +669,7 @@ } }, { - "id": "ede53929-8b01-4b2a-a513-195ee4900b77", + "id": "7cc14fac-43bc-4f77-95cf-15124f292d5f", "name": "List all gift card transactions", "request": { "name": "List all gift card transactions", @@ -732,7 +732,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8b371642-acc2-47d7-9c3a-7424d71350f4", + "id": "2f21bc05-2af8-4354-885a-74f9df2ba00f", "name": "OK", "originalRequest": { "url": { @@ -798,7 +798,7 @@ { "listen": "test", "script": { - "id": "f2bb5c4b-d97c-4491-86f5-9079df822f3d", + "id": "9ba785f2-fb25-4552-8ea6-cf8c627b5c5e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId/transactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -814,7 +814,7 @@ } }, { - "id": "83ba2a1d-bc19-4463-a924-60c1d6772669", + "id": "5d0c6fc0-0c3a-4a79-ac67-3a4c3e63d050", "name": "Get a gift card transaction by ID", "request": { "name": "Get a gift card transaction by ID", @@ -888,7 +888,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4b32d0f3-2f14-458e-a715-b24d513a1d3f", + "id": "5418f77c-dccd-4e4e-b7f3-3f83e8ceb92d", "name": "OK", "originalRequest": { "url": { @@ -955,7 +955,7 @@ { "listen": "test", "script": { - "id": "903b8481-b7ac-4a0f-83f1-5b717cfc8021", + "id": "063084b6-7761-40e4-b2a7-61b4a216ba51", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId/transactions/:transactionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -971,7 +971,7 @@ } }, { - "id": "8d304ccf-195d-4721-9021-b71da616736c", + "id": "80c006cd-12b6-44cc-9c28-af687b13d34a", "name": "Get a gift card transaction authorization", "request": { "name": "Get a gift card transaction authorization", @@ -1046,7 +1046,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d2bf3b8e-ea99-4006-938c-1a8736c438f9", + "id": "b53481a0-1ef2-443f-b732-d84cc3a0e6c4", "name": "OK", "originalRequest": { "url": { @@ -1114,7 +1114,7 @@ { "listen": "test", "script": { - "id": "ea13aaed-8da5-438c-8159-0dbc2cbaf20d", + "id": "53537f3c-274a-4c7e-8b5d-016db983a29a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId/transactions/:transactionId/authorization - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1130,7 +1130,7 @@ } }, { - "id": "a36f02c6-6f8d-4d40-ba2a-94f2e227040c", + "id": "e4685abf-051d-46cc-af3f-330d349a9490", "name": "Cancel a gift card transaction", "request": { "name": "Cancel a gift card transaction", @@ -1218,7 +1218,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "459693ef-6976-44d5-8aee-c13e9ceb06c7", + "id": "e88a2447-0d26-4489-91fc-01e9fa4cf52a", "name": "OK", "originalRequest": { "url": { @@ -1299,7 +1299,7 @@ { "listen": "test", "script": { - "id": "59a2e8e0-e07d-4a02-a412-2a18e3ac97e0", + "id": "c0d5b24b-2c6d-493d-99ba-3d8f5212c738", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/giftcards/:giftCardId/transactions/:transactionId/cancellations - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1315,7 +1315,7 @@ } }, { - "id": "dcc05994-717b-44fb-8e0b-94a4ca94b172", + "id": "b540acee-c30d-435a-a392-03ea6fa1bdd5", "name": "List all gift card transactions cancellations", "request": { "name": "List all gift card transactions cancellations", @@ -1390,7 +1390,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "053480d5-6847-4b87-a817-d64768d388b3", + "id": "97830b7a-6363-4af8-8864-172e10d02843", "name": "OK", "originalRequest": { "url": { @@ -1458,7 +1458,7 @@ { "listen": "test", "script": { - "id": "a6d619eb-ee32-4454-9259-237e19b5aeee", + "id": "884594cf-2d0c-4cd3-a60e-2c62a319c3cc", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId/transactions/:transactionId/cancellations - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1474,7 +1474,7 @@ } }, { - "id": "f5ceea62-2ad8-4a26-8c3c-d4ca2cf09608", + "id": "b31f5a8e-33dc-4340-a687-939a13a6af46", "name": "Settle a gift card transaction", "request": { "name": "Settle a gift card transaction", @@ -1562,7 +1562,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f6153195-45ca-4f00-92e4-f00949b3abaf", + "id": "c781f808-8bc0-4860-8d66-45f6acdbc8c1", "name": "OK", "originalRequest": { "url": { @@ -1643,7 +1643,7 @@ { "listen": "test", "script": { - "id": "9866ad3c-fc48-4e21-a1f5-7ed00f5592aa", + "id": "25bc4463-1758-41d3-978c-1a38466b79ad", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/giftcards/:giftCardId/transactions/:tId/settlements - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1659,7 +1659,7 @@ } }, { - "id": "c91db7d8-5859-4956-84e2-a5d2d0537a25", + "id": "745156bd-0520-4605-abc4-28d5ec0f0562", "name": "List all gift card transactions settlements", "request": { "name": "List all gift card transactions settlements", @@ -1734,7 +1734,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "94e16a9a-e3d1-4c2e-a72f-c45a47222f04", + "id": "98739437-d16b-4c5e-8aef-7aa6fe7d6215", "name": "OK", "originalRequest": { "url": { @@ -1802,7 +1802,7 @@ { "listen": "test", "script": { - "id": "8bb2f30b-9836-4f50-bc92-4fa4cfcc0ad7", + "id": "1e7aa006-5d90-4d28-8b2f-944cfe939069", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId/transactions/:tId/settlements - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1855,7 +1855,7 @@ } ], "info": { - "_postman_id": "e618919e-bebf-446f-a80c-79ea6d4eafce", + "_postman_id": "878cf2c5-924c-4225-917d-c8a4a49cc47f", "name": "Giftcard Provider Protocol", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { From 0c6d75c064d7a615355f4c4763e585097ba68f09 Mon Sep 17 00:00:00 2001 From: Ricardo Correia <87548049+ricardoaerobr@users.noreply.github.com> Date: Thu, 24 Oct 2024 11:30:57 -0300 Subject: [PATCH 15/16] Update VTEX - Giftcard Provider Protocol.json Co-authored-by: Pedro Antunes <47991446+PedroAntunesCosta@users.noreply.github.com> --- VTEX - Giftcard Provider Protocol.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Giftcard Provider Protocol.json b/VTEX - Giftcard Provider Protocol.json index e15f3a5da..f29a9e5b6 100644 --- a/VTEX - Giftcard Provider Protocol.json +++ b/VTEX - Giftcard Provider Protocol.json @@ -25,7 +25,7 @@ "Gift Cards" ], "summary": "List all gift cards", - "description": " Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\nFor scenarios in which there is a gift card with no balance associated with the customer, the payment provider must choose one of the options below to display the information in the response body and implement it on the endpoint:\n\r\n\r1. **Response body returns the complete gift card data mentioning the balance field equal to 0** (`\"balance\": 0`): In this option, whenever the customer has associated a gift card without a balance, they will need to log in to the store to access the balance information.\n\r2. **The response body only returns an empty array** (`[]`): The customer does not need to log in to the store to access balance information when they have a gift card with no balance associated with it.\n\r\n\r> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", + "description": " Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\nFor scenarios in which there is a gift card with no balance associated with the customer, the payment provider must choose one of the options below to display the information in the response body and implement it on the endpoint:\n\r\n\r- Response body returns the complete gift card data mentioning the balance field equal to 0 (`\"balance\": 0`): In this option, whenever the customer has associated a gift card without a balance, they will need to log in to the store to access the balance information.\n\r- The response body only returns an empty array (`[]`): The customer does not need to log in to the store to access balance information when they have a gift card with no balance associated with it.\n\r\n\r> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", "operationId": "ListAllGiftCards", "parameters": [ { From 02ac1d97da042498a044bb5c5f7b983cf70ec418 Mon Sep 17 00:00:00 2001 From: Geise Costa <136460310+geisecosta@users.noreply.github.com> Date: Mon, 28 Oct 2024 15:35:51 -0300 Subject: [PATCH 16/16] EDU-10167 Documented countries field (#1352) --- .../VTEX - Promotions & Taxes API.json | 218 +++++++++--------- VTEX - Promotions & Taxes API.json | 11 + 2 files changed, 120 insertions(+), 109 deletions(-) diff --git a/PostmanCollections/VTEX - Promotions & Taxes API.json b/PostmanCollections/VTEX - Promotions & Taxes API.json index c280933ce..2a65ea197 100644 --- a/PostmanCollections/VTEX - Promotions & Taxes API.json +++ b/PostmanCollections/VTEX - Promotions & Taxes API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "1986f854-2a78-401b-989a-49d587240f5f" + "postman_id": "0e6e94cc-da2b-47cb-9521-e6e36491202a" }, "item": [ { - "id": "cd8a3ddb-c4de-4e30-976c-2ec591de5bd7", + "id": "350a01d2-e3b3-4e94-a9ac-cd602d996046", "name": "Promotions and taxes", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "0efdfb4a-50ca-4038-9e16-9bafb7971906", + "id": "1419dcfe-38f2-42d6-bdda-a928c7baf826", "name": "Get all promotions", "request": { "name": "Get all promotions", @@ -66,7 +66,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c371c7af-045f-4147-ac3b-0e549e2dcff2", + "id": "3d163ab3-7a6f-462c-a512-d3646aee111d", "name": "OK", "originalRequest": { "url": { @@ -134,13 +134,13 @@ { "listen": "test", "script": { - "id": "cd3e9ecb-6e98-43af-aca9-ca8eeb747f5b", + "id": "25b2f7b2-8c3b-47d3-8932-d160715c03c4", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration - 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/rnb/pvt/benefits/calculatorconfiguration - 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/rnb/pvt/benefits/calculatorconfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"limitConfigurationMaxPrice\":{\"type\":\"object\",\"description\":\"Limit configuration max price.\",\"properties\":{\"activesCount\":{\"type\":\"integer\",\"description\":\"Actives count.\"},\"limit\":{\"type\":\"integer\",\"description\":\"Limit.\"}}},\"limitConfiguration\":{\"type\":\"object\",\"description\":\"Limit configuration.\",\"properties\":{\"activesCount\":{\"type\":\"integer\",\"description\":\"Actives count.\"},\"limit\":{\"type\":\"integer\",\"description\":\"Limit.\"}}},\"items\":{\"type\":\"object\",\"description\":\"Object with information about a promotion.\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"lastModifiedUtc\":{\"type\":\"string\",\"description\":\"Date and time when the promotion was last modified (UTC).\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"beginDate\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDate\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the promotion is activated. If set as `false` the promotion is deactivated.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"type\":{\"description\":\"Defines the type of promotion.\",\"type\":\"string\"},\"utmSource\":{\"type\":\"string\",\"description\":\"utmSource code.\"},\"utmCampain\":{\"type\":\"string\",\"description\":\"utmCampaign code.\"},\"utmiCampaign\":{\"type\":\"string\",\"description\":\"utmiCampaign code.\"},\"status\":{\"type\":\"string\",\"description\":\"Status of the promotion.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax applied.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"hasMaxPricePerItem\":{\"description\":\"Defines if there is a maximum price per item.\",\"type\":\"boolean\"},\"isTax\":{\"description\":\"Defines if it is a tax.\",\"type\":\"boolean\"},\"campaigns\":{\"description\":\"Campaign Audiences that activate this promotion.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Campaign Audience.\"}},\"activateGiftsMultiplier\":{\"description\":\"If set as `true`, it activates gifts Multiplier.\",\"type\":\"boolean\"},\"scope\":{\"description\":\"Scope of the promotion.\",\"type\":\"object\",\"properties\":{\"allCatalog\":{\"description\":\"Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).\",\"type\":\"boolean\"},\"skus\":{\"description\":\"Quantity of SKUs which activate or deactivate the promotion.\",\"type\":\"number\"},\"skusAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"products\":{\"description\":\"Quantity of products which activate or deactivate the promotion.\",\"type\":\"number\"},\"productsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"collections\":{\"description\":\"Quantity of collections which activate or deactivate the promotion.\",\"type\":\"number\"},\"collectionsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"categories\":{\"description\":\"Quantity of categories which activate or deactivate the promotion.\",\"type\":\"number\"},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this promotion not to be applied.\"},\"brands\":{\"description\":\"Quantity of brands which activate or deactivate the promotion.\",\"type\":\"number\"},\"brandsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"sellers\":{\"description\":\"Quantity of sellers which activate or deactivate the promotion.\",\"type\":\"number\"},\"sellersAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"}}},\"maxUsage\":{\"type\":\"number\",\"description\":\"Defines how many times the promotion can be used.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this promotion will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this promotion not to be applied.\"}}},\"disabledItems\":{\"type\":\"array\",\"description\":\"Disabled items.\",\"items\":{\"type\":\"string\",\"description\":\"Disabled item.\"}},\"archivedItems\":{\"type\":\"array\",\"description\":\"Archived items.\",\"items\":{\"type\":\"string\",\"description\":\"Archived item.\"}},\"nominalDiscountType\":{\"type\":\"string\",\"description\":\"Controls the behavior of the `NominalDiscount` effect. This field only accepts two string values:\\n\\n -`item`: applies the intended nominal discount on every item present on the cart. \\n\\n -`cart`: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"limitConfigurationMaxPrice\":{\"type\":\"object\",\"description\":\"Limit configuration max price.\",\"properties\":{\"activesCount\":{\"type\":\"integer\",\"description\":\"Actives count.\"},\"limit\":{\"type\":\"integer\",\"description\":\"Limit.\"}}},\"limitConfiguration\":{\"type\":\"object\",\"description\":\"Limit configuration.\",\"properties\":{\"activesCount\":{\"type\":\"integer\",\"description\":\"Actives count.\"},\"limit\":{\"type\":\"integer\",\"description\":\"Limit.\"}}},\"items\":{\"type\":\"array\",\"description\":\"Array with information about a promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about a promotion.\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"lastModifiedUtc\":{\"type\":\"string\",\"description\":\"Date and time when the promotion was last modified (UTC).\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"beginDate\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDate\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the promotion is activated. If set as `false` the promotion is deactivated.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"type\":{\"description\":\"Defines the type of promotion.\",\"type\":\"string\"},\"utmSource\":{\"type\":\"string\",\"description\":\"utmSource code.\"},\"utmCampain\":{\"type\":\"string\",\"description\":\"utmCampaign code.\"},\"utmiCampaign\":{\"type\":\"string\",\"description\":\"utmiCampaign code.\"},\"status\":{\"type\":\"string\",\"description\":\"Status of the promotion.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax applied.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"hasMaxPricePerItem\":{\"description\":\"Defines if there is a maximum price per item.\",\"type\":\"boolean\"},\"isTax\":{\"description\":\"Defines if it is a tax.\",\"type\":\"boolean\"},\"campaigns\":{\"description\":\"Campaign Audiences that activate this promotion.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Campaign Audience.\"}},\"activateGiftsMultiplier\":{\"description\":\"If set as `true`, it activates gifts Multiplier.\",\"type\":\"boolean\"},\"scope\":{\"description\":\"Scope of the promotion.\",\"type\":\"object\",\"properties\":{\"allCatalog\":{\"description\":\"Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).\",\"type\":\"boolean\"},\"skus\":{\"description\":\"Quantity of SKUs which activate or deactivate the promotion.\",\"type\":\"number\"},\"skusAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"products\":{\"description\":\"Quantity of products which activate or deactivate the promotion.\",\"type\":\"number\"},\"productsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"collections\":{\"description\":\"Quantity of collections which activate or deactivate the promotion.\",\"type\":\"number\"},\"collectionsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"categories\":{\"description\":\"Quantity of categories which activate or deactivate the promotion.\",\"type\":\"number\"},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this promotion not to be applied.\"},\"brands\":{\"description\":\"Quantity of brands which activate or deactivate the promotion.\",\"type\":\"number\"},\"brandsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"sellers\":{\"description\":\"Quantity of sellers which activate or deactivate the promotion.\",\"type\":\"number\"},\"sellersAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"}}},\"maxUsage\":{\"type\":\"number\",\"description\":\"Defines how many times the promotion can be used.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this promotion will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this promotion not to be applied.\"}}}},\"disabledItems\":{\"type\":\"array\",\"description\":\"Disabled items.\",\"items\":{\"type\":\"string\",\"description\":\"Disabled item.\"}},\"archivedItems\":{\"type\":\"array\",\"description\":\"Archived items.\",\"items\":{\"type\":\"string\",\"description\":\"Archived item.\"}},\"nominalDiscountType\":{\"type\":\"string\",\"description\":\"Controls the behavior of the `NominalDiscount` effect. This field only accepts two string values:\\n\\n -`item`: applies the intended nominal discount on every item present on the cart. \\n\\n -`cart`: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -150,7 +150,7 @@ } }, { - "id": "f976c00b-84e2-4971-96e5-07e60382e3dc", + "id": "3addddd3-ee81-430f-b7af-99f072925bc1", "name": "Search promotion by name", "request": { "name": "Search promotion by name", @@ -215,7 +215,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f438b939-0209-44f3-9988-2e58a12413ad", + "id": "ceac9212-5314-4ff5-9685-e32f161459ec", "name": "OK", "originalRequest": { "url": { @@ -294,7 +294,7 @@ { "listen": "test", "script": { - "id": "71daf1fb-e481-446c-85d8-7a500c7aeb97", + "id": "0e940643-1c66-41ed-9d50-6b8411a7fbeb", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration/search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -310,7 +310,7 @@ } }, { - "id": "4afbadb6-f1e8-4f9b-a739-93ba74f316c8", + "id": "3f45aac4-952e-4362-8c07-1bd8b97101c6", "name": "Get all taxes", "request": { "name": "Get all taxes", @@ -364,7 +364,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "70017b8a-6e50-4890-baf2-f436e8511271", + "id": "657f578e-f660-49e4-aa0e-670c982b62a3", "name": "OK", "originalRequest": { "url": { @@ -432,7 +432,7 @@ { "listen": "test", "script": { - "id": "f708846d-a0fa-453a-92d3-7bb82f8fd94d", + "id": "8eb7ed9c-0a1b-4ee1-b6d2-b6ab61d0f1b0", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/taxes/calculatorconfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -448,7 +448,7 @@ } }, { - "id": "a059f7e9-dd7a-4e27-a489-7c175c2c95f1", + "id": "91cbe67f-a62c-4953-aacc-7ce67b96209b", "name": "Get promotion or tax by ID", "request": { "name": "Get promotion or tax by ID", @@ -513,7 +513,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "be3a1553-d7e7-4344-8757-45d5a6b4c362", + "id": "77d9e5ed-48c1-416d-92b7-addffbc2d02d", "name": "OK", "originalRequest": { "url": { @@ -573,7 +573,7 @@ "value": "application/json" } ], - "body": "{\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"name\": \"Social Seller Promotion\",\n \"beginDateUtc\": \"2020-05-01T18:47:15.89Z\",\n \"lastModified\": \"2021-02-23T20:58:38.7963862Z\",\n \"daysAgoOfPurchases\": 0,\n \"isActive\": true,\n \"isArchived\": false,\n \"isFeatured\": false,\n \"disableDeal\": false,\n \"activeDaysOfWeek\": [],\n \"offset\": -3,\n \"activateGiftsMultiplier\": false,\n \"newOffset\": -3,\n \"maxPricesPerItems\": [],\n \"cumulative\": false,\n \"discountType\": \"percentual\",\n \"nominalShippingDiscountValue\": 0,\n \"absoluteShippingDiscountValue\": 0,\n \"nominalDiscountValue\": 0,\n \"nominalDiscountType\": \"item\",\n \"maximumUnitPriceDiscount\": 0,\n \"percentualDiscountValue\": 10,\n \"rebatePercentualDiscountValue\": 0,\n \"percentualShippingDiscountValue\": 0,\n \"percentualTax\": 0,\n \"shippingPercentualTax\": 0,\n \"percentualDiscountValueList1\": 0,\n \"percentualDiscountValueList2\": 0,\n \"skusGift\": {\n \"quantitySelectable\": 0\n },\n \"nominalRewardValue\": 0,\n \"percentualRewardValue\": 0,\n \"orderStatusRewardValue\": \"invoiced\",\n \"maxNumberOfAffectedItems\": 0,\n \"maxNumberOfAffectedItemsGroupKey\": \"perCart\",\n \"applyToAllShippings\": false,\n \"nominalTax\": 0,\n \"origin\": \"marketplace\",\n \"idSellerIsInclusive\": false,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [\n {\n \"id\": \"202\",\n \"name\": \"Dinheiro (202)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n }\n ],\n \"stores\": [],\n \"campaigns\": [],\n \"conditionsIds\": [\n \"372e1868-2c0e-4437-be45-1ef8c9cab735\"\n ],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": false,\n \"brands\": [],\n \"brandsAreInclusive\": false,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"utmSource\": \"georgeSource\",\n \"utmCampaign\": \"georgeTest\",\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 0,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [\n {\n \"id\": \"2\",\n \"name\": \"gustaBT\"\n },\n {\n \"id\": \"5\",\n \"name\": \"exampleSKU\"\n }\n ],\n \"listSku2BuyTogether\": [\n {\n \"id\": \"3\",\n \"name\": \"anotherSKU\"\n },\n {\n \"id\": \"6\",\n \"name\": \"exampleProduct\"\n }\n ],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": false,\n \"restrictionsBins\": [],\n \"cardIssuers\": [],\n \"totalValuePurchase\": 0,\n \"slasIds\": [],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": false,\n \"compareListPriceAndPrice\": false,\n \"isDifferentListPriceAndPrice\": false,\n \"zipCodeRanges\": [\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 0,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"merchants\": [],\n \"clusterExpressions\": [],\n \"paymentsRules\": [],\n \"giftListTypes\": [],\n \"productsSpecifications\": [],\n \"affiliates\": [],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"accumulateWithManualPrice\": false,\n \"type\": \"regular\",\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n}", + "body": "{\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"name\": \"Social Seller Promotion\",\n \"beginDateUtc\": \"2020-05-01T18:47:15.89Z\",\n \"lastModified\": \"2021-02-23T20:58:38.7963862Z\",\n \"daysAgoOfPurchases\": 0,\n \"isActive\": true,\n \"isArchived\": false,\n \"isFeatured\": false,\n \"disableDeal\": false,\n \"activeDaysOfWeek\": [],\n \"offset\": -3,\n \"activateGiftsMultiplier\": false,\n \"newOffset\": -3,\n \"maxPricesPerItems\": [],\n \"cumulative\": false,\n \"discountType\": \"percentual\",\n \"nominalShippingDiscountValue\": 0,\n \"absoluteShippingDiscountValue\": 0,\n \"nominalDiscountValue\": 0,\n \"nominalDiscountType\": \"item\",\n \"maximumUnitPriceDiscount\": 0,\n \"percentualDiscountValue\": 10,\n \"rebatePercentualDiscountValue\": 0,\n \"percentualShippingDiscountValue\": 0,\n \"percentualTax\": 0,\n \"shippingPercentualTax\": 0,\n \"percentualDiscountValueList1\": 0,\n \"percentualDiscountValueList2\": 0,\n \"skusGift\": {\n \"quantitySelectable\": 0\n },\n \"nominalRewardValue\": 0,\n \"percentualRewardValue\": 0,\n \"orderStatusRewardValue\": \"invoiced\",\n \"maxNumberOfAffectedItems\": 0,\n \"maxNumberOfAffectedItemsGroupKey\": \"perCart\",\n \"applyToAllShippings\": false,\n \"nominalTax\": 0,\n \"origin\": \"marketplace\",\n \"idSellerIsInclusive\": false,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [\n {\n \"id\": \"202\",\n \"name\": \"Dinheiro (202)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n }\n ],\n \"stores\": [],\n \"campaigns\": [],\n \"conditionsIds\": [\n \"372e1868-2c0e-4437-be45-1ef8c9cab735\"\n ],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": false,\n \"brands\": [],\n \"brandsAreInclusive\": false,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"utmSource\": \"georgeSource\",\n \"utmCampaign\": \"georgeTest\",\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 0,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [\n {\n \"id\": \"2\",\n \"name\": \"gustaBT\"\n },\n {\n \"id\": \"5\",\n \"name\": \"exampleSKU\"\n }\n ],\n \"listSku2BuyTogether\": [\n {\n \"id\": \"3\",\n \"name\": \"anotherSKU\"\n },\n {\n \"id\": \"6\",\n \"name\": \"exampleProduct\"\n }\n ],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": false,\n \"restrictionsBins\": [],\n \"cardIssuers\": [],\n \"totalValuePurchase\": 0,\n \"slasIds\": [],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": false,\n \"compareListPriceAndPrice\": false,\n \"isDifferentListPriceAndPrice\": false,\n \"zipCodeRanges\": [\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n }\n ],\n \"countries\": [\n \"BRA\"\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 0,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"merchants\": [],\n \"clusterExpressions\": [],\n \"paymentsRules\": [],\n \"giftListTypes\": [],\n \"productsSpecifications\": [],\n \"affiliates\": [],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"accumulateWithManualPrice\": false,\n \"type\": \"regular\",\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n}", "cookie": [] } ], @@ -581,13 +581,13 @@ { "listen": "test", "script": { - "id": "2c8a613b-f5fa-481c-9317-c1c83fdc6c9b", + "id": "88cb9012-bfd2-48d3-a6a9-22738a479798", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration - 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/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration - 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/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"lastModified\":{\"type\":\"string\",\"description\":\"When the Promotion was last modified.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is activated. If set as `false` the Promotion is deactivated.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"isFeatured\":{\"type\":\"boolean\",\"description\":\"Insert a flag with the promotion name used in the product's window display and page.\"},\"disableDeal\":{\"type\":\"boolean\",\"description\":\"Indicates whether a deal is disabled (`true`) or not (`false`).\"},\"activeDaysOfWeek\":{\"type\":\"array\",\"description\":\"Defines which days of the week the promotion will applied.\",\"items\":{\"type\":\"string\",\"description\":\"Day of the week that the promotion will be valid.\"}},\"offset\":{\"type\":\"integer\",\"description\":\"Time offset from UTC in seconds.\"},\"activateGiftsMultiplier\":{\"type\":\"boolean\",\"description\":\"If set as `true`, it activates gifts Multiplier.\"},\"newOffset\":{\"type\":\"number\",\"description\":\"New time offset from UTC in seconds.\"},\"maxPricesPerItems\":{\"type\":\"array\",\"description\":\"List of max price per items.\",\"items\":{\"type\":\"string\",\"description\":\"Max price.\"}},\"cumulative\":{\"type\":\"boolean\",\"description\":\"Defines if a promotion can accumulate with another one. (`true`) or not (`false`).\"},\"discountType\":{\"type\":\"string\",\"description\":\"The type of discount that will apply to the promotion.\"},\"nominalShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the shipping value.\"},\"absoluteShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Maximum value for the shipping.\"},\"nominalDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the total purchase value.\"},\"nominalDiscountType\":{\"type\":\"string\",\"description\":\"Controls the behavior of the `NominalDiscount` effect. This field only accepts two string values:\\n\\n -`item`: applies the intended nominal discount on every item present on the cart. \\n\\n -`cart`: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.\"},\"maximumUnitPriceDiscount\":{\"type\":\"number\",\"description\":\"The maximum price for each item of the purchase will be the price set up.\"},\"percentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for total purchase value.\"},\"rebatePercentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentual Shipping Discount Value.\"},\"percentualShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for shipping value.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax over purchase total value.\"},\"shippingPercentualTax\":{\"type\":\"number\",\"description\":\"Shipping Percentual tax over purchase total value.\"},\"percentualDiscountValueList1\":{\"type\":\"number\",\"description\":\"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.\"},\"percentualDiscountValueList2\":{\"type\":\"number\",\"description\":\"Equivalent to `percentualDiscountValueList1`.\"},\"skusGift\":{\"type\":\"object\",\"description\":\"SKU Gift Object. Total discount on the product value set as a gift.\",\"properties\":{\"quantitySelectable\":{\"type\":\"integer\",\"description\":\"Quantity of SKU Gifts.\"},\"gifts\":{\"type\":\"integer\",\"description\":\"Array with SKU Gifts IDs.\"}}},\"nominalRewardValue\":{\"type\":\"number\",\"description\":\"Nominal value for rewards program.\"},\"percentualRewardValue\":{\"type\":\"number\",\"description\":\"Percentage value for rewards program.\"},\"orderStatusRewardValue\":{\"type\":\"string\",\"description\":\"Order status reward value.\"},\"maxNumberOfAffectedItems\":{\"type\":\"integer\",\"description\":\"The maximum number of affected items for a promotion.\"},\"maxNumberOfAffectedItemsGroupKey\":{\"type\":\"string\",\"description\":\"The maximum number of affected items by group key for a promotion.\"},\"applyToAllShippings\":{\"type\":\"boolean\",\"description\":\"Promotion will be applied to all kind of shipping.\"},\"nominalTax\":{\"type\":\"number\",\"description\":\"Nominal tax.\"},\"origin\":{\"type\":\"string\",\"description\":\"Origin of the promotion, `marketplace` or `Fulfillment`. Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information.\"},\"idSeller\":{\"type\":\"string\",\"description\":\"Seller Name.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any seller present on the idSeller field. If set to `false`, sellers present on that field will make this promotion not to be applied.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this promotion will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this promotion not to be applied.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Promotion Marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Promotion Marketing tag.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this promotion will be applied to any marketing tag present on the `marketingTags` field. If set to `true`, marketing tags present on that field will make this promotion not to be applied.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this promotion not to be applied.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this promotion not to be applied.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this promotion not to be applied.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this promotion not to be applied.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"Coupon utmSource code.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"Coupon utmCampaign code.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount** or **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to activate the promotion.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to activate the promotion.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"description\":\"If products that already are receiving a promotion, will be considered on the chart total value. There are three options available: `IncludeMatchedItems`, `ExcludeMatchedItems`, `AllItems`.\"},\"collections\":{\"type\":\"array\",\"description\":\"Array composed by the collections that will be activated or deactivated the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this promotion not to be applied.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the promotion.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the promotion only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of the zip code that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code.\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the promotion will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"multipleSkusCause\":{\"type\":\"object\",\"description\":\"Object composed by a list of SKUs on a Multiple Effects promotion. Structure: `\\\"{SkuId}\\\": {PercentageDiscount}`. There is a limit of 400 SKUs for this type of promotion.\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"SKU ID.\"}},\"paymentsRules\":{\"type\":\"array\",\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the promotion can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"accumulateWithManualPrice\":{\"type\":\"boolean\",\"description\":\"Allows the promotion to apply to products whose prices have been manually added by a call center operator.\"},\"type\":{\"type\":\"string\",\"description\":\"Defines what is the type of the promotion or indicates if it is a tax. Possible values: `regular` ([Regular Promotion](https://help.vtex.com/tutorial/regular-promotion--tutorials_327)), `combo` ([Buy Together](https://help.vtex.com/en/tutorial/buy-together--tutorials_323)), `forThePriceOf` ([More for Less](https://help.vtex.com/en/tutorial/creating-a-more-for-less-promotion--tutorials_325)), `progressive` ([Progressive Discount](https://help.vtex.com/en/tutorial/progressive-discount--tutorials_324)), `buyAndWin` ([Buy One Get One](https://help.vtex.com/en/tutorial/buy-one-get-one--tutorials_322)), `maxPricePerItem` (Deprecated), `campaign` ([Campaign Promotion](https://help.vtex.com/en/tutorial/campaign-promotion--1ChYXhK2AQGuS6wAqS8Ume)), `tax` (Tax), `multipleEffects` (Multiple Effects).\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"lastModified\":{\"type\":\"string\",\"description\":\"When the Promotion was last modified.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is activated. If set as `false` the Promotion is deactivated.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"isFeatured\":{\"type\":\"boolean\",\"description\":\"Insert a flag with the promotion name used in the product's window display and page.\"},\"disableDeal\":{\"type\":\"boolean\",\"description\":\"Indicates whether a deal is disabled (`true`) or not (`false`).\"},\"activeDaysOfWeek\":{\"type\":\"array\",\"description\":\"Defines which days of the week the promotion will applied.\",\"items\":{\"type\":\"string\",\"description\":\"Day of the week that the promotion will be valid.\"}},\"offset\":{\"type\":\"integer\",\"description\":\"Time offset from UTC in seconds.\"},\"activateGiftsMultiplier\":{\"type\":\"boolean\",\"description\":\"If set as `true`, it activates gifts Multiplier.\"},\"newOffset\":{\"type\":\"number\",\"description\":\"New time offset from UTC in seconds.\"},\"maxPricesPerItems\":{\"type\":\"array\",\"description\":\"List of max price per items.\",\"items\":{\"type\":\"string\",\"description\":\"Max price.\"}},\"cumulative\":{\"type\":\"boolean\",\"description\":\"Defines if a promotion can accumulate with another one. (`true`) or not (`false`).\"},\"discountType\":{\"type\":\"string\",\"description\":\"The type of discount that will apply to the promotion.\"},\"nominalShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the shipping value.\"},\"absoluteShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Maximum value for the shipping.\"},\"nominalDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the total purchase value.\"},\"nominalDiscountType\":{\"type\":\"string\",\"description\":\"Controls the behavior of the `NominalDiscount` effect. This field only accepts two string values:\\n\\n -`item`: applies the intended nominal discount on every item present on the cart. \\n\\n -`cart`: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.\"},\"maximumUnitPriceDiscount\":{\"type\":\"number\",\"description\":\"The maximum price for each item of the purchase will be the price set up.\"},\"percentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for total purchase value.\"},\"rebatePercentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentual Shipping Discount Value.\"},\"percentualShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for shipping value.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax over purchase total value.\"},\"shippingPercentualTax\":{\"type\":\"number\",\"description\":\"Shipping Percentual tax over purchase total value.\"},\"percentualDiscountValueList1\":{\"type\":\"number\",\"description\":\"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.\"},\"percentualDiscountValueList2\":{\"type\":\"number\",\"description\":\"Equivalent to `percentualDiscountValueList1`.\"},\"skusGift\":{\"type\":\"object\",\"description\":\"SKU Gift Object. Total discount on the product value set as a gift.\",\"properties\":{\"quantitySelectable\":{\"type\":\"integer\",\"description\":\"Quantity of SKU Gifts.\"},\"gifts\":{\"type\":\"integer\",\"description\":\"Array with SKU Gifts IDs.\"}}},\"nominalRewardValue\":{\"type\":\"number\",\"description\":\"Nominal value for rewards program.\"},\"percentualRewardValue\":{\"type\":\"number\",\"description\":\"Percentage value for rewards program.\"},\"orderStatusRewardValue\":{\"type\":\"string\",\"description\":\"Order status reward value.\"},\"maxNumberOfAffectedItems\":{\"type\":\"integer\",\"description\":\"The maximum number of affected items for a promotion.\"},\"maxNumberOfAffectedItemsGroupKey\":{\"type\":\"string\",\"description\":\"The maximum number of affected items by group key for a promotion.\"},\"applyToAllShippings\":{\"type\":\"boolean\",\"description\":\"Promotion will be applied to all kind of shipping.\"},\"nominalTax\":{\"type\":\"number\",\"description\":\"Nominal tax.\"},\"origin\":{\"type\":\"string\",\"description\":\"Origin of the promotion, `marketplace` or `Fulfillment`. Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information.\"},\"idSeller\":{\"type\":\"string\",\"description\":\"Seller Name.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any seller present on the idSeller field. If set to `false`, sellers present on that field will make this promotion not to be applied.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this promotion will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this promotion not to be applied.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Promotion Marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Promotion Marketing tag.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this promotion will be applied to any marketing tag present on the `marketingTags` field. If set to `true`, marketing tags present on that field will make this promotion not to be applied.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this promotion not to be applied.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this promotion not to be applied.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this promotion not to be applied.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"required\":[\"id\",\"name\"],\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\",\"nullable\":false},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\",\"nullable\":false}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this promotion not to be applied.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"Coupon utmSource code.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"Coupon utmCampaign code.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount** or **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to activate the promotion.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to activate the promotion.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"description\":\"If products that already are receiving a promotion, will be considered on the chart total value. There are three options available: `IncludeMatchedItems`, `ExcludeMatchedItems`, `AllItems`.\"},\"collections\":{\"type\":\"array\",\"description\":\"Array composed by the collections that will be activated or deactivated the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this promotion not to be applied.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the promotion.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the promotion only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of the zip code that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code.\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"countries\":{\"type\":\"array\",\"description\":\"List of countries that are activated for this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Country abbreviation.\"}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the promotion will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"multipleSkusCause\":{\"type\":\"object\",\"description\":\"Object composed by a list of SKUs on a Multiple Effects promotion. Structure: `\\\"{SkuId}\\\": {PercentageDiscount}`. There is a limit of 400 SKUs for this type of promotion.\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"SKU ID.\"}},\"paymentsRules\":{\"type\":\"array\",\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the promotion can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"accumulateWithManualPrice\":{\"type\":\"boolean\",\"description\":\"Allows the promotion to apply to products whose prices have been manually added by a call center operator.\"},\"type\":{\"type\":\"string\",\"description\":\"Defines what is the type of the promotion or indicates if it is a tax. Possible values: `regular` ([Regular Promotion](https://help.vtex.com/tutorial/regular-promotion--tutorials_327)), `combo` ([Buy Together](https://help.vtex.com/en/tutorial/buy-together--tutorials_323)), `forThePriceOf` ([More for Less](https://help.vtex.com/en/tutorial/creating-a-more-for-less-promotion--tutorials_325)), `progressive` ([Progressive Discount](https://help.vtex.com/en/tutorial/progressive-discount--tutorials_324)), `buyAndWin` ([Buy One Get One](https://help.vtex.com/en/tutorial/buy-one-get-one--tutorials_322)), `maxPricePerItem` (Deprecated), `campaign` ([Campaign Promotion](https://help.vtex.com/en/tutorial/campaign-promotion--1ChYXhK2AQGuS6wAqS8Ume)), `tax` (Tax), `multipleEffects` (Multiple Effects).\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -597,7 +597,7 @@ } }, { - "id": "c9c12279-0373-4ed8-adf6-d0dcc9ce3482", + "id": "ca7bc1e6-0027-473b-a875-5a4f17549287", "name": "Create or update promotion or tax", "request": { "name": "Create or update promotion or tax", @@ -663,7 +663,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f353d2f9-6fd7-4d50-aa59-64fc2957b111", + "id": "7018421b-08b7-49c1-a5db-d63529e3b5bb", "name": "OK", "originalRequest": { "url": { @@ -742,7 +742,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5c0f2100-cb33-4c1d-8b49-4f72a01be655", + "id": "0ce78bc0-3c94-4f97-a137-42b427977bad", "name": "Bad request.", "originalRequest": { "url": { @@ -822,7 +822,7 @@ { "listen": "test", "script": { - "id": "c019449a-4a00-4101-803f-66a9dc1918ff", + "id": "870303e9-d420-4317-9b99-35b462192d99", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/calculatorconfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -838,7 +838,7 @@ } }, { - "id": "4be5e1a1-5ecc-4780-ab41-5aa83bc8d127", + "id": "b9970c3d-c251-492a-8830-9c0d6be27f38", "name": "Create multiple SKU promotion", "request": { "name": "Create multiple SKU promotion", @@ -957,7 +957,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "dc9b952d-b76e-46cd-8214-06036f935be1", + "id": "a19e5a24-abae-434d-a904-3bb2be2640b1", "name": "OK", "originalRequest": { "url": { @@ -1084,7 +1084,7 @@ { "listen": "test", "script": { - "id": "65a928d6-f471-49fb-af5a-37dc62bcd6ed", + "id": "6079e3bd-b199-4107-80a4-36f99da54d87", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/import/calculatorConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1097,7 +1097,7 @@ } }, { - "id": "7039f46b-b41b-45ea-8a76-15e22212e29c", + "id": "ba7bd3cd-de8f-43fb-a984-cd3123a249ac", "name": "Update multiple SKU promotion", "request": { "name": "Update multiple SKU promotion", @@ -1228,7 +1228,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "69430352-d547-46a8-9247-76b538eebd70", + "id": "dd8d59f8-a8d3-4b65-9f7d-bd9c779b249a", "name": "Accepted", "originalRequest": { "url": { @@ -1356,7 +1356,7 @@ { "listen": "test", "script": { - "id": "1844e5d9-d10e-4138-9dfd-457c8a35bd55", + "id": "19224d21-9277-44de-9ef5-4133c84444f2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/rnb/pvt/import/calculatorConfiguration/:promotionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1369,7 +1369,7 @@ } }, { - "id": "3c543ebe-ae19-4de2-a666-2c52ee9da313", + "id": "03a81ad3-b90e-403c-a1bc-72e7650a916d", "name": "Archive promotion or tax", "request": { "name": "Archive promotion or tax", @@ -1431,7 +1431,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "cd9caf50-fb90-463d-83ea-d6d8e6f15ca2", + "id": "4ca0e3e3-f3e7-4705-a280-48bda2ed03bb", "name": "No Content", "originalRequest": { "url": { @@ -1490,7 +1490,7 @@ { "listen": "test", "script": { - "id": "0e285066-022c-4bf7-817b-33fc2e24ad92", + "id": "8ea0b62c-2a7a-4bb5-b9ad-1f5d51ee69c5", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/archive/calculatorConfiguration/:idCalculatorConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1504,7 +1504,7 @@ } }, { - "id": "e0dc5aac-85a8-4810-becb-8dc9ff078bc9", + "id": "38af9beb-cda5-47ca-a7f1-48084db79949", "name": "Unarchive promotion or tax", "request": { "name": "Unarchive promotion or tax", @@ -1566,7 +1566,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "2968522f-ad98-4330-9f00-6da81ea44811", + "id": "2d2562e2-b3a9-4bc3-ac4f-cbbe028f075c", "name": "No Content", "originalRequest": { "url": { @@ -1625,7 +1625,7 @@ { "listen": "test", "script": { - "id": "74a4ae07-2711-4111-9d28-c6797a18425e", + "id": "a7fede01-e2cd-4dac-b7d5-e0e4d1804325", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/unarchive/calculatorConfiguration/:idCalculatorConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1639,7 +1639,7 @@ } }, { - "id": "3879a255-3714-4418-ade6-6b5fe781ecfb", + "id": "8ce35644-2a43-4a3c-a1d8-7c8d01dd46df", "name": "List archived promotions", "request": { "name": "List archived promotions", @@ -1694,7 +1694,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ac4525f7-1db3-4459-9f98-378fcdb31a99", + "id": "0576229b-4f93-4740-be9a-f246270d5929", "name": "OK", "originalRequest": { "url": { @@ -1763,13 +1763,13 @@ { "listen": "test", "script": { - "id": "3d02ffbb-a986-420e-9cf8-f32c12ef6c8c", + "id": "8b0d5cca-aa6b-4cb3-b8cf-af3c4af7833b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/archive/benefits/calculatorConfiguration - 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/rnb/pvt/archive/benefits/calculatorConfiguration - 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/rnb/pvt/archive/benefits/calculatorConfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"Response object.\",\"properties\":{\"items\":{\"type\":\"object\",\"description\":\"Object with information about a promotion.\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"lastModifiedUtc\":{\"type\":\"string\",\"description\":\"Date and time when the promotion was last modified (UTC).\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"beginDate\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDate\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the promotion is activated. If set as `false` the promotion is deactivated.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"type\":{\"description\":\"Defines the type of promotion.\",\"type\":\"string\"},\"utmSource\":{\"type\":\"string\",\"description\":\"utmSource code.\"},\"utmCampain\":{\"type\":\"string\",\"description\":\"utmCampaign code.\"},\"utmiCampaign\":{\"type\":\"string\",\"description\":\"utmiCampaign code.\"},\"status\":{\"type\":\"string\",\"description\":\"Status of the promotion.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax applied.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"hasMaxPricePerItem\":{\"description\":\"Defines if there is a maximum price per item.\",\"type\":\"boolean\"},\"isTax\":{\"description\":\"Defines if it is a tax.\",\"type\":\"boolean\"},\"campaigns\":{\"description\":\"Campaign Audiences that activate this promotion.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Campaign Audience.\"}},\"activateGiftsMultiplier\":{\"description\":\"If set as `true`, it activates gifts Multiplier.\",\"type\":\"boolean\"},\"scope\":{\"description\":\"Scope of the promotion.\",\"type\":\"object\",\"properties\":{\"allCatalog\":{\"description\":\"Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).\",\"type\":\"boolean\"},\"skus\":{\"description\":\"Quantity of SKUs which activate or deactivate the promotion.\",\"type\":\"number\"},\"skusAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"products\":{\"description\":\"Quantity of products which activate or deactivate the promotion.\",\"type\":\"number\"},\"productsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"collections\":{\"description\":\"Quantity of collections which activate or deactivate the promotion.\",\"type\":\"number\"},\"collectionsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"categories\":{\"description\":\"Quantity of categories which activate or deactivate the promotion.\",\"type\":\"number\"},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this promotion not to be applied.\"},\"brands\":{\"description\":\"Quantity of brands which activate or deactivate the promotion.\",\"type\":\"number\"},\"brandsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"sellers\":{\"description\":\"Quantity of sellers which activate or deactivate the promotion.\",\"type\":\"number\"},\"sellersAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"}}},\"maxUsage\":{\"type\":\"number\",\"description\":\"Defines how many times the promotion can be used.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this promotion will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this promotion not to be applied.\"}}},\"nominalDiscountType\":{\"type\":\"string\",\"description\":\"Controls the behavior of the `NominalDiscount` effect. This field only accepts two string values:\\n\\n -`item`: applies the intended nominal discount on every item present on the cart. \\n\\n -`cart`: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/archive/benefits/calculatorConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"Response object.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"Array with information about a promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about a promotion.\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"lastModifiedUtc\":{\"type\":\"string\",\"description\":\"Date and time when the promotion was last modified (UTC).\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"beginDate\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDate\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the promotion is activated. If set as `false` the promotion is deactivated.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"type\":{\"description\":\"Defines the type of promotion.\",\"type\":\"string\"},\"utmSource\":{\"type\":\"string\",\"description\":\"utmSource code.\"},\"utmCampain\":{\"type\":\"string\",\"description\":\"utmCampaign code.\"},\"utmiCampaign\":{\"type\":\"string\",\"description\":\"utmiCampaign code.\"},\"status\":{\"type\":\"string\",\"description\":\"Status of the promotion.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax applied.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"hasMaxPricePerItem\":{\"description\":\"Defines if there is a maximum price per item.\",\"type\":\"boolean\"},\"isTax\":{\"description\":\"Defines if it is a tax.\",\"type\":\"boolean\"},\"campaigns\":{\"description\":\"Campaign Audiences that activate this promotion.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Campaign Audience.\"}},\"activateGiftsMultiplier\":{\"description\":\"If set as `true`, it activates gifts Multiplier.\",\"type\":\"boolean\"},\"scope\":{\"description\":\"Scope of the promotion.\",\"type\":\"object\",\"properties\":{\"allCatalog\":{\"description\":\"Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).\",\"type\":\"boolean\"},\"skus\":{\"description\":\"Quantity of SKUs which activate or deactivate the promotion.\",\"type\":\"number\"},\"skusAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"products\":{\"description\":\"Quantity of products which activate or deactivate the promotion.\",\"type\":\"number\"},\"productsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"collections\":{\"description\":\"Quantity of collections which activate or deactivate the promotion.\",\"type\":\"number\"},\"collectionsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"categories\":{\"description\":\"Quantity of categories which activate or deactivate the promotion.\",\"type\":\"number\"},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this promotion not to be applied.\"},\"brands\":{\"description\":\"Quantity of brands which activate or deactivate the promotion.\",\"type\":\"number\"},\"brandsAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"},\"sellers\":{\"description\":\"Quantity of sellers which activate or deactivate the promotion.\",\"type\":\"number\"},\"sellersAreInclusive\":{\"description\":\"If set to `true`, this promotion will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this promotion not to be applied.\",\"type\":\"boolean\"}}},\"maxUsage\":{\"type\":\"number\",\"description\":\"Defines how many times the promotion can be used.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this promotion will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this promotion not to be applied.\"}}}},\"nominalDiscountType\":{\"type\":\"string\",\"description\":\"Controls the behavior of the `NominalDiscount` effect. This field only accepts two string values:\\n\\n -`item`: applies the intended nominal discount on every item present on the cart. \\n\\n -`cart`: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/archive/benefits/calculatorConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1779,7 +1779,7 @@ } }, { - "id": "7bf74f0f-94bb-495b-b335-a8bd45290d79", + "id": "1f4de2a0-53b6-43a5-9724-0f0332c36f87", "name": "List archived taxes", "request": { "name": "List archived taxes", @@ -1834,7 +1834,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "539cf3c0-7022-475a-bab1-57ca345ef9e1", + "id": "b0571fd6-e2d0-4b46-bb0e-d4e68b903fd5", "name": "OK", "originalRequest": { "url": { @@ -1903,7 +1903,7 @@ { "listen": "test", "script": { - "id": "567a4bfa-696d-42d6-9eb0-8e410a689e8d", + "id": "1a49c4a3-7efe-49b4-a2a2-78255485b623", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/archive/taxes/calculatorConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1922,7 +1922,7 @@ "event": [] }, { - "id": "e7940abe-12c1-4f5d-a708-ff1d7121695b", + "id": "83d7c166-f4b6-4f2d-b794-43945109b0a0", "name": "Coupons", "description": { "content": "", @@ -1930,7 +1930,7 @@ }, "item": [ { - "id": "aedfa43e-0089-4b78-98c0-a02b785bb1e7", + "id": "c9d80253-055b-4fd0-9760-d1588cf51954", "name": "Create multiple coupons", "request": { "name": "Create multiple coupons", @@ -1996,7 +1996,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1c2adb9b-24c6-44c8-98ca-a91235f28a4b", + "id": "ef2dff01-8a14-4680-9f3d-db93fc6bf9c5", "name": "OK", "originalRequest": { "url": { @@ -2076,7 +2076,7 @@ { "listen": "test", "script": { - "id": "8b5f8ca5-a952-4c51-a1bb-f1510c8ae81b", + "id": "a55047f3-69e4-4c39-803b-659d624f223b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/multiple-coupons - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2092,7 +2092,7 @@ } }, { - "id": "3c75f05e-503a-40a1-9b6c-e593a8209f94", + "id": "429984f1-68c8-4d52-b85a-f998fb740bd0", "name": "Create or update coupon", "request": { "name": "Create or update coupon", @@ -2158,7 +2158,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "523cd8c7-8920-43c9-abbe-a6a41d0101e3", + "id": "ba5b9960-5136-4603-8197-84980d80401a", "name": "OK", "originalRequest": { "url": { @@ -2237,7 +2237,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b4432cba-0de9-4ce6-aa5f-db299c44ed2d", + "id": "14cd0bd0-349b-4d36-b664-ef5eba0a1c40", "name": "Created", "originalRequest": { "url": { @@ -2317,7 +2317,7 @@ { "listen": "test", "script": { - "id": "06dcfb89-36de-403c-9cc6-a833bacc9de0", + "id": "1632e99c-89ed-471e-80ad-fd6d2c853f03", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/coupon - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2333,7 +2333,7 @@ } }, { - "id": "2b538344-447b-4194-8ad9-75ae8805cc96", + "id": "260896f6-150d-4184-a49f-f1b87c27d225", "name": "Get all coupons", "request": { "name": "Get all coupons", @@ -2386,7 +2386,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f14f0aa2-9d79-4a50-a90f-631eb819462d", + "id": "cfdc0c29-9e97-4f6d-bbc5-7a63ed3fd4ec", "name": "OK", "originalRequest": { "url": { @@ -2453,7 +2453,7 @@ { "listen": "test", "script": { - "id": "1439a107-5433-4a71-9608-3922a129ace6", + "id": "2f37a6ef-afc0-4af7-965e-a6885ef4d57c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/coupon - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2469,7 +2469,7 @@ } }, { - "id": "7c57f8e8-9477-47cc-b7ca-8565c908f085", + "id": "814e74d0-9f09-4ed5-a94c-5b793b24c3d4", "name": "Get coupon by coupon code", "request": { "name": "Get coupon by coupon code", @@ -2534,7 +2534,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9a610c00-10b5-462a-b816-2ffb0b527fc7", + "id": "06970ad2-ab97-4dce-81fd-19cb3aba3367", "name": "OK", "originalRequest": { "url": { @@ -2602,7 +2602,7 @@ { "listen": "test", "script": { - "id": "d30b8a73-c7f2-4d1c-8288-a5aa10183bdb", + "id": "30988df7-ccd2-46fe-a63c-8956e08ef52a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/coupon/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2618,7 +2618,7 @@ } }, { - "id": "3ceeb247-13df-45c4-bc2f-d81ce75fb63c", + "id": "e73e7af3-b8cd-4151-ae20-263ef845ad4f", "name": "Get archived coupon by coupon code", "request": { "name": "Get archived coupon by coupon code", @@ -2684,7 +2684,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1938d665-3a68-4cc5-b28c-4f43964d8656", + "id": "f137bdc4-b63b-40aa-a0d0-04ba6d3322be", "name": "OK", "originalRequest": { "url": { @@ -2753,7 +2753,7 @@ { "listen": "test", "script": { - "id": "14c490e4-7607-45b3-a931-018fa1a7f51c", + "id": "618ed50c-da51-40be-a9cd-dee432aca20a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/archive/coupon/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2769,7 +2769,7 @@ } }, { - "id": "65882f9a-2b7a-47aa-8bab-5cdddd5e85b2", + "id": "21d366dc-3e15-47de-8e0a-276c19e63ad2", "name": "Archive coupon by coupon code", "request": { "name": "Archive coupon by coupon code", @@ -2835,7 +2835,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "93afc2d5-f808-4a82-b0e8-dd84dceb7a89", + "id": "e4ac4a2a-0783-4484-af7e-77874cb7da98", "name": "OK", "originalRequest": { "url": { @@ -2904,7 +2904,7 @@ { "listen": "test", "script": { - "id": "f328aa91-c886-4252-b29c-627459d51404", + "id": "2c935222-e465-4dd2-9241-bba9c5862a90", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/archive/coupon/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2920,7 +2920,7 @@ } }, { - "id": "9927b3e3-f6f2-4ab3-a14e-7880c7891f1d", + "id": "22e8e3cc-33e4-44fe-9098-c79396796109", "name": "Generate coupons in bulk", "request": { "name": "Generate coupons in bulk", @@ -2942,7 +2942,7 @@ { "disabled": false, "description": { - "content": "(Required) Quantity of coupons created. The value must be a minimum of `1` and at maximum `1000`. If the amount is `1`, the coupon code will be the value of the couponCode parameter. If the value is greater than `1`, the coupon code will receive a random suffix.", + "content": "(Required) Number of coupons to create, which can be from `1` to `1000`. For a single coupon (`1`), the code will be the `couponCode` value. For multiple coupons (more than `1`), codes will be the `couponCode` value with a random suffix.", "type": "text/plain" }, "key": "quantity", @@ -2996,7 +2996,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "5c39c860-f6da-4c85-aa80-312d310fe6ec", + "id": "ffd3c085-2f0e-4b9c-8f12-e118bbf7580c", "name": "OK", "originalRequest": { "url": { @@ -3013,7 +3013,7 @@ { "disabled": false, "description": { - "content": "(Required) Quantity of coupons created. The value must be a minimum of `1` and at maximum `1000`. If the amount is `1`, the coupon code will be the value of the couponCode parameter. If the value is greater than `1`, the coupon code will receive a random suffix.", + "content": "(Required) Number of coupons to create, which can be from `1` to `1000`. For a single coupon (`1`), the code will be the `couponCode` value. For multiple coupons (more than `1`), codes will be the `couponCode` value with a random suffix.", "type": "text/plain" }, "key": "quantity", @@ -3086,7 +3086,7 @@ { "listen": "test", "script": { - "id": "f462a570-c329-44c7-a547-01a3cc84edba", + "id": "a7a7fb2b-18a6-4080-bfbd-e1ae7e1e82c9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/coupons - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3102,7 +3102,7 @@ } }, { - "id": "e4703b09-3498-4e15-b63a-2376dcd21d29", + "id": "9663b348-e5b7-4cab-9d01-dd8d8e71110e", "name": "Get coupon usage", "request": { "name": "Get coupon usage", @@ -3168,7 +3168,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9bc152b2-35d2-44b3-850f-18b138074885", + "id": "4004114d-b41f-4f2f-8b62-afa1855b6acb", "name": "OK", "originalRequest": { "url": { @@ -3237,7 +3237,7 @@ { "listen": "test", "script": { - "id": "f34ec2a6-2e55-4114-a26a-950c5144e01c", + "id": "46ea63e0-e18c-464d-8336-8e0f9a24973d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/coupon/usage/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3253,7 +3253,7 @@ } }, { - "id": "31462937-99cf-4b58-826e-95a1fa2776c9", + "id": "820935d3-b39d-479e-b6c7-e8b9a713e0aa", "name": "Unarchive coupon by coupon code", "request": { "name": "Unarchive coupon by coupon code", @@ -3319,7 +3319,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8828be52-5918-4331-8b12-9994a5725f28", + "id": "186f8cbc-3138-44d0-aff9-f235266c5811", "name": "OK", "originalRequest": { "url": { @@ -3388,7 +3388,7 @@ { "listen": "test", "script": { - "id": "9c2aa3b5-7dfd-4a03-b8f4-5b377dafd78d", + "id": "da7592af-3faa-4cae-a20b-ca5457fb3a7b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/unarchive/coupon/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3407,7 +3407,7 @@ "event": [] }, { - "id": "b22099ee-8f6c-46c9-b1ea-fbe327090763", + "id": "908d83cf-6762-41e5-9199-30f6737bdbc2", "name": "Campaign Audiences", "description": { "content": "", @@ -3415,7 +3415,7 @@ }, "item": [ { - "id": "497d4495-883d-4b3a-bd82-17f9f918d23d", + "id": "912edbf7-4ba3-4f29-bf25-950efd2c65ed", "name": "Get campaign audience configuration", "request": { "name": "Get campaign audience configuration", @@ -3480,7 +3480,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "60d35db1-15ed-4c41-8041-31b8f15a4e25", + "id": "060a8aa4-e9b2-476e-ad5d-d0c7bb746f85", "name": "OK", "originalRequest": { "url": { @@ -3548,7 +3548,7 @@ { "listen": "test", "script": { - "id": "804a7554-e525-49df-8f38-f8c1c78d95ac", + "id": "b7744baa-9327-4a10-b7a4-aec7c13c0f70", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration/:campaignId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3564,7 +3564,7 @@ } }, { - "id": "20511dce-244a-4d96-8c10-a85a70a4b3d5", + "id": "9b48f8d3-2c48-47ba-8d63-d5f259fd3fe1", "name": "Get all campaign audiences", "request": { "name": "Get all campaign audiences", @@ -3617,7 +3617,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "af7dde00-8d41-41d0-9b46-98c0ae2534ce", + "id": "04d965fe-2761-4706-8b31-9e6f26336f93", "name": "OK", "originalRequest": { "url": { @@ -3684,7 +3684,7 @@ { "listen": "test", "script": { - "id": "eb438d58-490f-4b0f-b833-d71560bc8316", + "id": "49c5961b-0a03-4d36-a9af-2cd7e5826218", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3700,7 +3700,7 @@ } }, { - "id": "87258013-b534-4c4a-a4cb-026b422e5d26", + "id": "e838b175-9999-4018-abf0-17cf89c145c3", "name": "Create campaign audience", "request": { "name": "Create campaign audience", @@ -3766,7 +3766,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b6ef1fef-2104-4fb0-a722-bd21b150d2e1", + "id": "290f9a95-fc16-4065-9bb9-a0aebd66613d", "name": "OK", "originalRequest": { "url": { @@ -3846,7 +3846,7 @@ { "listen": "test", "script": { - "id": "bf4ad296-9a3e-4371-af66-69e1dbd20316", + "id": "04f3ac1c-fcfc-4f9a-957d-19b36b29ccda", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/campaignConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3865,7 +3865,7 @@ "event": [] }, { - "id": "a4d805ae-d12e-42db-9069-552f54cf6240", + "id": "3df6a0f3-5d0b-4cb3-ab3f-7194ef01cee6", "name": "Notifications", "description": { "content": "", @@ -3873,7 +3873,7 @@ }, "item": [ { - "id": "acb4924e-f9f7-4c90-b790-29b2bcc50408", + "id": "419174f7-7f82-4e1b-9781-2bd190218996", "name": "Usage notification", "request": { "name": "Usage notification", @@ -3940,7 +3940,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "53078bf2-a660-46ea-8c9e-a6cbc4582718", + "id": "0f179d27-b181-4788-a0d8-25cf9a557873", "name": "OK", "originalRequest": { "url": { @@ -4020,7 +4020,7 @@ "event": [] }, { - "id": "720a601e-b0cb-46ec-ae81-35b0711569be", + "id": "75b4701f-39aa-4ff5-be53-4e2252fdd076", "name": "Bundles", "description": { "content": "", @@ -4028,10 +4028,10 @@ }, "item": [ { - "id": "5c1be2d5-1a34-4682-a84b-06174000f00b", - "name": "Calculate discounts and taxes (bundles)", + "id": "40ee397b-eee9-4764-bcb9-1ea33b810988", + "name": "Calculate discounts and taxes bundles", "request": { - "name": "Calculate discounts and taxes (bundles)", + "name": "Calculate discounts and taxes bundles", "description": { "content": "Calculate discounts and taxes\r\n\r\n## Permissions\r\n\r\nThis endpoint is usually used internally for backend services and does not require user [permissions]((https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3)).", "type": "text/plain" @@ -4093,7 +4093,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "a04a9302-b9d1-4246-a4a5-bec8557817c3", + "id": "d7084b94-832c-4a7b-9998-981387feb34d", "name": "OK", "originalRequest": { "url": { @@ -4171,7 +4171,7 @@ "event": [] }, { - "id": "8e32a75e-a1fc-46a3-a817-645649c4b4a5", + "id": "78bfd6dd-1d77-4de2-8d4b-6163393785d8", "name": "Prices (Legacy - v1)", "description": { "content": "", @@ -4179,7 +4179,7 @@ }, "item": [ { - "id": "e6353c36-9dc9-4d32-bdb0-ebf51fa93cc5", + "id": "8c0e0870-e89e-4c8d-9269-33a5ab5f0cf3", "name": "Get price by SKU ID", "request": { "name": "Get price by SKU ID", @@ -4221,7 +4221,7 @@ "type": "text/plain" }, "type": "any", - "value": "culpa", + "value": "ex Excepteur nulla", "key": "skuId" } ] @@ -4258,7 +4258,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9fa2b747-a681-4f04-b432-4e017f74d5fa", + "id": "7393121a-301c-4738-94b6-c967da57a473", "name": "OK", "originalRequest": { "url": { @@ -4342,7 +4342,7 @@ } }, { - "id": "ac44fe0f-aef9-4549-8717-33ec387ab5f0", + "id": "7624d438-c2e5-4b8c-9bec-e341207c903e", "name": "Delete price by SKU ID", "request": { "name": "Delete price by SKU ID", @@ -4384,7 +4384,7 @@ "type": "text/plain" }, "type": "any", - "value": "culpa", + "value": "ex Excepteur nulla", "key": "skuId" } ] @@ -4417,7 +4417,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "7301a451-7773-4b66-b235-4489308db84c", + "id": "dadde2a4-f4dd-4164-99fa-ca0d87d61732", "name": "OK", "originalRequest": { "url": { @@ -4491,7 +4491,7 @@ } }, { - "id": "a2faaf46-558d-4f73-81b0-61e873e278f0", + "id": "88a65c07-fd67-4ead-ac8d-6a400e44d372", "name": "Get all paged prices", "request": { "name": "Get all paged prices", @@ -4535,7 +4535,7 @@ "type": "text/plain" }, "type": "any", - "value": "culpa", + "value": "ex Excepteur nulla", "key": "page" }, { @@ -4545,7 +4545,7 @@ "type": "text/plain" }, "type": "any", - "value": "culpa", + "value": "ex Excepteur nulla", "key": "pageSize" } ] @@ -4578,7 +4578,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "4d710127-d35d-465b-8dd4-663e864718ba", + "id": "08bde4d2-4f66-4f53-8e29-0b806f779834", "name": "OK", "originalRequest": { "url": { @@ -4654,7 +4654,7 @@ } }, { - "id": "1b5dee07-4b13-46c4-819f-4ce450d70e51", + "id": "521d9094-7734-4460-bfe8-f791ea3ad4a7", "name": "Get price by context", "request": { "name": "Get price by context", @@ -4731,7 +4731,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "43754dce-c551-4296-ac76-370eaa0f3593", + "id": "2b8aea81-53c1-47f2-bd5e-4f45347af345", "name": "OK", "originalRequest": { "url": { @@ -4818,7 +4818,7 @@ } }, { - "id": "d17765bf-4768-42c5-88f0-673ca6176d35", + "id": "3df97f40-f503-47f8-8d26-8d9556918a72", "name": "Get price by SKU ID and trade policy", "request": { "name": "Get price by SKU ID and trade policy", @@ -4861,7 +4861,7 @@ "type": "text/plain" }, "type": "any", - "value": "culpa", + "value": "ex Excepteur nulla", "key": "skuId" }, { @@ -4871,7 +4871,7 @@ "type": "text/plain" }, "type": "any", - "value": "culpa", + "value": "ex Excepteur nulla", "key": "tradePolicy" } ] @@ -4908,7 +4908,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "29c54e0f-1cb2-443b-a013-d1afafee4703", + "id": "9523d307-d045-44e9-9a3d-7b629a24378f", "name": "OK", "originalRequest": { "url": { @@ -4993,7 +4993,7 @@ } }, { - "id": "ac809d9f-b375-4a70-9ea1-b7cedb41a838", + "id": "ce360900-f972-41f5-971a-fe205536d936", "name": "Save price", "request": { "name": "Save price", @@ -5069,7 +5069,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "9a2a565c-a278-4d8f-a1db-c20a4c69c733", + "id": "9e21afc8-f219-452b-a2b7-01d214228bba", "name": "OK", "originalRequest": { "url": { @@ -5197,7 +5197,7 @@ } ], "info": { - "_postman_id": "1986f854-2a78-401b-989a-49d587240f5f", + "_postman_id": "0e6e94cc-da2b-47cb-9521-e6e36491202a", "name": "Promotions & Taxes API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/VTEX - Promotions & Taxes API.json b/VTEX - Promotions & Taxes API.json index 160f77bce..dc88e9ac4 100644 --- a/VTEX - Promotions & Taxes API.json +++ b/VTEX - Promotions & Taxes API.json @@ -2384,6 +2384,9 @@ "inclusive": true } ], + "countries": [ + "BRA" + ], "itemMaxPrice": 0.0, "itemMinPrice": 0.0, "installment": 0, @@ -2970,6 +2973,14 @@ } } }, + "countries": { + "type": "array", + "description": "List of countries that are activated for this promotion.", + "items": { + "type": "string", + "description": "Three-digit country code." + } + }, "itemMaxPrice": { "type": "number", "description": "Maximum price of the item."