Guidelines for connecting your account in the Qoyod system with the Zid platform using FAI Sync to automatically track business transactions.
Procedures to follow:
Customer Response:
Currently, integration with the Zid platform is done through FAI Sync (formerly known as “Alt Flow”). You can follow the steps below to complete the connection process:
Phase One: Access your Qoyod account or register on the Qoyod platform
If you don’t have an account or business in Qoyod, here are the steps to create a new account:
Step 1: Create an Account
Visit the Qoyod website at qoyod.com. On the homepage, you’ll find two buttons:
-
“Subscribe Now”: to register for a paid plan directly.
-
“Start Your Free Trial”: to try the platform for free for 14 days without needing payment information.
Choose the option that suits you to proceed.
Step 2: Enter Basic Information
A “Create a New Account” page will appear with fields to enter the following information:
-
First and Last Name
-
Email Address
-
Mobile Number (with country code)
-
Company Name
-
Currency Type
-
Industry Field
-
Number of Employees
-
Facility Number (optional)
-
Agreement to Terms of Use
After filling in the fields, click “Start Now”.
Step 3: Confirm Registration
After clicking “Start Now”, a success page will appear with the message “Registration completed successfully” and “Thank you for registering with Qoyod”. This page confirms that your account has been created and an activation email has been sent to your email address.
Step 4: Activate Your Account via Email
Open your email and look for a message from Qoyod with a subject containing “Registration” or “Activate Your Account”. Inside the message, you’ll find a button labeled “Confirm Your Account”. Click it to complete account activation.
The email also contains a direct activation link in case the button doesn’t work, as well as contact information for Qoyod support.
Important Note: If you don’t find the activation email in your inbox, check your Spam folder before contacting customer service.
Step 5: Access General Settings
After logging into your Qoyod account, you’ll find the left sidebar containing several main sections. Click on “Settings” and then select “General Settings” from the submenu that appears below it.
Step 6: Generate an API Key
On the General Settings page, scroll down until you find the “API Key” section. You’ll find a “Generate New Key” button on the left side. Click it to create a new tracking key for your account.
After clicking, the code will appear in the field next to the button. Copy this code as you’ll need it later when connecting it to your Zid store.
Very Important: Click the “Save” button at the bottom of the page to save the code in the system. If you don’t click save, the API key won’t be saved and you’ll have to generate a new one.
Phase Two: Connect Your Qoyod Account to Your Zid Store Through FAI Sync
Step 1: Access the App Store on Zid
Log in to your store’s dashboard on the Zid platform. From the sidebar menu, select App Store
Step 2: Select the Qoyod App from FAI Sync
In the App Store, search for the “Qoyod from FAI” app or go directly to the link: https://apps.zid.sa/application/3158
You’ll find the app page displaying the Qoyod and FAI Sync logos, with a description explaining that the app allows you to connect your store with the Qoyod accounting system and access all data. Click the “Activate App” button.
Step 3: Choose a Plan and Subscribe
A page with available plans will appear
Select the appropriate plan and click “Subscribe”.
Step 4: Install the App
After selecting a plan, a page will appear asking you to grant the app access permissions to your Zid store. The permissions granted include:
-
Read your account information
-
Read store categories
-
Read store orders and their details
-
Read custom shipping methods on the store
-
Read payment methods for the currency in your store
-
Read store customer data
-
Create, add, and delete cards in your store
-
Read your store’s tax settings
-
Manage your store’s discount coupons, including adding new ones
-
Read all abandoned items in the store
-
Read cards in your store (those created by the app only)
-
Read the products in your store, including all their details
-
Manage and modify the store interface
-
Read your inventory information
-
Read marketing inventory management information
-
Add external JavaScript extensions to your store
-
Create new integrated orders within your store
-
Manage and modify visitor application usage codes
Click “Install App” to proceed.
Step 5: Paste the API Key
After installation, you’ll be directed to the FAI Sync interface for your store. You’ll find a “Qoyod Information” section with an “Access Key” field. Paste the API key you copied earlier from Qoyod settings here, then click “Confirm”.
Step 6: Select the Repository
After confirming the access key, a “Select Repository” window will appear showing a list of available repositories in your Qoyod account. Usually, “Main Branch” will appear as the default repository. Select the repository where you want orders to be transferred, then click “OK”.
After this step, the connection is complete and all new orders received on your store will begin being automatically transferred to Qoyod.
Transfer of Old Orders (Before Connection Date)
Orders prior to the connection date are not automatically transferred. You can manually transfer them as follows:
Step 7: Access Order Management
From the sidebar in the FAI Sync interface, click on “Order Management”. You’ll find the Zid / ORDERS page that displays your orders with the status of each order.
Step 8: Pull Old Orders
At the top toolbar of the page, you’ll find buttons including: “Pull Orders”, “Transfer”, “Filter Orders”, “Monthly Reports”, and “Refresh”. Click the “Pull Orders” button.
A “Select Specific Date” window will appear asking you to specify a date range:
-
From: Enter the start date (example: 01/11/2023)
-
To: Enter the end date (example: 01/02/2024)
Click “Confirm” to start the pull process.
Step 9: Wait for Pull to Complete
After confirmation, the system will start retrieving old orders from your store. The process may take several minutes if you have a large number of orders. Wait for the process to complete before proceeding.
Step 10: Transfer Orders
After the pull is complete, you can transfer in two ways:
-
Selective Transfer: Choose the orders you want to transfer manually by checking the box next to each order, then click “Transfer Selected”.
-
Select Specific Date: From the “Transfer” menu in the toolbar, select “Select Specific Date” or “Return Selected” to transfer all orders from the specified period at once.
Step 11: Confirm Transfer and Track Status
After clicking transfer, a confirmation window will appear showing the number of orders selected for transfer, for example: “Are you sure you want to transfer all 5 selected orders?”. Click “Yes” to confirm.
You can track the status of each order through the “Status” column in the order list:
-
Cancelled – Not Transferred: The order exists but hasn’t been transferred yet.
-
Transferring (in yellow): The order is currently being transferred.
-
Transferred to Qoyod (in green): Transfer completed successfully.
Important Notes for Configuring Transfer Settings
Step 12: Customize Default Transfer Settings
From the Administration page in the FAI Sync interface, you can control transfer options that will be applied automatically to all new orders. Available settings:
-
Create a customer for each invoice: Enabled / Disabled
-
Number invoices by order number: Enabled / Disabled
-
Transfer orders based on status: You can specify when transfer occurs automatically:
-
New (default – enabled): All new orders will be transferred immediately upon receipt.
-
Ready: Transfer occurs only when the order status becomes “Ready”.
-
In Transit: Transfer occurs when the status changes to “In Transit”.
-
Completed: Transfer occurs only when the order is completed and delivered.
-
After configuring the appropriate settings for your business, click “Save” to save the changes and apply them to all future orders.
An explanatory video showing how to connect the Zid platform with the Qoyod program:
https://www.youtube.com/watch?v=pjeqh3dg_vQ
