VTEX · Example Payload

Vtex Getuser Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getuser 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": "GetUser",
  "method": "GET",
  "path": "/api/license-manager/users/{userId}",
  "summary": "VTex Get user",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "e845b52a40e24654a2c70766adb5762b",
        "name": "Jane",
        "email": "jane@mail.com"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "Message": "Invalid UserId"
      }
    }
  ]
}