VTEX · Example Payload

Vtex Createnotes Example

CommerceE-CommerceRetailMarketplacePayments

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

Raw ↑ 
{
  "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'"
      }
    }
  ]
}