Get order notes

GET /orders/{order}/notes

Bearer auth

Requires view_orders permission

Headers

Account-ID string(uuid) Required

Account ID - Can be found on the Dashboard under Settings → API Tokens

Path parameters

order string(uuid) Required

Query parameters

page integer

Default value is 1.
per_page integer

Default value is 15.
sort string

Sort notes by one or more fields. Use '-' prefix for descending order. Available fields: created_at, updated_at, user (sorts by user's name) Default: -updated_at

Responses

200 application/json

Order notes with pagination
Hide response attributes Show response attributes object
- data array[object]
  
  Internal note attached to an order for staff communication and order management
  
  Hide data attributes Show data attributes object
  
  content string
  
  The note content/message. Supports plain text, maximum 1000 characters.
  
  created_at string(date-time)
  
  Timestamp when the note was created
  
  user object
  
  Staff member who created the note
  
  Hide user attribute Show user attribute object
  
  name string
  
  Display name of the staff member
- links object
- meta object
404

Order not found

GET /orders/{order}/notes

curl \
 --request GET 'https://api.gb.enjovia.app/orders/{order}/notes' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Account-ID: string"

Response examples (200)

{
  "data": [
    {
      "content": "Customer called to confirm delivery address. Will be home after 3pm.",
      "created_at": "2024-01-15T14:30:00Z",
      "user": {
        "name": "Sarah Johnson"
      }
    }
  ],
  "links": {},
  "meta": {}
}