Vtex Addclientprofile 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": "AddClientProfile",
"method": "POST",
"path": "/api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData",
"summary": "VTex Add client profile",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"orderFormId": "9ceee0fde6db489fbc809a0e2ab13a86",
"salesChannel": "1",
"loggedIn": false,
"isCheckedIn": false,
"storeId": "1",
"checkedInPickupPointId": "21",
"allowManualPrice": false,
"canEditData": true,
"userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
"userType": "User type",
"ignoreProfileData": false,
"value": 0,
"messages": [],
"items": [],
"selectableGifts": [],
"totalizers": [],
"shippingData": null,
"clientProfileData": {
"email": "clark.kent@examplemail.com",
"firstName": "Clark",
"lastName": "Kent",
"document": "44444444444",
"documentType": "cpf",
"phone": "+5511123456789",
"corporateName": "company-name",
"tradeName": "trade-name",
"corporateDocument": "12345678000100",
"stateInscription": "12345678",
"corporatePhone": "551100988887777",
"isCorporate": false,
"profileCompleteOnLoading": false,
"profileErrorOnLoading": false,
"customerClass": null
},
"paymentData": {
"updateStatus": "updated",
"installmentOptions": [],
"paymentSystems": [],
"payments": [
{
"paymentSystem": 6,
"bin": null,
"accountId": "12",
"tokenId": null,
"value": 34390,
"referenceValue": 34390,
"giftCardRedemptionCode": null,
"giftCardProvider": null,
"giftCardId": null
}
],
"giftCards": [],
"giftCardMessages": [],
"availableAccounts": [],
"availableTokens": []
},
"marketingData": null,
"sellers": [],
"clientPreferencesData": {
"locale": "pt-BR",
"optinNewsLetter": null
},
"commercialConditionData": null,
"storePreferencesData": {
"countryCode": "BRA",
"saveUserData": true,
"timeZone": "E. South America Standard Time",
"currencyCode": "BRL",
"currencyLocale": 1046,
"currencySymbol": "R$",
"currencyFormatInfo": {
"currencyDecimalDigits": 2,
"currencyDecimalSeparator": ",",
"currencyGroupSeparator": ".",
"currencyGroupSize": 3,
"startsWithCurrencySymbol": true
}
},
"giftRegistryData": null,
"openTextField": null,
"invoiceData": null,
"customData": null,
"itemMetadata": {
"items": [
{
"id": "1",
"seller": "1",
"name": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"skuName": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"productId": "1",
"refId": "0001",
"ean": "123456789",
"imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
"detailUrl": "/racao-royal-canin-feline-urinary/p",
"assemblyOptions": []
}
]
},
"hooksData": null,
"ratesAndBenefitsData": {
"rateAndBenefitsIdentifiers": [],
"teaser": []
},
"subscriptionData": null,
"itemsOrdination": {
"criteria": "NAME",
"ascending": true
}
}
}
]
}