commerce/returns/returnnotes

Use the Return Notes resource to access and modify internal notes associated with returns. These notes can be useful to customer service representatives viewing them in Admin.

JSON Example

OrderNote Properties

Property Description
auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

id

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

text

type: string

The text content of the order note.

Operations

Operation Name Request URI Description
CreateReturnNote POST %7breturnId%7d%2fnotes%3fresponseFields%3d%7bresponseFields%7d

Creates an internal note on a given return. This note is visible in Admin for customer service representatives to see.

DeleteReturnNote DELETE %7breturnId%7d%2fnotes%2f%7bnoteId%7d

Deletes an internal note from a given return.

GetReturnNote GET %7breturnId%7d%2fnotes%2f%7bnoteId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves a specific internal note from a return.

GetReturnNotes GET %7breturnId%7d%2fnotes

Retrieves all internal notes associated with a return.

UpdateReturnNote PUT %7breturnId%7d%2fnotes%2f%7bnoteId%7d%3fresponseFields%3d%7bresponseFields%7d

Updates an internal note on a given return. This note is visible in Admin for customer service representatives to see.