Vtex Removeallitems 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": "RemoveAllItems",
"method": "POST",
"path": "/api/checkout/pub/orderForm/{orderFormId}/items/removeAll",
"summary": "VTex Remove all items from shopping cart",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"orderFormId": "ede846222cd44046ba6c638442c3505a",
"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": {
"address": null,
"logisticsInfo": [],
"selectedAddresses": [],
"availableAddresses": [],
"pickupPoints": []
},
"clientProfileData": {
"email": "john.doe@google.com",
"firstName": "John",
"lastName": "Doe",
"document": "769387308",
"documentType": "dni",
"phone": "+5491111223344",
"corporateName": "company-name",
"tradeName": "trade-name",
"corporateDocument": "12345678000100",
"stateInscription": "12345678",
"corporatePhone": "551100988887777",
"isCorporate": false,
"profileCompleteOnLoading": false,
"profileErrorOnLoading": false,
"customerClass": null
},
"paymentData": {
"installmentOptions": [
{
"paymentSystem": 2,
"bin": null,
"paymentName": null,
"paymentGroupName": null,
"value": 15000,
"installments": [
{
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 15000,
"total": 15000,
"sellerMerchantInstallments": [
{
"id": "LOJADOBRENO",
"count": 1,
"hasInterestRate": false,
"interestRate": 0,
"value": 15000,
"total": 15000
}
]
}
]
}
],
"paymentSystems": [
{
"id": 4,
"name": "Mastercard",
"groupName": "creditCardPaymentGroup",
"validator": {
"regex": "^((5(([1-2]|[5-5])[0-3]{8}|0((2|9)([0-2]{5}))|1(0(5((0|[4-8])[1-7]{6})|([2-3]|[1-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})",
"mask": "9999 9999 9999 9999",
"cardCodeRegex": "^[1-3]{9}$",
"cardCodeMask": "999",
"weights": [
2,
1,
2,
1,
2
],
"useCvv": true,
"useExpirationDate": true,
"useCardHolderName": true,
"useBillingAddress": true
},
"stringId": "4",
"template": "creditCardPaymentGroup-template",
"requiresDocument": false,
"isCustom": false,
"description": "Payment description",
"requiresAuthentication": false,
"dueDate": "2020-03-05T14:23:23.8196668Z",
"availablePayments": null
}
],
"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": []
},
"hooksData": null,
"ratesAndBenefitsData": {
"rateAndBenefitsIdentifiers": [],
"teaser": []
},
"subscriptionData": null,
"itemsOrdination": {
"criteria": "NAME",
"ascending": true
}
}
}
]
}