These guides provide examples for many tasks that a developer will need to be familiar with during implementation.



Add Order Note

The Order Note API allows any user to add notes to orders and shipments, and mark them as publicly or privately visible.

Supported FormatsJSON

The .json address above can be used to access the schema within Postman. An example use of the Add Order Note API follows below, or view the schema or the sample Postman Collection.


The example case will add a note with the following properties to an order:

  • Public note on Order 44444
  • Written by user 012210

Required Parameters

Assigning an order requires:

userIDintegerA unique identifier for the user. The minimum value is “1”.
notestringThe body of the order note. The maximum length is 1000.
publicbooleanWhether the note is publicly viewable. The default is “true”.

Optional Parameters

There are several optional parameters that can add more details and ID associations to the note:

noteIDintegerA unique identifier for the order note.
noteTimestringThe date-time at which the note was created. Note that this ID is read-only – it is automatically assigned by OMS, so do not attempt to set this parameter.
orderIDintegerA unique identifier for the order. The minimum value is “1”.
externalOrderIDstringA client-generated unique identifier for the order. The minimum length is 1 and the maximum length is 100.
shipmentIDintegerA unique identifier for the shipment. The minimum value is “1”.
userNamestringThe user’s name. This parameter is also read-only, so do not attempt to set this parameter. Use the required userID instead.

The Full Request

The order that this note is being applied to should be specified in the URL endpoint.

The body contains all the information about the note itself.

 "note":"Here is another note.",

The returned response provides information about the note that was created, including the note text, user ID, order ID, and a new Order Note ID when applicable.