Store Configuration

Create or change store configuration

Changed on Dec 21, 2023

Creates or changes 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:

Product	Category	Resource
Credit Control	Main	Main Access
Credit Control	Store Configuration	Edit 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.

put/api/creditcontrol/storeconfig

Request

Base URL
https://apiexamples.vtexcommercestable.com.br
URL
https://apiexamples.vtexcommercestable.com.br/api/creditcontrol/storeconfig
Auth
- API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
- or API key in header VtexIdclientAutCookie

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.

Request body

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.

maxPreAuthorizationGrowthRatenumber required

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

myCreditsEnabledboolean required

Show the My Credits page on storefront.

toleranceEnabledboolean required

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

automaticCheckingAccountCreationEnabledboolean required

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

postponementEnabledboolean required

Postponement option activated.

Example request

{
  "dailyInterestRate": 0.01,
  "invoicePostponementLimit": 2,
  "taxRate": 0.4,
  "maxPostponementDays": 3,
  "defaultCreditValue": 150,
  "maxPreAuthorizationGrowthRate": 0.1,
  "myCreditsEnabled": true,
  "toleranceEnabled": true,
  "automaticCheckingAccountCreationEnabled": true,
  "postponementEnabled": true,
  "notificationsSettings": {
    "daysPrior": [
      {
        "days": 1,
        "timeOfDay": "16:00:00"
      }
    ],
    "daysAfter": [
      {
        "timeOfDay": "12:00:00"
      }
    ]
  }
}

Response