EDU-11961 | Map seller specifications to marketplace catalog #1455
+120
−288
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your contribution. The .json file will be checked now with Spectral. |
Isabella-Veloso
requested changes
May 16, 2025
| "Multiple product specification mapping" | ||
| ], | ||
| "summary": "Map seller specifications to marketplace catalog", | ||
| "description": "This endpoint allows the seller to perform a bulk mapping of product specifications to the marketplace catalog.\r\n\r\nSpecifications are additional properties that can be registered on products. To ensure this information is correctly interpreted, the marketplace must map the seller\u2019s specifications to the corresponding fields in its own catalog.\r\n\r\nThis process ensures that products sent by the seller contain data that matches the marketplace's catalog. Sending a new item without prior mapping does not override existing values. Adding new specifications must follow the instructions in the Mapping categories, brands, and specifications for the marketplace guide.\r\nThe mapping must be done based on specifications that already exist in the marketplace's catalog.\r\n\r\n\uD83D\uDD39 All differing specifications must be mapped, even if the only difference is the capitalization of the word.\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| Catalog | Content | **Product and SKU Management** |\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.", |
There was a problem hiding this comment.
Substituir por caracteres e emojis: u2019s, uD83D\uDD39, u2757.
| }, | ||
| "description": "Key-value pairs where the key is the seller's specification name and the value is the equivalent specification in the marketplace." | ||
| }, | ||
| "example": { |
There was a problem hiding this comment.
Conforme nosso template, o exemplo do request body vem dentro do schema, separamos o exemplo completo somente no response body.
https://github.com/vtex/openapi-schemas/edit/master/templates/VTEX%20-%20Template%20openAPI.jsonc
Comment on lines
+1357
to
+1358
| "BROWN": "Marrom", | ||
| "Brand": "Marca" |
There was a problem hiding this comment.
Traduzir termos em PT para EN.
| "description": "OK" | ||
| } | ||
| }, | ||
| "deprecated": false |
| } | ||
| } | ||
| }, | ||
| "responses": { |
There was a problem hiding this comment.
Se aplicável, declarar schema da response.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Types of changes
Changelog
Do not forget to update your changes to our Developer Portal's changelog. Did you create a release note?