Add Storefront and Order APIs to API reference#121
Merged
tolu-paystack merged 1 commit intoPaystackOSS:mainfrom Feb 5, 2026
Merged
Add Storefront and Order APIs to API reference#121tolu-paystack merged 1 commit intoPaystackOSS:mainfrom
tolu-paystack merged 1 commit intoPaystackOSS:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds API reference code snippets and example responses for the Storefront and Order APIs.
Changes:
- Added Storefront endpoint request snippets (sh/js/php) and example responses (verify slug, CRUD, publish, products, orders).
- Added Order endpoint request snippets (sh/js/php) and example responses (create, list, fetch, validate, fetch product orders).
- Added corresponding compiled
dist/artifacts (requests.js+response.json) for the new endpoints.
Reviewed changes
Copilot reviewed 80 out of 112 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/api/storefront/verify-slug/response.json | Storefront verify-slug example response (source) |
| src/api/storefront/verify-slug/index.sh | Storefront verify-slug request snippet (sh, source) |
| src/api/storefront/verify-slug/index.php | Storefront verify-slug request snippet (php, source) |
| src/api/storefront/verify-slug/index.js | Storefront verify-slug request snippet (js, source) |
| src/api/storefront/verify-slug/config.yml | Storefront verify-slug snippet language config (source) |
| src/api/storefront/update/response.json | Storefront update example response (source) |
| src/api/storefront/update/index.sh | Storefront update request snippet (sh, source) |
| src/api/storefront/update/index.php | Storefront update request snippet (php, source) |
| src/api/storefront/update/index.js | Storefront update request snippet (js, source) |
| src/api/storefront/update/config.yml | Storefront update snippet language config (source) |
| src/api/storefront/publish/response.json | Storefront publish example response (source) |
| src/api/storefront/publish/index.sh | Storefront publish request snippet (sh, source) |
| src/api/storefront/publish/index.php | Storefront publish request snippet (php, source) |
| src/api/storefront/publish/index.js | Storefront publish request snippet (js, source) |
| src/api/storefront/publish/config.yml | Storefront publish snippet language config (source) |
| src/api/storefront/list/response.json | Storefront list example response (source) |
| src/api/storefront/list/index.sh | Storefront list request snippet (sh, source) |
| src/api/storefront/list/index.php | Storefront list request snippet (php, source) |
| src/api/storefront/list/index.js | Storefront list request snippet (js, source) |
| src/api/storefront/list/config.yml | Storefront list snippet language config (source) |
| src/api/storefront/list-products/response.json | Storefront list-products example response (source) |
| src/api/storefront/list-products/index.sh | Storefront list-products request snippet (sh, source) |
| src/api/storefront/list-products/index.php | Storefront list-products request snippet (php, source) |
| src/api/storefront/list-products/index.js | Storefront list-products request snippet (js, source) |
| src/api/storefront/list-products/config.yml | Storefront list-products snippet language config (source) |
| src/api/storefront/fetch/response.json | Storefront fetch example response (source) |
| src/api/storefront/fetch/index.sh | Storefront fetch request snippet (sh, source) |
| src/api/storefront/fetch/index.php | Storefront fetch request snippet (php, source) |
| src/api/storefront/fetch/index.js | Storefront fetch request snippet (js, source) |
| src/api/storefront/fetch/config.yml | Storefront fetch snippet language config (source) |
| src/api/storefront/fetch-orders/response.json | Storefront fetch-orders example response (source) |
| src/api/storefront/fetch-orders/index.sh | Storefront fetch-orders request snippet (sh, source) |
| src/api/storefront/fetch-orders/index.php | Storefront fetch-orders request snippet (php, source) |
| src/api/storefront/fetch-orders/index.js | Storefront fetch-orders request snippet (js, source) |
| src/api/storefront/fetch-orders/config.yml | Storefront fetch-orders snippet language config (source) |
| src/api/storefront/duplicate/response.json | Storefront duplicate example response (source) |
| src/api/storefront/duplicate/index.sh | Storefront duplicate request snippet (sh, source) |
| src/api/storefront/duplicate/index.php | Storefront duplicate request snippet (php, source) |
| src/api/storefront/duplicate/index.js | Storefront duplicate request snippet (js, source) |
| src/api/storefront/duplicate/config.yml | Storefront duplicate snippet language config (source) |
| src/api/storefront/delete/response.json | Storefront delete example response (source) |
| src/api/storefront/delete/index.sh | Storefront delete request snippet (sh, source) |
| src/api/storefront/delete/index.php | Storefront delete request snippet (php, source) |
| src/api/storefront/delete/index.js | Storefront delete request snippet (js, source) |
| src/api/storefront/delete/config.yml | Storefront delete snippet language config (source) |
| src/api/storefront/create/response.json | Storefront create example response (source) |
| src/api/storefront/create/index.sh | Storefront create request snippet (sh, source) |
| src/api/storefront/create/index.php | Storefront create request snippet (php, source) |
| src/api/storefront/create/index.js | Storefront create request snippet (js, source) |
| src/api/storefront/create/config.yml | Storefront create snippet language config (source) |
| src/api/storefront/add-products/response.json | Storefront add-products example response (source) |
| src/api/storefront/add-products/index.sh | Storefront add-products request snippet (sh, source) |
| src/api/storefront/add-products/index.php | Storefront add-products request snippet (php, source) |
| src/api/storefront/add-products/index.js | Storefront add-products request snippet (js, source) |
| src/api/storefront/add-products/config.yml | Storefront add-products snippet language config (source) |
| src/api/order/validate/response.json | Order validate example response (source) |
| src/api/order/validate/index.sh | Order validate request snippet (sh, source) |
| src/api/order/validate/index.php | Order validate request snippet (php, source) |
| src/api/order/validate/index.js | Order validate request snippet (js, source) |
| src/api/order/validate/config.yml | Order validate snippet language config (source) |
| src/api/order/list/response.json | Order list example response (source) |
| src/api/order/list/index.sh | Order list request snippet (sh, source) |
| src/api/order/list/index.php | Order list request snippet (php, source) |
| src/api/order/list/index.js | Order list request snippet (js, source) |
| src/api/order/list/config.yml | Order list snippet language config (source) |
| src/api/order/fetch/response.json | Order fetch example response (source) |
| src/api/order/fetch/index.sh | Order fetch request snippet (sh, source) |
| src/api/order/fetch/index.php | Order fetch request snippet (php, source) |
| src/api/order/fetch/index.js | Order fetch request snippet (js, source) |
| src/api/order/fetch/config.yml | Order fetch snippet language config (source) |
| src/api/order/fetch-product-orders/response.json | Order fetch-product-orders example response (source) |
| src/api/order/fetch-product-orders/index.sh | Order fetch-product-orders request snippet (sh, source) |
| src/api/order/fetch-product-orders/index.php | Order fetch-product-orders request snippet (php, source) |
| src/api/order/fetch-product-orders/index.js | Order fetch-product-orders request snippet (js, source) |
| src/api/order/fetch-product-orders/config.yml | Order fetch-product-orders snippet language config (source) |
| src/api/order/create/response.json | Order create example response (source) |
| src/api/order/create/index.sh | Order create request snippet (sh, source) |
| src/api/order/create/index.php | Order create request snippet (php, source) |
| src/api/order/create/index.js | Order create request snippet (js, source) |
| src/api/order/create/config.yml | Order create snippet language config (source) |
| dist/api/storefront/verify-slug/response.json | Storefront verify-slug example response (dist) |
| dist/api/storefront/verify-slug/requests.js | Storefront verify-slug request snippets bundle (dist) |
| dist/api/storefront/update/response.json | Storefront update example response (dist) |
| dist/api/storefront/update/requests.js | Storefront update request snippets bundle (dist) |
| dist/api/storefront/publish/response.json | Storefront publish example response (dist) |
| dist/api/storefront/publish/requests.js | Storefront publish request snippets bundle (dist) |
| dist/api/storefront/list/response.json | Storefront list example response (dist) |
| dist/api/storefront/list/requests.js | Storefront list request snippets bundle (dist) |
| dist/api/storefront/list-products/response.json | Storefront list-products example response (dist) |
| dist/api/storefront/list-products/requests.js | Storefront list-products request snippets bundle (dist) |
| dist/api/storefront/fetch/response.json | Storefront fetch example response (dist) |
| dist/api/storefront/fetch/requests.js | Storefront fetch request snippets bundle (dist) |
| dist/api/storefront/fetch-orders/response.json | Storefront fetch-orders example response (dist) |
| dist/api/storefront/fetch-orders/requests.js | Storefront fetch-orders request snippets bundle (dist) |
| dist/api/storefront/duplicate/response.json | Storefront duplicate example response (dist) |
| dist/api/storefront/duplicate/requests.js | Storefront duplicate request snippets bundle (dist) |
| dist/api/storefront/delete/response.json | Storefront delete example response (dist) |
| dist/api/storefront/delete/requests.js | Storefront delete request snippets bundle (dist) |
| dist/api/storefront/create/response.json | Storefront create example response (dist) |
| dist/api/storefront/create/requests.js | Storefront create request snippets bundle (dist) |
| dist/api/storefront/add-products/response.json | Storefront add-products example response (dist) |
| dist/api/storefront/add-products/requests.js | Storefront add-products request snippets bundle (dist) |
| dist/api/order/validate/response.json | Order validate example response (dist) |
| dist/api/order/validate/requests.js | Order validate request snippets bundle (dist) |
| dist/api/order/list/response.json | Order list example response (dist) |
| dist/api/order/list/requests.js | Order list request snippets bundle (dist) |
| dist/api/order/fetch/response.json | Order fetch example response (dist) |
| dist/api/order/fetch/requests.js | Order fetch request snippets bundle (dist) |
| dist/api/order/fetch-product-orders/response.json | Order fetch-product-orders example response (dist) |
| dist/api/order/fetch-product-orders/requests.js | Order fetch-product-orders request snippets bundle (dist) |
| dist/api/order/create/response.json | Order create example response (dist) |
| dist/api/order/create/requests.js | Order create request snippets bundle (dist) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Adds code snippets for the Storefront and Order APIs