cartSetDeliveryRemarks
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
| Argument | Type | Description |
|---|---|---|
id | ID! | |
version | String | |
deliveryRemarks | String |
Returns
CartSetDeliveryRemarksResponse!
| Field | Type | Description |
|---|---|---|
cart | Cart | The 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 } } }}{ "id": "id-1", "version": "Example", "deliveryRemarks": "Example"}{ "data": { "cartSetDeliveryRemarks": { "cart": { "id": "id-1", "version": "Example", "createdAt": "2026-10-01T09:30:00Z", "lastModifiedAt": "2026-10-01T09:30:00Z", "currency": "EUR", "customerEmail": "jane@example.com", "isGuest": true, "totalQuantity": 1, "deliveryRemarks": "Example", "vatNumber": "Example", "purchaseOrderNumber": "Example", "deliverySplit": "COMPLETE", "requestedDeliveryDate": "2026-10-01", "earliestCompleteDeliveryDate": "2026-10-01", "name": "Example", "defaultName": "Example", "status": "ACTIVE" }, "cartErrors": [ { "__typename": "ValidationError", "message": "Example" } ] } }}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/commercetools | Resolved |
| @evolve-framework/medusa | Resolved |
| @evolve-framework/sfcc | Not resolved |
Used by
The storefront packages that send it, in these GraphQL documents:
- @evolve-storefront/feature-cart:
CartSetDeliveryRemarks

