commerce/customer/accounts/notes

This resources manages notes for a customer account. For example, a client can track a shopper's interests or complaints. Only clients can add and view notes. Shoppers cannot view these notes from the My Account page.

Note:  At this time, you can add, read, update, and delete notes only through the API. You cannot view or edit notes within Admin. If you would like to view your notes within Admin through a custom subnav link, contact your Kibo eCommerce support representative.

JSON Example

CustomerNote Properties

Property Description
content

type: string

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

Operations

Operation Name Request URI Description
AddAccountNote POST %7baccountId%7d%2fnotes%3fresponseFields%3d%7bresponseFields%7d

Adds a new note to the specified customer account.

Note:  At this time, you can add, read, update, and delete notes only through the API. You cannot view or edit notes within Admin. If you would like to view your notes within Admin through a custom subnav link, contact your Kibo eCommerce support representative.
DeleteAccountNote DELETE %7baccountId%7d%2fnotes%2f%7bnoteId%7d

Removes a note from the specified customer account.

Note:  At this time, you can add, read, update, and delete notes only through the API. You cannot view or edit notes within Admin. If you would like to view your notes within Admin through a custom subnav link, contact your Kibo eCommerce support representative.
GetAccountNote GET %7baccountId%7d%2fnotes%2f%7bnoteId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the contents of a particular note attached to a specified customer account.

Note:  At this time, you can add, read, update, and delete notes only through the API. You cannot view or edit notes within Admin. If you would like to view your notes within Admin through a custom subnav link, contact your Kibo eCommerce support representative.
GetAccountNotes GET %7baccountId%7d%2fnotes%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of notes added to a customer account according to any specified filter criteria and sort options.

Note:  At this time, you can add, read, update, and delete notes only through the API. You cannot view or edit notes within Admin. If you would like to view your notes within Admin through a custom subnav link, contact your Kibo eCommerce support representative.
UpdateAccountNote PUT %7baccountId%7d%2fnotes%2f%7bnoteId%7d%3fresponseFields%3d%7bresponseFields%7d

Modifies an existing note for a customer account.

Note:  At this time, you can add, read, update, and delete notes only through the API. You cannot view or edit notes within Admin. If you would like to view your notes within Admin through a custom subnav link, contact your Kibo eCommerce support representative.