cartSetDeliveryPreference

Mutationin Delivery options

Choose whether the cart ships complete or split, and the date the buyer asks to receive it on. The date has to be one the cart can be delivered on and, for a complete delivery, no earlier than every line is in stock. Pass null to drop a requested date.

Arguments

Argument	Type	Description
`id`	`ID!`
`version`	`String`
`deliverySplit`	`DeliverySplitType!`
`requestedDeliveryDate`	`Date`

Returns

CartSetDeliveryPreferenceResponse!

Field	Type	Description
`cart`	`Cart`	The cart with the preference set
`cartErrors`	`[CartSetDeliveryPreferenceError!]`	Error details if the preference could not be set

Example

mutation CartSetDeliveryPreference(
  $id: ID!
  $version: String
  $deliverySplit: DeliverySplitType!
  $requestedDeliveryDate: Date
) {
  cartSetDeliveryPreference(
    id: $id
    version: $version
    deliverySplit: $deliverySplit
    requestedDeliveryDate: $requestedDeliveryDate
  ) {
    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
      }
      ... on DeliveryError {
        message
        code
      }
    }
  }
}

{
  "id": "id-1",
  "version": "Example",
  "deliverySplit": "COMPLETE",
  "requestedDeliveryDate": "2026-10-01"
}

{
  "data": {
    "cartSetDeliveryPreference": {
      "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

Used by

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

@evolve-storefront/feature-cart: CartSetDeliveryPreference