VTvtex
Configuration

Update order form configuration

Changed on

Updates specific properties of the settings that apply to every orderForm in the account. Only the properties sent in the request body are changed, and all other properties keep their current values.

To check the current configuration, use the request Get orderForm configuration.

⚠️ The apps field cannot be modified through this endpoint. Requests that include it return a 400 status code with the CHK0288 error code.

⚠️ Some properties are restricted and can only be changed by VTEX internal teams. Requests from other users that attempt to change a restricted property return a 403 status code with the CHK003 error code.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
CheckoutCheckoutResourcesSave OrderForm Configuration

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

patch/api/checkout/pvt/configuration/orderForm

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/checkout/pvt/configuration/orderForm
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Query parameters

individualShippingEstimatesboolean
Example:true

Shows the product's estimated shipping date in the shippingEstimate field from the orderForm.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

minimumQuantityAccumulatedForItemsinteger

Minimum SKU quantity by cart.

decimalDigitsPrecisioninteger

Number of price digits.

minimumValueAccumulatedinteger nullable

Minimum cart value.

allowMultipleDeliveriesboolean nullable

On the same purchase, allows the selection of items from multiple delivery channels.

allowManualPriceboolean nullable

Allows the editing of SKU prices right in the cart.

savePersonalDataAsOptInboolean nullable

Allows users to select whether they want the store to keep their personal and payment data saved.

maxNumberOfWhiteLabelSellersinteger

Allows the input of a limit of white label sellers involved on the cart.

maskFirstPurchaseDataboolean

Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client doesn't want to share its data.

maskStateOnAddressboolean

If the response body is masked, on a first purchase, this flag causes the state (UF) to be masked. The default behavior is to be masked.

recaptchaValidationstring nullable

Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about reCAPTCHA validation for VTEX stores

Possible values are:

  • "never": no purchases are validated with reCAPTCHA.
  • null: no purchases are validated with reCAPTCHA. The same as never.
  • "always": every purchase is validated with reCAPTCHA.
  • "vtexCriteria": only some purchases are validated with reCAPTCHA in order to minimize friction and improve the shopping experience. VTEX’s algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option.
paymentSystemToCheckFirstInstallmentstring

If you want to apply a first installment discount to a particular payment system, set this field to that payment system's ID. Learn more: Configuring a discount for orders prepaid in full.

Example request

{
  "paymentConfiguration": {
    "requiresAuthenticationForPreAuthorizedPaymentOption": false,
    "allowInstallmentsMerge": false,
    "blockPaymentSession": false
  },
  "taxConfiguration": {
    "appId": "12345"
  },
  "recaptchaValidation": "vtexCriteria",
  "paymentSystemToCheckFirstInstallment": "6"
}

Response

OK

object required

Complete orderForm configuration of the account after the update. For more details about each property, see Get orderForm configuration.

Changes

  • a3bcd26e4dcbRevision changes
    • breaking

      removed the success response with the status

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status

  • ac4514e99654Revision changes
    • info

      endpoint added