{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Custom Data API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Custom Data",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Set multiple custom field values",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{providerApiEndpoint}/api/checkout/pub/orderForm/:orderFormId/customData/:appId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderFormId",
                "value": "",
                "type": "path",
                "description": "ID of the orderForm that will receive the new custom field values."
              },
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "ID of the app created with the configuration API."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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 val"
        },
        {
          "info": {
            "name": "VTex Set single custom field value",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{providerApiEndpoint}/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderFormId",
                "value": "",
                "type": "path",
                "description": "The ID of the orderForm whose custom field's value you want to change."
              },
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "ID of the app created through the Update orderForm Configuration endpoint."
              },
              {
                "name": "appFieldName",
                "value": "",
                "type": "path",
                "description": "Name of the app's field created through the Update orderForm Configuration endpoint."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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 thro"
        },
        {
          "info": {
            "name": "VTex Remove single custom field value",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{providerApiEndpoint}/api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderFormId",
                "value": "",
                "type": "path",
                "description": "The ID of the orderForm from which you want to remove the custom field value."
              },
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "ID of the app created through the Update orderForm Configuration endpoint."
              },
              {
                "name": "appFieldName",
                "value": "",
                "type": "path",
                "description": "Name of the app's field created through the Update orderForm Configuration endpoint and which will be deleted."
              }
            ]
          },
          "docs": "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 `appFieldNa"
        }
      ]
    }
  ],
  "bundled": true
}