Send up to 2,000 characters; line breaks are kept. Send null to clear the note. It replaces the note the merchant wrote, and it sends no email: to tell the customer, use Notify the order customer.
Path parameters
idstringrequired
Request body
notestring | nullrequired
A note the customer sees on the order page. It may have several lines. null clears it.
Response
dataobjectrequired
order_idstring
merchant_notestring | null
executionobject
Who executed the request: the app, version, installation and store. Field names here are camelCase.
appIdstring (uuid)
versionIdstring (uuid)
installationIdstring (uuid)
storeIdstring (uuid)
requestIdstring (uuid)
generationinteger
routeEpochinteger
appAuthEpochinteger
grantRevisioninteger
metaobjectrequired
request_idstring (uuid)
The request ID; include it in any support request.
Errors
HTTP
Code
Meaning
404
RESOURCE_NOT_FOUND
The ID does not exist in this store.
422
INVALID_TEXT
The note is empty, too long, or has control characters.
403
SCOPE_REQUIRED
The token does not carry the required scope.
503
APPS_SCOPE_RUNTIME_NOT_READY
The resource is not enabled on this merchant's store yet.
