Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-28250234.8 KB
Store Configuration

Retrieve store configuration

Gets store configuration data related to customer credit accounts.

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
Credit ControlMainMain Access
Credit ControlStore ConfigurationRead 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/creditcontrol/storeconfig

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

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

Response

OK

dailyInterestRatenumber required

Daily interest rate (percent 0.1 = 10%).

invoicePostponementLimitnumber required

Maximum number of postponements allowed.

taxRatenumber required

Tax rate value (percent 0.1 = 10%).

maxPostponementDaysnumber required

Maximum number of days of postponement.

defaultCreditValuenumber required

Default credit amount.

postponementEnabledboolean required

Postponement option activated.

automaticCheckingAccountCreationEnabledboolean required

Allows users who have not previously received credit to complete an order.

toleranceEnabledboolean required

Allows orders to be placed even if they exceed X % of the account's credit limit.

myCreditsEnabledboolean required

Show the My Credits page on storefront.

maxPreAuthorizationGrowthRatenumber required

Pre-authorization growth-rate value (percent 0.1 = 10%).