Welcome to XAPHOS Developer Platform. Check out our REST API Documentation.

Zid Docs
Home
Website
Zid Docs
REST API v1 (beta)
  • Introduction
  • Access API
  • Admin API
  • Analytics API
  • Audit API
  • Auth API
  • Billing API
  • Core API
  • Integration API
  • Notification API
  • Signal API
  • Support API
  • User Management API
  • Schemas
logoPowered by Apidog

Start Here 🚀

As a Zid Partner, you have the opportunity to create and offer apps and themes that help merchants scale their businesses. Whether you’re a developer, designer, or tech entrepreneur, we provide you with the ideal platform to bring your innovative solutions to a growing network of online stores.

:::tip[Your Guide to Building Better]
Explore the Merchant's help center to understand the dashboard features and configure your testing environment.
:::

Join as a Zid Partner

Your partnership journey begins by registering your partner account on Zid. Once registered, you will have access to the Partner Dashboard, where you can manage your apps and themes, track subscribed stores, monitor your monthly payouts and more!

Unlock Growth and Opportunities!

Joining Zid as a partner opens the door to numerous benefits, including:

  • Expand Your Reach: Connect with a broad network of merchants eager to enhance their stores.
  • Unlock Revenue Streams: Generate income through app sales, theme designs, and additional services.
  • Comprehensive Support & Resources: Access a wealth of developer tools, technical assistance, and marketing resources to help you succeed.

Access Partner Dashboard

API Reference and Documentation

Merchant APIs

The Merchant API allows developers to interact directly with merchant stores, enabling them to perform various tasks such as updating store information, creating and managing products, set up webhooks for real-time data synchronization and more:

:::caution[]
Need a specific endpoint that’s not listed? Click here to request and help us tailor our services to your needs!
:::

Manage and track customer orders, including reversed orders and abandoned carts. Access and modify store's product catalog, including variants and product setting.


Monitor and adjust stock levels for products across different locations.


Set up and list shipping options for stores.


Create and manage promotions, discounts, and other marketing tools.


List store customers, including profiles and addresses.


List general store settings, payment methods, and other preferences.


List geographic regions for shipping and other location-based settings.


Set up automated notifications for specific store events.


Integrate custom scripts to enhance store functionality and automation.

Theme Documentation

Our Theme Documentation provides everything you need to build, customize, and manage themes that merchants can use to personalize their online stores. The documentation includes:

Files contains specific data that developers can utilize, offering the opportunity to create themes within Zid. Schemas that will enable you to create customizable, SEO-friendly, and user-friendly components for your theme. Files containing data and customization options that developers can utilize to support store features.

Access Help and Support

Beyond the documentation, Zid offers several resources to support your development journey:

Access detailed how-to guides and troubleshooting tips Stay updated with the latest platform changes and improvements. Share your feedback and ideas or vote on existing ones to help us improve.

In case you need additional assistance, reach out through:

  • Chat: Access the chat widget directly from your dashboard for instant help.
  • Email: Get direct support via email.
  • Slack: Join our community channel for collaboration.
  • Book a Meeting: Schedule time for technical troubleshooting or other issues.
Last modified: 3 months ago