Zid.sa (by noqtatain)

Contact information:
- Email: [info@noqtatain.com] (mailto:info@noqtatain.com)
- WhatsApp: +966 54 356 9492

Working Hours (+3 Asia/Riyadh):
- Sunday to Thursday
- From 9 A.M to 5 P.M

# Zidx24 — Installation Guide (Bitrix24 Market)

Zidx24 connects a **Zid** online store to a **Bitrix24** instance, so orders, customers, and
abandoned carts placed on Zid automatically become Deals/Leads/Contacts in Bitrix24 — with
an optional product & inventory sync into a Bitrix24 catalog. Zid is always the source of
truth; nothing is written back to Zid.

## Prerequisites

- A Zid store with the **Zidx24** app already installed fr om the Zid App Store.
- Admin access to the Bitrix24 instance you want to connect (to approve app permissions).

## Step-by-step installation

1. **Install Zidx24 on your Zid store**, if you haven't already — from the Zid App Store,
  inside your Zid admin panel.
2. Open **Zidx24** from your Zid store admin, then go to **Settings → Bitrix24 Integration**.
3. Enter your Bitrix24 instance address (e.g. `yourcompany.bitrix24.com`) and click **Connect**.
4. A new tab opens on your own Bitrix24 instance, asking you to approve the permissions
  Zidx24 needs:
  - **CRM** — create and update Deals, Leads, and Contacts; read pipelines and stages.
  - **User (brief)** — read basic pipeline/user info used to build the stage-mapping list.
  - **Placement** — add a "Zid Order" tab to the Deal detail view, showing the linked
    order's full details.
5. Click **Install/Allow**. The tab confirms the connection and closes automatically,
  returning you to the Zidx24 dashboard.

> If you instead find and install Zidx24 directly from inside the **Bitrix24 Market**
> first, you'll see a message saying the instance isn't linked to a Zid store yet. This is
> expected — every Bitrix24 connection is tied to a specific Zid store, so finish the
> connection from Settings inside Zidx24 on the Zid side (step 2 above) using the same
> instance address.

## Configure sync settings

Back in Zidx24's Settings page, once Bitrix24 shows as connected:

1. Choose how **customers** map — to a Contact or a Lead.
2. Choose how **orders** map — to a Deal or a Lead. If mapping to Deal, pick a pipeline and
  match each Zid order status (New, Preparing, Ready, In Delivery, Delivered, Cancelled)
  to a stage in that pipeline.
3. Optionally enable **abandoned cart** sync, and wh ere existing carts should move once a
  customer resumes checkout.
4. Optionally map Zid order fields (order number, totals, payment method, shipping city,
  etc.) onto your own Bitrix24 custom fields.
5. Optionally enable **Products & Inventory** sync, and pick the Bitrix24 catalog, price
  type, and (if your Bitrix24 uses Store/warehouse mode) a warehouse for each Zid pickup
  location.
6. Click **Save**. Zidx24 registers the required Bitrix24 webhooks and the "Zid Order"
  deal-tab widget automatically — no manual webhook setup is needed.

## What happens after installation

- New and updated Zid orders and customers automatically create or update the matching
 Deal/Lead/Contact in Bitrix24, per your mapping.
- Abandoned carts sync the same way, if enabled.
- If product sync is enabled, your Bitrix24 catalog's name, price, and stock stay in sync
 with Zid.
- Opening a synced order's Deal in Bitrix24 shows a **Zid Order** tab with the full order
 detail.

## Disconnecting / uninstalling

- In Zidx24 Settings, click **Disconnect** to unlink Bitrix24. This removes the webhooks
 and the deal-tab widget that were registered during installation.
- Uninstalling Zidx24 from the Bitrix24 side (**Applications → Zidx24 → Uninstall**) stops
 all sync activity for that instance as well.