Hardware Order Now End-to-End Integrator Journey

Custom Telematic Device (CTD) Integrations

Introduction

This guide provides insight into the journey of fulfilling an Order Now (ON) purchase through the Geotab Marketplace, including the customer purchase, Partner approval and integrator fulfillment.

Key aspects include:

1. Marketplace Purchase: Customers buy solutions through the Marketplace.
2. Reselling Partners Approval: Resellers review and approve customer orders.
3. Order Communication: Solution providers receive order details via email, MyAdmin UI, or APIs.
4. Actioning an Order: Solution providers are responsible for provisioning a corresponding virtual Geotab serial number to represent the physical devices.
5. Order Fulfillment: Integrator sends the devices to the customers based on order details and shares the shipment details accordingly through the fulfillment workflow.
6. Data Ingestion: Once devices are provisioned, integrators push data via the DIG platform.

Order journey

Marketplace purchase

Through the Geotab Marketplace, Customers can view the current selection of solutions available to them by their Partners. These are solutions provided by our integration partners.

Once a Customer purchases a solution, they receive a purchase confirmation.

Partner order review

Completed orders are triaged to the Partner responsible for managing them. They review and approve the order to keep them up to date with incoming purchases and their status.

For further confirmation, the Partner also receives an email relaying the final information regarding every purchase. This can be used for future reference, if needed.

Solution provider order intake

Once a customer order is approved by their Partner, the order is then communicated to the solution provider for fulfillment. The solution provider can access the necessary order details through the following methods:

Email

Providers will receive email notifications containing essential order information:

1. Purchase Order (PO): This document details the specific items ordered, quantities, and pricing.
2. Packing Slip: This document lists the items included in the shipment, often used for verification upon receipt.

Both the Purchase Order and Packing Slip provide crucial information for accurate and efficient order fulfillment.

MyAdmin

The Partner Fulfillment page within MyAdmin displays new and existing orders created towards the integrator. Each order contains the same information outlined over email.

For the complete process, refer to the Partner Fulfillment User Guide.

MyAdmin APIs

Geotab also supports a simpler way to view such information through API usage, allowing the integrator to view the same order details also found in the Packing Slip email.

For a comprehensive guide on the API implementation, refer to the Partner Fulfillment API document.

API response example

{

"orderHeaderId":,

"account": {

"accountId": "",

"id":

},

"orderDate": "",

"shipmentStatus": "PendingFulfillment",

"comment": "",

"shippingContact": {

"name": "",

"email": "",

"street1": "",

"street2": "",

"city": "",

"state": "",

"zipCode": "",

"telephone1": "",

"telephone2": ""

},

"resellerName": "",

"resellerEmail": "",

"purchaseOrderNumber": "",

"shipmentReference": "",

"validated":,

"id":

}

Fulfillment

Once an order has been placed, depending on the order requirements, the integrator is in charge of delivering the solution while also keeping Geotab updated regarding the order details and shipment information.

This is implemented through the fulfilment workflow, which also in some cases includes the following CTD provisioning process to fulfill the order.

Custom Telematics Device provisioning

In cases where the order is made for a solution that employs CTD integration, the integrator must provision serial numbers on the Partner’s account. This allows the Partner to have ownership over the devices and manage their status accordingly, including termination.

Integrators should provision the CTDs through a MyAdmin service account under their own account, with the following conditions:

1. Account type: Marketplace Partner
2. Role: Third-Party Integrator

The specific method is ProvisionDeviceToAccount.

API request example

URL = 'https://myadmin.geotab.com/v2/myadminapi.ashx'

RequestObject=

{

"method": "ProvisionDeviceToAccount",

"params": {

"productId": "",

"erpNo": "",

"apiKey": "",

"sessionId": ""

}

}

API response example

{

"result": {

"isSuccess": true,

"serialNo": "CX...."

}

}

Solution Provider order fulfillment

Once the specific products assigned to the order have been determined, the solution provider must share such details on MyAdmin via the Partner Fulfillment page. This ensures accurate tracking and management of the order within Geotab. It also facilitates clear communication and coordination with the Partner and Customer.

Details include:

1. Shipment tracking information, including shipping carrier and tracking number.
2. Device assignments as applicable:
3. 1. Serial number assigned to each module
   2. SIM number of the device, if applicable
   3. IMEI of the device, if applicable

These details should be documented in the Partner Fulfillment page.

Data ingestion

Once devices have been provisioned, fulfilled, and are ready to be activated, the integrator can start pushing data to them via our DIG platform. This involves using the DIG API to send custom telematics device records. Proper formatting and authentication are crucial for successful data ingestion. For more information, refer to the Data Intake Gateway Guide.

On successful implementation of the DIG integration, the CTD will kick-off billing automatically. Depending on the type of integration, this data will make its way to the MyGeotab platform for the Customer to view and interact.

Terminations

In cases where customers no longer want to keep their device active or have requested to terminate it, the reselling partner can terminate the devices in MyAdmin, consequently stopping billing.

As an effort to keep the integrator updated, Geotab will share a daily updating termination summary sheet of all devices that've been terminated recently.