What You'll Need
- Access to your Supreme ERP account
- Admin permissions to access Settings
- Basic understanding of API concepts
Step-by-Step Guide to Create Your API Key
1. Navigate to API Key Settings
- Log into your Supreme ERP account
- Go to Settings from the main navigation
- Click on the Keys tab
- This section contains all your API key management tools
2. Generate a New API Key
- Click Create New Key or similar button
- Enter a descriptive name for your key (e.g., "Test Key for Integration")
- Add an optional description to help identify the key's purpose
- Click Generate to create your API key
- Important: Copy and securely store your API key immediately - it won't be shown again
3. Access API Documentation
Once your key is created:
- Find the API documentation at https://public.skupreme.com/docs
- The documentation provides interactive testing capabilities
- You can test API calls directly from the documentation interface
Testing Your API Key
Test Inventory Access
- Navigate to the Inventory section in the API docs
- Paste your API key into the authentication field
- Run a test call to verify your key works
- You should see live inventory data from your account
Create a Test Order
The API allows you to create orders programmatically:
Required Fields:
- SKU: Use the primary display SKU from your inventory
- State: Two-letter state abbreviation (e.g., "CA", "NY")
- UPC: Optional but recommended for catalogs with multiple SKUs
Optional Fields:
- Customer email
- Order memo/notes
- Additional product identifiers
Sample API Call Structure
When creating orders, ensure your JSON is properly formatted:
- Include commas after each field except the last
- Validate JSON using tools like JSONLint before submission
- Required fields must be included or the API will return errors
Best Practices
Security
- Store API keys securely and never expose them in client-side code
- Use environment variables for API key storage
- Regularly rotate keys for enhanced security
API Usage
- Test all API calls in the documentation interface first
- Use UPC codes for catalogs with complex SKU structures
- Validate JSON formatting to avoid common syntax errors
Error Handling
- Common errors include missing commas in JSON
- Ensure required fields are always included
- Use the interactive docs to troubleshoot API responses
Next Steps
After creating your API key:
- Test basic inventory queries
- Practice creating test orders
- Integrate the API into your application
- Monitor API usage and performance
Troubleshooting
Common API Errors and Solutions
SKU Not Found Errors:
- Verify the SKU exists in your inventory before creating orders
- Check for typos in SKU formatting
- Ensure the SKU is active and available for sale
Invalid Product Errors:
- Double-check UPC codes for accuracy
- Confirm product is properly configured in your catalog
- Verify inventory levels are sufficient for the order quantity
API Response Errors:
- 400 errors typically indicate malformed requests or missing required fields
- 401 errors suggest authentication issues with your API key
- 404 errors may indicate invalid SKUs or unavailable products
- 500 errors require contacting support for server-side issues
General Issues
Missing Comma Error: The most common issue is JSON formatting. Always validate your JSON structure before making API calls.
Authentication Errors: Ensure your API key is correctly copied and included in all requests.
Order Creation Failures: Verify all required fields are included and properly formatted.
Additional Resources
- API Documentation: https://public.skupreme.com/docs
- JSON Validator: https://jsonlint.com/
- Contact support for advanced integration questions
Need help with API integration? Contact our support team for personalized assistance with your Supreme ERP implementation.