VTEX · Example Payload

Vtex Get Apistorageprofile Systemschemasprofilesystem Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Get Apistorageprofile Systemschemasprofilesystem 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": "get-apistorageprofile-systemschemasprofilesystem",
  "method": "GET",
  "path": "/api/storage/profile-system/schemas/profileSystem",
  "summary": "VTex Get full schema",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "title": "Profile System Profile Schema",
        "description": "Schema used for integration testing with Checkout",
        "type": "object",
        "properties": {
          "firstName": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": true,
            "pii": true
          },
          "lastName": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": true,
            "pii": true
          },
          "email": {
            "type": "string",
            "sensitive": true,
            "pii": true
          },
          "corporateName": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": false,
            "pii": false
          },
          "fancyName": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": false,
            "pii": false
          },
          "document": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": true,
            "pii": true
          },
          "businessDocument": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": false,
            "pii": false
          },
          "documentType": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": false,
            "pii": false
          },
          "homePhone": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": true,
            "pii": true
          },
          "cellPhone": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": true,
            "pii": true
          },
          "businessPhone": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": false,
            "pii": false
          },
          "gender": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": true,
            "pii": false
          },
          "birthdate": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": true,
            "pii": true
          },
          "priceTable": {
            "type": "string",
            "sensitive": false,
            "pii": false
          },
          "tags": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string",
              "maxLength": 50
            },
            "sensitive": false,
            "pii": false
          },
          "customerCode": {
            "type": [
              "string",
              "null"
            ],
            "sensitive": true,
            "pii": true
          }
        },
        "required": [
          "email"
        ],
        "additionalProperties": true,
        "v-indexed": [
          "email",
          "document"
        ],
        "v-unique": [
          "email"
        ]
      }
    }
  ]
}