Order Note GET
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}/order-service/order/{ORDER-ID}/note/{ORDER-NOTE-ID-SET} Refer to our documentation on URI syntax for more information on how to construct URIs.
Description
Retrieve one or more notes placed against a single order. If no note IDs are supplied
then all notes for the chosen order will be returned.
| Field | Description | Data type |
|---|---|---|
| noteId | Unique ID for the note | Integer |
| contactId | Contact which the order relates to | Integer |
| text | This is the text for the note | String |
| isPublic | Visibility of the order note on the Brightpearl customer portal | Boolean |
| addedOn | The date on which the order note was added | Timestamp |
| addedBy | Contact who added to note | Integer |
| orderStatusId | The status that the order was is when the note was added | Integer |
| fileId | ID of an attached file uploaded to Brightpearl | Integer |
Example 1
Retrieving all notes for order 104528.
Request URI
/order/104528/note Response
{
"response": [
{
"noteId": 11248,
"contactId": 292,
"text": "Created by John Smith",
"isPublic": false,
"addedOn": "2015-04-02T14:34:42.000+01:00",
"addedBy": 863,
"orderStatusId": 55
},
{
"noteId": 11249,
"contactId": 292,
"text": "I\\'m adding a note to this",
"isPublic": false,
"addedOn": "2015-04-02T14:37:06.000+01:00",
"addedBy": 863,
"orderStatusId": 55
},
{
"noteId": 11250,
"contactId": 292,
"text": "I\\'m adding another note",
"isPublic": false,
"addedOn": "2015-04-02T14:37:29.000+01:00",
"addedBy": 863,
"orderStatusId": 55
}
]
}Example 2
Retrieving note 11248 for order 104528.
Request URI
/order/104528/note/11248 Response
{
"response": [
{
"noteId": 11248,
"contactId": 292,
"text": "Created by Guest Login",
"isPublic": false,
"addedOn": "2015-04-02T14:34:42.000+01:00",
"addedBy": 863,
"orderStatusId": 55
}
]
}