Connect to Ninja Van
This is the setup guidelines on how to Connect your OpenCart Website to Ninja Van. What you need:
A Ninja Van Production Pro Account
A Ninja Van Extension Installation
An OpenCart Website
Authorization Approval (1-3 working days)
Connect OpenCart Website to Ninja Van
Do take note that the integration setup may take around 1-3 working days to get the Authorization Approval before you are able to use any of the integration features. You will be notified in your email and WhatsApp by your Ninja Van Sales Representative or Account Manager.
Our Integration Audit will comprise 2 API audit before we grant the access in Production Environment
Order Create API
Waybill API
Request OpenCart Integration Authorization Approval
Fill the form below OR Click on the link here to view the Request Form (if not shown)
Fill in your API key, Client ID & Client Key in our Integration Authorization Approval Form, and then click Submit
The authorization will take usually around 1-3 working days
Note: the period may differ based on the number of authorization requests we received daily
We'll inform you through email once your account is ready to use the integration
You will get this email to your registered email address same as the login email on Ninjavan Dashboard.
Extension Plugin Installation
You can find and download our Extension Plugin through the link here. You can also find it in OpenCart Marketplace as we have already published it. You can refer to the Installation Guideline for each Version Respectively once you have installed the Extension Plugin
It's free and supports for all OpenCart Versions:
Version 1.x
Version 2.x
Version 3.x
You can refer the Installation Guideline for each Version Respectively once you have installed the Extension Plugin
OpenCart 1.x
Download the extension compatible for your OpenCart version
Download vQmod from here and follow the instructions here. Ignore this step if you have done before
Unzip the extension zip file and upload everything inside the “upload” folder to the root of your OpenCart store.
Login to your OpenCart admin and go to Extensions > Modules
Find “Ninja Van” and click install.
OpenCart 2.x
Download the extension compatible with your OpenCart version
Login to your OpenCart admin
Ensure you have FTP enabled on your server. If the FTP is disabled by your hosting or you don’t want to setup FTP, you are recommended to install QuickFix to avoid installation permission error.
Go to Extensions > Extension installer
Click “Upload” and select the Ninja Van extension you had downloaded. Then click Continue
Go to Extensions > Modifications. Click the “Refresh” button at top right
Go to Extensions > Modules. Find for Ninja Van and click “Install” button
OpenCart 3.x
Download the extension compatible with your OpenCart version
Login to your OpenCart admin
Go to Extensions > Installer
Click “Upload” and select the Ninja Van extension you had downloaded.
Go to Extensions > Modifications. Click the “Refresh” button at top right
Go to Extensions > Modules. Find for Ninja Van and click “install” button
Production Account Setup
Once you have been granted the Authorization Access in Production Environment, kindly login to both your Website Admin Page and your Ninja Van Pro Account Dashboard (URL: https://dashboard.ninjavan.co/login-v2)
1. Go back to Ninja Van modules in your Website Admin Page
2. In the dashboard, click “Setting”
3. Login to your Ninja Van Production Pro Account Dashboard,
4. Go to Settings > IT Settings
5. Copy the Client ID and Client Key
Note: Click "Generate Client ID & Key" if it doesn't appear)
6. Paste the API keys
Go back to your Website Admin Page, Enter “Client ID” and “Client key”, then click “Save”
7. Click the “Generate” button to generate a token
8. You should see the success message.
In the “Access Token” field, you should see the expiration date.
Always check the expiration date to avoid function interruption.
You can click “Regenerate” to refresh the token if necessary.
Note: Always check the token first before creating any orders
9. Go back to Ninja Van modules
10. In the dashboard, click "Address Book"
11. Click “add” to add a new address
12. Fill in the address form and click “Save”
13. You can add more than 1 address as your Pickup Location
Maximum 10 Addresses
Set CronJob for Auto Token Generation
This setting was required in order to auto generating the Access Token. Kindly refer below for the guidelines
1. Go to Ninja Van modules
2. In the dashboard, click “Setting”
3. Go to the “Cronjob” tab
4. If cronjob token is not generated,
Click the refresh icon to generate a cronjob token, then click save.
5. Go to the “Cronjob” tab again,
Copy the “auto regenerate token” URL and set the cronjob in your server.
Note: Every Hosting provides a different way of setting the cronjob. Kindly refer your hosting provider
Webhooks & Order Fulfillment
You can synchronize your Website's Order Status to Ninja Van's Order Status by setting up Webhooks in your Ninja Van Account. This will allow you to get Ninja Van's Parcel Tracking Status update in real-time, but also update your Website Order by mapping the order status. For example, if the Ninja Van order is completed, you can set the Website order status to completed also.
1. Login to your Ninja Van Production Pro Account Dashboard
2. Go to Settings > IT Settings
3. Scroll down to the Webhooks section
- Click “Add” to add a new webhook
4. Login to your Website Admin Page
Go to Ninja Van modules
5. In the dashboard, click “Setting”
6. Click on the “Order fulfillment” tab
7. Copy the webhook URL
8. Go back to your Ninja Dashboard,
Select "Pending Pickup" for the event
Select “1.1” for the version
Then paste the URL you have copied from the Website Admin Page into the URL Endpoint section.
Click “Save” to save
9. Repeat this by clicking “Add another” to add other events with the same version and URL Endpoint
10. These are the suggested Events to add:
Pending Pickup
Arrived at Sorting Hub
On Vehicle For Delivery
Completed
Return to Sender
Cancelled
11. You can add all events available in the event field as well
12. Go back to your Website Admin Page
13. For each event, you can select an order status to update when receiving a Webhook, then click “Save”. You can select “No update” if you don’t want to update the Website order status.
14. You are suggested to map as follows:
Ninja Van Event = OpenCart Order Status
Pending Pickup = Processing
Arrived at Sorting Hub = Processed
On Vehicle For Delivery = Shipped
Completed = Complete
Return to Sender = Reversed
Cancelled = Canceled
15. Go back to Ninja Van Module's Setting
16. Go to "Status"
17. Select "Enabled" for Status
Email Notifications
You can set up a customized email notification to be sent to your customers. This email notification can be mapped also to any Ninja Van Status Triggered to send automatic emails
1. Go back to your OpenCart store
2. For each of the event
You can select an order status to update and an email template to send when receiving a webhook
Then click “Save”.
You can select “No update” if you don’t want to update the OpenCart order status.
3. Add email templates
4. Go to Ninja Van modules
5. In the dashboard, click “Email Template”
Set Ninja Van COD Charge
You can set up a different additional charge for Cash-on-Delivery Orders based on the customer's total checkout amount. Kindly refer the guidelines below:
1. Ninja van COD charge
Allows you to add extra charges when customers choose COD as a payment method.
2. Go to Ninja Van modules
3. In the dashboard, click “Setting”
4. Go to the “COD Charge” tab
5. COD Setup:
Enable the COD charge and set the sort order
The sort order should be after the sub-total and before the order total.
Enter the minimum total and the amount to be charged,
You can add up to 5 charges.
Click save to save the setting.
6. You can go to your storefront to check if it is working.
First, add a product to the cart and checkout,
In the payment method step, select “Cash on delivery” as a payment method,
Then click “Next”, you should see a “Ninja Van COD charge” in the order total.
Default Settings
Here are some of the default settings that you can set to the extensions. You can find this setting in your Website Admin Dashboard > Ninja Van Module > Setting > Setting
Pickup Timeslot
This is to set the default timeslot for pickup reservation to Ninja Van
Select your Default Pickup Timeslot, this will be the default timeslot used during order creation
Autofill Product to Delivery Instructions
This is to set whether if you wanted to display the item descriptions with quantity on the Waybills Generated
Note: This will only show the product name, you may need to edit the extension file if you wanted to display "Product Options" or "Product Variations".
Simply go to the Ninja Van's Plugin Folder > admin > controller > extension > module > ninja_van.php and look for $delivery_instructions[] = $product['model'] . ' x' . $product['quantity' to add or edit the parameter you use
Select "Yes" for Autofill delivery instructions if you wanted to display Item Descriptions on Waybills
Autofill order ID to delivery instructions
You can display the Order ID in the Waybill's Delivery Instructions
Select "Yes" to display Order ID in Waybills
Requested Tracking Number as Order ID
You can use your Order ID as the Requested Tracking Number to prevent any duplicate order creations
Select "Yes" to use your Order ID as the Requested Tracking Number
Requested Tracking Number Prefix
If you are using your Order ID as the Requested Tracking Number, you may encounter the error "Duplicate Tracking: Tracking Number has been used"
You can add a prefix to prevent this error
Autofill Minimum Insured Value
You can autofill the insured value of each of your parcels (Not recommended if most of your parcel value is less than RM 200.00 due to the default insurance Ninja Van offered)
Select "Yes" if you want the insured value to be autofill for every order
Hide Shipper Detail (Waybill)
You can hide your Sender Details on the Waybills if you wanted some privacy of your Address from your customers
Select "Yes" for Hiding the Sender Details on Waybills
Status
This is to enable Ninja Van's Webhooks Status to be synchronized with your website Order Status
Select "Enabled" for Status
I'm ready to start my tutorial!
You can set a tutorial session with Ninja Van Team with you require on-hand guidance