Skip to content

chore: adds api walkthrough docs#2214

Open
somethings (lasomethingsomething) wants to merge 13 commits intomainfrom
mar30-apiwalkthroughs
Open

chore: adds api walkthrough docs#2214
somethings (lasomethingsomething) wants to merge 13 commits intomainfrom
mar30-apiwalkthroughs

Conversation

@lasomethingsomething
Copy link
Copy Markdown
Contributor

Aims to help dev-users with common workflows while we implement improvements in the APIs, while also illustrating step-by-step the workflow being considered here shopware/shopware#15348 as part of API improvements.

Partially responds to a request by Viktor Khliupko (@biotech-shopware) listed here: #2128 (comment)

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new “API Walkthroughs” docs section under the integrations API guides to provide end-to-end, copy/pasteable workflows (Admin API + Store API) aligned with the API improvement discussions in shopware/shopware#15348 and docs issue #2128.

Changes:

  • Introduces a new walkthrough index page for the integrations API docs.
  • Adds a detailed “Create a Product and Complete Checkout” walkthrough covering token creation, entity setup, Store API context, cart, customer registration, ordering, and payment handling.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
guides/development/integrations-api/walkthroughs/index.md New section landing page listing available API walkthroughs.
guides/development/integrations-api/walkthroughs/create-product.md New end-to-end walkthrough demonstrating a full Admin API → Store API flow for product creation through checkout.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…t.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…t.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Michael Telgmann <mitelg@users.noreply.github.com>
@Isengo1989 Micha Hobert (Isengo1989) added the DX Team #product-cc-dx-tools label Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DX Team #product-cc-dx-tools

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants