The Bulk Downloads API allows you to initiate a download process for a group of entities from the Get Paid APIs.
The download process creates a .zip file that's available to download using a returned download URL.
With the Bulk Downloads API, you can:
- Initiate a bulk download.
- Retrieve a bulk download.
- Delete a bulk download.
It's important to note the following before starting to code:
- The Bulk Download API only works with entities in the Get Paid APIs.
Currently, only entities in the receipts namespace are supported.
- Once a download is started, a .zip file is created in the Wix Media platform which can then be downloaded using the
downloadUrl returned in the response.
- The .zip file exists for 24 hours after its creation before it's deleted.
- A maximum of 100 entities can be included in a bulk download.
- Bulk download: An entity that contains information about the files to download and the URL to use to download the generated .zip file that contains those files.