OrderNoteDTO Object

Overview

The REST API makes use of the OrderNoteDTO object whenever working with orders.  This article will help you to know the various members of this object.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

There are no tasks needed to get started with understanding this object. 

OrderNoteDTO

The OrderNoteDTO object will contain all of the most common details details of a single note for orders made in your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the OrderNoteDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
AuditDate UtcNow Used for auditing purposes to know when the order note was created.
Id 0 The unique ID of the current order note.
IsPublic False If true, the note will be shown to the customer, otherwise only merchants will see the note.
LastUpdatedUtc UtcNow The last updated date is used for auditing purposes to know when the order note was last updated.
Note (empty string) The text that the note should contain, such as a message to the customer about shipping.
OrderID 0 The unique ID of the order that the current order note belongs to.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.

 

Example of OrderNoteDTO

{
      "Notes":[
         {
            "Id":17,
            "StoreId":1,
            "LastUpdatedUtc":"\/Date(1406677252637)\/",
            "OrderID":"ddea7421-501d-44ce-b94f-48e10b8baff5",
            "AuditDate":"\/Date(1406677252207)\/",
            "Note":"Starting Process Order Workflow",
            "IsPublic":false
         },
         {
            "Id":18,
            "StoreId":1,
            "LastUpdatedUtc":"\/Date(1406677252640)\/",
            "OrderID":"ddea7421-501d-44ce-b94f-48e10b8baff5",
            "AuditDate":"\/Date(1406677252220)\/",
            "Note":"This order was assigned number 3",
            "IsPublic":false
         },
         {
            "Id":19,
            "StoreId":1,
            "LastUpdatedUtc":"\/Date(1406677252640)\/",
            "OrderID":"ddea7421-501d-44ce-b94f-48e10b8baff5",
            "AuditDate":"\/Date(1406677252410)\/",
            "Note":"Customer IP: 127.0.0.1\u003cbr\u003e Customer Host: 127.0.0.1\u003cbr\u003e Browser: Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36",
            "IsPublic":false
         },
         {
            "Id":20,
            "StoreId":1,
            "LastUpdatedUtc":"\/Date(1406677252640)\/",
            "OrderID":"ddea7421-501d-44ce-b94f-48e10b8baff5",
            "AuditDate":"\/Date(1406677252417)\/",
            "Note":"Finished Process Order Workflow",
            "IsPublic":false
         },
         {
            "Id":21,
            "StoreId":1,
            "LastUpdatedUtc":"\/Date(1406677252643)\/",
            "OrderID":"ddea7421-501d-44ce-b94f-48e10b8baff5",
            "AuditDate":"\/Date(1406677252427)\/",
            "Note":"Starting Process Payment Workflow",
            "IsPublic":false
         },
         {
            "Id":22,
            "StoreId":1,
            "LastUpdatedUtc":"\/Date(1406677252643)\/",
            "OrderID":"ddea7421-501d-44ce-b94f-48e10b8baff5",
            "AuditDate":"\/Date(1406677252530)\/",
            "Note":"Finished Process Payment Workflow",
            "IsPublic":false
         },
         {
            "Id":23,
            "StoreId":1,
            "LastUpdatedUtc":"\/Date(1406677252643)\/",
            "OrderID":"ddea7421-501d-44ce-b94f-48e10b8baff5",
            "AuditDate":"\/Date(1406677252540)\/",
            "Note":"Starting Order After Payment Workflow",
            "IsPublic":false
         },
         {
            "Id":24,
            "StoreId":1,
            "LastUpdatedUtc":"\/Date(1406677252643)\/",
            "OrderID":"ddea7421-501d-44ce-b94f-48e10b8baff5",
            "AuditDate":"\/Date(1406677252633)\/",
            "Note":"Finished Order After Payment Workflow",
            "IsPublic":false
         }
      ]
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.