VTvtex
Configuration

Create order form configuration

Changed on

Creates the settings that will apply to every orderForm in the account.

For example, if you create an app using this request, every orderForm of this account will have the custom fields created through it.

⚠️ We recommend using the request Update order form configuration instead, even when changing several properties, since it only changes the properties sent in the request body and keeps all others unchanged. If you use this request, always retrieve the current configuration beforehand using the request Get orderForm configuration.

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 403 status code. 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.

post/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 required

Minimum SKU quantity by cart.

decimalDigitsPrecisioninteger required

Number of price digits.

minimumValueAccumulatedinteger nullable required

Minimum cart value.

allowMultipleDeliveriesboolean nullable required

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

allowManualPriceboolean nullable required

Allows the editing of SKU prices right in the cart.

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 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
  },
  "taxConfiguration": null,
  "minimumQuantityAccumulatedForItems": 1,
  "decimalDigitsPrecision": 2,
  "minimumValueAccumulated": null,
  "apps": null,
  "allowMultipleDeliveries": null,
  "allowManualPrice": null
}

Response

No Content

Changes

  • ac4514e99654Revision changes
    • info

      api operation id UpdateorderFormconfiguration removed and replaced with CreateorderFormconfiguration

  • c172274d5facRevision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property