# GET order

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.

Endpoint: GET /orders/v1/{orderId}
Version: 1.11.1
Security: oauthClientCredentials

## Path parameters:

  - `orderId` (string, required)
    Unique number to identify an order. This order Identifier is provided in the response when initially submitting an order.

## Header parameters:

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

  - `x-correlation-id` (string)
    Optional unique UUID which can assist with tracing / debugging requests.
    Example: "824993ab-7366-4faa-963d-c456dec227a5"

## Response 200 fields (application/json):

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

  - `orderDate` (string, required)
    Date and time the item was ordered.
    Example: "2023-07-14T00:00:00.000000+11:00"

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

  - `totalGst` (integer, required)
    The gst amount (in cents) charged for this product.
    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)

  - `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 product will be delivered to.

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

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

  - `customerReference` (string)
    Any description customer entered during ordering process to identify a transaction.

  - `products` (array, required)

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

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

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

  - `products.authorityName` (string, required)
    Name of authority who is responsible for the information product.
    Example: "Victorian Land Title Registry"

  - `products.productStatus` (string, 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"

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

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

  - `products.extraData` (object)

  - `products.prerequisites` (array)
    Prerequisites specified for the product
    Example: [{"productCode":"RegisterSearchStatement","productIds":{"titleId":"12345/678"}}]

## 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 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.