API archive entry · source-reported
Suggestions
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. `GET`Get autoApprove St
Plan the first integration safely
The access fields below come from the connected directory. Their likely implementation impact is explained without assuming provider-specific behavior.
Authentication
OAuth is reported. Confirm flows, scopes, consent, token lifetime, and refresh rules.
Transport
HTTPS is not confirmed. Do not send credentials or production data until secure transport is verified.
Browser access
CORS is unknown. Treat direct browser access as unconfirmed and test before choosing a client-only architecture.
First-request sequence
- Identify the current base URL, version, and endpoint for the use case.
- Confirm how credentials are issued and where they may be stored.
- Test success, invalid input, throttling, unavailable data, and timeouts.
- Record response fields, pagination, caching, and error shapes.
- Add monitoring, retries with backoff, and an appropriate fallback.
Questions to resolve before production
Pricing and quotas
Confirm current plans, free-tier limits, overages, and request ceilings.
Endpoint coverage
Check that the operations and response fields match the intended workload.
Reliability
Look for uptime history, a status page, support routes, and service commitments.
Data and privacy
Review retention, licensing, regional processing, and compliance requirements.
Versioning
Confirm the active version, change policy, deprecation window, and migration guidance.
Developer experience
Validate SDKs, examples, error formats, pagination, and test environments.
Source reference
This page separates source-reported facts from questions that need live provider verification.