SRS Integration Partner Services
Home
APIs
Home
APIs
  1. Getting Started
  • SRS Integration Partner Services (SIPS)
  • FAQs
  • Getting Started
    • Introduction
    • Authentication
    • Order Flow
  • SRS API Guides
    • Reference Data
    • Product Data
    • Invoices
    • Web Hooks
  • Security
    • Credentials
  1. Getting Started

Introduction

Introduction to SRS Integration Partner Services#

Welcome to the SRS Integration Partner System (SIPS)! This guide helps software partners integrate with SRS Distribution to place orders, manage inventory, and track deliveries through our API.

🎯 What You'll Learn - Click to expand
This documentation will guide you through:
βœ… Setting up your API credentials and authentication
βœ… Making your first calls to validate customers and explore data
βœ… Implementing the complete order flow from product selection to submission
βœ… Setting up webhooks for real-time order updates
βœ… Best practices for production deployments
⏱️ Time to Complete: Most integrations are live within 2-3 weeks following this guide
πŸ“‹ Integration Progress Tracker - Click to expand
Prerequisites (from Authentication Guide):
  • API credentials obtained
  • Access token retrieved
  • Customer validated
  • Branch locations explored
Steps 5-8 Progress (from Order Flow Guide):
  • πŸͺ Step 5: Customer branches retrieved
  • πŸ“¦ Step 6: Products browsed at branch
  • πŸ’° Step 7: Real-time pricing obtained
  • βœ… Step 8: Order successfully submitted
Key Data Collected:
  • jobAccountNumber saved (from Step 5)
  • Product IDs identified (from Step 6)
  • Pricing validated (from Step 7)
  • Order ID received (from Step 8)
Integration Complete:
  • First test order submitted successfully
  • Order confirmation received
  • Webhook setup planned (for Production)
  • Error handling implemented

πŸ—ΊοΈ Integration Journey#

The path to success:
1.
πŸ” Setup (Steps 1-2) - Get credentials and authenticate
2.
πŸ” Explore (Steps 3-4) - Validate and discover
3.
πŸ“‹ Build (Steps 5-7) - Construct your order
4.
βœ… Execute (Step 8) - Submit and track

πŸ“‹ Integration Overview - 8 Steps#

πŸ“š Complete guide: Follow the Authentication Guide (Steps 1-4) then Place Order Guide (Steps 5-8) for full implementation.

πŸ” Phase 1: Setup & Authentication (Steps 1-2)#

πŸ’Ό Step 1: Request Credentials - Click to expand
What you need to do:
Email APISupportTeam@srsdistribution.com
Include your company name and integration purpose
What you'll receive:
client_id - Your unique identifier
client_secret - Your authentication secret (keep secure!)
Response time: Usually within 1-2 business days
πŸ”’ Security Tip: Never share your client_secret publicly or commit it to version control!
πŸ”‘ Step 2: Authenticate - Click to expand
Endpoint: POST /authentication/token
What you'll get:
access_token - Your session token (valid 24 hours)
expires_in - Token expiration time in seconds
Quick Example:
⏰ Token Management: Tokens expire after 24 hours. Implement automatic refresh before expiration!

πŸ” Phase 2: Explore & Validate (Steps 3-4)#

βœ… Step 3: Validate Customer - Click to expand
Endpoint: /api/customer/validate
Why this matters:
Verifies customer has access to API
Returns customer account details
Required before placing orders
Key Response Field:
validIndicator: true βœ… Customer can place orders
validIndicator: false ❌ Customer not eligible
⚠️ Critical: Always check validIndicator before proceeding with orders!
πŸ“ Step 4: Get Branch Locations - Click to expand
Endpoint: /branches/v2/branchLocations
What you'll discover:
All SRS branch locations
Available shipping methods per branch
Branch contact information
Operating hours
Use this data to:
Show available branches to your users
Let customers choose preferred pickup/delivery location
Calculate shipping costs

πŸ“‹ Phase 3: Build Your Order (Steps 5-7)#

πŸͺ Step 5: Find Customer Branches - Click to expand
Endpoint: /branches/v2/customerBranchLocations/{customerCode}
Critical Information Retrieved:
jobAccountNumber - Required for order submission
Customer-specific branch relationships
Delivery addresses (ShipTo locations)
Example Response:

{
  "jobAccountNumber": 78,
  "branchCode": "AMDEN",
  "shipToSequenceNumber": 1
}
πŸ’‘ Pro Tip: Save the jobAccountNumber - you'll need it for every order!
πŸ“¦ Step 6: Get Available Products - Click to expand
Endpoint: /branches/v2/activeBranchProducts/{branchCode}
Returns:
Products available at the specific branch
Product IDs, names, and descriptions
Available units of measure (UOM)
Product categories
Why this matters:
Not all products are available at all branches
Shows current inventory availability
Prevents ordering unavailable items
πŸ’° Step 7: Get Pricing - Click to expand
Endpoint: /products/v2/price
Real-time Information:
Current prices per customer
Stock availability (In Stock / Out of Stock)
Quantity discounts
Product substitution options
Request Example:

{
  "customerCode": "ABC123",
  "branchCode": "AMDEN",
  "productList": [
    {
      "productId": 12345,
      "quantity": 10,
      "uom": "EA"
    }
  ]
}
⚑ Performance Tip: Prices are customer-specific. Always use the correct customerCode!

βœ… Phase 4: Submit Order (Step 8)#

πŸš€ Step 8: Submit Order - Click to expand
Endpoint: /orders/v2/submit
Required Data (from previous steps):
βœ… Access token (Step 2)
βœ… Validated customer (Step 3)
βœ… Job account number (Step 5)
βœ… Product IDs (Step 6)
βœ… Pricing information (Step 7)
Successful Response:

{
  "message": "Order Submitted",
  "transactionID": "YOUR-UNIQUE-ID",
  "orderID": "35818786",
  "queueID": null
}
Order Methods:
Synchronous: Immediate processing (Staging/Testing)
Asynchronous: Queue-based processing (Production - Recommended)
🎯 Success! You've completed the full integration flow!

🌐 API Environments#

Staging (Testing):
URL: https://services-qa.roofhub.pro
Safe testing, synchronous orders only
Production (Live Orders):
Contact SRS API Support for credentials
Real orders, async/sync available

πŸ’¬ Need Help?#

Contact SRS API Support:
Email: APISupportTeam@srsdistribution.com
Include: Client ID (NOT secret), Environment (QA/Production), Error details
Response Time: 1-2 business days
Let's build something great together! πŸš€
Modified atΒ 2026-05-11 16:27:38
Previous
FAQs
Next
Authentication
Built with