VTEX · Example Payload

Vtex Createnewdocument Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Createnewdocument 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": "Createnewdocument",
  "method": "POST",
  "path": "/api/dataentities/{dataEntityName}/documents",
  "summary": "VTex Create new document",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "email": "clark.kent@examplemail.com",
        "firstName": "Clark",
        "lastName": "Kent",
        "phone": "+12025550195",
        "documentType": "CPF",
        "document": "12345678900",
        "isCorporate": false,
        "isNewsletterOptIn": false,
        "localeDefault": "en-US"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "Newsletter-cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827",
        "Href": "http://cosmetics2.vtexcommercestable.com.br/api/dataentities/Newsletter/documents/cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827",
        "DocumentId": "cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827"
      }
    }
  ]
}