Zid Docs
Merchant APIApp APIThemes
Merchant APIApp APIThemes
Help Center
Slack
  1. Merchant API
  • Start Here 🚀
  • Overview to Zid Apps
  • Authorization
  • Responses
  • Webhooks
  • Rate Limiting
  • APIs
    • Orders
      • Update Order by ID
      • Get Order Credit Notes
      • Get Order by ID
      • List of Orders
    • Reverse Orders
      • Reverse Order Reasons
      • Create Reverse Orders
      • Create Reverse Orders Waybill
      • Add Reverse Order Reasons
    • Carts
      • Get Abandoned Cart Details
      • List Abandoned Carts
    • Products
      • Managing Products
        • Get a Product by ID
        • Retrieve a list of products
        • Create a new product
        • Update an existing product.
        • Bulk update of products using their IDs or SKUs
        • Delete a product.
        • Product Setting
      • Digital Vouchers
        • Product Vouchers
        • Order Voucher
        • Add Product Voucher
        • Import Vouchers
        • Export Vouchers
        • Update Product Voucher
        • Remove Product Voucher
      • Product Categories
        • Get Single Category Details
        • Get all categories
        • Create Store Category
        • Update a Store Category
        • Add a product to a certain category
        • Publish/Unpublish a Category
        • Detach Category from All Products
        • Remove Category from Product
      • Product Badge
        • Product Badge
      • Product Attributes
        • Get Product Attributes
        • Get Product Attributes
        • Retrieve a product attribute
        • Add a New Product Attribute
        • Add a New Product Attribute
        • Update a product attribute
        • Delete a product attribute
      • Product Attribute Presets
        • Get attribute presets
        • Create Attribute Preset
        • Update Attribute Preset
        • Delete an attribute preset
      • Product Customizations
        • Add Product Variants
        • Insert Custom Options to a Product
        • Insert Custom User-Input Fields to a Product
      • Product Manual Sorting
        • Set Custom Product Order
        • Reset the manual sorting of all products
      • Product Images
        • Get List of images of a product.
        • Add an image to a product
        • Update a product Image Order
        • Delete a product image
      • Product Notifications
        • Availability Notification Stats
        • Availability Notifications Settings
        • List Availability Notifications
        • Add Availability Notification
        • Save Availability Notifications Settings
        • Manually Send Availability Notification Email
        • Export Availability Notifications
      • Product Import
        • Email All Products to Store Owner
        • Import Products via CSV or xlsx File
      • Product Stock (Multi-Inventory)
        • Get Product Stock by ID
        • List Product Stocks
        • Add Product Stock
        • Update Single Product Stock
        • Bulk Update Product Stocks
      • Product Questions & Answers
        • Get Question
        • Get Answer
        • Get All Questions
        • List Question Answers
        • Create Question
        • Create Answer
        • Update Question
        • Update Answer
        • Delete Question
        • Delete Answer
      • Product Reviews
        • List Reviews
        • New Reviews Total
      • Digital Products
        • Create Downloadable Product
        • Generate an Upload URL
        • Upload File to S3
        • Create Product Downloadables
        • Get Product Downloadables
        • Delete Product Downloadables
        • Get Store Downloadables
        • Create Store Downloadables
        • Delete Store Downloadables
    • Inventories
      • Get Store Location by ID
      • List Store Locations
      • Add a New Location
      • Update a Location by ID
      • Update Products Stock by Location ID
    • Shipping
      • List Store Delivery Options
      • Add Shipping Option
    • Marketing
      • Gift Cards
        • Get Store Settings
        • Add gift card to the cart
        • Update Store Settings
        • Upload gift card designs
        • Remove gift card from the cart
      • Coupons
        • Create a New Coupon
        • List Coupons
        • Get Coupon Details
        • Update Coupon
        • Delete Coupon
      • Bundle Offers
        • Retrieve all Bundle Offers
      • Loyalty Program
        • Loyalty Program Points per Order
        • Store Loyalty Status
        • Info Page
        • Loyalty Program Activation
        • Loyalty Status
        • Set Points Expiration
        • Cashback Rule Method Update
        • Cashback Rule Method Update Status
        • Add Points Redemption Method
        • Update Points Redemption Method
        • Delete Points Redemption Method
        • Toggle Redemption Method Status
        • Show Loyalty Points Info for Specific Customer
        • Customer Profile
        • List Data
        • Customer Points History
        • Info Page - Managers
        • Update Info Page
        • Adjust Customer Points
    • Customers
      • List of Customers
      • Get Customer by ID
    • Store Settings
      • 📄 User Roles and Permissions
      • Get Manager's Profile
      • Get VAT Settings
      • List of Payment Method
    • Countries and Cities
      • Retrieve Store Operating Countries
      • Retrieve Cities by Country ID
      • Countries List
    • Webhook
      • List of Webhooks
      • Create a Webhook
      • Delete a Webhook by OriginalId
      • Delete a Webhook by Subscriber
  • Store Events
    • Order
    • Product
    • Abandoned Cart
    • Customer
    • Product Category
  1. Merchant API

Overview to Zid Apps

Zid offers a strong platform for partners to develop applications that enhance the functionality of online stores. Understanding the different types of apps in Zid is essential for developers aiming for successful integrations. This article provides an overview of the app types supported by Zid, the development process, and the publishing options.

App Types#

When you develop an app in Zid, you must decide whether it will be public or private. These options determine how the app is published and who can access it:
ZAM Merchant Dashboard Store Setup (2).png

Subscription Apps#

Subscription apps are designed to provide multiple plan prices with recurring services and trial periods that merchants can subscribe to within defined period, typically monthly or yearly basis. The subscription model allows developers to offer continuous value while generating recurring revenue.
Public apps: Apps designed for wider use and are listed in Zid App Market. All merchants on the platform can view, install, and benefit from these apps.
Private apps: Apps intended for specific stores only. They are not listed in the Zid App Market and can only be installed by stores explicitly granted access.
💡
Prerequisites for Developing Private Apps
The app should not be of the "logistic" type, as all shipping and fulfillment apps must be public.
The store must have a Professional or Enterprise plan subscription, or the merchant must have activated API Access from the dashboard to be able to install the private app.

Shipping apps#

Shipping apps are specifically designed to integrate logistics and shipping services into the merchant's store. These apps connect merchants with shipping and fulfillment providers, helping them manage orders, shipments, and delivery services efficiently.
Shipping and fulfillment company: Apps that connect merchants with companies that handle both shipping and fulfillment. They manage the entire logistics chain, from warehousing products to delivering them to customers.
Shipping company only: Apps that are focused only on the shipping aspect. They allow merchants to partner with carriers for delivering orders but do not include warehousing or fulfillment services.

App Development Cycle#

Follow these steps to develop and integrate your application with Zid:
1
Complete Partnership Details
Start by completing the partnership agreement here. This step is not required for private apps.
2
Create Your App
Follow our step-by-step guide to get started. Whether you're building a Public, Private, or Shipping app, this guide covers all the key steps
3
Start Development
Utilize Zid’s APIs available in this documentation to begin your app development.
4
Submit for Review
After developing the app, our team will take some time to review your submission and test the app functionality before publishing it to the public.
5
Publish Your App
Once your app is tested and approved, your app will be listed in Zid App Market for all merchants or installed directly to the store if it’s a private app.

Additional Features to Discover#

The Partner Dashboard offers a suite of tools designed to help you manage and optimize your app's performance, including:
Promotions Management: Easily create and manage promotional offers and coupons that can be targeted to Zid merchants, helping to drive engagement and boost app adoption.
Analytics & Reporting: Gain insights into how your app is performing with access to detailed analytics that track user interactions and operational metrics.
Payouts: Sccess detailed monthly payout reports and upload invoices, ensuring you receive accurate and timely payments.
Webhook Logs: Access detailed logs of webhook activities to ensure seamless communication between your app and Zid. This feature allows you to monitor data exchanges and troubleshoot any issues efficiently.
Modified at 2024-09-04 11:08:17
Previous
Start Here 🚀
Next
Authorization
Built with