Skip to main content

Set Up Honda Web API Integration (Australia Only)

This article explains how to set up and use the Honda Web API integration in Blackpurl, available exclusively to Australian dealerships.

The Honda Web API integration allows Australian Blackpurl dealerships to automate data exchange with Honda across four functions: Part Inventory Upload, Service Data Upload, Submit Orders, and Download Invoice Data. This article covers the setup requirements and explains how each function works.

Available APIs

The Honda Web API integration in Blackpurl supports the following functions:

  • Part Inventory Upload

  • Service Data Upload

  • Submit Orders

  • Download Invoice Data

Setup

To enable the Honda Web API integration, contact Blackpurl Support by emailing [email protected] or via the chat bubble. You will need to provide the following details:

  • Dealer Number — as supplied by Honda

  • Honda Vendor Code — the vendor code assigned to the Honda vendor record in your Blackpurl. Navigate to the relevant Vendor Record for Honda in Blackpurl and locate the Vendor Code field. For example, the Vendor Code for a Honda vendor record might be HON.

  • Web Key Number — as supplied by Honda

  • Username and Password — the credentials your dealership uses to log into the Honda site. For the Part Inventory Upload and Service Data Upload, Blackpurl uploads the relevant data to Honda automatically on your behalf — these credentials allow Blackpurl to do this instead of requiring a manual upload each time.

  • Frequency of Upload for Part Inventory and Service Data — how often the uploads should run automatically to the Honda API

How It Works

Each of the four API functions operates differently. The sections below explain what Blackpurl does automatically and where manual steps are still required.

Part Inventory Upload

Blackpurl automatically uploads all Honda part records that are currently in stock to the Honda API at your scheduled upload times. No manual action is required from the dealership.

Service Data Upload

Blackpurl automatically uploads service data for service jobs on Honda units that have been invoiced. The upload runs at your scheduled times. No manual action is required from the dealership.

Submit Vendor Orders

Dealerships can submit a Vendor Order directly to Honda from Blackpurl for Daily orders and Stock orders.

For Campaign orders, the dealership must still manually enter items on the Honda website in the Campaign ordering section. Honda does not support automatic uploading or importing of Campaign orders.

The process for submitting a Vendor Order to Honda works as follows:

1. Create a Vendor Order for Honda using the normal process.

2. Click SUBMIT ORDER. A dialog will appear asking Send Order to Honda?

3. The order type defaults to Daily order. To change this, click the dropdown arrow and select Stock order or Campaign order.

4. Click YES, SUBMIT TO HONDA to proceed.

Shows a dialog asking 'SEND ORDER TO HONDA?' with a dropdown menu set to 'Daily order' and a blue button labeled 'YES, S
Shows the expanded dropdown menu for order types with options: 'Campaign order', 'Daily order', 'Stock order', and 'Camp


What happens next depends on the order type selected:

  • If you selected Daily order or Stock order, a loading indicator will appear while the Vendor Order is processed and uploaded directly to the Honda API. Once the upload completes successfully, you will see a green SENT confirmation. The Vendor Order status in Blackpurl will automatically change to Submitted.

  • If you selected Campaign order, the Vendor Order status in Blackpurl will also automatically change to Submitted. However, you must still manually enter the Campaign order items on the Honda website. Blackpurl cannot submit Campaign orders to Honda automatically.

Download Invoice Data

Dealerships can download Honda invoice data directly into a Vendor Receiving in Blackpurl. The process works as follows:

1. Process ORDER > PARTS RECEIVING for the relevant Honda vendor. This triggers the Honda API to check for invoices available for download.

2. If no invoices are available, you will see the message No Invoices available from Honda and can continue with the normal vendor receiving process.

3. If invoices are available, a Select an Invoice dropdown will appear, populated with all invoices available for download. Select the invoice you want to download into your Vendor Receiving.

4. Once you select an invoice, a Download Invoice action begins and all line items from that invoice are loaded into the Vendor Receiving.

5. Finalise the Vendor Receiving using the normal process.

Shows a dialog titled 'SELECT AN INVOICE FROM HONDA' with a dropdown menu showing placeholder text 'Select an invoice' a
Did this answer your question?