Skip to content

Conversation

@shahednasser
Copy link
Member

Summary

What — What changes are introduced in this PR?

Add a best practices doc for syncing data between Medusa and external services

Closes DX-2351

Why — Why are these changes relevant or necessary?

Please provide answer here

How — How have these changes been implemented?

Please provide answer here

Testing — How have these changes been tested, or how can the reviewer test the feature?

Please provide answer here


Examples

Provide examples or code snippets that demonstrate how this feature works, or how it can be used in practice.
This helps with documentation and ensures maintainers can quickly understand and verify the change.

// Example usage

Checklist

Please ensure the following before requesting a review:

  • I have added a changeset for this PR
    • Every non-breaking change should be marked as a patch
    • To add a changeset, run yarn changeset and follow the prompts
  • The changes are covered by relevant tests
  • I have verified the code works as intended locally
  • I have linked the related issue(s) if applicable

Additional Context

Add any additional context, related issues, or references that might help the reviewer understand this PR.

@shahednasser shahednasser requested a review from a team as a code owner December 3, 2025 11:49
@vercel
Copy link

vercel bot commented Dec 3, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs-v2 Ready Ready Preview Comment Dec 3, 2025 11:53am
7 Skipped Deployments
Project Deployment Preview Comments Updated (UTC)
api-reference Ignored Ignored Dec 3, 2025 11:53am
api-reference-v2 Ignored Ignored Dec 3, 2025 11:53am
cloud-docs Ignored Ignored Dec 3, 2025 11:53am
docs-ui Ignored Ignored Dec 3, 2025 11:53am
medusa-docs Ignored Ignored Dec 3, 2025 11:53am
resources-docs Ignored Ignored Dec 3, 2025 11:53am
user-guide Ignored Ignored Dec 3, 2025 11:53am

@changeset-bot
Copy link

changeset-bot bot commented Dec 3, 2025

⚠️ No Changeset found

Latest commit: 2660e7c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@shahednasser shahednasser merged commit 2087c8d into develop Dec 3, 2025
47 checks passed
@shahednasser shahednasser deleted the docs/best-practices-3rd-party branch December 3, 2025 13:47
Balu-Varanasi pushed a commit to Balu-Varanasi/medusa that referenced this pull request Dec 11, 2025
* docs: add best practices doc for third-party syncing

* small fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants