Plataformas Digitais - Brazil
  1. Shared
Plataformas Digitais - Brazil
  • SPDBR Journey API
  • Service PDP
    • Get Product by Slug V2
      GET
    • Get Translate review
      GET
    • Get product review
      GET
    • Get Product by Slug
      GET
  • Service Search
    • Search
      • Search Products by Term
      • teste, preco na busca
    • Autocomplete
      • Get Autocomplete suggestions
    • Recommendation
      • Pages Recommendations V3
    • TopSearch
  • Service Member
    • Address
      • UpdateAddress
      • AddAddress
      • RemoveAddress
      • GetAddress
    • Consent
      • UpdateConsent
      • GetConsent
    • Store
      • UpdateFavoriteStore
      • DeleteSportPratice
      • AddSportPratice
      • GetFavoriteStore
    • Purchase
      • GetPurchase
    • Profile
      • UpdateProfile
      • GetProfile
    • Login
      • RefreshToken
      • RefreshMemberToken
      • UserToken
    • User
      • UserDataCpf
      • UserDataCpf
  • Member Login
  • Service Checkout APP
    • Full Vtex
      • OrderForm
      • Items
      • Profile
      • Update Payment Data
      • Start Transaction
      • Send Payment Data
      • Proccess Order
    • APP
      • Cart
        • Get Or Create orderForm
        • Add Cart Items
        • Remove Cart Items
      • Profile
        • Check Guest checkout Eligibility
        • Guest Add Profile Data
        • Autenticated Profile
      • Shipping
        • Address
      • Payment
        • Guest Update Payment Method
        • Autenticated Update Payment Method
        • Guest Transaction
        • Autenticated Transaction
        • Send Payment Data
        • Process Order
      • Orderplaced
        • Autenticated OrderPlaced
        • Guest OrderPlaced
      • Shared
        • Clear orderForm Messages
          POST
        • Add Preference Data
          POST
        • Add Coupon
          POST
    • WEB
      • Create cart
      • Get cart
  • Service Omni
    • Orders
      • Get Orders
  • Service Events
    • List all events
  • Service app
    • Pix Email
      • Send Pix Email
  1. Shared

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

Responses

🟢200OK
application/json
Body
orderFormId
string 
required
salesChannel
string 
required
loggedIn
boolean 
required
isCheckedIn
boolean 
required
storeId
null 
required
checkedInPickupPointId
null 
required
allowManualPrice
boolean 
required
canEditData
boolean 
required
userProfileId
string 
required
userType
null 
required
ignoreProfileData
boolean 
required
value
integer 
required
messages
array
required
items
array [object {42}] 
required
uniqueId
string 
optional
id
string 
optional
productId
string 
optional
productRefId
string 
optional
refId
string 
optional
ean
string 
optional
name
string 
optional
skuName
string 
optional
modalType
null 
optional
parentItemIndex
null 
optional
parentAssemblyBinding
null 
optional
assemblies
array
optional
priceValidUntil
null 
optional
tax
integer 
optional
price
integer 
optional
listPrice
integer 
optional
manualPrice
null 
optional
manualPriceAppliedBy
null 
optional
sellingPrice
integer 
optional
rewardValue
integer 
optional
isGift
boolean 
optional
additionalInfo
object 
optional
preSaleDate
null 
optional
productCategoryIds
string 
optional
productCategories
object 
optional
quantity
integer 
optional
seller
string 
optional
sellerChain
array[string]
optional
imageUrl
string 
optional
detailUrl
string 
optional
components
array
optional
bundleItems
array
optional
attachments
array
optional
attachmentOfferings
array
optional
offerings
array
optional
priceTags
array
optional
availability
string 
optional
measurementUnit
string 
optional
unitMultiplier
integer 
optional
manufacturerCode
null 
optional
priceDefinition
object 
optional
taxCode
null 
optional
selectableGifts
array
required
totalizers
array
required
shippingData
object 
required
address
object 
required
logisticsInfo
array [object {8}] 
required
selectedAddresses
array [object {14}] 
required
availableAddresses
array [object {14}] 
required
pickupPoints
array
required
contactInformation
array
required
clientProfileData
object 
required
email
string 
required
firstName
string 
required
lastName
string 
required
document
string 
required
documentType
string 
required
phone
string 
required
corporateName
null 
required
tradeName
null 
required
corporateDocument
null 
required
stateInscription
null 
required
corporatePhone
null 
required
isCorporate
boolean 
required
profileCompleteOnLoading
boolean 
required
profileErrorOnLoading
boolean 
required
customerClass
null 
required
paymentData
object 
required
updateStatus
string 
required
installmentOptions
array [object {6}] 
required
paymentSystems
array [object {13}] 
required
payments
array [object {8}] 
required
giftCards
array [object {10}] 
required
giftCardMessages
array
required
availableAccounts
array
required
availableTokens
array
required
availableAssociations
object 
required
marketingData
object 
required
utmSource
string 
required
utmMedium
string 
required
utmCampaign
null 
required
utmipage
null 
required
utmiPart
null 
required
utmiCampaign
string 
required
coupon
null 
required
marketingTags
array
required
sellers
array [object {3}] 
required
id
string 
optional
name
string 
optional
logo
string 
optional
clientPreferencesData
object 
required
locale
string 
required
optinNewsLetter
boolean 
required
commercialConditionData
null 
required
storePreferencesData
object 
required
countryCode
string 
required
saveUserData
boolean 
required
timeZone
string 
required
currencyCode
string 
required
currencyLocale
integer 
required
currencySymbol
string 
required
currencyFormatInfo
object 
required
giftRegistryData
null 
required
openTextField
null 
required
invoiceData
null 
required
customData
null 
required
itemMetadata
object 
required
items
array [object {10}] 
required
hooksData
null 
required
ratesAndBenefitsData
object 
required
rateAndBenefitsIdentifiers
array
required
teaser
array
required
subscriptionData
null 
required
merchantContextData
null 
required
purchaseAgentsData
null 
required
itemsOrdination
null 
required
Previous
Guest OrderPlaced
Next
Add Preference Data
Built with