VTEX

Suggestions

The Marketplace API enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must [create an appKey and…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Marketplace API enables marketplaces and sellers hosted on VTEX to perform their collaborative operations.

>⚠️ The marketplace must create an appKey and appToken for each non-VTEX seller that will use this API.

Index

Notification

Endpoints used by sellers to notify marketplaces that the price or inventory language has changed for one of their SKUs.

POST Notify marketplace of price update

POST Notify marketplace of inventory update

Suggestions

Get Suggestions

Search and filter all suggestions using specific criteria.

GET Get all SKU Suggestions

GET Get SKU Suggestion by ID

Manage Suggestions

Send or delete SKU suggestions from the seller to marketplace.

PUT Send SKU Suggestion

DELETE Delete SKU Suggestion

Get Versions

Search and filter all versions of suggestions, using specific criteria.

GET Get all versions

GET Get version by ID

Match Received SKUs

Match SKU suggestions received in the marketplace.

PUT Match Received SKUs individually

PUT Match Multiple Received SKUs

SKU Approval Settings

Allows marketplaces to configure rules for automatically and manually approving SKUs received from sellers.

GETGet autoApprove Status in Account Settings

PUTActivate autoApprove in Marketplace's Account

GETGet Account's Approval Settings

PUTSave Account's Approval Settings

GETGet Seller's Approval Settings

PUTSave Seller's Approval Settings

PUTActivate autoApprove Setting for a Seller

Matched Offers

Offers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.

GETGet Matched Offers List

GETGet Matched Offer's Data by SKU ID

GETGet Matched Offer's Data by Product ID

Endpoints 15

Get Suggestions

  • GETGet all SKU suggestions/suggestions?accountName=apiexamples&q=&type=new&seller=&status=accepted&hasmapping=true&matcherid=vtex-matcher&_from=1&_to=50This endpoint retrieves a list of all SKUs sent by the seller for the Marketplace's approval. Marketplace operators should use this endpoint whenever they…
  • GETGet SKU Suggestion by ID/suggestions/:sellerId/:sellerSkuId?accountName=apiexamplesThis 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…

Manage Suggestions

  • PUTSend SKU Suggestion/suggestions/:sellerId/:sellerSkuId?accountName=apiexamplesThis 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…
  • DELETEDelete SKU Suggestion/suggestions/:sellerId/:sellerSkuId?accountName=apiexamplesThis 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,…

Get Versions

  • GETGet all Versions/suggestions/:sellerId/:sellerskuid/versions?accountName=apiexamplesWhenever 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…
  • GETGet Version by ID/suggestions/:sellerId/:sellerskuid/versions/:version?accountName=apiexamplesWhenever 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…

SKU Approval Settings

  • GETGet Account's Approval Settings/suggestions/configuration?accountName=apiexamplesThis endpoint retrieves the current approval settings of a marketplace's Received SKUs module. Its response includes: Score: Matcher scores for approving and…
  • PUTSave Account's Approval Settings/suggestions/configuration?accountName=apiexamplesMarketplaces use this endpoint to create or update approval settings on their Received SKUs module. The request includes all the details necessary to…
  • GETGet autoApprove Status in Account Settings/suggestions/configuration/autoapproval/toggle?sellerId=seller123&accountName=apiexamplesThis 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…
  • PUTActivate autoApprove in Marketplace's Account/suggestions/configuration/autoapproval/toggle?accountName=apiexamplesThis endpoint enables the autoapprove rule to a marketplace's whole Received SKUs module. Once enabling the rule, received SKUs will be automatically approved…
  • PUTActivate autoApprove Setting for a Seller/suggestions/configuration/autoapproval/toggle/seller/:sellerId?accountName=apiexamplesThis endpoint enables the auto approve setting to received SKUs from a specific seller. Be aware that once enabling the rule through this request, all…
  • GETGet Seller's Approval Settings/suggestions/configuration/seller/:sellerId?accountName=apiexamplesThis endpoint retrieves the current Received SKUs approval settings applied to a specific seller. Its response includes: sellerId: A string that identifies…
  • PUTSave Seller's Approval Settings/suggestions/configuration/seller/:sellerId?accountName=apiexamplesMarketplaces use this endpoint to create or update approval settings to a specific seller, on the Received SKUs module. The request includes all the details…

Match Received SKUs

  • PUTMatch Multiple Received SKUs/suggestions/matches/action/:actionName?accountName=apiexamplesThis 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.…
  • PUTMatch Received SKUs individually/suggestions/:sellerId/:sellerskuid/versions/:version/matches/:matchid?accountName=apiexamplesAll 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…

API details

Base URL
https://vtex.local
https://api.vtex.com/{accountName}
Authentication
An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header
Operations
15 operations on 10 pathsGET 7PUT 7DELETE 1
Main resources
SKU Approval Settings 7Get Suggestions 2Get Versions 2Manage Suggestions 2Match Received SKUs 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Suggestions in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Suggestions collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get all SKU suggestions” (GET /suggestions?accountName=apiexamples&q=&type=new&seller=&status=accepted&hasmapping=true&matcherid=vtex-matcher&_from=1&_to=50), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Suggestions?

The Marketplace API enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must [create an appKey and… It is listed under Other and has 15 endpoints.

Who publishes the Suggestions?

It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Suggestions?

Its description lists 2 base URLs: https://vtex.local, https://api.vtex.com/{accountName}. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Suggestions?

It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.

How many endpoints does the Suggestions have?

15 operations on 10 paths (7 GET, 7 PUT, 1 DELETE). The largest groups are SKU Approval Settings, Get Suggestions, Get Versions, Manage Suggestions.

Is forking the Suggestions free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.