Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

VCO / Device and Accessory Ordering

  • Article
  • 2 minutes to read

Operation Information

Hornbill Integration method for ordering device and accessories from VCO.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Username + Password.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Username + Password in the Type pick list;
  • Give the Username + Password KeySafe key a Title (this is the name / identifier for the Username + Password account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Username string Authentication Username
Password string Authentication Password
API Endpoint string Optional API Endpoint

Tip

In order to integrate with Vodafone VCO, you will need to add your unique VCO Username and Secret (into the Password field), which are provided by Vodafone Corporate when registering with the VCO API interface. The API Endpoint field is not required to be populated for this integration.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Username + Password account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Production or Test _production string Perform the API call in the Production or Test VCO Environment Yes Production, Test
Payload/Unique Identifier 0_payload string A unique identifier to allow VCO to track the order and to prevent resubmission Yes None provided
PO Number 1_po_number string The Purchase Order Number Yes None provided
Business Unit 2_business_unit string Optional value to identitfy the subsidiary that the order should be placed for; leave blank for the organization level the provided is assigned to No None provided
Delivery Address 3_delivery_address object Address to deliver the order to No None provided
Billing Address 4_billing_address object Address to bill the equipment order to No None provided
Equipment Billing 5_equipment_billing object Optional billing account to use for equipment charges No None provided
Items 6_items array Hardware items in the order, handsets and accessories. The order must have at least one item No None provided

Output Parameters

Display Name ID Type Description
Status status string API Response status
Queued queued string Queued for later submission
message message string Message returned by VCO
Reference reference string Order Reference
Stock stock string In Stock?
Delivery Date delivery_date string Delivery Date
Despatch Date despatch_date string Despatch Date
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document