Discovering the Selling Partner API Postman Workspace 🔎

[jawheral]

Every developer working with Amazon's Selling Partner API needs efficient tools to explore, test, and integrate APIs. The official SP-API Postman Workspace provides a comprehensive environment for learning and experimenting with the API ecosystem.

Authored by: Jawher A. - Solutions Architect, Selling Partner Developer Services

This guide introduces the Selling Partner API Postman Workspace and shows you how to leverage the available collections, flows, and resources to accelerate your development journey.

What is the SP-API Postman Workspace? 🚀

The Selling Partner API Postman Workspace is an official collection of ready-to-use API requests, workflows, and documentation maintained by Amazon. It provides:

Pre-configured Collections: Ready-to-use API requests organized by use case and API category

Authentication Templates: Pre-built OAuth2 authentication flows with automatic token management

Recipe Collections: Step-by-step workflows for common seller use cases like managing listings, buying shipping, or handling FBA Inbound

Documentation: Inline documentation and examples to help you understand each API operation

Why Use the Postman Workspace? 💡

Benefit	Description
Quick Start ⚡	Skip the setup complexity and start testing APIs immediately
Learn by Example 📚	Explore real-world use cases through pre-built use cases and workflows
Experiment Safely 🧪	Test API calls before implementing code in production
Collaborate 👥	Share collections and workflows with your team

Getting Started with the Workspace 🎯

To be able to fork and use the workspace, make sure to create a Postman account and use your web browser or alternatively install the Postman Desktop client. This page from Postman Docs is a good start.

1. Fork Collections to Your Workspace

Forking allows you to create your own copy of any collection, enabling you to:

• Customize requests with your own credentials and parameters
• Save your modifications
• Keep your fork synchronized with updates from the official workspace

How to Fork:

1. Navigate to the SP-API Postman Workspace
2. Browse available collections
3. Click the "Fork" button on any collection
4. Select your workspace and create the fork

2. Configure Your Environment

The workspace includes pre-configured environments which you can fork for all three regions with OAuth2 authentication:

Pre-configured Environments:

• NA
• EU
• FE

Each environment comes with all necessary variables pre-configured, including regional API endpoints, OAuth URLs, and placeholders for your credentials. Simply select your region and add your authentication credentials to get started.

Setup Steps:

1. Select the appropriate regional environment (NA, EU, or FE)
2. Update the environment with your SP-API credentials (client ID, client secret, refresh token)
3. Set a seller ID and a target marketplace ID if needed
4. Start making API calls - authentication is handled through dedicated requests or through automated pre-request scripts in certain collections

3. Learn to Navigate Collections

The workspace is organized into different formats of collections to support different learning and integration needs:

Getting Started Collections:

• Getting Started with SP-API for Sellers: Overview and discovery of available APIs for sellers integration path
• Getting Started with SP-API for Vendors: Overview and discovery of available APIs for vendors integration path

These foundational collections provide a comprehensive introduction to each API section, helping you understand what's available for your integration path.

Use Case-Focused Workflows:

These collections guide you through complete business processes in a structured, step-by-step manner.

Examples:

• [Listings APIs] Workflows: Step-by-step processes for managing product listings such as creating a new listing or creating a new offer for a listing
• AWD Inbound Order Creation: Complete workflow for Amazon Warehousing and Distribution inbound orders and shipping
• EasyShip Order Processing with External Fulfillment APIs: End-to-end EasyShip order handling

Recipe Collections - "How to do X with this API?":

• Listings Recipes: Practical examples like "How to add a B2B offer", "How to switch a listing from MFN to FBA",...
• Pricing Recipes: Specific tasks like "How to update a price with sample location"

Recipes provide focused, actionable examples for specific tasks within an API domain.

Leveraging Postman Flows 🔄

Postman Flows is a visual tool that lets you chain API requests and build complex workflows without writing code. The workspace includes ready-to-use flows that demonstrate powerful automation scenarios.

Getting Started with Flows:
Flows can be cloned directly into your workspace for you to run. Simply browse the available flows, clone the flow that you are interested in, configure your environment and variables, and finally execute it to visualize the actions step-by-step.

Available Flows:

Repricing:
Automatically adjust product prices based on competitive pricing data and predefined thresholds to stay competitive in the marketplace.

Buy Shipping
Streamline your shipping label purchase process with an automated flow that uses Amazon Buy Shipping

Analytics and Reporting with Data Kiosk
Build reporting using Data Kiosk to extract and analyze your business data.

Best Practices for Using the Workspace 🎓

1. Use Pre-configured Environments

• Select the appropriate regional environment (NA, EU, or FE) based on your marketplace
• Update the environment variables with your credentials
• Switch between regions easily when testing across marketplaces
• Leverage the pre-configured base URLs, OAuth endpoints, sandbox endpoints and global variables

2. Organize Your Forks

• Create a dedicated workspace for your SP-API development
• Use descriptive names for forked collections

3. Test Before Coding or Production

• Use sandbox endpoints when available
• Validate responses and error handling

4. Keep Collections Updated

• Watch the original collection and official workspace for updates
• Merge changes from the source collection to your forks

5. Leverage Variables

• Use collection variables where available for values specific to a use-case
• Store common parameters like marketplace IDs and seller IDs

Start Your Journey Now🛠️

• Fork the "Getting Started with SP-API for Sellers" or "Getting Started with SP-API for Vendors" collection
• Explore the available APIs for your integration path
• Understand the breadth of functionality available

Getting Started with SP-API for Sellers
Getting Started with SP-API for Vendors

---

Additional Resources 📚

• Check our Youtube Video on How to Use the Postman Workspace
• Selling Partner API Documentation
• SP-API Developer Support
• Postman Learning Center

Need Help? 📞

For assistance with the Postman Workspace or SP-API:

• Check the Selling Partner API Documentation
• Raise an issue on Github
• Contact Developer Support

Share Your Thoughts! 💭

• ❤️ Found this helpful?

• 💡 Have suggestions?

• 🤔 Questions?

Keywords: Postman, SP-API, API-Testing, Development, Workflows, Collections, PostmanFlows

Please note the publication date above. While we strive to keep our content current, the rapid evolution of this topic means some details may have changed since publication. For the most up-to-date information, we encourage readers to follow the announcements in SP-API developer documentation.