Development #46
Merged
Development #46
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…bhook endpoints - Enhanced payment API examples with detailed request and response structures. - Added admin payment management endpoints including capture, cancel, and refund functionalities. - Updated product API examples to reflect admin-only access and improved request/response formats. - Expanded shipping API documentation with new methods for creating shipping zones and rates. - Revised user API examples to align with authentication changes. - Introduced a new webhook API documentation outlining Stripe and MobilePay webhook handling.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation for several API systems in the Commercify platform, including the addition of new endpoint summaries, response formats, and example usage. The changes aim to enhance clarity, usability, and consistency across the documentation.
API Documentation Enhancements:
Comprehensive API Endpoint Summary:
docs/API_ENDPOINTS_SUMMARY.md.Category API Examples:
docs/category_api_examples.md. This includes endpoints for listing categories, retrieving child categories, and admin operations like creating, updating, and deleting categories.Checkout API Updates:
successfield and other standardized properties indocs/checkout_api_examples.md. [1] [2] [3]Removed Outdated Documentation:
Payment Provider System:
docs/PAYMENT_PROVIDER_SYSTEM.md, which described the previous implementation of the PaymentProviderRepository system. The new centralized management approach is already reflected in other parts of the documentation.Database Setup Guide:
docs/DATABASE_SETUP.md, which detailed database configuration steps for SQLite and PostgreSQL. This guide has been deprecated in favor of environment-specific setup instructions provided elsewhere.