Skip to content
Orders API/
/Product Listing

Orders API (1.11.1)

List available products, place orders, view order history, and retrieve ordered products.

Find out more about these services
Download OpenAPI description
openapi.json
openapi.yaml
Overview
E-mail
legal@servictoria.com.au
Terms of Service
Languages
Servers
Mock server
https://developer.servictoria.io/_mock/portal/rest/ddp-orders-api/openapi
Production environment
https://api.servictoria.io/ddp
Test environment
https://test.api.servictoria.io/ddp

Product Listing

Operations

GET products

Request

Get the list of certificate products available for order on a specified title, by providing a volume & folio number or encrypted title ID created by discovery APIs. The response will include important details about each product like the pricing, description, pre-requisites, responsible authority, turnaround time and more.

Security
oauthClientCredentials
Query
titleIdstring

Title identifier, this can be either a volume/folio (eg: '10940/843') or an encrypted titleId as returned by operations on this API (eg: 'qp0gjuieZ5VzbNKtT/eZvqPryobRkEYxMA==' - this example is valid for the TEST environment only). The returned product listing will include products related to the requested titleId. A maximum of one of titleId, propertyPfi, or documentId is required.

Example: titleId=10940/843
propertyPfistring^[0-9]{1,20}$

Unique identifier for a property. The returned product listing will include products related to the requested propertyPfi. A maximum of one of titleId, propertyPfi, or documentId is required.

Example: propertyPfi=208045633
documentIdstring^[A-Za-z0-9/]*$

Unique identifier for a document. The returned product listing will include products related to the requested documentId. A maximum of one of titleId, propertyPfi, or documentId is required.

Example: documentId=AR122019D
Headers
customer-idstring[ 1 .. 40 ] characters

Identifier of the customer this request is on behalf of.

x-correlation-idstring(uuid)

Optional unique UUID which can assist with tracing / debugging requests.

Example: 824993ab-7366-4faa-963d-c456dec227a5
curl -i -X GET \
  'https://developer.servictoria.io/_mock/portal/rest/ddp-orders-api/openapi/orders/v1/products?titleId=10940%2F843&propertyPfi=208045633&documentId=AR122019D' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'customer-id: string' \
  -H 'x-correlation-id: 824993ab-7366-4faa-963d-c456dec227a5'

Responses

Successful Operation

Bodyapplication/json
productsArray of objects(Product)required
products[].​productCodestringrequired

Each product type offered has a unique productCode. The productCode together with productIds will uniquely specify a specific instance of a product that can be ordered.

Example: "RegisterSearchStatement"
products[].​productIdsobjectrequired

To place an order for a product these productIds need to be provided together with the productCode which uniquely specifies an instance of a product that can be ordered. Each product type can have different productIds. A couple of examples:

  • for productCode RegisterSearchStatement the productIds will include a titleId, eg: { "titleId": "10940/843" }
  • for productCode VicRoads productIds will include two fields, eg: { "propertyPfi": "5365126", "authorityId": 431 }
Example: {"titleId":"10940/843"}
products[].​productIds.​property name*anyadditional property
products[].​productNamestringrequired

Name of the product, suitable for display to customers.

Example: "Register Search Statement (Copy of Title)"
products[].​productDescriptionstring

Text that appears under the product to describe it in more detail.

Example: "PDF version of the copy of the Title, lists the current registered proprietors, any encumbrances, caveats or notices that apply to the land, but does not include a sketch of the plan."
products[].​productInformationobject

For some products additional product specific information is made available that may be useful in assisting users to understand if this is the product they wish to purchase.

Example: {"documentType":"MORTGAGE"}
products[].​productAvailabilitystringrequired

Indicate whether a product is available for purchase. Some products such as destroyed instruments are listed but are UNAVAILABLE and cannot be purchased.

Enum"AVAILABLE""UNAVAILABLE"
products[].​authorityNamestringrequired

Name of Authority who is responsible for the information product

Example: "Victorian Land Title Registry"
products[].​priceintegerrequired

The price (in cents) for this product (including gst). For example 891 refers to $8.91 Australian dollars and includes the GST in tht total.

Example: 891
products[].​gstintegerrequired

The gst amount (in cents) for this product.

Example: 89
products[].​turnaroundTimeintegerrequired

How soon the product will be ready for delivery. This integer must be connected with the turnaroundTimeUnit to fully understand the time.

Example: 5
products[].​turnaroundTimeUnitstringrequired

Unit of measure for turnaround time.

Enum"DAY""MIN""SEC"
products[].​customerWarningstring

Any warning content attached to the product. These must be shown to the customer and accepted before making a purchase.

Example: "Please note that Commemorative Title Certificate is a decorative memento that celebrates property ownership and makes pride of ownership tangible. This cannot be used for any legal purpose."
products[].​extraDataArray of objects(SupportedExtraData)

Some products support (or require) extra data to be provided when they are ordered. What extra data is supported varies depending on the product. The elements in this array indicate which extra data types this product supports.

Example: [{"key":"vendors"},{"key":"meterRead"}]
products[].​prerequisitesArray of objects(Prerequisite)
Response
application/json
{
  "products": [
    { … }
  ]
}

Extra Data

Operations

Orders

Operations