---
title: "Get order form configuration"
method: GET
path: "/api/checkout/pvt/configuration/orderForm"
tags: ["Configuration"]
---

# Get order form configuration

`GET /api/checkout/pvt/configuration/orderForm`

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


These settings are defined by the request [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm).


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](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Checkout | CheckoutResources | **Save OrderForm Configuration** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Query parameters

- `individualShippingEstimates` boolean

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `paymentConfiguration` object — Payment configuration information.
    - `requiresAuthenticationForPreAuthorizedPaymentOption` boolean — Determines whether pre-authorized payments require authentication.
    - `allowInstallmentsMerge` boolean — By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installment options configured by every seller will be available. When indicated as `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those do not match. Installment values may not be equal in this case.
  - `taxConfiguration` object, nullable — External tax service configuration information.
    - `url` string, nullable — Endpoint URL.
    - `authorizationHeader` string, nullable — Authorization header.
    - `appId` string — Custom data ID sent to the tax system.
    - `isMarketplaceResponsibleForTaxes` boolean — Indicates whether the marketplace is responsible for the products taxes.
  - `minimumQuantityAccumulatedForItems` integer — Minimum SKU quantity by cart.
  - `decimalDigitsPrecision` integer — Number of price digits.
  - `minimumValueAccumulated` integer, nullable — Minimum cart value.
  - `apps` object[], nullable — Array of objects containing Apps configuration information.
    - `id` string — App ID.
    - `fields` string[] — Array of fields available to the app.
    - `major` integer — App major version.
  - `allowMultipleDeliveries` boolean, nullable — On the same purchase, allows the selection of items from multiple delivery channels.
  - `allowManualPrice` boolean, nullable — Allows the editing of SKU prices right in the cart.
  - `savePersonalDataAsOptIn` boolean, nullable — Allows users to select whether they want the store to keep their personal and payment data saved.
  - `maxNumberOfWhiteLabelSellers` integer, nullable — Allows the input of a limit of white label sellers involved on the cart.
  - `maskFirstPurchaseData` boolean, 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.
  - `recaptchaValidation` string — 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](https://help.vtex.com/en/tutorial/using-recaptcha-at-checkout--18Te3oDd7f4qcjKu9jhNzP) 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.

---

[API](https://skmtc.net/vtex/apis/checkout-api.md) · [All operations](https://skmtc.net/vtex/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/checkout-api/versions/fc777477b318/schema)