VTvtex
Configuration

Get order form configuration

Changed on

Retrieves the settings that are currently applied to every orderForm in the account.

These settings are defined by the request Update order form configuration.

Always use this request to retrieve the current configuration before performing an update. By doing so, you ensure that you are modifying only the properties you want.

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.

get/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.

Response

OK

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 nullable

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

maskFirstPurchaseDataboolean nullable

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

recaptchaValidationstring

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.

  • "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.

Changes

  • c172274d5facRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status