# POST orders

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.

Endpoint: POST /orders/v1
Version: 1.11.1
Security: oauthClientCredentials

## Header parameters:

  - `customer-id` (string)
    Identifier of the customer this request is on behalf of.

  - `customer-reference` (string)
    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-id` (string)
    Optional unique UUID which can assist with tracing / debugging requests.
    Example: "824993ab-7366-4faa-963d-c456dec227a5"

  - `idempotency-key` (string)
    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"

## Request fields (application/json):

  - `products` (array, required)

  - `products.productCode` (string, required)
    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.productIds` (object, required)
    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.isWarningAcknowledged` (boolean)
    Customers are allowed to proceed only if they have accepted the warning messages. Warning messages are supplied in GET products.

  - `products.extraData` (object)

  - `products.extraData.settlementDate` (string)
    Settlement date
    Example: "yyyy-mm-dd"

  - `products.extraData.meterReadDate` (string)
    Special meter read date
    Example: "yyyy-mm-dd"

  - `products.extraData.waterShareId` (string)
    Water share id. The format must be 'WEE or LTE' followed by a number containing 1 to 6 digits
    Example: "WEE123456"

  - `products.extraData.landUseApplicationReason` (string)
    Reason for purchasing the product
    Enum: "VENDOR", "PURCHASER", "MORTGAGEE"

  - `products.extraData.postalAddress` (object)

  - `products.extraData.postalAddress.recipientName` (string, required)
    Recipient's name

  - `products.extraData.postalAddress.companyName` (string)
    Company's name

  - `products.extraData.postalAddress.contactNumber` (string, required)
    Contact Number

  - `products.extraData.postalAddress.email` (string, required)
    Email for tracking the mail

  - `products.extraData.postalAddress.streetAddress` (string, required)
    Street address for the postal address

  - `products.extraData.postalAddress.suburb` (string, required)
    Suburb for the postal address

  - `products.extraData.postalAddress.state` (string, required)
    State for the postal address
    Enum: "VIC", "NSW", "QLD", "WA", "SA", "TAS", "NT", "ACT"

  - `products.extraData.postalAddress.postcode` (integer, required)
    Postcode for the postal address. Must be within Australia

  - `products.extraData.vendors` (array)

  - `products.extraData.vendors.vendorType` (string, required)
    Enum: "INDIVIDUAL", "ORGANISATION"

  - `products.extraData.vendors.firstName` (string)
    First name of the proprietor or vendor. If you provide more than 15 characters, only the first 15 characters are used.

  - `products.extraData.vendors.middleName` (string)
    Middle name of the proprietor or vendor. If you provide more than 15 characters, only the first 15 characters are used.

  - `products.extraData.vendors.lastName` (string)
    Last name of the proprietor or vendor. If you provide more than 40 characters, only the first 40 characters are used.

  - `products.extraData.vendors.companyName` (string)
    Company name of the proprietor or vendor. If you provide more than 120 characters, only the first 120 characters are used.

  - `products.extraData.purchasers` (array)

  - `products.extraData.purchasers.purchaserType` (string, required)
    Enum: "INDIVIDUAL", "ORGANISATION"

  - `products.extraData.ratesRequestDate` (string)
    Rates Settlement Statement request date
    Example: "yyyy-mm-dd"

  - `products.extraData.salePrice` (integer)
    The sale price (in dollars)

  - `products.extraData.ownersCorpManagerData` (object)

  - `products.extraData.ownersCorpManagerData.managerId` (integer)
    Unique identifier for the owners corporation manager. Applicable when using predetermined OC list

  - `products.extraData.ownersCorpManagerData.managerName` (string)
    Owners corporation manager name. Used for manual input.

  - `products.extraData.ownersCorpManagerData.address` (string)
    Owners corporation manager's address. Used for manual input.

  - `products.extraData.ownersCorpManagerData.phone` (string)
    Owners corporation manager's contact number. Used for manual input.

  - `products.extraData.wisNumber` (integer)
    Water Information Statement number

  - `products.extraData.deliverySpeed` (string)
    The delivery process used for section 151 products. The value determines the time it takes to deliver the product.
    Enum: "STANDARD", "EXPRESS", "PRIORITY"

  - `products.extraData.parcel` (string)
    Standard Parcel Identifier (SPI)
    Example: "1\\\\PS508629"

  - `products.extraData.emailFormat` (string)
    The email format used for Property Transaction Alert products. The value determines the email's content type to deliver the product.
    Enum: "TEXT", "XML"

  - `products.prerequisites` (array)

  - `deliveryPreference` (string, required)
    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"

  - `email` (string)
    Email address where the products will be delivered to. Required if deliveryPreference is EMAIL or if alerting products are ordered.

  - `contactName` (string)
    Contact person for the order.

  - `contactNumber` (string)
    Phone number of the contact person.

  - `alternateAddress` (object)

  - `alternateAddress.unitOrFlatNumber` (string)
    The unit or flat number of the address. Include any prefixes and suffixes e.g. 5B. Include the range using hyphen if required e.g. 1B-1C.
    Example: "G10A"

  - `alternateAddress.streetNumber` (string, required)
    The street number, include any prefixes and suffixies of the street number e.g. 2A. Inclde the range using hyphen if required e.g. 11-13.
    Example: "23-25"

  - `alternateAddress.streetName` (string, required)
    The name of the street.
    Example: "Flinders"

  - `alternateAddress.streetType` (string, required)
    The street type of the address e.g. Street, Road, Avenue, Court, Crescent
    Example: "Road"

  - `alternateAddress.suburbOrTownOrLocality` (string, required)
    The suburb/town/locality of the address.
    Example: "Brunswick East"

  - `alternateAddress.postcode` (integer, required)
    Postcode of the address. Must be within Australia.

## Response 200 fields (application/json):

  - `orderId` (string, required)
    Unique number to identify an order.
    Example: "10219435"

  - `totalPrice` (integer, required)
    The total price (in cents) for this order (including gst).
    Example: 891

  - `totalGst` (integer, required)
    The total gst amount (in cents) for this order.
    Example: 89

  - `fees` (array)
    Any additional charges such as land index search surcharge.

  - `fees.type` (string, required)
    Description of what the fee/charge is for. Fees such as land index search surcharge will be listed here.

  - `fees.amount` (integer, required)
    The fee amount (in cents) for this product (including gst).
    Example: 891

  - `fees.gst` (integer, required)
    The gst fee amount (in cents) for this product.
    Example: 89

  - `fees.feeDetails` (object)

  - `itemsOrdered` (array, required)

  - `itemsOrdered.orderItemNumber` (integer, required)
    Identifier for the item previously ordered.

  - `itemsOrdered.productCode` (string, required)
    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.productIds` (object, required)
    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.productName` (string)
    Name of the product, suitable for display to customers.
    Example: "Register Search Statement (Copy of Title)"

  - `itemsOrdered.productInformation` (object)
    For some products additional product specific information is provided to users such as decrypted product id, product type and more
    Example: {"documentType":"MORTGAGE"}

  - `itemsOrdered.authorityName` (string)
    Name of Authority who is responsible for the information product.
    Example: "Victorian Land Title Registry"

  - `itemsOrdered.price` (integer, required)
    The amount (in cents) charged for this product (including gst).
    Example: 891

  - `itemsOrdered.gst` (integer, required)
    The gst amount (in cents) charged for this product.
    Example: 89

## Response 400 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.

## Response 401 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.

## Response 403 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.

## Response 404 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.

## Response 429 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.

## Response 500 fields (application/json):

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "UNAUTHORIZED"

  - `errorMessage` (string)
    Invalid Authorization token.