Skip to main content

Postman Collection

Get started quickly with our comprehensive Postman collection that includes all Reachu API endpoints, sample requests, and pre-configured environment variables.

🏗️ Channel-Based Architecture​

Reachu uses a channel-based architecture where:

  • Products are accessed through your channel - Not directly
  • Each channel has its own product catalog - Filtered and scoped to your business
  • All product operations require channel context - /api/channel/products instead of /api/products

This ensures you only see and work with products relevant to your specific channel and business configuration.

📥 Download Collection​

Download Reachu Postman Collection

🚀 Quick Setup​

1. Import the Collection​

  1. Open Postman
  2. Click Import in the top left
  3. Select the downloaded reachu-postman-collection.json file
  4. Click Import

2. Configure Your API Key​

The collection comes with a sample API key. Replace it with your own:

  1. Go to the Authorization tab in the collection
  2. Replace the sample key CFN9A5W-V74MACA-K2XD00S-W2D42D3 with your API key
  3. Or set it as an environment variable

3. Update Environment Variables​

The collection includes these pre-configured variables:

VariableDefault ValueDescription
apihttps://api-qa.reachu.ioBase API URL
cartId62d15502-6864-4511-a1fb-9f2047037a78Sample cart ID
productId68787Sample product ID
checkoutId9e828884-1a71-4031-b915-b157bf62f5e8Sample checkout ID
shippingId6999657f-df54-4777-8f0e-5c917aef03a2Sample shipping ID
itemId1d6ce8be-83f7-4de3-9201-c7574bcb962dSample item ID
supplierId1243Sample supplier ID

📋 Available Endpoints​

🏪 Channel & Products (Channel-based architecture)​

  • Get channel products - /api/channel/products - Get all products from your channel
  • Get product by ID - /api/channel/products/{productId} - Get specific product from your channel
  • Get products by category - /api/channel/products/category/{categoryId} - Filter products by category
  • Get products by multiple categories - /api/channel/products/categories - Filter by multiple categories
  • Get channel info - /api/channel/me - Get your channel information

Important: All product operations go through your channel context - you cannot access products directly.

🛒 Cart Management​

  • Create shopping cart - Initialize a new cart
  • Update cart - Modify cart properties (shipping country, etc.)
  • Get cart by ID - Retrieve cart details
  • Delete cart - Remove a cart completely

📦 Cart Items​

  • Add items to cart - Add products to existing cart
  • Update cart item - Modify quantity or shipping
  • Delete cart item - Remove specific items
  • Get items by supplier - View cart items grouped by supplier

💳 Checkout Process​

  • Create checkout - Initialize checkout from cart
  • Get checkout - Retrieve checkout details
  • Update checkout - Add billing/shipping addresses
  • Get payment methods - Available payment options

💰 Payment Integration​

  • Stripe Payment Link - Generate payment link
  • Stripe Embedded - Payment intent for embedded checkout
  • Klarna Embedded - Klarna payment initialization
  • Vipps Payment - Norwegian mobile payment

🔄 Common Workflows​

Complete Purchase Flow (Channel-based)​

  1. Get Products → GET /api/channel/products - Browse your channel's product catalog
  2. Create Cart → POST /api/cart - Initialize shopping cart
  3. Add Products → POST /api/cart/{cartId}/item/add - Add selected products to cart
  4. Set Shipping → PATCH /api/cart/{cartId} - Configure shipping options
  5. Create Checkout → POST /api/checkout - Initialize checkout process
  6. Add Addresses → PATCH /api/checkout/{checkoutId} - Set billing/shipping addresses
  7. Initialize Payment → POST /api/checkout/{checkoutId}/payment - Process payment

Product Discovery Workflow​

  1. Get Channel Info → GET /api/channel/me - Verify your channel configuration
  2. Browse Products → GET /api/channel/products?currency=NOK - Get all available products
  3. Filter by Category → GET /api/channel/products/category/{categoryId} - Find specific product types
  4. Get Product Details → GET /api/channel/products/{productId} - Get detailed product information

Testing Tips​

  • Start with Channel: Always begin by testing /api/channel/products to understand your available inventory
  • Use Channel Context: Remember that all product operations are scoped to your channel - no direct product access
  • Sequential Testing: Start with creating a cart using the "Create shopping cart" request
  • Update Variables: Use the returned cart_id to update the cartId variable for subsequent requests
  • Check Response Data: Always check response data to get IDs for subsequent requests
  • Currency Parameter: Include currency parameter when getting products (e.g., ?currency=NOK)

🛠️ Customizing Requests​

Environment Setup​

Create a new environment in Postman with these variables:

{
  "api": "https://api-qa.reachu.io",
  "authorization": "YOUR_API_KEY_HERE",
  "cartId": "",
  "productId": "",
  "checkoutId": "",
  "categoryId": "",
  "currency": "NOK"
}

Testing Channel Products​

Before testing cart operations, verify your channel's product catalog:

# Get all channel products
GET {{api}}/api/channel/products?currency={{currency}}

# Get channel information
GET {{api}}/api/channel/me

# Get products by category
GET {{api}}/api/channel/products/category/{{categoryId}}

Authentication​

All requests use API Key authentication in the header:

Authorization: YOUR_API_KEY_HERE

📞 Support​

If you encounter issues with the Postman collection:

  • Check your API key is correctly set
  • Ensure you're using the latest collection version
  • Contact support: support@reachu.io
  • Book a demo: Book a Demo