vtex.local – Marketplace-APIs-

Tools (17)

Extracted live via the executor SDK.

• getSuggestions.getSuggestion

  This endpoint retrieves the data of a specific SKU sent by the seller, to the marketplace. Marketplaces or external matchers can call this endpoint when they want to check the information about a single SKU.

  Note that all the information sent by the seller will be in the [content] object. All remaining information in this endpoint's response is given by the Matcher.

  Matcher rates received SKUs by correlating the data sent by sellers, to existing fields in the marketplace. The calculation of these scores determines whether the product has been:

  Approved: score equal to or greater than 80 points.

  Pending: from 31 to 79 points.

  Denied: from 0 to 30 points.

  Note that if the autoApprove setting is enabled, the SKUs will be approved, regardless of the Score.

• getSuggestions.getsuggestions

  This endpoint retrieves a list of all SKUs sent by the seller for the Marketplace's approval. Marketplace operators should use this endpoint whenever they want to check the full list of received SKUs and their information.

  Note that all the information sent by the seller will be in the [content] object. All remaining information in this endpoint's response is given by the Matcher.

  Matcher rates received SKUs by correlating the data sent by sellers, to existing fields in the marketplace. The calculation of these scores determines whether the product has been:

  Approved: score equal to or greater than 80 points.

  Pending: from 31 to 79 points.

  Denied: from 0 to 30 points.

  Note that if the autoApprove setting is enabled, the SKUs will be approved, regardless of the Score.

• getVersions.getSuggestionbyversion

  Whenever an SKU Suggestion is updated or changed, a new version of the original one is created. All versions are logged, so you can search for previous our current states of SKU suggestions.

  This endpoint retrieves a specific version of a chosen SKU sent by the seller. Add the Seller's ID, Seller's SKU ID, and version ID in the path to detail your search.

• getVersions.getSuggestionsVersions

  Whenever an SKU Suggestion is updated or changed, a new version of the original one is created. All versions are logged, so you can search for previous our current states of SKU suggestions.

  This endpoint retrieves the data of all previous and latest versions of a specific SKU suggestion, sent by the seller. Whenever an SKU is updated, it is important to map previous versions, to compare and identify changes.

  The response's object [latestversion] provides the information of the most recent version of that SKU suggestion.

• manageSuggestions.deleteSuggestion

  This endpoint deletes a chosen SKU suggestion. Only one SKU should be deleted per request. This request cannot be undone. A workaround to revert its action, is to send the suggestion again, through the Send Suggestion API.

• manageSuggestions.saveSuggestion

  This request is used by the seller when it wants to suggest that one of their SKUs is sold in the marketplace.

  Before using this request, the seller should always use the Change Notification request in order to check if the SKU already exists in the marketplace. If it doesn't, then this is the next call in the SKU integration flow.

  In the Send Suggestion request, the seller must send information about the SKU, such as the product and SKU name, the seller ID, and the image URL. All parameters are explained below.

• matchReceivedSkUs.match

  All SKUs sent from a seller to a marketplace must be reviewed and matched. Actions in the matching process are added in the request body through the [matchType] object. Match type actions include:

  1. newproduct: match the SKU as a new product.

  2. itemMatch: associate the received SKU to an existing SKU.

  3. productMatch: associate the received SKU to an existing product.

  4. deny: deny the received SKU.

  5. pending: the received SKU requires attention.

  6. incomplete: the received SKU is lacking information to be matched.

  7. insufficientScore: the score given by the Matcher to this received SKU doesn't qualify it to be matched.

  Note that if the autoApprove setting is enabled, the SKUs will be approved, regardless of the Score.

• matchReceivedSkUs.matchMultiple

  This endpoint allows the user to bulk approve, deny, or associate received SKUs. In a single request, you can match up to 25 received SKUs from your sellers.

  Through the actionName attribute you can select the operation you want to apply to the received SKU.

  Actions include:

  1. newproduct: match the SKU as a new product.

  2. skuassociation: associate the received SKU to an existing SKU.

  3. productassociation: associate the received SKU to an existing product.

  4. deny: deny the received SKU.

• skuApprovalSettings.getaccountconfig

  This endpoint retrieves the current approval settings of a marketplace's Received SKUs module. Its response includes:

  • Score: Matcher scores for approving and rejecting SKUs received from sellers.

  • Matchers: All Matchers configured on the marketplace, and their respective details.

  • SpecificationsMapping: Mapping of product and SKU specifications, per seller.

  • MatchFlux: This field determines the type of approval configuration applied to SKUs received from a seller.

  The possible values include:

  -default, where the Matcher reviews the SKU, and approves it based on its score.

  -manual, for manual approvals through the Received SKU UI, or Match API.

  -autoApprove, for every SKU received from a given seller to be approved automatically, regardless of their Matcher Score.

• skuApprovalSettings.getautoApprovevaluefromconfig

  This endpoint can be used to check whether the autoapprove setting is active or not, for a specific seller.

  If the response is true, the autoapprove setting is active. If the response is false, it is inactive.

• skuApprovalSettings.getselleraccountconfig

  This endpoint retrieves the current Received SKUs approval settings applied to a specific seller. Its response includes:

  • sellerId: A string that identifies the seller in the marketplace.

  • accountId: Marketplace’s account ID.

  • accountName: Marketplace’s account name.

  • mapping: Mapping of SKU and product Specifications.

  • matchFlux: This field determines the type of approval configuration applied to SKUs received from a seller.

  The possible values include:

  -default, where the Matcher reviews the SKU, and approves it based on its score.

  -manual, for manual approvals through the Received SKU UI and Match API.

  -autoApprove, for every SKU received from a given seller to be approved automatically, regardless of the Matcher Score.

• skuApprovalSettings.putselleraccountconfig

  Marketplaces use this endpoint to create or update approval settings to a specific seller, on the Received SKUs module.

  The request includes all the details necessary to implement the chosen approval settings.

• skuApprovalSettings.saveaccountconfig

  Marketplaces use this endpoint to create or update approval settings on their Received SKUs module.

  The request includes all the details necessary to implement the chosen approval settings.

• skuApprovalSettings.saveautoapproveforaccount

  This endpoint enables the autoapprove rule to a marketplace's whole Received SKUs module. Once enabling the rule, received SKUs will be automatically approved on your store, regardless of the seller.

  For the autoapprove rule to work as expected, the approval Matcher score should be set up as 80 (default value), but you can configure a different number through the field Score in Save Account's Approval Settings.

• skuApprovalSettings.saveautoapproveforaccountseller

  This endpoint enables the auto approve setting to received SKUs from a specific seller. Be aware that once enabling the rule through this request, all received SKUs from that seller will be automatically approved on your store, regardless of the Matcher Score.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools