{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Cart Attachments API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Cart Attachments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Get client profile by email",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/checkout/pub/profiles",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Client's email address to be searched."
              },
              {
                "name": "ensureComplete",
                "value": "",
                "type": "query",
                "description": "Indicates whether the returned profiles must be complete or not."
              }
            ]
          },
          "docs": "Retrieves a client's profile information by providing an email address.\n\r\n\rIf the response body fields are empty, the following situations may have occurred:\n\r\n\r1. There is no client registered with the email address provided in your store, or;\n\r2. Client profile is invalid or incomplete. However, you can use the query parameter `ensureComplete=false` to get incomplete profiles. For more information, see [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/s"
        },
        {
          "info": {
            "name": "VTex Add client profile",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/checkout/pub/orderForm/:orderFormId/attachments/clientProfileData",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderFormId",
                "value": "",
                "type": "path",
                "description": "ID of the orderForm that will receive client profile information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this request to include client profile information to a given shopping cart.\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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n>⚠️ The authentication of this endpoint can change depending on the customer context. If you are modifying information f"
        },
        {
          "info": {
            "name": "VTex Add shipping address and select delivery option",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/checkout/pub/orderForm/:orderFormId/attachments/shippingData",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderFormId",
                "value": "",
                "type": "path",
                "description": "ID of the orderForm that will receive client profile information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this request to include shipping information and/or selected delivery option to a given shopping cart.\r\n\r\nTo add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array.\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.\n\r\n\r> This request has a time "
        },
        {
          "info": {
            "name": "VTex Add client preferences",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/checkout/pub/orderForm/:orderFormId/attachments/clientPreferencesData",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderFormId",
                "value": "",
                "type": "path",
                "description": "ID of the orderForm that will receive client profile information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this request to include client preferences information to a given shopping cart.\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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-app"
        },
        {
          "info": {
            "name": "VTex Add marketing data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/checkout/pub/orderForm/:orderFormId/attachments/marketingData",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderFormId",
                "value": "",
                "type": "path",
                "description": "ID of the orderForm that will receive client profile information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this request to include marketing information to a given shopping cart.\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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-"
        },
        {
          "info": {
            "name": "VTex Add payment data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/checkout/pub/orderForm/:orderFormId/attachments/paymentData",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderFormId",
                "value": "",
                "type": "path",
                "description": "ID of the orderForm that will receive client profile information."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this request to include payment information to a given shopping cart. The payment information attachment in the shopping cart does not determine the final order payment method in itself. However, it allows tha platform to update any relevant information that may be impacted by the payment method.\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 `orderFo"
        },
        {
          "info": {
            "name": "VTex Add merchant context data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/checkout/pub/orderForm/:orderFormId/attachments/merchantContextData",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "orderFormId",
                "value": "",
                "type": "path",
                "description": "ID of the orderForm that will receive the relevant information added by the merchant."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is used for the merchant to add to the cart any relevant information that is related to the context of a specific order.\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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers"
        }
      ]
    }
  ],
  "bundled": true
}