# Orders

The Order object stores completed Orders.

### Portal View

#### Accessing Orders

Assess the Orders screen in the console via the console navigation bar.

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M64QQVEB8U9ZnVvorTl%2F-M64_oUM6NDW-CFAVxpg%2Fimage.png?alt=media\&token=8540428e-376a-4e8b-9874-71149f6620cc)

#### View Orders

Orders can be accessed by clicking on the main order screen:

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M64QQVEB8U9ZnVvorTl%2F-M64TnxFZjTnTtizJMw0%2Fimage.png?alt=media\&token=7541d298-9952-4b06-aa28-1f54c8b60fa9)

Click **Edit** to commit view the Order Detail modifications.

Additional a summary of the order is visible by expanding the tree view.

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M64QQVEB8U9ZnVvorTl%2F-M64U57l-7WtftudMePX%2Fimage.png?alt=media\&token=06a116ed-178c-4f80-95bc-3c491fb7aa33)

#### Order Details - General and Purchaser Details

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M64QQVEB8U9ZnVvorTl%2F-M64Zifyv7AlahINIpmo%2Fimage.png?alt=media\&token=2ebeef14-0a81-4a5c-b97a-bb5516edd023)

#### Order Details - Items

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M64QQVEB8U9ZnVvorTl%2F-M64ZnA0P7BeTbsCx_yk%2Fimage.png?alt=media\&token=6ee3136c-21e7-41a9-a407-fccaa3981b3e)

#### Order Details - Billing and Shipping Details

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M64QQVEB8U9ZnVvorTl%2F-M64_7ylg9XR4hoh9ccU%2Fimage.png?alt=media\&token=4bf0626e-0177-48f3-b76e-9210371387a8)

### Order Properties

{% tabs %}
{% tab title="Attributes" %}

| Element                        | Description                                                                |
| ------------------------------ | -------------------------------------------------------------------------- |
| orderId                        | A unique identifier for the Order (Guid/UUID)                              |
| version                        | A incremental version number tracking modifications to the Customer object |
| status                         | The Order Status ()                                                        |
| createdOnUtc                   | Created in UTC time (2020-04-29T10:02:03.212Z)                             |
| customerId                     | A unique identifier for the Customer (Guid/UUID)                           |
| purchaserName                  | Purchaser Name                                                             |
| purchaserContactNumberLocal    | Purchaser Contact Number (local)                                           |
| purchaserEmail                 | Purchaser Email Address                                                    |
| receiverName                   | Receiver Name                                                              |
| receiverContactNumberLocal     | Receiver Contact Number (local)                                            |
| receiverEmail                  | Receiver Email Address                                                     |
| items\[]                       | An array of Items                                                          |
| items\[].productId             | A unique identifier for the Product (Guid/UUID)                            |
| items\[].quantity              | Quantity of Product                                                        |
| items\[].sellPrice             | Sell Price                                                                 |
| items\[].total                 | Total (Quantity x Sell Price)                                              |
| currencyCode                   | ISO currency code                                                          |
| shippingFee                    | Shipping Fee                                                               |
| subtotal                       | Total (excluding Shipping Fee)                                             |
| total                          | Total                                                                      |
| payments\[]                    | An array of payments                                                       |
| payments\[].paymentId          | A unique identifier for the Payment (Guid/UUID)                            |
| payments\[].paidOnUtc          | Paid in UTC time (2020-04-29T10:02:03.212Z)                                |
| payments\[].type               | Payment Type (Credit, Cash, Points)                                        |
| payments\[].status             | Payment Status                                                             |
| payments\[].paidAmount         | Payment Amount                                                             |
| payments\[].cancellationReason | Cancellation Reason                                                        |
| payments\[].refundId           | Redund Identifier                                                          |
| payments\[].refundReason       | Redund Reason                                                              |
| payments\[].attributes         | Attributes are a list of Key/Value to support customisation of a Payment   |
| totalPaid                      | Total Paid (Total of all Payments)                                         |
| attributes                     | Attributes are a list of Key/Value to support customisation of a Order     |
| {% endtab %}                   |                                                                            |

{% tab title="Sample Object" %}

```
{
  "orderId": "string",
  "version": "string",
  "status": "Created",
  "createdOnUtc": "2020-04-29T10:02:03.212Z",
  "customerId": "string",
  "purchaserName": "string",
  "purchaserContactNumberLocal": "string",
  "purchaserEmail": "string",
  "receiverName": "string",
  "receiverContactNumberLocal": "string",
  "receiverEmail": "string",
  "items": [
    {
      "productId": "string",
      "title": "string",
      "quantity": 0,
      "sellPrice": 0,
      "total": 0
    }
  ],
  "currencyCode": "string",
  "shippingFee": 0,
  "subtotal": 0,
  "total": 0,
  "payments": [
    {
      "paymentId": "string",
      "paidOnUtc": "2020-04-29T10:02:03.212Z",
      "type": "Credit",
      "status": "Successful",
      "paidAmount": 0,
      "cancellationReason": "string",
      "refundId": "string",
      "refundReason": "string",
      "attributes": {}
    }
  ],
  "totalPaid": 0,
  "attributes": {}
}
```

{% endtab %}
{% endtabs %}