Add Order Note - Sellercloud API Docs

Table of Contents

Overview

In order to add order note, you can do it by calling the endpoint described in this article.

In order to consume the endpoint, you must:

• Be an authenticated user

For information on how you can authenticate, see: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed on the call when retrieving order notes.

• Have a valid ID of an existing order

Endpoint

Example for such endpoint for TT server is https://tt.api.sellercloud.com/rest/api/orders/{orderID}/notes/

For your server, the endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/orders/{orderID}/notes/

Request

• Method Type: HttpPost
• Authorization: Use Bearer Token + token received from token authentication
• Header info: Content-Type: application/json
• Body data:

      {
          "OrderID": 13232,
          "note":
                 {
                     "Category": 0,
                     "Message": "test note message"
                 }
      }

Response

• If a server error appears, then the response will be with status code 500 => Internal Server Error
• If adding a note is successful, the response will be in the following format:

Note Types:

General: 0
Customer Instructions: 1
Customer Service Note: 2