Skip to content

Commit 3b1c2ae

Browse files
committed
feat: add more setup instructions to the readme
1 parent c6b7e10 commit 3b1c2ae

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

examples/spa-manual-payments/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,54 @@ spa-manual-payments/
4242
└── README.md # ← you are here
4343
```
4444

45+
---
46+
47+
## Store Setup Requirements
48+
49+
To use this example, your **Elastic Path Commerce Cloud store** must be properly configured:
50+
51+
### 🔌 **Payment Gateway Configuration**
52+
53+
1. **Enable Manual Gateway** in Commerce Manager:
54+
55+
- Go to **Settings****Payments**
56+
- Configure **Manual** gateway
57+
- Enable the gateway
58+
59+
### 📦 **Product Setup**
60+
61+
Your store needs products in a published catalog for the payment demo to work. Learn more about how to publish a catalog [in the docs](https://elasticpath.dev/docs/commerce-manager/product-experience-manager/catalogs/catalog-configuration):
62+
63+
1. **Product Requirements**:
64+
65+
- Add at least one **simple product** (not a base product requiring variations)
66+
- Products should have **prices** associated with them
67+
- Products must be **active** and included in the published catalog
68+
69+
2. **Inventory Configuration** (Optional):
70+
- If using inventory management, ensure products have **stock levels** configured
71+
72+
### 🔑 **API Access Setup**
73+
74+
1. **Client Credentials**:
75+
76+
- Go to **Settings****API Keys** and create a new application key
77+
- Note your **Client ID** and **Store URL** and use them in your .env
78+
79+
### 🚨 **Common Setup Issues**
80+
81+
**"No products available" Error**:
82+
83+
- **Cause**: No products in published catalog, catalog not published, or all products are base products
84+
- **Solution**: Create and publish a catalog with at least one simple product
85+
86+
**404 Inventory Errors**:
87+
88+
- **Cause**: Product inventory not configured
89+
- **Solution**: Either configure inventory or ignore (example handles gracefully)
90+
91+
---
92+
4593
## How It Works
4694

4795
### 1. Test Order Creation

0 commit comments

Comments
 (0)