Sign in

v1

latestOpenAPI 3.0.02026-07-148061.0 KB
Note

Create note

Creates a new note in VTEX DO. Be aware of the following limitations:

  • The maximum number of notes for an order is 30.

  • The maximum number of characters in a note's description is 2000.

Permissions

This endpoint does not require License Manager resources.

post/notes

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

domainstring required

Domain identification.

descriptionstring required

Note description. Maximum number of characters: 2000.

Example request

{
  "target": {
    "id": "v964735bdev-01",
    "type": "order",
    "url": "https://basedevmkp.environment.com/admin/checkout/#/orders/v964741bdev-01"
  },
  "domain": "oms",
  "description": "Order ID in the marketplace is 786-09.",
  "createdBy": {
    "id": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
    "name": "Mario Smith"
  }
}

Response

OK

idstring

Note ID.

domainstring

VTEX module oms.

ownerstring

Owner ID.

descriptionstring

Note description.

creationDatestring

Creation date in UTC time format, as in YYYY-MM-DDThh:mm:ssZ.

lastUpdatestring

Last update date in UTC time format, as in YYYY-MM-DDThh:mm:ssZ.