Adding notes

Learn how to add notes to orders

There are several different notes that can be added to an Order . Notes can be added to an order to provide further context to either the retailer or supplier. There are 3 different types of notes:


Retailer Notes

The retailerNote field is an internal note that is only visible to the retailer.

curl --location --request PUT 'https://lsapi-supplier-orders.lightspeedappstg.com/orders/$ORDER_ID' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer $LIGHTSPEED_API_TOKEN' \ --data-raw '{ "retailerNote": "Order for Christmas 2020 Season" }'

Supplier Notes

The supplierNote field is an internal note that is only visible to the supplier.

curl --location --request PUT 'https://lsapi-supplier-orders.lightspeedappstg.com/orders/$ORDER_ID' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer $LIGHTSPEED_API_TOKEN' \ --data-raw '{ "supplierNote": "Retailer has requested fragile care for the packaging." }'

Public Notes

The publicNote field is a public note that is visible to both the supplier and retailer.

curl --location --request PUT 'https://lsapi-supplier-orders.lightspeedappstg.com/orders/$ORDER_ID' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer $LIGHTSPEED_API_TOKEN' \ --data-raw '{ "publicNote": "Deliver package to back shop." }'