Skip to content
Orders API/API Reference/
/
GET orders

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

Extra Data

Operations

Orders

Operations

POST orders

Request

Submit an order for Landata information products when ready for confirming the purchase. Provide the list of products intended for purchase, along with customer account details, pre-requisites or extra data required and a title identifier.

Security
oauthClientCredentials
Headers
customer-idstring[ 1 .. 40 ] characters

Identifier of the customer this request is on behalf of.

customer-referencestring<= 40 characters^[0-9a-zA-Z-_&(),.@ ]+$

Optional description to identify a transaction, used for billing purposes. Note that we'll be providing a separate order ID once the order has been submitted.

x-correlation-idstring(uuid)

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

Example: 824993ab-7366-4faa-963d-c456dec227a5
idempotency-keystring(uuid)

Unique UUID used to prevent duplicate order submissions. This allows requests to be retried after a network failure without accidentally submitting two orders. If you receive a network error or timeout, you should resend the request with the same idempotency-key. If you resend a request with the same value for the idempotency-key, you will receive the original response. If the server is still processing the original POST, you will receive 429 Too Many Requests. Idempotency keys expire after 24 hours.

Example: cc4d91e3-17af-4d11-b333-eb449e62ff07
Bodyapplication/jsonrequired
productsArray of objects(OrderProduct)[ 1 .. 50 ] itemsrequired
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[].​isWarningAcknowledgedboolean

Customers are allowed to proceed only if they have accepted the warning messages. Warning messages are supplied in GET products.

products[].​extraDataobject(ExtraData)
products[].​prerequisitesArray of PrerequisiteProduct (object) or PrerequisiteOrder (object) or PrerequisiteSecurityNumber (object)
deliveryPreferencestringrequired

Indicate how product is delivered to customers. If 'EMAIL' is selected, then product will be emailed to recipient. If 'NONE' then product will not be delivered and must be retrieved via API.

Enum"NONE""EMAIL"
emailstring(email)<= 200 characters

Email address where the products will be delivered to. Required if deliveryPreference is EMAIL or if alerting products are ordered.

contactNamestring<= 130 characters^[0-9a-zA-Z\x{00C0}-\x{017E}#\-+_&(),.@{}:$?!...

Contact person for the order.

contactNumberstring<= 20 characters^[0-9()\-\+ ]+$

Phone number of the contact person.

alternateAddressobject(AlternateAddress)
curl -i -X POST \
  https://developer.servictoria.io/_mock/portal/rest/ddp-orders-api/openapi/orders/v1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'customer-id: string' \
  -H 'customer-reference: string' \
  -H 'idempotency-key: cc4d91e3-17af-4d11-b333-eb449e62ff07' \
  -H 'x-correlation-id: 824993ab-7366-4faa-963d-c456dec227a5' \
  -d '{
    "products": [
      {
        "productCode": "RegisterSearchStatement",
        "productIds": {
          "titleId": "10940/843"
        },
        "isWarningAcknowledged": true,
        "extraData": {
          "settlementDate": "yyyy-mm-dd",
          "meterReadDate": "yyyy-mm-dd",
          "waterShareId": "WEE123456",
          "landUseApplicationReason": "VENDOR",
          "postalAddress": {
            "recipientName": "string",
            "companyName": "string",
            "contactNumber": "string",
            "email": "string",
            "streetAddress": "string",
            "suburb": "string",
            "state": "VIC",
            "postcode": 1000
          },
          "vendors": [
            {
              "vendorType": "INDIVIDUAL",
              "firstName": "string",
              "middleName": "string",
              "lastName": "string",
              "companyName": "string"
            }
          ],
          "purchasers": [
            {
              "purchaserType": "INDIVIDUAL",
              "firstName": "string",
              "middleName": "string",
              "lastName": "string",
              "companyName": "string"
            }
          ],
          "ratesRequestDate": "yyyy-mm-dd",
          "salePrice": 0,
          "ownersCorpManagerData": {
            "managerId": 0,
            "managerName": "string",
            "address": "string",
            "phone": "string"
          },
          "wisNumber": 99999999,
          "deliverySpeed": "STANDARD",
          "parcel": "1\\\\PS508629",
          "emailFormat": "TEXT"
        },
        "prerequisites": [
          {
            "productCode": "RegisterSearchStatement",
            "productIds": {
              "titleId": "10940/843"
            }
          }
        ]
      }
    ],
    "deliveryPreference": "NONE",
    "email": "user@example.com",
    "contactName": "string",
    "contactNumber": "string",
    "alternateAddress": {
      "unitOrFlatNumber": "G10A",
      "streetNumber": "23-25",
      "streetName": "Flinders",
      "streetType": "Road",
      "suburbOrTownOrLocality": "Brunswick East",
      "postcode": 1000
    }
  }'

Responses

Successful Operation

Bodyapplication/json
orderIdstringrequired

Unique number to identify an order.

Example: "10219435"
totalPriceintegerrequired

The total price (in cents) for this order (including gst).

Example: 891
totalGstintegerrequired

The total gst amount (in cents) for this order.

Example: 89
feesArray of objects(Fee)

Any additional charges such as land index search surcharge.

itemsOrderedArray of objects(OrderItem)required
itemsOrdered[].​orderItemNumberintegerrequired

Identifier for the item previously ordered.

itemsOrdered[].​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"
itemsOrdered[].​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"}
itemsOrdered[].​productIds.​property name*anyadditional property
itemsOrdered[].​productNamestring

Name of the product, suitable for display to customers.

Example: "Register Search Statement (Copy of Title)"
itemsOrdered[].​productInformationobject

For some products additional product specific information is provided to users such as decrypted product id, product type and more

Example: {"documentType":"MORTGAGE"}
itemsOrdered[].​authorityNamestring

Name of Authority who is responsible for the information product.

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

The amount (in cents) charged for this product (including gst).

Example: 891
itemsOrdered[].​gstintegerrequired

The gst amount (in cents) charged for this product.

Example: 89
Response
application/json
{
  "orderId": "10219435",
  "totalPrice": 891,
  "totalGst": 89,
  "fees": [
    { … }
  ],
  "itemsOrdered": [
    { … }
  ]
}

GET orders

Request

Get a paginated list of past orders. This will provide a history of orders made by a specified customer along with full captured details of each order and the summary of included items.

Security
oauthClientCredentials
Query
pageNumberinteger>= 1

Page number starting at 1.

Default 1
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?pageNumber=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'customer-id: string' \
  -H 'x-correlation-id: 824993ab-7366-4faa-963d-c456dec227a5'

Responses

Successful Operation

Bodyapplication/json
paginationobject(Pagination)
ordersArray of objects(Order)required
orders[].​orderIdstringrequired

Unique number to identify an order.

Example: "10219435"
orders[].​orderDatestring(date-time)required

Date and time the item was ordered.

Example: "2023-07-14T00:00:00.000000+11:00"
orders[].​totalPriceintegerrequired

The amount (in cents) charged for this product (including gst).

Example: 891
orders[].​totalGstintegerrequired

The gst amount (in cents) charged for this product.

Example: 89
orders[].​feesArray of objects(Fee)

Any additional charges such as land index search surcharge.

orders[].​deliveryPreferencestringrequired

Indicate how product is delivered to customers. If 'EMAIL' is selected, then product will be emailed to recipient. If 'NONE' then product will not be delivered and must be retrieved via API.

Enum"NONE""EMAIL"
orders[].​emailstring

Email address where the product will be delivered to.

orders[].​contactNamestring

Contact person for the order.

orders[].​contactNumberstring

Phone number of the contact.

orders[].​customerReferencestring

Any description customer entered during ordering process to identify a transaction.

orders[].​productsArray of objects(OrderSummaryProduct)required
orders[].​products[].​orderItemNumberintegerrequired

Identifier for the item previously ordered.

orders[].​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"
orders[].​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"}
orders[].​products[].​productIds.​property name*anyadditional property
orders[].​products[].​productNamestringrequired

Name of the product, suitable for display to customers.

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

For some products additional product specific information is provided to users such as decrypted product id, product type and more

Example: {"titleId":"AB123456C"}
orders[].​products[].​authorityNamestringrequired

Name of authority who is responsible for the information product.

Example: "Victorian Land Title Registry"
orders[].​products[].​productStatusstring(ProductStatus)required

Product processing status of the ordered product. The possible options are COMPLETE (successfully fulfilled), PROCESSING (Product is still being fulfilled), EXTERNAL_PROCESSING (certificate is with the external responsible authority), FAILED (there was an error causing fulfilment to not complete) or CANCELLED (product ordered was manually cancelled).

Enum"COMPLETE""PROCESSING""EXTERNAL_PROCESSING""FAILED""CANCELLED"
Example: "COMPLETE"
orders[].​products[].​priceintegerrequired

The amount (in cents) charged for this product (including gst).

Example: 891
orders[].​products[].​gstintegerrequired

The gst amount (in cents) charged for this product.

Example: 89
orders[].​products[].​extraDataobject
orders[].​products[].​prerequisitesArray of PrerequisiteProduct (object) or PrerequisiteOrder (object) or PrerequisiteSecurityNumber (object)

Prerequisites specified for the product

Example: [{"productCode":"RegisterSearchStatement","productIds":{"titleId":"12345/678"}}]
Response
application/json
{
  "pagination": {
    "totalRecords": 0,
    "nextPage": 2
  },
  "orders": [
    { … }
  ]
}

GET order

Request

Get details of an order. This will provide details of a specified order using the order ID along with full captured details of each order and the summary of included items.

Security
oauthClientCredentials
Path
orderIdstring^[A-Za-z0-9]*$required

Unique number to identify an order. This order Identifier is provided in the response when initially submitting an order.

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/{orderId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'customer-id: string' \
  -H 'x-correlation-id: 824993ab-7366-4faa-963d-c456dec227a5'

Responses

Successful Operation

Bodyapplication/json
orderIdstringrequired

Unique number to identify an order.

Example: "10219435"
orderDatestring(date-time)required

Date and time the item was ordered.

Example: "2023-07-14T00:00:00.000000+11:00"
totalPriceintegerrequired

The amount (in cents) charged for this product (including gst).

Example: 891
totalGstintegerrequired

The gst amount (in cents) charged for this product.

Example: 89
feesArray of objects(Fee)

Any additional charges such as land index search surcharge.

deliveryPreferencestringrequired

Indicate how product is delivered to customers. If 'EMAIL' is selected, then product will be emailed to recipient. If 'NONE' then product will not be delivered and must be retrieved via API.

Enum"NONE""EMAIL"
emailstring

Email address where the product will be delivered to.

contactNamestring

Contact person for the order.

contactNumberstring

Phone number of the contact.

customerReferencestring

Any description customer entered during ordering process to identify a transaction.

productsArray of objects(OrderSummaryProduct)required
products[].​orderItemNumberintegerrequired

Identifier for the item previously ordered.

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[].​productInformationobject

For some products additional product specific information is provided to users such as decrypted product id, product type and more

Example: {"titleId":"AB123456C"}
products[].​authorityNamestringrequired

Name of authority who is responsible for the information product.

Example: "Victorian Land Title Registry"
products[].​productStatusstring(ProductStatus)required

Product processing status of the ordered product. The possible options are COMPLETE (successfully fulfilled), PROCESSING (Product is still being fulfilled), EXTERNAL_PROCESSING (certificate is with the external responsible authority), FAILED (there was an error causing fulfilment to not complete) or CANCELLED (product ordered was manually cancelled).

Enum"COMPLETE""PROCESSING""EXTERNAL_PROCESSING""FAILED""CANCELLED"
Example: "COMPLETE"
products[].​priceintegerrequired

The amount (in cents) charged for this product (including gst).

Example: 891
products[].​gstintegerrequired

The gst amount (in cents) charged for this product.

Example: 89
products[].​extraDataobject
products[].​prerequisitesArray of PrerequisiteProduct (object) or PrerequisiteOrder (object) or PrerequisiteSecurityNumber (object)

Prerequisites specified for the product

Example: [{"productCode":"RegisterSearchStatement","productIds":{"titleId":"12345/678"}}]
Response
application/json
{
  "orderId": "10219435",
  "orderDate": "2023-07-14T00:00:00.000000+11:00",
  "totalPrice": 891,
  "totalGst": 89,
  "fees": [
    { … }
  ],
  "deliveryPreference": "NONE",
  "email": "string",
  "contactName": "string",
  "contactNumber": "string",
  "customerReference": "string",
  "products": [
    { … }
  ]
}

GET order item

Request

Get details of an ordered item. Item refers to a product purchased as part of an order. Provide the order number along with Order item number to recieve its details including the information product itself in the available format/s.

Security
oauthClientCredentials
Path
orderIdstring^[A-Za-z0-9]*$required

Unique number to identify an order.

orderItemNumberintegerrequired

Item number the product appears within the order.

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/{orderId}/item/{orderItemNumber}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'customer-id: string' \
  -H 'x-correlation-id: 824993ab-7366-4faa-963d-c456dec227a5'

Responses

Successful Operation

Bodyapplication/json
orderIdstringrequired

Unique number to identify an order.

Example: "10219435"
orderItemNumberinteger>= 1required

Item number within the order.

Example: 1
productNamestringrequired

Name of the product, suitable for display to customers.

Example: "Register Search Statement (Copy of Title)"
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"
productStatusstring(ProductStatus)required

Product processing status of the ordered product. The possible options are COMPLETE (successfully fulfilled), PROCESSING (Product is still being fulfilled), EXTERNAL_PROCESSING (certificate is with the external responsible authority), FAILED (there was an error causing fulfilment to not complete) or CANCELLED (product ordered was manually cancelled).

Enum"COMPLETE""PROCESSING""EXTERNAL_PROCESSING""FAILED""CANCELLED"
Example: "COMPLETE"
customerReferencestring

Any description customer entered during ordering process to identify a transaction.

resourceTextstring

Content of the ordered item in text format. Relevant for text based information products.

resourceJsonstring

Content of the ordered item in json format. Relevant for JSON based information products

resourceLocationstring

Pre-signed URL to retrieve the item. Relevant for products available as PDFs.

resourceExpirystring(date-time)

Date and time the item/product link expires.

Example: "2024-11-07T04:43:46.564302+11:00"
resourceFileTypestring
resourceFileSizeinteger

File size in kByte.

Example: 1897
Response
application/json
{
  "orderId": "10219435",
  "orderItemNumber": 1,
  "productName": "Register Search Statement (Copy of Title)",
  "productCode": "RegisterSearchStatement",
  "productStatus": "COMPLETE",
  "customerReference": "string",
  "resourceText": "string",
  "resourceJson": "string",
  "resourceLocation": "string",
  "resourceExpiry": "2024-11-07T04:43:46.564302+11:00",
  "resourceFileType": "string",
  "resourceFileSize": 1897
}

POST decrypt titles

Request

API which accepts a list of encrypted titleIds and returns a list of decrypted titleIds (aka Volume/Folios).

Security
oauthClientCredentials
Headers
customer-idstring[ 1 .. 40 ] characters

Identifier of the customer this request is on behalf of.

customer-referencestring<= 40 characters^[0-9a-zA-Z-_&(),.@ ]+$

Optional description to identify a transaction, used for billing purposes. Note that we'll be providing a separate order ID once the order has been submitted.

x-correlation-idstring(uuid)

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

Example: 824993ab-7366-4faa-963d-c456dec227a5
idempotency-keystring(uuid)

Unique UUID used to prevent duplicate order submissions. This allows requests to be retried after a network failure without accidentally submitting two orders. If you receive a network error or timeout, you should resend the request with the same idempotency-key. If you resend a request with the same value for the idempotency-key, you will receive the original response. If the server is still processing the original POST, you will receive 429 Too Many Requests. Idempotency keys expire after 24 hours.

Example: cc4d91e3-17af-4d11-b333-eb449e62ff07
Bodyapplication/jsonrequired

Object containing an array of encrypted titleIds

titleIdsArray of strings[ 1 .. 10 ] itemsrequired
Example: ["qp0gjuieZ5VzbNKtT/eZvqPryobRkEYxMA==","5JhN+47g1efe+q3uMjyaMiRQ6ySj0844Hg=="]
curl -i -X POST \
  https://developer.servictoria.io/_mock/portal/rest/ddp-orders-api/openapi/orders/v1/titles/decrypt \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'customer-id: string' \
  -H 'customer-reference: string' \
  -H 'idempotency-key: cc4d91e3-17af-4d11-b333-eb449e62ff07' \
  -H 'x-correlation-id: 824993ab-7366-4faa-963d-c456dec227a5' \
  -d '{
    "titleIds": [
      "qp0gjuieZ5VzbNKtT/eZvqPryobRkEYxMA==",
      "5JhN+47g1efe+q3uMjyaMiRQ6ySj0844Hg=="
    ]
  }'

Responses

Successful Operation

Bodyapplication/json
titleIdsobjectrequired
Example: {"qp0gjuieZ5VzbNKtT/eZvqPryobRkEYxMA==":"10940/843","5JhN+47g1efe+q3uMjyaMiRQ6ySj0844Hg==":"11000/100"}
titleIds.​property name*stringadditional property
Response
application/json
{
  "titleIds": {
    "qp0gjuieZ5VzbNKtT/eZvqPryobRkEYxMA==": "10940/843",
    "5JhN+47g1efe+q3uMjyaMiRQ6ySj0844Hg==": "11000/100"
  }
}