VTEX Store Configuration API

openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account Store Configuration API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: Store Configuration
paths:
  /api/creditcontrol/storeconfig:
    get:
      tags:
      - Store Configuration
      summary: VTex Retrieve store configuration
      description: "Gets store configuration data related to [customer credit accounts](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Store Configuration | **Read Configuration** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: Retrievestoreconfiguration
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - dailyInterestRate
                - invoicePostponementLimit
                - taxRate
                - maxPostponementDays
                - defaultCreditValue
                - postponementEnabled
                - automaticCheckingAccountCreationEnabled
                - toleranceEnabled
                - myCreditsEnabled
                - maxPreAuthorizationGrowthRate
                type: object
                properties:
                  dailyInterestRate:
                    type: number
                    description: Daily interest rate (percent 0.1 = 10%).
                  invoicePostponementLimit:
                    type: number
                    description: Maximum number of postponements allowed.
                  taxRate:
                    type: number
                    description: Tax rate value (percent 0.1 = 10%).
                  maxPostponementDays:
                    type: number
                    description: Maximum number of days of postponement.
                  defaultCreditValue:
                    type: number
                    description: Default credit amount.
                  postponementEnabled:
                    type: boolean
                    description: Postponement option activated.
                    default: false
                  automaticCheckingAccountCreationEnabled:
                    type: boolean
                    description: Allows users who have not previously received credit to complete an order.
                    default: false
                  toleranceEnabled:
                    type: boolean
                    description: Allows orders to be placed even if they exceed X % of the account's credit limit.
                    default: false
                  myCreditsEnabled:
                    type: boolean
                    description: Show the [My Credits](https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0#my-credits) page on storefront.
                    default: false
                  maxPreAuthorizationGrowthRate:
                    type: number
                    description: Pre-authorization growth-rate value (percent 0.1 = 10%).
                  notificationsSettings:
                    type: object
                    description: Notification settings information.
                    properties:
                      daysPrior:
                        type: array
                        description: Notification information sent before invoice payment date.
                        items:
                          required:
                          - days
                          - timeOfDay
                          type: object
                          description: Object with information about the moment when the notification is sent.
                          properties:
                            days:
                              type: integer
                              description: How many days before the invoice payment date is the notification sent.
                            timeOfDay:
                              type: string
                              description: Notification sending time.
                      daysAfter:
                        type: array
                        description: Notification information sent after invoice payment date.
                        items:
                          required:
                          - days
                          - timeOfDay
                          type: object
                          description: Object with information about the moment when the notification is sent.
                          properties:
                            days:
                              type: integer
                              description: How many days after the invoice payment date is the notification sent.
                            timeOfDay:
                              type: string
                              description: Notification sending time.
              example:
                dailyInterestRate: 0
                invoicePostponementLimit: 0
                taxRate: 0
                maxPostponementDays: 0
                defaultCreditValue: 2000
                postponementEnabled: false
                automaticCheckingAccountCreationEnabled: false
                toleranceEnabled: false
                myCreditsEnabled: false
                maxPreAuthorizationGrowthRate: 0
                notificationsSettings:
                  daysPrior:
                  - days: 5
                    timeOfDay: '12:00:00'
                  - days: 1
                    timeOfDay: '12:00:00'
                  - days: 0
                    timeOfDay: '12:00:00'
                  daysAfter:
                  - days: 3
                    timeOfDay: '12:00:00'
      deprecated: false
    put:
      tags:
      - Store Configuration
      summary: VTex Create or change store configuration
      description: "Creates or changes store configuration data related to [customer credit accounts](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Store Configuration | **Edit Configuration** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: Createorchangestoreconfiguration
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - dailyInterestRate
              - invoicePostponementLimit
              - taxRate
              - maxPostponementDays
              - defaultCreditValue
              - maxPreAuthorizationGrowthRate
              - myCreditsEnabled
              - toleranceEnabled
              - automaticCheckingAccountCreationEnabled
              - postponementEnabled
              type: object
              properties:
                dailyInterestRate:
                  type: number
                  description: Daily interest rate (percent 0.1 = 10%).
                  example: 0.01
                invoicePostponementLimit:
                  type: number
                  description: Maximum number of postponements allowed.
                  example: 2
                taxRate:
                  type: number
                  description: Tax rate value (percent 0.1 = 10%).
                  example: 0.4
                maxPostponementDays:
                  type: number
                  description: Maximum number of days of postponement.
                  example: 3
                defaultCreditValue:
                  type: number
                  description: Default credit amount.
                  example: 150
                maxPreAuthorizationGrowthRate:
                  type: number
                  description: Pre-authorization growth rate value (percent 0.1 = 10%).
                  example: 0.1
                myCreditsEnabled:
                  type: boolean
                  description: Show the [My Credits](https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0#my-credits) page on storefront.
                  example: true
                toleranceEnabled:
                  type: boolean
                  description: Allows orders to be placed even if they exceed X % of the account's credit limit.
                  example: true
                automaticCheckingAccountCreationEnabled:
                  type: boolean
                  description: Allows users who have not previously received credit to complete an order.
                  example: true
                postponementEnabled:
                  type: boolean
                  description: Postponement option activated.
                  example: true
                notificationsSettings:
                  type: object
                  description: Notification settings information.
                  properties:
                    daysPrior:
                      type: array
                      description: Notification information sent before invoice payment date.
                      items:
                        required:
                        - days
                        - timeOfDay
                        type: object
                        description: Object with information about the moment when the notification is sent.
                        properties:
                          days:
                            type: integer
                            description: How many days before the invoice payment date is the notification sent.
                            example: 1
                          timeOfDay:
                            type: string
                            description: Notification sending time.
                            example: '16:00:00'
                    daysAfter:
                      type: array
                      description: Notification information sent after invoice payment date.
                      items:
                        required:
                        - days
                        - timeOfDay
                        type: object
                        description: Object with information about the moment when the notification is sent.
                        properties:
                          days:
                            type: integer
                            description: How many days after the invoice payment date is the notification sent.
                            example: 0
                          timeOfDay:
                            type: string
                            description: Notification sending time.
                            example: '12:00:00'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - dailyInterestRate
                - invoicePostponementLimit
                - taxRate
                - maxPostponementDays
                - defaultCreditValue
                - postponementEnabled
                - automaticCheckingAccountCreationEnabled
                - toleranceEnabled
                - myCreditsEnabled
                - maxPreAuthorizationGrowthRate
                type: object
                properties:
                  dailyInterestRate:
                    type: number
                    description: Daily interest rate (percent 0.1 = 10%).
                  invoicePostponementLimit:
                    type: number
                    description: Maximum number of postponements allowed.
                  taxRate:
                    type: number
                    description: Tax rate value (percent 0.1 = 10%).
                  maxPostponementDays:
                    type: number
                    description: Maximum number of days of postponement.
                  defaultCreditValue:
                    type: number
                    description: Default credit amount.
                  postponementEnabled:
                    type: boolean
                    description: Postponement option activated.
                    default: false
                  automaticCheckingAccountCreationEnabled:
                    type: boolean
                    description: Allows users who have not previously received credit to complete an order.
                    default: false
                  toleranceEnabled:
                    type: boolean
                    description: Allows orders to be placed even if they exceed X % of the account's credit limit.
                    default: false
                  myCreditsEnabled:
                    type: boolean
                    description: Show the [My Credits](https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0#my-credits) page on storefront.
                    default: false
                  maxPreAuthorizationGrowthRate:
                    type: number
                    description: Pre-authorization growth rate value (percent 0.1 = 10%).
                  notificationsSettings:
                    type: object
                    description: Notification settings information.
                    properties:
                      daysPrior:
                        type: array
                        description: Notification information sent before invoice payment date.
                        items:
                          required:
                          - days
                          - timeOfDay
                          type: object
                          description: Object with information about the moment when the notification is sent.
                          properties:
                            days:
                              type: integer
                              description: How many days before the invoice payment date is the notification sent.
                            timeOfDay:
                              type: string
                              description: Notification sending time.
                      daysAfter:
                        type: array
                        description: Notification information sent after invoice payment date.
                        items:
                          required:
                          - days
                          - timeOfDay
                          type: object
                          description: Object with information about the moment when the notification is sent.
                          properties:
                            days:
                              type: integer
                              description: How many days after the invoice payment date is the notification sent.
                            timeOfDay:
                              type: string
                              description: Notification sending time.
              example:
                dailyInterestRate: 0.01
                invoicePostponementLimit: 2
                taxRate: 0.4
                maxPostponementDays: 3
                defaultCreditValue: 150
                postponementEnabled: false
                automaticCheckingAccountCreationEnabled: false
                toleranceEnabled: false
                myCreditsEnabled: false
                maxPreAuthorizationGrowthRate: 0.1
                notificationsSettings:
                  daysPrior:
                  - days: 5
                    timeOfDay: '12:00:00'
                  - days: 1
                    timeOfDay: '12:00:00'
                  - days: 0
                    timeOfDay: '12:00:00'
                  daysAfter:
                  - days: 3
                    timeOfDay: '12:00:00'
      deprecated: false
components:
  parameters:
    Accept:
      name: Accept
      in: header
      description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
    Content-Type:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
  securitySchemes:
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'