Skip to content

cartSetDeliveryRemarks

Mutationin Cart

Record a note for whoever delivers the goods. Part of the delivery step of checkout, so it is set on the cart and travels to the order.

Pass null to clear a note already recorded.

Arguments

ArgumentTypeDescription
idID!
versionString
deliveryRemarksString

Returns

CartSetDeliveryRemarksResponse!

FieldTypeDescription
cartCartThe cart carrying the note
cartErrors[CartSetDeliveryRemarksError!]Error details if the note could not be recorded

Example

mutation CartSetDeliveryRemarks(
$id: ID!
$version: String
$deliveryRemarks: String
) {
cartSetDeliveryRemarks(
id: $id
version: $version
deliveryRemarks: $deliveryRemarks
) {
cart {
id
version
createdAt
lastModifiedAt
currency
customerEmail
isGuest
totalQuantity
deliveryRemarks
vatNumber
purchaseOrderNumber
deliverySplit
requestedDeliveryDate
earliestCompleteDeliveryDate
name
defaultName
status
}
cartErrors {
__typename
... on ValidationError {
message
}
... on CartError {
message
code
}
}
}
}

The query selects the return type's fields two levels deep; pick the ones you need. The response shows its shape with placeholder values.

Served by

@evolve-framework/commercetoolsResolved
@evolve-framework/medusaResolved
@evolve-framework/sfccNot resolved

Used by

The storefront packages that send it, in these GraphQL documents: