Overview
In order to get order notes, you can do it by calling endpoint described in this article.
In order to consume the endpoint you must:
- Be authenticated user
For information on how you can authenticate, see: Authentication
As soon as you do authentication and receive a valid token, it needs to be passed on the call when retrieving order notes.
- Have valid ID of an existing order
Endpoint
Example for such endpoint for TT server is https://tt.api.sellercloud.com/rest/api/orders/notes/{order_id}
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/orders/notes/{id}
Request
- Method Type: HttpGet
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
- Body data:
Parameter Data Type Description Is Required id integer ID of existing order. yes
Response
- If server error appears, then response will be with status code 500 => Internal Server Error
- If getting order notes is successful, response will be with following format:
[
{
"EntityID": 1,
"Category": 0,
"NoteID": 33,
"Note": "Simple test note",
"AuditData": "2019-10-03",
"CreatedBy": 789,
"CreatedByName": "Daniel Dimitrov",
"CreatedByEmail": "[email protected]"
}
]
- field EntityID – ID of the sales order, which the notes are linked to.
- field NoteID – ID of the note
- field Note – text field that represents the text note message
- field CreatedBy – ID of the user who has created the note. If CreatedBy = 0 then note was generated automatically by the system.
- Category – category of the notesGeneral: 0
Customer Instructions: 1
Customer Service Note: 2