VTEX Custom Data API

The Custom Data API from VTEX — 2 operation(s) for custom data.

Documentation

📖
Documentation
https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works
📖
Documentation
https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet
📖
Documentation
https://developers.vtex.com/docs/guides/catalog-api-seller-portal-overview
📖
Documentation
https://developers.vtex.com/docs/guides/catalog-overview
📖
Documentation
https://developers.vtex.com/docs/guides/checkout-overview
📖
Documentation
https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0
📖
Documentation
https://help.vtex.com/en/tutorial/data-subject-rights--6imchxTx09icupKMbzHVIM
📖
Documentation
https://developers.vtex.com/docs/api-reference/do-api
📖
Documentation
https://developers.vtex.com/docs/guides/managing-vtex-gift-cards
📖
Documentation
https://developers.vtex.com/docs/guides/gift-card-integration-guide
📖
Documentation
https://developers.vtex.com/docs/guides/faststore/headless-cms-overview
📖
Documentation
https://developers.vtex.com/docs/api-reference/vtex-id-api
📖
Documentation
https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.search@1.0.8
📖
Documentation
https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj
📖
Documentation
https://developers.vtex.com/docs/guides/search-overview
📖
Documentation
https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3
📖
Documentation
https://developers.vtex.com/docs/guides/fulfillment
📖
Documentation
https://developers.vtex.com/docs/guides/marketplace-overview
📖
Documentation
https://developers.vtex.com/updates/release-notes/marketplace-protocol-documentation-update
📖
Documentation
https://developers.vtex.com/docs/guides/external-marketplace-integration-guide
📖
Documentation
https://developers.vtex.com/docs/guides/external-seller-integration-connector
📖
Documentation
https://developers.vtex.com/docs/guides/external-seller-integration-guide
📖
Documentation
https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw
📖
Documentation
https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials_84
📖
Documentation
https://developers.vtex.com/docs/guides/orders-overview
📖
Documentation
https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data
📖
Documentation
https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m
📖
Documentation
https://developers.vtex.com/docs/guides/payments-integration-guide
📖
Documentation
https://help.vtex.com/en/tutorial/vtex-pick-and-pack-last-mile--HN7WKV0xoq2ssVjsJlfzr
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-io-documentation-policies
📖
Documentation
https://developers.vtex.com/docs/guides/pricing-hub
📖
Documentation
https://developers.vtex.com/docs/guides/pricing-overview
📖
Documentation
https://developers.vtex.com/docs/guides/profile-system
📖
Documentation
https://developers.vtex.com/docs/guides/promotions-overview
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings
📖
Documentation
https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors
📖
Documentation
https://developers.vtex.com/docs/guides/sessions-system-overview
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-shipping-network
📖
Documentation
https://help.vtex.com/en/tutorial/sku-bindings--1SmrVgNwjJX17hdqwLa0TX
📖
Documentation
https://developers.vtex.com/docs/guides/subscriptions
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.search/suggestions
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-tracking

Specifications

OpenAPI Specification

vtex-custom-data-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account Custom Data 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: Custom Data
paths:
  /api/checkout/pub/orderForm/{orderFormId}/customData/{appId}:
    put:
      tags:
      - Custom Data
      summary: VTex Set multiple custom field values
      description: "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm) request. The values of these custom fields can then be updated by this request.\n\r\n\rTo do that, you need to inform the ID of the app you created with the configuration API (`appId`).\n\r\n\rIn the body of the request, for each field created in this app (`appFieldName`) you will inform a value (`appFieldValue`).\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\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| Checkout | CheckoutResources | **Read Shopping Cart** |\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: SetMultipleCustomFieldValues
      security: []
      parameters:
      - name: orderFormId
        in: path
        description: ID of the orderForm that will receive the new custom field values.
        required: true
        style: simple
        schema:
          type: string
          example: 29154e27383145cc8ce1f7a1df0d99c4
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: appId
        in: path
        description: ID of the app created with the configuration API.
        required: true
        style: simple
        schema:
          type: string
          example: appId
      requestBody:
        content:
          application/json:
            schema:
              description: Here you must add the pairs of Field Name and Field Value.
              type: object
              additionalProperties: true
              example:
                fieldName: fieldValue
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderForm'
              example:
                orderFormId: ede846222cd44046ba6c638442c3505a
                salesChannel: '1'
                loggedIn: false
                isCheckedIn: false
                storeId: '1'
                checkedInPickupPointId: '21'
                allowManualPrice: false
                canEditData: true
                userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94
                userType: User type
                ignoreProfileData: false
                value: 10000
                messages: []
                items:
                - uniqueId: E0F2B7AF5CD74D668F1E27537206912C
                  id: '1'
                  productId: '1'
                  productRefId: '1'
                  refId: '0001'
                  ean: '123456789'
                  name: Ração Royal Canin Feline Urinary 500g
                  skuName: Ração Royal Canin Feline Urinary 500g
                  modalType: null
                  parentItemIndex: null
                  parentAssemblyBinding: null
                  assemblies: []
                  priceValidUntil: '2021-02-27T14:59:00.8288784Z'
                  tax: 0
                  price: 15000
                  listPrice: 30000
                  manualPrice: 10000
                  sellingPrice: 10000
                  rewardValue: 0
                  isGift: false
                  additionalInfo:
                    brandName: Royal Canin
                    brandId: '2000000'
                    offeringInfo: null
                    offeringType: null
                    offeringTypeId: null
                  preSaleDate: null
                  productCategoryIds: /1/10/
                  productCategories:
                    '1': Alimentação
                    '10': Ração Seca
                  quantity: 1
                  seller: '1'
                  sellerChain:
                  - '1'
                  imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000
                  detailUrl: /racao-royal-canin-feline-urinary/p
                  components: []
                  bundleItems: []
                  attachments: []
                  attachmentOfferings: []
                  offerings: []
                  priceTags:
                  - name: DISCOUNT@MANUALPRICE
                    value: -5000
                    rawValue: -50
                    isPercentual: false
                    identifier: null
                  availability: available
                  measurementUnit: un
                  unitMultiplier: 1
                  manufacturerCode: null
                selectableGifts: []
                totalizers:
                - id: Items
                  name: Total dos Itens
                  value: 15000
                - id: Discounts
                  name: Total dos Descontos
                  value: -5000
                shippingData:
                  address: null
                  logisticsInfo:
                  - itemIndex: 0
                    selectedSla: Normal
                    selectedDeliveryChannel: delivery
                    addressId: 666c2e830bd9474ab6f6cc53fb6dd2d2
                    slas: []
                    shipsTo:
                    - BRA
                    itemId: '1'
                    deliveryChannels:
                    - id: pickup-in-point
                    - id: delivery
                  selectedAddresses: []
                  availableAddresses: []
                  pickupPoints: []
                clientProfileData: null
                paymentData:
                  installmentOptions:
                  - paymentSystem: 2
                    bin: null
                    paymentName: null
                    paymentGroupName: null
                    value: 10000
                    installments:
                    - count: 1
                      hasInterestRate: false
                      interestRate: 0
                      value: 10000
                      total: 10000
                      sellerMerchantInstallments:
                      - id: LOJADOBRENO
                        count: 1
                        hasInterestRate: false
                        interestRate: 0
                        value: 10000
                        total: 10000
                    - count: 2
                      hasInterestRate: false
                      interestRate: 0
                      value: 5000
                      total: 10000
                      sellerMerchantInstallments:
                      - id: LOJADOBRENO
                        count: 2
                        hasInterestRate: false
                        interestRate: 0
                        value: 5000
                        total: 10000
                  paymentSystems:
                  - id: 2
                    name: Visa
                    groupName: creditCardPaymentGroup
                    validator:
                      regex: ^4[0-9]{15}$
                      mask: 9999 9999 9999 9999
                      cardCodeRegex: ^[0-9]{3}$
                      cardCodeMask: '999'
                      weights:
                      - 2
                      - 1
                      - 2
                      - 1
                      useCvv: true
                      useExpirationDate: true
                      useCardHolderName: true
                      useBillingAddress: true
                    stringId: '2'
                    template: creditCardPaymentGroup-template
                    requiresDocument: false
                    isCustom: false
                    description: Payment description
                    requiresAuthentication: false
                    dueDate: '2020-03-05T16:42:31.7836281Z'
                    availablePayments: null
                  payments:
                  - paymentSystem: 6
                    bin: null
                    accountId: '12'
                    tokenId: null
                    value: 34390
                    referenceValue: 34390
                    giftCardRedemptionCode: null
                    giftCardProvider: null
                    giftCardId: null
                  giftCards: []
                  giftCardMessages: []
                  availableAccounts: []
                  availableTokens: []
                marketingData: null
                sellers:
                - id: '1'
                  name: lojadobreno
                  logo: Logo
                clientPreferencesData:
                  locale: pt-BR
                  optinNewsLetter: null
                commercialConditionData: null
                storePreferencesData:
                  countryCode: BRA
                  saveUserData: true
                  timeZone: E. South America Standard Time
                  currencyCode: BRL
                  currencyLocale: 1046
                  currencySymbol: R$
                  currencyFormatInfo:
                    currencyDecimalDigits: 2
                    currencyDecimalSeparator: ','
                    currencyGroupSeparator: .
                    currencyGroupSize: 3
                    startsWithCurrencySymbol: true
                giftRegistryData: null
                openTextField: null
                invoiceData: null
                customData:
                  customApps:
                  - fields:
                      testField1: testValue1
                      testField2: testValue2
                    id: abcd
                    major: 1
                itemMetadata:
                  items:
                  - id: '1'
                    seller: '1'
                    name: Ração Royal Canin Feline Urinary 500g
                    skuName: Ração Royal Canin Feline Urinary 500g
                    productId: '1'
                    refId: '0001'
                    ean: '123456789'
                    imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000
                    detailUrl: /racao-royal-canin-feline-urinary/p
                    assemblyOptions: []
                hooksData: null
                ratesAndBenefitsData:
                  rateAndBenefitsIdentifiers: []
                  teaser: []
                subscriptionData: null
                itemsOrdination:
                  criteria: NAME
                  ascending: true
      deprecated: false
  /api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName}:
    put:
      tags:
      - Custom Data
      summary: VTex Set single custom field value
      description: "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm) request. The value of a specific custom field can then be updated by this request.\n\r\n\rTo do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`).\n\r\n\rIn the body of the request, you will inform the new value (`appFieldValue`, passed through the body) of the specific field created in this app (identified by the `appFieldName` parameter, passed through the URL).\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\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| Checkout | CheckoutResources | **Read Shopping Cart** |\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: SetSingleCustomFieldValue
      security: []
      parameters:
      - name: orderFormId
        in: path
        description: The ID of the orderForm whose custom field's value you want to change.
        required: true
        style: simple
        schema:
          type: string
          example: 29154e27383145cc8ce1f7a1df0d99c4
      - name: appId
        in: path
        description: ID of the app created through the Update orderForm Configuration endpoint.
        required: true
        style: simple
        schema:
          type: string
          example: appId
      - name: appFieldName
        in: path
        description: Name of the app's field created through the Update orderForm Configuration endpoint.
        required: true
        style: simple
        schema:
          type: string
          example: appFieldName
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetsinglecustomfieldvalueRequest'
            example:
              value: '{appFieldValue}'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                orderFormId: ede846222cd44046ba6c638442c3505a
                salesChannel: '1'
                loggedIn: false
                isCheckedIn: false
                storeId: '1'
                checkedInPickupPointId: '21'
                allowManualPrice: false
                canEditData: true
                userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94
                userType: User type
                ignoreProfileData: false
                value: 10000
                messages: []
                items:
                - uniqueId: E0F2B7AF5CD74D668F1E27537206912C
                  id: '1'
                  productId: '1'
                  productRefId: '1'
                  refId: '0001'
                  ean: '123456789'
                  name: Ração Royal Canin Feline Urinary 500g
                  skuName: Ração Royal Canin Feline Urinary 500g
                  modalType: null
                  parentItemIndex: null
                  parentAssemblyBinding: null
                  assemblies: []
                  priceValidUntil: '2021-02-27T14:59:00.8288784Z'
                  tax: 0
                  price: 15000
                  listPrice: 30000
                  manualPrice: 10000
                  sellingPrice: 10000
                  rewardValue: 0
                  isGift: false
                  additionalInfo:
                    brandName: Royal Canin
                    brandId: '2000000'
                    offeringInfo: null
                    offeringType: null
                    offeringTypeId: null
                  preSaleDate: null
                  productCategoryIds: /1/10/
                  productCategories:
                    '1': Alimentação
                    '10': Ração Seca
                  quantity: 1
                  seller: '1'
                  sellerChain:
                  - '1'
                  imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000
                  detailUrl: /racao-royal-canin-feline-urinary/p
                  components: []
                  bundleItems: []
                  attachments: []
                  attachmentOfferings: []
                  offerings: []
                  priceTags:
                  - name: DISCOUNT@MANUALPRICE
                    value: -5000
                    rawValue: -50
                    isPercentual: false
                    identifier: null
                  availability: available
                  measurementUnit: un
                  unitMultiplier: 1
                  manufacturerCode: null
                selectableGifts: []
                totalizers:
                - id: Items
                  name: Total dos Itens
                  value: 15000
                - id: Discounts
                  name: Total dos Descontos
                  value: -5000
                shippingData:
                  address: null
                  logisticsInfo:
                  - itemIndex: 0
                    selectedSla: Normal
                    selectedDeliveryChannel: delivery
                    addressId: 666c2e830bd9474ab6f6cc53fb6dd2d2
                    slas: []
                    shipsTo:
                    - BRA
                    itemId: '1'
                    deliveryChannels:
                    - id: pickup-in-point
                    - id: delivery
                  selectedAddresses: []
                  availableAddresses: []
                  pickupPoints: []
                clientProfileData: null
                paymentData:
                  installmentOptions:
                  - paymentSystem: 2
                    bin: null
                    paymentName: null
                    paymentGroupName: null
                    value: 10000
                    installments:
                    - count: 1
                      hasInterestRate: false
                      interestRate: 0
                      value: 10000
                      total: 10000
                      sellerMerchantInstallments:
                      - id: LOJADOBRENO
                        count: 1
                        hasInterestRate: false
                        interestRate: 0
                        value: 10000
                        total: 10000
                    - count: 2
                      hasInterestRate: false
                      interestRate: 0
                      value: 5000
                      total: 10000
                      sellerMerchantInstallments:
                      - id: LOJADOBRENO
                        count: 2
                        hasInterestRate: false
                        interestRate: 0
                        value: 5000
                        total: 10000
                  paymentSystems:
                  - id: 2
                    name: Visa
                    groupName: creditCardPaymentGroup
                    validator:
                      regex: ^4[0-9]{15}$
                      mask: 9999 9999 9999 9999
                      cardCodeRegex: ^[0-9]{3}$
                      cardCodeMask: '999'
                      weights:
                      - 2
                      - 1
                      - 2
                      - 1
                      - 2
                      useCvv: true
                      useExpirationDate: true
                      useCardHolderName: true
                      useBillingAddress: true
                    stringId: '2'
                    template: creditCardPaymentGroup-template
                    requiresDocument: false
                    isCustom: false
                    description: Payment description
                    requiresAuthentication: false
                    dueDate: '2020-03-05T16:42:31.7836281Z'
                    availablePayments: null
                  payments:
                  - paymentSystem: 6
                    bin: null
                    accountId: '12'
                    tokenId: null
                    value: 34390
                    referenceValue: 34390
                    giftCardRedemptionCode: null
                    giftCardProvider: null
                    giftCardId: null
                  giftCards: []
                  giftCardMessages: []
                  availableAccounts: []
                  availableTokens: []
                marketingData: null
                sellers:
                - id: '1'
                  name: lojadobreno
                  logo: Logo
                clientPreferencesData:
                  locale: pt-BR
                  optinNewsLetter: null
                commercialConditionData: null
                storePreferencesData:
                  countryCode: BRA
                  saveUserData: true
                  timeZone: E. South America Standard Time
                  currencyCode: BRL
                  currencyLocale: 1046
                  currencySymbol: R$
                  currencyFormatInfo:
                    currencyDecimalDigits: 2
                    currencyDecimalSeparator: ','
                    currencyGroupSeparator: .
                    currencyGroupSize: 3
                    startsWithCurrencySymbol: true
                giftRegistryData: null
                openTextField: null
                invoiceData: null
                customData:
                  customApps:
                  - fields:
                      testField1: Hello World
                      testField2: testValue2
                    id: abcd
                    major: 1
                itemMetadata:
                  items:
                  - id: '1'
                    seller: '1'
                    name: Ração Royal Canin Feline Urinary 500g
                    skuName: Ração Royal Canin Feline Urinary 500g
                    productId: '1'
                    refId: '0001'
                    ean: '123456789'
                    imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000
                    detailUrl: /racao-royal-canin-feline-urinary/p
                    assemblyOptions: []
                hooksData: null
                ratesAndBenefitsData:
                  rateAndBenefitsIdentifiers: []
                  teaser: []
                subscriptionData: null
                itemsOrdination:
                  criteria: NAME
                  ascending: true
              schema:
                $ref: '#/components/schemas/orderForm'
      deprecated: false
    delete:
      tags:
      - Custom Data
      summary: VTex Remove single custom field value
      description: "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm) request. The value of a specific custom field can be removed by this request.\n\r\n\rTo do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`).\n\r\n\rYou also need to iform the specific field created in this app (identified by the `appFieldName` parameter, also passed through the URL) whose value you want to remove.\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| Checkout | CheckoutResources | **Read Shopping Cart** |\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: Removesinglecustomfieldvalue
      security: []
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: orderFormId
        in: path
        description: The ID of the orderForm from which you want to remove the custom field value.
        required: true
        style: simple
        schema:
          type: string
          example: 29154e27383145cc8ce1f7a1df0d99c4
      - name: appId
        in: path
        description: ID of the app created through the Update orderForm Configuration endpoint.
        required: true
        style: simple
        schema:
          type: string
          example: appId
      - name: appFieldName
        in: path
        description: Name of the app's field created through the Update orderForm Configuration endpoint and which will be deleted.
        required: true
        style: simple
        schema:
          type: string
          example: appFieldName
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                orderFormId: ede846222cd44046ba6c638442c3505a
                salesChannel: '1'
                loggedIn: false
                isCheckedIn: false
                storeId: '1'
                checkedInPickupPointId: '21'
                allowManualPrice: false
                canEditData: true
                userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94
                userType: User type
                ignoreProfileData: false
                value: 10000
                messages: []
                items:
                - uniqueId: E0F2B7AF5CD74D668F1E27537206912C
                  id: '1'
                  productId: '1'
                  productRefId: '1'
                  refId: '0001'
                  ean: '123456789'
                  name: Ração Royal Canin Feline Urinary 500g
                  skuName: Ração Royal Canin Feline Urinary 500g
                  modalType: null
                  parentItemIndex: null
                  parentAssemblyBinding: null
                  assemblies: []
                  priceValidUntil: '2021-02-27T14:59:00.8288784Z'
                  tax: 0
                  price: 15000
                  listPrice: 30000
                  manualPrice: 10000
                  sellingPrice: 10000
                  rewardValue: 0
                  isGift: false
                  additionalInfo:
                    brandName: Royal Canin
                    brandId: '2000000'
                    offeringInfo: null
                    offeringType: null
                    offeringTypeId: null
                  preSaleDate: null
                  productCategoryIds: /1/10/
                  productCategories:
                    '1': Alimentação
                    '10': Ração Seca
                  quantity: 1
                  seller: '1'
                  sellerChain:
                  - '1'
                  imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000
                  detailUrl: /racao-royal-canin-feline-urinary/p
                  components: []
                  bundleItems: []
                  attachments: []
                  attach

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-custom-data-api-openapi.yml