Skip to main content
PATCH
Update order notes

Overview

Update the notes field on an order. Use this to add internal comments, special instructions, or any relevant information about the order.

Request Fields

Example Request

Response Fields

Common Use Cases

Delivery Instructions

Add special delivery requirements or time preferences

Customer Communication

Log phone calls or email exchanges about the order

Internal Tracking

Add reference numbers or internal tracking info

Special Handling

Note VIP customers or priority handling requirements

Example: Append to Existing Notes

Notes are replaced, not appended. To preserve existing notes:

Example: Log Customer Interaction

Error Handling

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Path Parameters

orderId
string
required

The order ID

Body

application/json
notes
string
required
Maximum string length: 5000

Response

Notes updated

success
enum<boolean>
required
Available options:
true
message
string
required
orderId
string
required