Authorization: If GET/POST/PATCH/DELETE /sales/comments returns 403 or 401, the signed-in user cannot perform that action in the sales workspace; use Admin Comments routes with an account that has access, or surface an error in your UI.
Payloads and filters: Match Admin Comments; only the path prefix changes to /sales/comments.
/sales/comments
Path:
/sales/commentsNamespace: sales
Resource: comments
Overview
The Comment resource in the sales namespace allows adding notes and annotations to sales-related resources such as invoices and addresses.
Key Difference from Admin: Sales namespace provides sales-focused access to comments for sales operations.
Relationships
See Admin Comments for complete relationship documentation. Sales comments use the same Comment model with sales-focused access.
Available Operations
List Comments (GET)
Endpoint:
GET /sales/comments.jsonRequest Examples:
2
3
JavaScript Example:
2
3
4
5
Show Comment (GET /:id)
Endpoint:
GET /sales/comments/:id.jsonCreate Comment (POST)
Endpoint:
POST /sales/comments.jsonUpdate Comment (PATCH /:id)
Endpoint:
PATCH /sales/comments/:id.jsonDelete Comment (DELETE /:id)
Endpoint:
DELETE /sales/comments/:id.jsonScopes
See Admin Comments for complete scope documentation.
Filters
See Admin Comments for complete filter documentation.
Business Rules
GET/POST/PATCH/DELETE /sales/commentsreturns 403 or 401, the signed-in user cannot perform that action in the sales workspace; use Admin Comments routes with an account that has access, or surface an error in your UI./sales/comments.Related Resources