Create Note

Creates new note in VTEX Do. Beware of these limitations:

Maximum number of notes for any single order: 30

Maximum number of characters in a note's description: 2000

Request body example

curl --location --request POST 'https://{{accountName}}.{{environment}}.com.br/api/do/notes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \
--header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' \
--data-raw '{
  "target": 
    {
      "id": "v964735bdev-01",
      "type": "order",
      "url": "https://basedevmkp.vtexcommercebeta.com.br/admin/checkout/#/orders/v964741bdev-01"
    },
  "domain": "oms",
  "description": "Id do pedido no marketplace é 786-09"
}'
Language
Authentication
URL
Click Try It! to start a request and see the response here!