{"_id":"5ac9372a53bb3900032f9e46","project":"567f0c06143cc60d00c1fdbe","version":{"_id":"567f0c06143cc60d00c1fdc1","__v":9,"project":"567f0c06143cc60d00c1fdbe","createdAt":"2015-12-26T21:52:06.734Z","releaseDate":"2015-12-26T21:52:06.734Z","categories":["567f0c07143cc60d00c1fdc2","56a9783109cb9c0d00f0c7d3","56a97837f834950d0037b363","56a9783b2d8fd90d0036eed6","56a979912d8fd90d0036eed8","5834b5691a80690f00d31faf","5834b5e4f775120f00c45f9d","5bf1a1473031e4005075ae14","5c64c200244bda003204b97f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"56a9783b2d8fd90d0036eed6","version":"567f0c06143cc60d00c1fdc1","__v":10,"pages":["56a99246318e6c1700a19d06","56a9924c257fbc0d00d4763a","56a9926bf834950d0037b381","56a99273257fbc0d00d4763c","56a992863b04f20d00ecca87","56a9928df834950d0037b383","56a992aff834950d0037b385","56a992d413a69a0d00a778de","56a9f82aca491e0d00eb8b12","56a9f959257fbc0d00d476c2"],"project":"567f0c06143cc60d00c1fdbe","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-28T02:08:59.138Z","from_sync":false,"order":3,"slug":"orders","title":"Orders"},"user":"567f0baca74a1c0d003e1fba","githubsync":"","__v":6,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-07T21:24:58.777Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{  \n   \"order_id\": 40184783,\n   ...\n   \"annotation\" : \"PROCESSED\",\n   ...\n}","language":"json","status":200}]},"method":"post","examples":{"codes":[{"language":"curl","code":"curl -X POST https://tophatter.com/merchant_api/v1/orders/annotate.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'order_id=40184783' \\\n-d 'annotation=PROCESSED\"'"}]},"settings":"","auth":"required","params":[{"_id":"5771d33b92c56c0e00b38167","ref":"","in":"body","required":true,"desc":"The order_id of the order you wish to refund.","default":"","type":"int","name":"order_id"},{"_id":"5771da3792c56c0e00b38170","ref":"","in":"body","required":true,"desc":"The annotation you'd like to attach to this order.","default":"","type":"string","name":"annotation"}],"url":"/orders/annotate.json"},"isReference":false,"order":5,"body":"Order annotation is useful for keeping track of the status of your orders before they are fulfilled. For example if your warehouse has processed an order but not yet shipped the order you can annotate the order with the string `processed` to denote that it has been processed.","excerpt":"Attach a note to an order.","slug":"order-annotate","type":"endpoint","title":"Annotate an Order"}

postAnnotate an Order

Attach a note to an order.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

order_id:
required
integer
The order_id of the order you wish to refund.
annotation:
required
string
The annotation you'd like to attach to this order.

Examples


Result Format


Documentation

Order annotation is useful for keeping track of the status of your orders before they are fulfilled. For example if your warehouse has processed an order but not yet shipped the order you can annotate the order with the string `processed` to denote that it has been processed.