Add a Buyer Note to an Order

Buyers can add an order note during checkout, which will be saved to the resulting nauticalOrder and orders, accessible to both the marketplace operator and sellers.

note

There may be only one customerNote per order. If you need more than one note, consider using order line notes.

Add a note from the buyer

Buyers can add notes to their orders during the checkout process with the checkoutNoteUpdate mutation.

The note is initially stored in the checkout.note field. After the checkout is complete, the note is saved to the customerNote field on both the nauticalOrder and all orders.

1

Query the checkout

The following query returns the id of the last open checkout for the currently authenticated buyer:

Request

query {
  me {
    checkout {
      id
    }
  }
}

2

Add the order note

Using the id of the checkout returned in step 1, the following mutation adds a buyer note to a checkout:

Request

mutation {
  checkoutNoteUpdate(
    checkoutId: "Q2hlY2tvdXQ6NGUxYTljMTYtYTUxMi00ZGRiLTliOGUtZjY1OTJkN2Y5ZWZk"
    note: "If possible, expedite shipping to meet our project deadline on December 15th. There is a loading dock out back at our Toronto warehouse. Call to be let in."
  ) {
    checkout {
      created
      lastChange
      quantity
      note
      currency
      id
      email
      isShippingRequired
      token
    }
    checkoutErrors {
      field
      message
      code
      variants
    }
  }
}

Show more ↓

---

View buyer order notes

After an order is placed, the note is saved to the customerNote field on both the nauticalOrder and all orders. These notes are accessible to the operator and sellers in the API and Dashboard.

The following query returns the first 10 marketplace orders and their notes:

Request

query {
  nauticalOrders(first: 10) {
    edges {
      node {
        id
        status
        customerNote
        lines {
          productName
        }
        orderSource
        created
        token
        number
        paymentStatus
        userEmail
        isShippingRequired
        shippingMethodName
      }
    }
  }
}

Show more ↓

Buyers can also access their notes, for example by querying me.nauticalOrders:

Request

query {
  me {
    nauticalOrders(first: 10) {
      edges {
        node {
          id
          status
          customerNote
          lines {
            productName
          }
        }
      }
    }
  }
}