Skip to main content
Skip to main content

AdminNotesResource

admin/notes.AdminNotesResource

Methods​

create​

create(payload, customHeaders?): ResponsePromise<AdminNotesRes>

Parameters​

payloadAdminPostNotesReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminNotesRes>

ResponsePromiseResponsePromise<AdminNotesRes>Required

delete​

delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Parameters​

idstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

list​

list(query?, customHeaders?): ResponsePromise<AdminNotesListRes>

Parameters​

queryAdminGetNotesParams
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminNotesListRes>

ResponsePromiseResponsePromise<AdminNotesListRes>Required

retrieve​

retrieve(id, customHeaders?): ResponsePromise<AdminNotesRes>

Parameters​

idstringRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminNotesRes>

ResponsePromiseResponsePromise<AdminNotesRes>Required

update​

update(id, payload, customHeaders?): ResponsePromise<AdminNotesRes>

Parameters​

idstringRequired
payloadAdminPostNotesNoteReqRequired
customHeadersRecord<string, any>Required

Default: `{}`

Returns​

ResponsePromise<AdminNotesRes>

ResponsePromiseResponsePromise<AdminNotesRes>Required
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.