Skip to main content

UpdateDeliverySettingsInput

Changes to the delivery settings.

input UpdateDeliverySettingsInput {
  autoDeliverFromCarrier: Boolean @deprecated
  customerEmailOnDelivered: Boolean
  customerEmailOnShipped: Boolean
  defaultParcel: DeliveryParcelInput @deprecated
  defaultPickupWarehouseId: String @deprecated
  feeMode: DeliveryFeeMode!
  flatFee: String
  freeDeliveryThreshold: String
  liveQuoteFreeThreshold: String
  stickerFormat: ShipmentStickerFormat
  stickerHeightMm: Int
  stickerWidthMm: Int
}

Fields​

UpdateDeliverySettingsInput.autoDeliverFromCarrier ● Boolean deprecated scalar​

DEPRECATED

Always on: a carrier's delivered marks the order delivered (D-127). Not read.

Deprecated and not read: a carrier's delivered report always marks the order delivered.

UpdateDeliverySettingsInput.customerEmailOnDelivered ● Boolean scalar​

True to email the customer when an outbound shipment is delivered.

UpdateDeliverySettingsInput.customerEmailOnShipped ● Boolean scalar​

True to email the customer when an outbound shipment is booked.

UpdateDeliverySettingsInput.defaultParcel ● DeliveryParcelInput deprecated input​

DEPRECATED

Set a Default box in updateDeliveryPackingSettings instead. Omitted = unchanged.

Deprecated: the parcel size and weight to quote with when none is given. The Default box replaces it.

UpdateDeliverySettingsInput.defaultPickupWarehouseId ● String deprecated scalar​

DEPRECATED

Not read: couriers collect from the order line's warehouse, else the Inventory default warehouse.

Deprecated and not read: the warehouse shipments were collected from by default.

UpdateDeliverySettingsInput.feeMode ● DeliveryFeeMode! non-null enum​

How the delivery fee is worked out: a flat fee or a live quote from the delivery partners.

UpdateDeliverySettingsInput.flatFee ● String scalar​

The flat delivery fee, as a decimal string in the organization's base currency.

UpdateDeliverySettingsInput.freeDeliveryThreshold ● String scalar​

The order total at or above which delivery is free, as a decimal string. Empty means no threshold.

UpdateDeliverySettingsInput.liveQuoteFreeThreshold ● String scalar​

The order total at or above which live-quoted delivery is free, as a decimal string. Empty means no threshold.

UpdateDeliverySettingsInput.stickerFormat ● ShipmentStickerFormat enum​

The default layout of the shipping sticker. Leave out to keep the saved one.

UpdateDeliverySettingsInput.stickerHeightMm ● Int scalar​

The height of the custom sticker size, in whole millimetres. Null clears it. Leave out to keep the saved one.

UpdateDeliverySettingsInput.stickerWidthMm ● Int scalar​

The width of the custom sticker size, in whole millimetres. Null clears it. Leave out to keep the saved one.

Member Of​

updateDeliverySettings mutation