The Order Note API allows any user to add notes to orders and shipments, and mark them as publicly or privately visible.
Note that the request body and parameter schemas outlined in this guide are the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoint, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.
| Production URL | https://{tenantId}-translation.mozu.com/api/v2/orderNote/{orderID} |
| Sandbox URL | https://{tenantId}-translation.sandbox.mozu.com/api/v2/orderNote/{orderID} |
| Supported Formats | JSON |
| HTTP Method | POST |
Example
The example 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:
| Parameter | Type | Description |
| userID | integer | A unique identifier for the user. The minimum value is “1”. |
| note | string | The body of the order note. The maximum length is 1000. |
| public | boolean | Whether 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:
| Parameter | Type | Description |
| noteID | integer | A unique identifier for the order note. |
| noteTime | string | The 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. |
| orderID | integer | A unique identifier for the order. The minimum value is “1”. |
| externalOrderID | string | A client-generated unique identifier for the order. The minimum length is 1 and the maximum length is 100. |
| shipmentID | integer | A unique identifier for the shipment. The minimum value is “1”. |
| userName | string | The 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.
https://{tenantId}-translation.mozu.com/api/v2/orderNote/?orderID=44444The body contains all the information about the note itself.
{
"note":"Here is another note.",
"public":true,
"userID":012210
}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.