API reference
- Getting Started with Your API
- SDKs and Toolkits
- Commerce Overview
- POSTAdd Package to Return
- POSTAuto Refund Return
- POSTCreate Payment Action For Return
- POSTCreate Return Shipment
- POSTCreate Return Shipping Order
- DELDelete Order Item
- POSTDispose Return Items
- GETGet Available Return Actions
- GETGet Item Conditions
- GETGet Payment
- GETGet Payment Distribution
- GETGet Payments
- GETGet Reasons
- GETGet Return
- PUTUpdate Return
- DELDelete Return
- GETGet Return Attributes
- PUTUpdate Return Attributes
- POSTCreate Return Attributes
- GETGet Return Item
- GETGet Return Item Attributes
- PUTUpdate Return Item Attributes
- POSTCreate Return Item Attributes
- GETGet Return Items
- POSTCreate Return Item
- GETGet Return Label
- GETGet Return Note
- PUTUpdate Return Note
- DELDelete Return Note
- GETGet Return Notes
- POSTCreate Return Note
- GETGet Return Package
- PUTUpdate Return Package
- DELDelete Return Package
- GETGet Return Package Label
- GETGet Return Shipment
- DELDelete Return Shipment
- GETGet Returns
- POSTCreate Returns
- POSTPerform Payment Action For Return
- POSTPerform Return Action
- PUTResend Return Email
- POSTRestock Return Items
Error
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"text": "<string>"
}Create Return Note
Adds a note to the return. This is an internal note that the merchant might want to add to a return. This note is visible in Admin for customer service representatives to see.
POST
/
commerce
/
returns
/
{returnId}
/
notes
Error
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"text": "<string>"
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique identifier of the return to which you want to add a note.
Query Parameters
limits which fields are returned in the response body
Body
application/json
Text of the note. Maximum 256 characters.
⌘I