Zid Docs
Apps
ThemesPayments
Apps
ThemesPayments
Help Center
Slack
  1. Authorization
  • πŸ—‚οΈ Overview
  • πŸš€ Start Here
  • Create your First App
  • Responses
  • Rate Limiting
  • Embedded Apps
  • StoreFront Events
  • Zid MUI
  • Zid SDKs
  • Our custom MCP server
  • Zid AI Agent Skill
  • Authorization
    • Authorization
    • Public Apps OAuth Requirements
    • OAuth Errors & Troubleshooting
    • Zid Bridge Tool
  • Merchant APIs
    • Account
      • Me
        • Me
      • Store
        • Store
        • Branding
        • Localization
        • Social
        • Operations
        • Business
        • Upload Logo Image
        • Delete Logo Image
        • Upload Icon Image
        • Delete Icon Image
        • Upload Cover Image
        • Delete Cover Image
    • Orders
      • Order Tags
        • List Order Tags
        • Create Order Tag
      • Validate Order Request
      • Create Order
      • Change Order Status
      • Add Order Comment
      • View Order
      • List Orders
      • List Custom Order Statuses
      • List Order Credit Notes
      • Get Orders Highlights
      • Order Fulfillment Inventories
      • Bulk Create/Update Custom Order Statuses
    • Reverse Orders
      • Create Reverse Orders
      • Create Reverse Orders Waybill
      • Add Reverse Order Reasons
      • List Reverse Reasons
      • Calculate Reverse Totals
      • Create refund for reverse order
      • Upload bank transfer receipt
      • Update return products
      • Order Details – View for Return
    • Abandoned Carts
      • List Carts
      • View Cart
      • Validate Abandoned Cart Messages
      • Send Abandoned Cart Notification Manually
    • Products
      • Managing Products
        • Create Product Types
        • Create Product
        • List Products
        • View Product
        • List Product Settings
        • Update Product
        • Bulk Update Products
        • Delete Product
      • Digital Vouchers
        • List Vouchers
        • Order Vouchers
        • Create Voucher
        • Import Vouchers
        • Export Vouchers
        • Update Voucher
        • Remove Voucher
      • Product Categories
        • List Categories
        • View Category
        • Create Category
        • Create Subcategory
        • Update Category
        • Assign Product to Category
        • Bulk Assign Products to Category
        • Publish Category
        • Detach Category from All Products
        • Remove Product from Category
        • Set Categories Nesting
        • Delete Category Cover Image
        • Upload Category Cover Image
        • Delete Category
        • Delete Category Image
        • Upload Category Image
        • Update Category
      • Product Brands
        • List Brands
        • Single Brand
      • Product Badge
        • List Badges
      • Product Attributes
        • List Attributes
        • View Attribute
        • Create Attribute
        • Update Attribute
        • Delete Attribute
      • Product Attribute Presets
        • List Presets
        • Create Preset
        • Update Preset
        • Delete Preset
      • Product Variants
        • Create Variants
        • Create Custom Option
        • Update Custom Option
        • Delete Custom Option Field
        • Create Custom Input Field
        • Update Custom Input Field
        • Delete Custom Input Field
      • Product Sorting
        • Set Manual Product Order
        • Reset Manual Product Order
      • Product Images
        • List Images
        • Upload Image
        • Update Image Order
        • Delete Image
      • Product Availability Notifications
        • Notification Stats
        • Noticiation Settings
        • List Notifications
        • Create Notification
        • Update Settings
        • Send Notification Email
        • Export Notifications
      • Product Export
        • Email All Products to Store Owner
        • Import Products via CSV or xlsx File
      • Product Stock
        • Retrieve Product Stock
        • List Product Stock Records
        • Create Product Stock
        • Update Product Stock
        • Bulk Update Product Stock Records
      • Product Questions & Answers
        • Retrieve Product Question
        • Retrieve Product Answer
        • List Product Questions
        • List Answers for Question
        • Create Product Question
        • Create Product Answer
        • Update Product Question
        • Update Product Answer
        • Delete Product Question
        • Delete Product Answer
        • List Store Product Questions
      • Product Reviews
        • List Reviews
        • Count Reviews
      • Digital Products
        • Create Downloadable Product
        • Generate Upload URL
        • Upload File to S3
        • Create Product Downloadable
        • Get Product Downloadables
        • Delete Product Downloadable
        • List Store Downloadables
        • Create Store Downloadable
        • Delete Store Downloadable
    • Inventories
      • Create Location
      • Update Location
      • Update Product Stock for Location
      • List Locations
      • View Location
    • Shipping
      • List Store Shipping Methods
    • Marketing
      • Coupons
        • List Coupons
        • View Coupon
        • Create Coupon
        • Generate Bulk Coupons
        • Duplicate Coupon
        • Duplicate Bulk Coupons
        • Update Coupon Note
        • Update Coupon
        • Update Bulk Coupons
        • Update Coupon Status
        • Update Bulk Coupons Status
        • Delete Coupon
        • Delete Bulk Coupons
      • Bundle Offers
        • List Bundle Offers
        • View Bundle Offer
        • Create Bundle Offer
        • Update Bundle Offer
        • Delete Bundle Offer
        • Bulk Delete Bundle Offers
      • Loyalty Program
        • Loyalty Program Status
        • Loyalty Program Details
        • Loyalty Program Info
        • Customer Loyalty Summary
        • Customer Points History
        • Activate Loyalty Program
        • Set Points Expiration Rules
        • Update Cashback Rule
        • Create Points Redemption Method
        • Update Points Redemption Method
        • Delete Points Redemption Method
        • Adjust Customer Points
        • Update Redemption Method Status
        • Loyalty Program Analytics
        • Loyalty Program Settings
      • Customer Wallets
        • Cashback Rules
          • List Cashback Rules
          • Create Cashback Rule
          • Retrieve Cashback Rule
          • Update Cashback Rule
          • Delete Cashback Rule
        • Wallet Analytics
          • Get Wallet Analytics
          • Get Wallet Analytics by Rule
        • Manager Customer Wallet
          • List Customer Wallets
          • Bulk Credit Customer Wallets
          • Bulk Debit Customer Wallets
          • Export Customer Wallets
          • Get Customer Wallet Balance
          • Credit Customer Wallet
          • Debit Customer Wallet
          • Customer Pending Cashbacks
          • Customer Wallet Transactions
    • Customers
      • Customer Tags
        • List Customer Tags
        • Add Customer Tag
        • Ω’Update Customer Tag
        • Delete Customer Tag
      • Customer Portal Tickets
        • List Customer Portal Tickets
        • Customer Portal Ticket Detail
      • List Customers
      • View Customer
      • Primary Customer List
      • FInd Customer By Phone Number
      • Customer Profile
      • Add Customer
      • Update Customer
      • Delete Customer
      • Add Bulk Customers
      • Import Customers
    • Store Settings
      • πŸ“„ User Roles and Permissions
      • Retrieve Store Manager Profile
      • Retrieve VAT Settings
      • List Payment Methods
      • List Store Operating Countries
      • OneSignal Store Settings
      • Create or Update OneSignal Store Settings
      • Get Payment Options
    • Countries and Cities
      • List Countries
      • List Cities for Country
    • Blogs
      • Settings
        • Create
        • List
      • Categories
        • Create
        • List
        • Bulk Activate
        • Bulk Deactivate
        • Bulk Delete
        • Retrieve
        • Destroy
        • Partial Update
        • Bulk Add To Posts
        • Bulk Remove From Posts
        • Bulk Delete Blog Categories
      • Posts
        • Media
          • List
          • Create
          • Destroy
        • Create
        • List
        • Retrieve
        • Partial Update
        • Destroy
        • Archive
        • Publish
        • Bulk Archive
        • Bulk Publish
        • Bulk Delete
        • Export Posts
        • Import Template
        • Import Posts
      • Tags
        • Create
        • List
        • Retrieve
        • Partial Update
        • Destroy
        • Bulk Delete Tags
        • Bulk Add To Posts
        • Bulk Remove From Posts
      • Storefront
        • Posts
          • List
          • Retrieve
        • Categories
          • List
          • Retrieve
        • Tags
          • List
  • Webhooks
    • Overview
    • Webhook Health Tracking
    • Events
      • Order
      • Product
      • Abandoned Cart
      • Customer
      • Product Category
    • APIs
      • Health Summary
      • Broken Webhooks
      • Recover Broken Webhooks
      • List Webhooks
      • Create Webhook
      • Delete Webhook
      • Delete Webhook By subscriber
  • App Management
    • Events
    • APIs
      • Subscription Details
      • Update Usage-Based Charges
  1. Authorization

Zid Bridge Tool

Zid Bridge is a hosted tool that completes the Zid OAuth flow for you and hands you a working set of tokens. You do not need to write any code or run a server to use it.
Use it to test the OAuth flow while you build, or as the permanent token source for a private single-store app.
Try it: bridge.zid.dev Β· Video walkthrough: watch the tutorial
❌
Not for public apps in production. Zid Bridge is a testing and private-app tool. Any public app submitted for review with Zid Bridge URLs registered as its redirect or callback URL will be rejected. A public app must implement the OAuth flow on its own server β€” see Public Apps OAuth Requirements.

When to use it#

SituationUse Zid Bridge?
Exploring the Merchant APIs before writing any codeβœ… Yes
Testing your OAuth setup, scopes or credentials during developmentβœ… Yes
Generating a token to try a request in Postman or APIDogβœ… Yes
A private app β€” a single-store integration with an ERP or internal systemβœ… Yes
A public app listed in Zid App Market❌ No β€” will be rejected at review
Private apps have no specific activation-flow requirements, so Zid Bridge is a supported way to obtain and refresh their tokens without building an OAuth callback of your own.

How it works#

1.
Sign up at bridge.zid.dev.
2.
Register your app β€” enter a name, then your Client ID and Client secret from the Partner Dashboard (Apps β†’ All Apps β†’ edit app β†’ General settings β†’ API keys).
3.
Copy the two generated URLs. Zid Bridge creates a pair unique to your app:
Redirect URL β€” https://bridge.zid.dev/zid/<your-app-uuid>/redirect
Callback URL β€” https://bridge.zid.dev/zid/<your-app-uuid>/callback
4.
Paste them into the Partner Dashboard as your app's redirect and callback URLs.
5.
Activate the app on a store β€” your own development store, or a merchant's store for a private app.
6.
Download the tokens from the page that appears.

What you get#

After a successful authorization, Zid Bridge shows the tokens once and offers them in three formats:
Postman environment β€” import and start calling the API immediately
APIDog environment β€” same, for APIDog
Raw JSON β€” the full token response
Each export is pre-filled with the Authorization token, the Access-Token (X-Manager-Token) and the store ID, and is named after the store it belongs to.
A complete Zid API Postman collection is also available from the Zid Bridge home page, so you can pair the environment with ready-made requests.
πŸ’‘
The token page is shown only once. Download what you need before closing it β€” Zid Bridge does not keep a copy. If you lose the tokens, activate the app again to generate a new set.

What Zid Bridge stores#

StoredNot stored
Your account (name, email)❌ Access tokens
Your app's name, Client ID and Client secret❌ Manager tokens (X-Manager-Token)
A history of which stores activated your app β€” store ID, name, URL and timestamp❌ Refresh tokens
Zid Bridge needs your Client secret because it performs the token exchange on your behalf. Prefer the credentials of a development or private app, and rotate your secret in the Partner Dashboard if you stop using the tool.

Token lifetime#

The tokens Zid Bridge returns are ordinary Zid OAuth tokens with the normal lifetimes β€” the refresh token is valid for one year. If you are using Zid Bridge for a private app in day-to-day use, you still need to refresh on a schedule, or re-run the activation before the year is out.
See Authorization for the refresh flow, and OAuth Errors & Troubleshooting if a token stops working.

Running your own instance#

Zid Bridge is open source and can be self-hosted with Docker if you would rather keep credentials inside your own infrastructure. See the project's README.md for setup.

Related resources#

Authorization β€” the OAuth 2.0 flow in full
Public Apps OAuth Requirements β€” what public apps must implement instead
OAuth Errors & Troubleshooting β€” error codes and fixes
Modified atΒ 2026-10-19 15:41:04
Previous
OAuth Errors & Troubleshooting
Next
Me
Built with