Discovery API - Test
Example - Place order for a product which has prerequisites
1. Use Orders API to list products for a property
Example request
curl --request GET \
--location 'https://test.api.servictoria.io/ddp/orders/v1/products?propertyPfi=125302241' \
--header 'customer-id: example123' \
--header 'Authorization: Bearer ******'Example response (truncated)
Take note of the "prerequisites" field, the elements in this array indicate which prerequisites this product requires. In this example, the "prerequisites" section shows 2 RSS with different titleIds, this indicates that there are 2 titles associated with the provided property.
{
"products": [
...
{
"productCode": "VicRoads",
"productIds": {
"propertyPfi": "125302241",
"authorityId": 431
},
"productName": "Vicroads Certificate",
"productDescription": "Information on approved road proposals requiring any portion of the described property. This certificate only covers road proposals involving VicRoad. It does not cover road proposals under the control of Local Government authorities.",
"productAvailability": "AVAILABLE",
"authorityName": "VICROADS",
"price": 2222,
"gst": 202,
"turnaroundTime": 5,
"turnaroundTimeUnit": "DAY",
"prerequisites": [
{
"productCode": "RegisterSearchStatement",
"productIds": {
"titleId": "cYllw6nIgbPwfF8q/F3zPvtOTMR+8e5cCA=="
},
"productName": "Register Search Statement (Copy of Title)",
"productDescription": "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.",
"productAvailability": "AVAILABLE",
"authorityName": "Land Registry",
"price": 640,
"gst": 0,
"turnaroundTime": 5,
"turnaroundTimeUnit": "MIN"
},
{
"productCode": "RegisterSearchStatement",
"productIds": {
"titleId": "buh0CO0tzybFTdBDoY61kG+j17oqMj95nQ=="
},
"productName": "Register Search Statement (Copy of Title)",
"productDescription": "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.",
"productAvailability": "AVAILABLE",
"authorityName": "Land Registry",
"price": 640,
"gst": 0,
"turnaroundTime": 5,
"turnaroundTimeUnit": "MIN"
}
]
},
...
]
}2. Submit order with prerequisites
To order this product, all 2 RSS will also need to be purchased within the same order (alternatively, a previous order which purchased the same RSS can be provided). The provided RSS titleIds must match the prerequisite RSS titleIds. The RSS for all 2 of the associated titles needs to be provided in order for the VicRoads Certificate to be purchased.
Example request
curl --request POST \
--location 'https://test.api.servictoria.io/ddp/orders/v1' \
--header 'customer-id: example123' \
--header 'customer-reference: Example customer reference' \
--header 'Authorization: Bearer ******' \
--data-raw '{
"products": [
{
"productCode": "VicRoads",
"productIds": {
"propertyPfi": "203487790",
"authorityId": 431
},
"prerequisites": [
{
"productCode": "RegisterSearchStatement",
"productIds": {
"titleId": "cYllw6nIgbPwfF8q/F3zPvtOTMR+8e5cCA=="
}
},
{
"productCode": "RegisterSearchStatement",
"productIds": {
"titleId": "buh0CO0tzybFTdBDoY61kG+j17oqMj95nQ=="
}
}
]
},
{
"productCode": "RegisterSearchStatement",
"productIds": {
"titleId": "cYllw6nIgbPwfF8q/F3zPvtOTMR+8e5cCA=="
}
},
{
"productCode": "RegisterSearchStatement",
"productIds": {
"titleId": "buh0CO0tzybFTdBDoY61kG+j17oqMj95nQ=="
}
}
],
"deliveryPreference": "EMAIL",
"email": "john.citizen@example.com",
"contactName": "John Citizen"
}'Example response
{
"orderId": "11908226",
"totalPrice": 5090,
"totalGst": 346,
"fees": [
{
"type": "Land Index Search Charge",
"amount": 794,
"gst": 72,
"feeDetails": {
"titleId": {
"cYllw6nIgbPwfF8q/F3zPvtOTMR+8e5cCA==": "10820/137"
}
}
},
{
"type": "Land Index Search Charge",
"amount": 794,
"gst": 72,
"feeDetails": {
"titleId": {
"buh0CO0tzybFTdBDoY61kG+j17oqMj95nQ==": "11016/968"
}
}
}
],
"itemsOrdered": [
{
"orderItemNumber": 1,
"productCode": "VicRoads",
"productIds": {
"propertyPfi": "125302241",
"authorityId": 431
},
"productName": "Vicroads Certificate",
"authorityName": "VICROADS",
"price": 2222,
"gst": 202
},
{
"orderItemNumber": 2,
"productCode": "RegisterSearchStatement",
"productIds": {
"titleId": "cYllw6nIgbPwfF8q/F3zPvtOTMR+8e5cCA=="
},
"productName": "Register Search Statement (Copy of Title)",
"authorityName": "Land Registry",
"price": 640,
"gst": 0
},
{
"orderItemNumber": 3,
"productCode": "RegisterSearchStatement",
"productIds": {
"titleId": "buh0CO0tzybFTdBDoY61kG+j17oqMj95nQ=="
},
"productName": "Register Search Statement (Copy of Title)",
"authorityName": "Land Registry",
"price": 640,
"gst": 0
}
]
}3. Types of prerequisites
There are three types of prerequisites that can be used: current order, previous order, and security number. Note that you can use any combination of any types of prerequisites.
Current order
Prerequisites can be ordered in the same order that the product requiring the prerequisites is ordered. For this type of prerequisite, you provide the productIds and productCode in the prerequisites array. Ensure the same productIds and productCode are also ordered.
Example request
{
"products": [
{
"productCode": "RegisterSearchStatement",
"productIds": {
"titleId": "aUwq9HdVt2lX8mduzYM8C4/4731ye5hgYA=="
}
},
{
"productCode": "RegisterSearchStatement",
"productIds": {
"titleId": "c6UlCP+a5Trv/go2LKnVFbDIoA0rmDzd"
}
},
{
"productCode": "Section50Heritage",
"productIds": {
"propertyPfi": "1000690",
"authorityId": 271
},
"prerequisites": [
{
"productIds": {
"titleId": "aUwq9HdVt2lX8mduzYM8C4/4731ye5hgYA=="
},
"productCode": "RegisterSearchStatement"
},
{
"productIds": {
"titleId": "c6UlCP+a5Trv/go2LKnVFbDIoA0rmDzd"
},
"productCode": "RegisterSearchStatement"
}
]
}
],
"deliveryPreference": "EMAIL",
"email": "john_citizen@example.com"
}Previous Order
Prerequisites can also be from previous orders. You need to provide the order ID and order item number that corresponds to the prerequisite product. For example: if you ordered title A and title B in order 12345 and later order a property product requiring an RSS prerequisite with title A, then you can provide orderId = 12345 and orderItemNumber = 1 for the previous order prerequisite. Note that previous orders must be associated to the same customer that is submitting the current order. Previous order prerequisites can be from different orders as long as they belong to the same customer.
Example request
{
"products": [
{
"productCode": "Section50Heritage",
"productIds": {
"propertyPfi": "1000690",
"authorityId": 271
},
"prerequisites": [
{
"orderId": "1234",
"orderItemNumber": 1
},
{
"orderId": "6789",
"orderItemNumber": 3
}
]
}
],
"deliveryPreference": "EMAIL",
"email": "john_citizen@example.com"
}Security Number
Title prerequisites can also use security numbers instead. The security number is a unique identifier found in the top right of your RSS. In this case, you can use the security number of RSS documents ordered from any customer. If you provide security number prerequisites, a verify title charge will be applied to your order for each security number provided. The verify title charges will appear in the fees section of the response. Note that security numbers can only be used to satisfy title prerequisites.
Example request
{
"products": [
{
"productCode": "Section50Heritage",
"productIds": {
"propertyPfi": "1000690",
"authorityId": 271
},
"prerequisites": [
{
"securityNumber": "111122223333A"
},
{
"securityNumber": "444455556666P"
}
]
}
],
"deliveryPreference": "EMAIL",
"email": "john_citizen@example.com"
}Example response
{
"orderId": "1234",
"totalPrice": 3204,
"totalGst": 32,
"fees": [
{
"type": "Verify Title",
"amount": 352,
"gst": 32,
"feeDetails": {
"securityNumber": "111122223333A"
}
},
{
"type": "Verify Title",
"amount": 352,
"gst": 32,
"feeDetails": {
"securityNumber": "444455556666P"
}
}
],
"itemsOrdered": [
{
"orderItemNumber": 1,
"productCode": "Section50Heritage",
"productIds": {
"propertyPfi": "1000690",
"authorityId": 271
},
"productName": "Heritage Certificate (Sec 50)",
"authorityName": "Heritage Victoria",
"price": 2500,
"gst": 0
}
]
}