Exporting bulk data from records in Master Data v1 can be done in two ways:
- Downloading a spreadsheet via the Master Data interface.
- Using the Scroll documents endpoint from the Master Data v1 API.
The purpose of this document is to show the steps required for exporting data to a spreadsheet.
Exporting data from Master Data is not an immediate operation, and its execution time depends on the amount of data in Master Data. Therefore, in stores with a very large amount of data and a high update frequency, the exported file may become outdated in relation to the new data. If this occurs, the solution may be to export the data again, preferably when there are not many updates taking place (for example, outside of business hours or on weekends).
Export report with data from Master Data v1
Follow the instructions below to export a report with data from documents of a form in Master Data v1.
- In the VTEX Admin, access Store Settings > Storefront > Master Data.
- Make sure you are in the Applications tab.
- Click the list icon next to the desired form.
- Click on the
Export XLSbutton. - Select the fields that you want to see in the report.
- Inform the email to which the report will be sent (by default, the system will show the email of the user who is logged in, but this can be changed).
- Click on
Export.
Exported customer data
Below you can see all fields exported from the Customers tab in the Profile System (CRM) in Master Data v1.
| Field | Description | Origin |
|---|---|---|
| Email address of customer | Register | |
| firstName | First name of customer | Register |
| lastName | Last name of customer | Register |
| document | No. of CPF or CNPJ of customer | Register |
| documentType | Type of document of customer | Register |
| homePhone | Registered phone no. of customer | Register |
| tradeName | Company (PJ) – Trade name | Register |
| businessPhone | PJ – Registered phone no. | Register |
| corporateName | PJ – Company name | Register |
| isCorporate | PJ- Indicates it is a company | Register |
| stateRegistration | PJ- State registration | Register |
| isFreeStateRegistration | PJ- Exempt from state registration | Register |
| corporateDocument | PJ- CNPJ number | Register |
| isNewsletterOptIn | Opted to receive Newsletter | Register |
| createdIn | Date record created | Internal |
| updatedIn | Date of last update of record in CRM | Internal |
| lastInteractionIn | Date of last update of record in CRM | Internal |
| userId | ID of customer in CRM | Internal |
| createdBy | User who created the record | Internal |
| lastInteractionBy | User who amended the record | Internal |
| updatedBy | User who amended the record | Internal |
| rclastsession | ID of browsing script session | Browsing script |
| rclastsessiondate | Date of last browsing session saved | Browsing script |
| checkouttag | List of Checkout steps completed by the customer | Browsing script |
| categoryVisitedTag | List of last categories visited | Browsing script |
| searchTermTag | List of last terms searched for on the site | Browsing script |
| visitedProductWithStockOutSkusTag | List of IDs of last unavailable products visited | Browsing script |
| productVisitedTag | List of IDs of last products visited | Browsing script |
| brandVisitedTag | List of last brands visited | Browsing script |
| rclastcart | URL to restock shopping cart with all the products | Browsing script |
| rclastcartvalue | Value of last cart | Browsing script |
| carttag | List of IDs of last SKUs in the cart | Browsing script |
These fields are the ones shown by default in the Customer form. If the store has customized this entity (Customer), other fields may have been created.