Locations

Add a location note

Adds a location note for the specified location. If a note is already added, you can change it by sending the request, or leave the Value parameter empty to delete the note. <br /> To retrieve location IDs along with the location notes, send either of these requests: GET/stores, GET/locations. Get location notes separately for the specified location by sending the GET/locations/{locationId}/notes request. <br />Note: Method is available for users with the Super Admin or Admin roles, or the Location Admin permission. <br /> Example request

             POST /locations/{locationId}/notes
             {
               "Header": "Location Manager",
               "Value": "John Smith"
             }
post/locations/{locationId}/notes

Request

Path parameters

locationIdinteger required

Unique ID of the location you want to update a note for.

Request body

Headerstring

Name of the existing location note to add, update or delete a note for. The maximum length is 100 characters.

Valuestring

Text of the note a user wants to replace the existing note with. The maximum length is 7000 characters including spaces.

Response

The note is added to the specified location.

Changes

No recorded changes to this operation across all 1 revision of this API.