Importing and exporting collections in Postman - Build an Automation Script

Import and Export Postman Collection

Preconditions (2)

Step 1: Click on the 'Import' button in the Postman app

Step 2: Select the collection JSON file from the local system

Step 3: Confirm the import and wait for the collection to appear in the sidebar

Step 4: Select the imported collection

Step 5: Click on the three dots next to the collection name to open the menu

Step 6: Choose 'Export' option

Step 7: Select the export format (e.g., Collection v2.1)

Step 8: Save the exported collection file to the local system

✅ Expected Result: The collection is successfully imported and visible in Postman. The exported collection file is saved correctly and matches the imported collection content.

Automation Requirements - Postman Newman CLI

Assertions Needed:

Verify collection is imported without errors

Verify collection contains expected requests

Verify exported collection file exists and is valid JSON

Best Practices:

Use Newman CLI commands for import and export simulation

Validate JSON schema of collection files

Use file system checks for exported file existence

Keep test data files organized and reusable

Automated Solution

Postman

import fs from 'fs';
import { execSync } from 'child_process';

// Paths for collection files
const importCollectionPath = './test_collections/sample_collection.json';
const exportCollectionPath = './test_collections/exported_collection.json';

// Step 1: Import collection using Newman (simulate by running a simple run)
try {
  execSync(`newman run ${importCollectionPath} --disable-unicode`);
  console.log('Collection imported and run successfully');
} catch (error) {
  throw new Error('Failed to import or run collection: ' + error.message);
}

// Step 2: Export collection - Newman does not support export directly, so simulate export by copying file
try {
  fs.copyFileSync(importCollectionPath, exportCollectionPath);
  console.log('Collection exported successfully');
} catch (error) {
  throw new Error('Failed to export collection: ' + error.message);
}

// Step 3: Validate exported collection file exists and is valid JSON
if (!fs.existsSync(exportCollectionPath)) {
  throw new Error('Exported collection file does not exist');
}

const exportedContent = fs.readFileSync(exportCollectionPath, 'utf-8');
try {
  const json = JSON.parse(exportedContent);
  if (!json.info || !json.item) {
    throw new Error('Exported collection JSON missing required fields');
  }
  console.log('Exported collection JSON is valid');
} catch (error) {
  throw new Error('Exported collection JSON is invalid: ' + error.message);
}

// Step 4: Verify imported collection contains expected requests
// For simplicity, check if collection has at least one request
const importedContent = fs.readFileSync(importCollectionPath, 'utf-8');
const importedJson = JSON.parse(importedContent);
if (!importedJson.item || importedJson.item.length === 0) {
  throw new Error('Imported collection has no requests');
}

console.log('Imported collection contains requests');

This script uses Node.js to automate the import and export verification of a Postman collection.

First, it runs the collection using Newman CLI to simulate import and execution, ensuring no errors occur.

Since Newman does not support exporting collections, the script simulates export by copying the original collection file to a new location.

Then, it checks if the exported file exists and parses it as JSON to verify it has the required structure.

Finally, it verifies the imported collection contains at least one request to confirm it is valid.

This approach uses file system operations and Newman CLI commands to automate the manual test steps effectively.

Common Mistakes - 3 Pitfalls

Using Newman CLI without checking for errors

Hardcoding file paths without verifying existence

{'mistake': 'Not validating JSON structure of imported/exported collections', 'why_bad': 'Invalid or corrupted collections may pass unnoticed, causing failures later.', 'correct_approach': "Parse JSON and verify required fields like 'info' and 'item' are present."}

Bonus Challenge

Now add data-driven testing with 3 different Postman collection files to import and export

Show Hint

Practice

1. What is the main purpose of importing a collection in Postman?

easy

A. To add existing API tests into Postman for use

B. To delete all current tests in Postman

C. To export tests to a JSON file

D. To create a new API from scratch

Solution

1. Step 1: Understand importing collections

   Importing collections means bringing existing API tests into Postman so you can use or modify them.

2. Step 2: Differentiate from exporting and creating

   Exporting saves tests out of Postman, and creating new APIs is different from importing.

3. Final Answer:

   To add existing API tests into Postman for use -> Option A

4. Quick Check:

   Import = Add existing tests [OK]

Hint: Import means bringing tests in, not creating or deleting [OK]

Common Mistakes:

• Confusing import with export
• Thinking import deletes tests
• Assuming import creates new APIs

2. Which file format is used when exporting a collection from Postman?

easy

A. .xml

B. .csv

C. .json

D. .txt

Solution

1. Step 1: Identify export file format

   Postman exports collections as JSON files, which store structured data about API tests.

2. Step 2: Exclude other formats

   XML, TXT, and CSV are not used by Postman for exporting collections.

3. Final Answer:

   .json -> Option C

4. Quick Check:

   Exported collections use JSON files [OK]

Hint: Postman collections export as JSON files only [OK]

Common Mistakes:

• Choosing XML or CSV instead of JSON
• Confusing export format with import options
• Assuming text files are used

3. You exported a collection from Postman and shared the JSON file. Your teammate imports it but sees no requests. What is the likely cause?

medium

A. Postman does not support importing JSON files

B. The JSON file was empty or corrupted

C. The teammate did not restart Postman after import

D. The collection was exported in XML format

Solution

1. Step 1: Check file integrity

   If the imported collection shows no requests, the JSON file might be empty or corrupted, causing no data to load.

2. Step 2: Verify import support and format

   Postman supports JSON imports, and restarting is not required. Exporting in XML is not possible, so that is invalid.

3. Final Answer:

   The JSON file was empty or corrupted -> Option B

4. Quick Check:

   Empty/corrupt JSON causes no requests on import [OK]

Hint: Empty or broken JSON files cause empty imports [OK]

Common Mistakes:

• Thinking Postman can't import JSON
• Assuming restart is needed after import
• Believing XML export is possible

4. You tried to export a collection but the export button is disabled. What should you check to fix this?

medium

A. Ensure a collection is selected in Postman

B. Restart your computer immediately

C. Change the export file format to XML

D. Uninstall and reinstall Postman

Solution

1. Step 1: Verify collection selection

   The export button is disabled if no collection is selected. Selecting a collection enables export.

2. Step 2: Exclude unnecessary actions

   Restarting, changing to XML (unsupported), or reinstalling are not needed to enable export.

3. Final Answer:

   Ensure a collection is selected in Postman -> Option A

4. Quick Check:

   Export button needs a selected collection [OK]

Hint: Select a collection first to enable export button [OK]

Common Mistakes:

• Trying unsupported XML format
• Restarting unnecessarily
• Reinstalling Postman without checking selection

5. You want to share a set of API tests with a teammate who uses Postman. Which steps correctly describe exporting and importing the collection?

hard

A. Copy the collection URL, teammate pastes it in browser to import

B. Export the collection as CSV, send the file, teammate imports CSV in Postman

C. Export the collection as XML, send the file, teammate imports XML in Postman

D. Export the collection as JSON, send the file, teammate imports JSON in Postman

Solution

1. Step 1: Export collection as JSON

   Postman exports collections only as JSON files for sharing or backup.

2. Step 2: Teammate imports JSON file

   The teammate imports the JSON file into their Postman app to get the same tests.

3. Final Answer:

   Export the collection as JSON, send the file, teammate imports JSON in Postman -> Option D

4. Quick Check:

   Export and import use JSON files [OK]

Hint: Always export/import collections as JSON files [OK]

Common Mistakes:

• Using CSV or XML formats
• Thinking URL copy imports collections
• Skipping export step