Orders Export Feature

The Orders Export feature allows users to export order data from Skupreme. Rather than generating reports on the fly, this feature creates background tasks that compile the requested data and provide it via email or direct download.

How It Works

1. Request Process: Users can request order exports by specifying date ranges
2. Background Processing: The system processes the request as a background task
3. Notification: Once complete, the system either:
   • Sends the export file to the user's email
   • Makes it available for download via a link in the Orders Export History

Using the Orders Export Feature

To Export Orders:

1. Navigate to the Orders List screen
2. Click the "Export" button in the top-right corner
3. Select your desired date range in the modal
4. Enter your email address (optional)
5. Click "Export"
6. The system will confirm your export request has been initiated

To Access Previous Exports:

1. Navigate to the Orders List screen
2. Click "Export History"
3. View the list of your previous export requests with their statuses
4. Download completed exports directly from this screen

Technical Details

Export File Format

The export generates a CSV file with flattened order data, meaning:

• Orders with multiple line items will appear as multiple rows in the CSV
• Each row represents a single line item with all relevant order details

API Endpoints

For developers integrating with the Orders Export feature:

1. Create Export Request:
   • Endpoint: POST /v1/orders/exports
   • Parameters:
      

     json

     {
       "start_date": "YYYY-MM-DD",
       "end_date": "YYYY-MM-DD",
       "email": "user@example.com" // Optional
     }

2. Get Export History:
   • Endpoint: GET /v1/orders/exports
   • Returns a list of all export requests with their status and download links (when available)

Status Tracking

Each export request has a status that can be:

• Processing: The export is currently being generated
• Completed: The export is ready and available for download
• Failed: The export could not be completed (with an error message)

Notes

• Large date ranges may take longer to process
• The system processes one export request at a time to avoid database overload
• Export files are stored securely in cloud storage

Support

For any issues with the Orders Export feature, please contact support at support@skupreme.com or submit a ticket through the Help Center.