Vtex Createnotes Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "Createnotes",
"method": "POST",
"path": "/notes/{carrierId}/{serviceId}",
"summary": "VTex Create notes",
"requestExamples": [
{
"contentType": "application/json",
"example": [
{
"type": "ERROR",
"note": "The package takes time to be shipped",
"author": "Oscar Rojas"
},
{
"type": "COMMENT",
"note": "The package was picked up",
"author": "Oscar Rojas"
}
]
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json; charset=utf-8",
"example": {
"message": "Notes saved successfully",
"data": [
{
"type": "ERROR",
"note": "The package takes time to be shipped",
"author": "Oscar Rojas"
},
{
"type": "COMMENT",
"note": "The package was picked up",
"author": "Oscar Rojas"
}
]
}
},
{
"status": "401",
"contentType": "application/json; charset=utf-8",
"example": {
"message": "Unauthorized",
"requestId": "3c685f11-45ec-4b8a-88ce-b9fff421eafe"
}
},
{
"status": "403",
"contentType": "application/json",
"example": {
"message": "Authentication token expired",
"requestId": "6fd59420-57c6-4111-bb32-e2aa35eff256"
}
},
{
"status": "404",
"contentType": "application/json; charset=utf-8",
"example": {
"type": "exception",
"code": "TRP0005E",
"data": {
"0": "1",
"carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50",
"serviceId": "servicemock"
},
"requestId": "6129725b-fbb1-42dd-9ec2-4fefecce41c1",
"date": "2024-03-15T06:14:15.950Z",
"message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&servicemock'"
}
}
]
}
Work with this as data
Every example here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for examples
4 MCP tools reach this
find_examplesBrowse and filter every example in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This example
curl "https://apis.io/api/v1/examples/vtex-createnotes-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.