Create a Note - Medusa

Create a Note which can be associated with any resource.

curl --location -g --request POST '{{BASE_URL}}/admin/notes' \ --header 'Content-Type: application/json' \ --data-raw '{ "resource_id": "string", "resource_type": "string", "value": "string" }'

{ "note": { "id": "note_01G8TM8ENBMC7R90XRR1G6H26Q", "resource_type": "order", "resource_id": "order_01G8TJSYT9M6AVS5N4EMNFS1EK", "value": "This order must be fulfilled on Monday", "author_id": "usr_01G1G5V26F5TB3GPAPNJ8X1S3V", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" }, "author": { "id": "usr_01G1G5V26F5TB3GPAPNJ8X1S3V", "email": "user@example.com", "first_name": "Levi", "last_name": "Bogan", "api_token": null, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "role": "member", "metadata": { "car": "white" } } } }

Request

Body Params application/json

resource_id

string

required

The ID of the resource which the Note relates to. For example, an order ID.

resource_type

string

required

The type of resource which the Note relates to. For example, order.

value

string

required

The content of the Note to create.

Examples

Responses

🟢200OK

application/json

Body

note

object (Note)

required

A Note is an element that can be used in association with different resources to allow admin users to describe additional information. For example, they can be used to add additional information about orders.

string

required

The note's ID

Example:

note_01G8TM8ENBMC7R90XRR1G6H26Q

resource_type

string

required

The type of resource that the Note refers to.

Example:

order

resource_id

string

required

The ID of the resource that the Note refers to.

Example:

order_01G8TJSYT9M6AVS5N4EMNFS1EK

value

string

required

The contents of the note.

Example:

This order must be fulfilled on Monday

author_id

string | null

required

The ID of the user that created the note.

Example:

usr_01G1G5V26F5TB3GPAPNJ8X1S3V

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

author

object (User)

optional

A User is an administrator who can manage store settings and data.

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error