Add Order Line Notes
When you need more granularity than order-level notes, you can leverage order line notes. Order line notes offer a detailed way to communicate specific instructions or requirements for each item within an order.
Customers can add order line notes during checkout, and both marketplace operators and sellers can manage these notes. Staff can also use the Dashboard to manage order line notes.
Order line notes are visible to the buyer, marketplace operator, and sellers.
Only one note can be added per order line and type. After a note has been added, subsequent mutations overwrite the original note.
Add a checkout line note
During checkout, buyers can add notes to line items with the checkoutLineAddNote mutation.
After the checkout is complete and converted to an order, any checkout line notes are saved to the resulting nauticalOrder.lines and order.lines.
Query checkout lines
You will need the id of the checkout.line to which you want to add the note.
The following query returns the checkout lines in the last open checkout for a buyer:
query {
me {
checkout {
id
lines {
id
variant {
id
name
product {
name
}
}
}
}
}
}
Add the line note
The following mutation adds a checkout line note using the id of the checkout.line:
mutation {
checkoutLineAddNote(
id: "Q2hlY2tvdXRMaW5lOjU4"
input: {
note: "Custom print instructions- please print Wave Makers 2023 on the back"
}
) {
checkoutLine {
id
note
quantity
requiresShipping
}
checkoutErrors {
field
message
code
variants
}
}
}
Add a marketplace order line note
Marketplace operators can use the nauticalOrderLineAddNote mutation to add notes to nauticalOrder.lines. This information will be accessible to the marketplace operator and buyer, but not to sellers.
While any checkout line notes are copied over to the nauticalOrder, this mutation may be useful for example to add a line item note to a draft order, or to add more context to an existing order.
This mutation will overwrite any existing note on the marketplace order line, for example if a note was added during checkout.
Query marketplace order lines
You will need the id of the nauticalOrder.line to which you want to add the note.
The following query return the first 10 marketplace orders and their order lines:
query {
nauticalOrders(first: 10) {
edges {
node {
id
created
lines {
id
productName
variantName
}
user {
email
}
}
}
}
}
Add the line note
The following mutation adds a marketplace order line note using the id of the nauticalOrder.line:
mutation {
nauticalOrderLineAddNote(
id: "TmF1dGljYWxPcmRlckxpbmU6MzY="
input: { note: "Custom print instructions- please print Wave Makers 2023 on the back. Update: Called customer to confirm printing should be in block letters." }
) {
nauticalOrderLine {
id
isLinePriceOverridden
unitPriceOverriddenNote
note
productName
variantName
productSku
isShippingRequired
quantityOrdered
}
orderErrors {
field
message
code
warehouse
orderLine
variant
}
}
}
Add a seller order line note
Sellers or marketplace operators can use the orderLineAddNote mutation to add seller order line notes. This does not modify order line notes on the nauticalOrder.
While any checkout line notes are copied over to the order, this mutation may be useful for example to add a line item note to a draft order, or to add more context to an existing order.
This mutation will overwrite any existing note on the seller order line, for example if a note was added during checkout.
Query order lines
You will need the id of the order.line to which you want to add the note. Query the seller order to get the order line id.
The following query return the first 10 orders and their order lines:
query {
orders(first: 10) {
edges {
node {
id
created
lines {
id
productName
variantName
}
}
}
}
}
Add the line note
The following mutation adds a seller order line note using the id of the order.line:
mutation {
orderLineAddNote(
id: "T3JkZXJMaW5lOjM2"
input: { note: "Custom print instructions- please print Wave Makers 2023 on the back. Update: Called customer to confirm printing should be in block letters. Requested expedited delivery." }
) {
orderLine {
id
isLinePriceOverridden
unitPriceOverriddenNote
note
productName
variantName
productSku
isShippingRequired
quantityFulfilled
quantityOrdered
}
orderErrors {
field
message
code
warehouse
orderLine
variant
}
}
}
View order line notes
Both buyers and staff members can access order line notes to understand specific instructions or requests tied to each product in the order.
- To retrieve marketplace order lines, query
nauticalOrder.lines.note. - To retrieve seller order lines, you can query one of the following:
- Query
nauticalOrder.subOrders.lines.notefor all seller order lines under a given marketplace order. - Query
order.lines.notefor a specific seller order
- Query
See the following example query, returning both the order lines at the marketplace order and seller order levels:
query {
nauticalOrder(id: "TmF1dGljYWxPcmRlcjoyOA==") {
lines {
id
productName
note
}
subOrders {
lines {
id
productName
note
}
}
id
customerNote
orderSource
created
updated
status
token
importedAt
number
isPaid
paymentStatus
paymentStatusDisplay
statusDisplay
canFinalize
userEmail
isShippingRequired
shippingMethodName
}
}
In the response, notice how there are different notes for the same product at the nauticalOrder.lines and subOrders.lines. Order line notes offer flexibility to store different notes against each order type.
{
"data": {
"nauticalOrder": {
"lines": [
{
"id": "TmF1dGljYWxPcmRlckxpbmU6NDI=",
"productName": "4-Point Ratchet Suspension Cap Style Hard Hat",
"note": "Check previous issue logs for this item. There were reports of sizing inconsistencies in the last batch."
}
],
"subOrders": [
{
"lines": [
{
"id": "T3JkZXJMaW5lOjQy",
"productName": "4-Point Ratchet Suspension Cap Style Hard Hat",
"note": "Please check that the ratchet suspension is properly adjusted before shipping. This hard hat is needed urgently for a construction project starting next week."
}
]
}
],
"id": "TmF1dGljYWxPcmRlcjoyOA==",
"orderSource": "CHECKOUT",
"created": "2023-12-05T20:50:56.493852+00:00",
"updated": "2023-12-05T20:50:56.512138+00:00",
"status": "UNFULFILLED",
"token": "24841348-4df2-4a2b-9798-5dbe0fc98fca",
"importedAt": null,
"number": "28",
"isPaid": false,
"paymentStatus": "NOT_CHARGED",
"paymentStatusDisplay": "not-charged",
"statusDisplay": "unfulfilled",
"canFinalize": true,
"userEmail": "barbara.buyer@example.com",
"isShippingRequired": true,
"shippingMethodName": "Multiseller"
}
}
}