Skip to main content

Add a Staff Note to an Order

Marketplace operators and sellers can add notes to orders that will only be accessible to other staff members.

Add a note to a marketplace order

Notes can be added to a marketplace order with the nauticalOrderAddNote mutation. The note will be stored as an event on the nauticalOrder. These notes will only be accessible to other marketplace operators.

1

Query marketplace orders

The following query return the first 10 marketplace orders:

Request
query {
nauticalOrders(first: 10) {
edges {
node {
id
created
lines {
productName
variantName
}
user {
email
}
}
}
}
}
2

Add the staff note

See the following example mutation to add a note to a marketplace order:

Request
mutation {
nauticalOrderAddNote(
order: "TmF1dGljYWxPcmRlcjoyNQ=="
input: { message: "Double-check the shipping address, as there have been previous delivery issues with this location. Coordinate with the vendor for expedited fulfillment." }
) {
event {
id
date
type
message
}
order {
customerNote
id
orderSource
created
updated
status
subStatus
languageCode
trackingClientId
currency
token
actions
number
isPaid
paymentStatus
paymentStatusDisplay
statusDisplay
canFinalize
userEmail
isShippingRequired
shippingMethodName
}
orderErrors {
field
message
code
warehouse
orderLine
variant
}
}
}
Show more ↓

Add a note to a seller order

Notes can be added to a seller order with the orderAddNote mutation. You can add as many notes as you like. The note will be stored as an event on the order.

These notes will be accessible to marketplace operators and the relevant seller.

1

Query seller orders

The following query return the first 10 seller orders:

Request
query {
orders(first: 10) {
edges {
node {
id
created
lines {
productName
variantName
}
}
}
}
}
2

Add the staff note

The following mutation adds a seller order note using the id of the order:

Request
mutation {
orderAddNote(
order: "T3JkZXI6MzE="
input: {
message: "Reminder: Verify stock levels for SKU HHS-FS-001 before processing this order. Coordinate with the warehouse team to ensure accurate fulfillment."
}
) {
event {
id
date
type
message
}
order {
customerNote
id
orderSource
created
updated
status
subStatus
languageCode
trackingClientId
currency
shippingMethodName
isShippingPriceOverridden
token
discountName
translatedDiscountName
displayGrossPrices
customerNote
importedAt
allowedSubStatuses
number
marketplaceOrderNumber
isPaid
paymentStatus
paymentStatusDisplay
statusDisplay
canFinalize
userEmail
isShippingRequired
payoutStatus
isOnlySellerOnNauticalOrder
}
orderErrors {
field
message
code
warehouse
orderLine
variant
}
}
}
Show more ↓

Was this page helpful?