Change notification with SKU ID

⚠️ Check out the updated version of this endpoint in our SKU Bindings API documentation. If you are doing this integration for the first time, we recommend that you follow the updated documentation.

The seller is responsible for suggesting new SKUs to be sold in the VTEX marketplace and also for informing the marketplace about changes in their SKUs that already exist in the marketplace. Both actions start with a catalog notification, which is made by this request.

With this notification, the seller is telling the marketplace that something has changed about a specific SKU, like its name or description, or that this is a new SKU that the seller would like to offer to the marketplace. The body of the request should be empty.

⚠️ Do not use this endpoint for price and inventory changes, because these types of updates should be notified using Marketplace API. For price changes, we recommend using the Notify marketplace of price update endpoint. For inventory changes, use Notify marketplace of inventory update.

Example

Let's say your seller has the ID 123 in the marketplace and you want to inform the marketplace that has been a change in the SKU with ID 700.

In this case, you would have to replace the sellerId parameter with the value 123 and the skuId parameter with the value 700. The URL of the request would be the following.

https://{{accountName}}.vtexcommercestable.com.br/api/catalog_system/pvt/skuseller/changenotification/123/700

Response codes

The following response codes are possible for this request.

• 404: the SKU was not found in the marketplace. The body of the response, in this case, should follow this format: "Seller StockKeepingUnit {{skuId}} not found for this seller id {{sellerId}}". This means that the seller can now proceed with sending an offer to the marketplace in order to suggest that this SKU is sold there.
• 200: the SKU whose ID was informed in the URL already exists in the marketplace and was found. The marketplace can now proceed with a fulfillment simulation in order to get updated information about this SKU's inventory and price.
• 429: Failure due to too many requests.
• 403: Failure in the authentication.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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:

There are no applicable predefined roles for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.