VTEX Purchase Information API

openapi: 3.2.0
info:
  title: VTex Profile System - PII data architecture Purchase Information API
  description: '>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.

    >

    > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).


    The **Profile System** is VTEX''s single source of truth regarding shoppers'' profile data for stores using the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture-specifications) from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus). Other modules, such as **Checkout** and **Order Management**, can request data from the **Profile System** when necessary. Learn more at the [Profile System](https://developers.vtex.com/docs/guides/profile-system) guide.


    >⚠️ Data stored in the Profile System is not related to documents saved in [Master Data v1](https://developers.vtex.com/docs/api-reference/masterdata-api) or [Master Data v2](https://developers.vtex.com/docs/api-reference/master-data-api-v2). The API endpoints and features described in this article only apply to documents registered in the new Profile System designed to handle PII data architecture.


    ## Index


    ### Profiles


    - `POST` [Create client profile](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles)

    - `GET` [Get profile](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-)

    - `PATCH` [Update client profile](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/profiles/-profileId-)

    - `DELETE` [Delete client profile](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/profiles/-profileId-)

    - `GET` [Get unmasked profile](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/unmask)

    - `GET` [Get profile by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/versions/-profileVersionId-)

    - `GET` [Get unmasked profile by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/versions/-profileVersionId-/unmask)


    ### Addresses


    - `POST` [Create client address](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/addresses)

    - `GET` [Get client addresses](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses)

    - `GET` [Get unmasked client addresses](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/unmask)

    - `GET` [Get address](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)

    - `PATCH` [Update client address](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)

    - `DELETE` [Delete address](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)

    - `GET` [Get unmasked address](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/unmask)

    - `GET` [Get address by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/versions/-addressVersionId-)

    - `GET` [Get unmasked address by version](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/versions/-addressVersionId-/unmask)


    ### Prospects


    - `POST` [Create prospect](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/prospects)

    - `GET` [Get prospect](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/-prospectId-)

    - `PATCH` [Update prospect](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/prospects/-prospectId-)

    - `DELETE` [Delete prospect](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/prospects/-prospectId-)

    - `GET` [Get unmasked prospect](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/prospects/-prospectId-/unmask)


    ### Purchase information


    - `POST` [Create purchase information](https://developers.vtex.com/docs/api-reference/profile-system#post-/api/storage/profile-system/profiles/-profileId-/purchase-info)

    - `GET` [Get purchase information](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/purchase-info)

    - `PATCH` [Update purchase information](https://developers.vtex.com/docs/api-reference/profile-system#patch-/api/storage/profile-system/profiles/-profileId-/purchase-info)

    - `DELETE` [Delete purchase information](https://developers.vtex.com/docs/api-reference/profile-system#delete-/api/storage/profile-system/profiles/-profileId-/purchase-info)

    - `GET` [Get unmasked profile information](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/purchase-info/unmask)'
  contact: {}
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL.
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey: []
  appToken: []
- VtexIdclientAutCookie: []
tags:
- name: Purchase Information
paths:
  /api/storage/profile-system/profiles/{profileId}/purchase-info:
    post:
      tags:
      - Purchase Information
      summary: VTex Create purchase information
      description: 'Creates purchase information for a given client profile.


        Learn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.


        >⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.

        >

        > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).


        ## Permissions


        Any 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:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | Profile System | Documents | **Get Item** |

        | Profile System | Documents | **Save and Update Item** |

        | Profile System | Documents | **Delete Item** |


        There 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).


        >❗ 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: CreatePurchaseInformation
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/alternativeKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseInfo'
            example:
              paymentData:
                availableAccounts:
                - accountId: D09F5E3F01054C959CFC4CB357961ADE
                  paymentSystem: '2'
                  paymentSystemName: Visa
                  cardNumber: '************1111'
                  bin: '44443334'
                  availableAddresses:
                  - db267dcc53c14fb2b9a985532dd287bc
                  expirationDate: 01/2032
                  isExpired: false
                  accountStatus: null
                availableTokens: []
                transactions: null
                giftCards: []
                giftCardMessages: []
                numberOfPaymentErrors: 0
                numberOfDeniedTransactions: 0
                lastDeniedTransaction: null
              clientPreferences:
                userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                localeDefault: pt-BR
                isNewsletterOptIn: true
              isToSavePersonalData: true
              lastUserPurchases:
              - creationDate: '2023-10-23T19:22:12.8989883Z'
                orderId: 1370990595750-01
                orderGroup: '1370990595750'
                value: 3498
              lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaskedPurchaseInfoResponse'
              example:
                id: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                document:
                  paymentData:
                    availableAccounts:
                    - accountId: D09F5E3F01054C959CFC4CB357961ADE
                      paymentSystem: '2'
                      paymentSystemName: Visa
                      cardNumber: '************1111'
                      bin: '44443334'
                      availableAddresses:
                      - db267dcc53c14fb2b9a985532dd287bc
                      expirationDate: 01/2032
                      isExpired: false
                      accountStatus: null
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  clientPreferences:
                    userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                    localeDefault: pt-BR
                    isNewsletterOptIn: true
                  isToSavePersonalData: true
                  lastUserPurchases:
                  - creationDate: '2023-10-23T19:22:12.8989883Z'
                    orderId: 1370990595750-01
                    orderGroup: '1370990595750'
                    value: 3498
                  lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
                meta:
                  version: 6f693feb-7354-4a44-af96-3693ed282a2e
                  author: 7b95bb3d-b567-48b2-b6fa-48b0b6c7f112
                  creationDate: '2023-10-23T19:22:23.6716469+00:00'
                  lastUpdateDate: '2023-10-24T16:18:25.7338837+00:00'
                  expirationDate: null
      deprecated: false
    get:
      tags:
      - Purchase Information
      summary: VTex Get purchase information
      description: 'Retrieves purchase information of a given client, by its `profileId`.


        > For security and privacy reasons, this request returns masked data. For unmasked information, see [Get unmasked purchase information](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/purchase-info/unmask).


        Learn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.


        >⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.

        >

        > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).


        ## Permissions


        Any 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:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | Profile System | Documents | **Get Item** |

        | Profile System | Documents | **Save and Update Item** |

        | Profile System | Documents | **Delete Item** |


        There 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).


        >❗ 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: GetPurchaseInformation
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/alternativeKey'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MaskedPurchaseInfoResponse'
              example:
              - id: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                document:
                  paymentData:
                    availableAccounts:
                    - accountId: D09F5E3F01054C959CFC4CB357961ADE
                      paymentSystem: '2'
                      paymentSystemName: Visa
                      cardNumber: '************1111'
                      bin: '44443333'
                      availableAddresses:
                      - db267dcc53c14fb2b9a985532dd287bc
                      expirationDate: 01/2032
                      isExpired: false
                      accountStatus: null
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  clientPreferences:
                    userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                    localeDefault: pt-BR
                    isNewsletterOptIn: true
                  isToSavePersonalData: true
                  lastUserPurchases:
                  - creationDate: '2023-10-23T19:22:12.8989883Z'
                    orderId: 1370990595750-01
                    orderGroup: '1370990595750'
                    value: 3498
                  lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
                meta:
                  version: 3117771f-8ea6-4297-a487-07e9b5497bc5
                  author: 6fd337ba-1e6c-4d3e-aceb-1d8993432193
                  creationDate: '2023-10-23T19:22:23.6716469+00:00'
                  lastUpdateDate: '2023-10-23T19:22:25.5466348+00:00'
                  expirationDate: null
      deprecated: false
    patch:
      tags:
      - Purchase Information
      summary: VTex Update purchase information
      description: 'Updates one or more fields of existing purchase information for a given client profile.


        Learn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.


        >⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.

        >

        > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).


        ## Permissions


        Any 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:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | Profile System | Documents | **Get Item** |

        | Profile System | Documents | **Save and Update Item** |

        | Profile System | Documents | **Delete Item** |


        There 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).


        >❗ 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: UpdatePurchaseInformation
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/alternativeKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseInfo'
            example:
              paymentData:
                availableAccounts:
                - accountId: D09F5E3F01054C959CFC4CB357961ADE
                  paymentSystem: '2'
                  paymentSystemName: Visa
                  cardNumber: '************1111'
                  bin: '44443334'
                  availableAddresses:
                  - db267dcc53c14fb2b9a985532dd287bc
                  expirationDate: 01/2032
                  isExpired: false
                  accountStatus: null
                availableTokens: []
                transactions: null
                giftCards: []
                giftCardMessages: []
                numberOfPaymentErrors: 0
                numberOfDeniedTransactions: 0
                lastDeniedTransaction: null
              clientPreferences:
                userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                localeDefault: pt-BR
                isNewsletterOptIn: true
              isToSavePersonalData: true
              lastUserPurchases:
              - creationDate: '2023-10-23T19:22:12.8989883Z'
                orderId: 1370990595750-01
                orderGroup: '1370990595750'
                value: 3498
              lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaskedPurchaseInfoResponse'
              example:
                id: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                document:
                  paymentData:
                    availableAccounts:
                    - accountId: D09F5E3F01054C959CFC4CB357961ADE
                      paymentSystem: '2'
                      paymentSystemName: Visa
                      cardNumber: '************1111'
                      bin: '44443334'
                      availableAddresses:
                      - db267dcc53c14fb2b9a985532dd287bc
                      expirationDate: 01/2032
                      isExpired: false
                      accountStatus: null
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  clientPreferences:
                    userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                    localeDefault: pt-BR
                    isNewsletterOptIn: true
                  isToSavePersonalData: true
                  lastUserPurchases:
                  - creationDate: '2023-10-23T19:22:12.8989883Z'
                    orderId: 1370990595750-01
                    orderGroup: '1370990595750'
                    value: 3498
                  lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
                meta:
                  version: 6f693feb-7354-4a44-af96-3693ed282a2e
                  author: 7b95bb3d-b567-48b2-b6fa-48b0b6c7f112
                  creationDate: '2023-10-23T19:22:23.6716469+00:00'
                  lastUpdateDate: '2023-10-24T16:18:25.7338837+00:00'
                  expirationDate: null
      deprecated: false
    delete:
      tags:
      - Purchase Information
      summary: VTex Delete purchase information
      description: "Deletes purchase informaiton by `profileId`.\n\nLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\n\n>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\n>\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/). \n\n## Permissions\n\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:\n\n| **Product** | **Category** | **Resource** |\n| --------------- | ----------------- | ----------------- |\n| Profile System | Documents | **Get Item** |\n| Profile System | Documents | **Save and Update Item** |\n| Profile System | Documents | **Delete Item** |\n\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).\n\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: DeletePurchaseInformation
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/alternativeKey'
      responses:
        '204':
          description: No content
      deprecated: false
  /api/storage/profile-system/profiles/{profileId}/purchase-info/unmask:
    get:
      tags:
      - Purchase Information
      summary: VTex Get unmasked purchase information
      description: "Retrieves unmasked purchase information of a given client, by its `profileId`.\n\nLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\n\n>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\n>\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/). \n\n## Permissions\n\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:\n\n| **Product** | **Category** | **Resource** |\n| --------------- | ----------------- | ----------------- |\n| Profile System | Documents | **Get Item** |\n| Profile System | Documents | **Save and Update Item** |\n| Profile System | Documents | **Delete Item** |\n\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).\n\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: GetUnmaskedPurchaseInformation
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/reason'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: List of purchase information.
                items:
                  $ref: '#/components/schemas/MaskedPurchaseInfoResponse'
              example:
              - id: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                document:
                  paymentData:
                    availableAccounts:
                    - accountId: D09F5E3F01054C959CFC4CB357961ADE
                      paymentSystem: '2'
                      paymentSystemName: Visa
                      cardNumber: '************1111'
                      bin: '44443333'
                      availableAddresses:
                      - db267dcc53c14fb2b9a985532dd287bc
                      expirationDate: 01/2032
                      isExpired: false
                      accountStatus: null
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  clientPreferences:
                    userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                    localeDefault: pt-BR
                    isNewsletterOptIn: true
                  isToSavePersonalData: true
                  lastUserPurchases:
                  - creationDate: '2023-10-23T19:22:12.8989883Z'
                    orderId: 1370990595750-01
                    orderGroup: '1370990595750'
                    value: 3498
                  lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
                meta:
                  version: cea5fcd2-7444-492d-9d63-1c05713e6776
                  author: 7b95bb3d-b567-48b2-b6fa-48b0b6c7f112
                  creationDate: '2023-10-24T16:22:55.0252384+00:00'
                  lastUpdateDate: '2023-10-24T16:22:55.0252384+00:00'
                  expirationDate: null
      deprecated: false
components:
  parameters:
    Accept:
      name: Accept
      in: header
      description: HTTP Client Negotiation _Accept_ He

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