Clear orderForm Messages
Developing
Testing Env
https://testing--decathlonstore.myvtex.com
Testing Env
https://testing--decathlonstore.myvtex.com
POST
/api/checkout/pub/orderForm/{{orderFormId}}/messages/clear
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://testing--decathlonstore.myvtex.com/api/checkout/pub/orderForm//messages/clear'
Response Response Example
{
"orderFormId": "string",
"salesChannel": "string",
"loggedIn": true,
"isCheckedIn": true,
"storeId": null,
"checkedInPickupPointId": null,
"allowManualPrice": true,
"canEditData": true,
"userProfileId": "string",
"userType": null,
"ignoreProfileData": true,
"value": 0,
"messages": [
null
],
"items": [
{
"uniqueId": "string",
"id": "string",
"productId": "string",
"productRefId": "string",
"refId": "string",
"ean": "string",
"name": "string",
"skuName": "string",
"modalType": null,
"parentItemIndex": null,
"parentAssemblyBinding": null,
"assemblies": [
null
],
"priceValidUntil": null,
"tax": 0,
"price": 0,
"listPrice": 0,
"manualPrice": null,
"manualPriceAppliedBy": null,
"sellingPrice": 0,
"rewardValue": 0,
"isGift": true,
"additionalInfo": {
"dimension": null,
"brandName": "string",
"brandId": "string",
"offeringInfo": null,
"offeringType": null,
"offeringTypeId": null
},
"preSaleDate": null,
"productCategoryIds": "string",
"productCategories": {
"72371526": "string",
"72371552": "string",
"72371715": "string"
},
"quantity": 0,
"seller": "string",
"sellerChain": [
"string"
],
"imageUrl": "string",
"detailUrl": "string",
"components": [
null
],
"bundleItems": [
null
],
"attachments": [
null
],
"attachmentOfferings": [
null
],
"offerings": [
null
],
"priceTags": [
null
],
"availability": "string",
"measurementUnit": "string",
"unitMultiplier": 0,
"manufacturerCode": null,
"priceDefinition": {
"calculatedSellingPrice": 0,
"total": 0,
"sellingPrices": [
{
"value": 0,
"quantity": 0
}
],
"reason": null
},
"taxCode": null
}
],
"selectableGifts": [
null
],
"totalizers": [
null
],
"shippingData": {
"address": {
"addressType": "string",
"receiverName": "string",
"addressId": "string",
"isDisposable": true,
"postalCode": "string",
"city": "string",
"state": "string",
"country": "string",
"street": "string",
"number": "string",
"neighborhood": "string",
"complement": "string",
"reference": null,
"geoCoordinates": [
null
]
},
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": null,
"selectedDeliveryChannel": "string",
"addressId": "string",
"slas": [
null
],
"shipsTo": [
"string"
],
"itemId": "string",
"deliveryChannels": [
{
"id": "string"
}
]
}
],
"selectedAddresses": [
{
"addressType": "string",
"receiverName": "string",
"addressId": "string",
"isDisposable": true,
"postalCode": "string",
"city": "string",
"state": "string",
"country": "string",
"street": "string",
"number": "string",
"neighborhood": "string",
"complement": "string",
"reference": null,
"geoCoordinates": [
null
]
}
],
"availableAddresses": [
{
"addressType": "string",
"receiverName": "string",
"addressId": "string",
"isDisposable": true,
"postalCode": "string",
"city": "string",
"state": "string",
"country": "string",
"street": "string",
"number": "string",
"neighborhood": "string",
"complement": "string",
"reference": "string",
"geoCoordinates": [
null
]
}
],
"pickupPoints": [
null
],
"contactInformation": [
null
]
},
"clientProfileData": {
"email": "string",
"firstName": "string",
"lastName": "string",
"document": "string",
"documentType": "string",
"phone": "string",
"corporateName": null,
"tradeName": null,
"corporateDocument": null,
"stateInscription": null,
"corporatePhone": null,
"isCorporate": true,
"profileCompleteOnLoading": true,
"profileErrorOnLoading": true,
"customerClass": null
},
"paymentData": {
"updateStatus": "string",
"installmentOptions": [
{
"paymentSystem": "string",
"bin": null,
"paymentName": null,
"paymentGroupName": null,
"value": 0,
"installments": [
{
"count": 0,
"hasInterestRate": true,
"interestRate": 0,
"value": 0,
"total": 0,
"sellerMerchantInstallments": [
{
"id": "string",
"count": 0,
"hasInterestRate": true,
"interestRate": 0,
"value": 0,
"total": 0
}
]
}
]
}
],
"paymentSystems": [
{
"id": 0,
"name": "string",
"groupName": "string",
"validator": {
"regex": "string",
"mask": "string",
"cardCodeRegex": "string",
"cardCodeMask": "string",
"weights": [
0
],
"useCvv": true,
"useExpirationDate": true,
"useCardHolderName": true,
"useBillingAddress": true
},
"stringId": "string",
"template": "string",
"requiresDocument": true,
"displayDocument": true,
"isCustom": true,
"description": null,
"requiresAuthentication": true,
"dueDate": "string",
"availablePayments": null
}
],
"payments": [
{
"paymentSystem": "string",
"bin": null,
"accountId": null,
"tokenId": null,
"installments": 0,
"referenceValue": 0,
"value": 0,
"merchantSellerPayments": [
{
"id": "string",
"installments": 0,
"referenceValue": 0,
"value": 0,
"interestRate": 0,
"installmentValue": 0
}
]
}
],
"giftCards": [
{
"redemptionCode": null,
"provider": "string",
"value": 0,
"balance": 0,
"name": "string",
"caption": "string",
"id": "string",
"inUse": true,
"isSpecialCard": true,
"groupName": "string"
}
],
"giftCardMessages": [
null
],
"availableAccounts": [
null
],
"availableTokens": [
null
],
"availableAssociations": {}
},
"marketingData": {
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": null,
"utmipage": null,
"utmiPart": null,
"utmiCampaign": "string",
"coupon": null,
"marketingTags": [
null
]
},
"sellers": [
{
"id": "string",
"name": "string",
"logo": "string"
}
],
"clientPreferencesData": {
"locale": "string",
"optinNewsLetter": true
},
"commercialConditionData": null,
"storePreferencesData": {
"countryCode": "string",
"saveUserData": true,
"timeZone": "string",
"currencyCode": "string",
"currencyLocale": 0,
"currencySymbol": "string",
"currencyFormatInfo": {
"currencyDecimalDigits": 0,
"currencyDecimalSeparator": "string",
"currencyGroupSeparator": "string",
"currencyGroupSize": 0,
"startsWithCurrencySymbol": true
}
},
"giftRegistryData": null,
"openTextField": null,
"invoiceData": null,
"customData": null,
"itemMetadata": {
"items": [
{
"id": "string",
"seller": "string",
"name": "string",
"skuName": "string",
"productId": "string",
"refId": "string",
"ean": "string",
"imageUrl": "string",
"detailUrl": "string",
"assemblyOptions": [
null
]
}
]
},
"hooksData": null,
"ratesAndBenefitsData": {
"rateAndBenefitsIdentifiers": [
null
],
"teaser": [
null
]
},
"subscriptionData": null,
"merchantContextData": null,
"purchaseAgentsData": null,
"itemsOrdination": null
}
Request
None