Skip to main content

DeliverySettingsGql

The organization's delivery settings.

type DeliverySettingsGql {
  autoDeliverFromCarrier: Boolean! @deprecated
  configured: Boolean!
  customerEmailOnDelivered: Boolean!
  customerEmailOnShipped: Boolean!
  defaultParcel: DeliveryParcelGql @deprecated
  defaultPickupWarehouseId: String @deprecated
  feeMode: DeliveryFeeMode!
  flatFee: String
  freeDeliveryThreshold: String
  liveQuoteFreeThreshold: String
  stickerFormat: ShipmentStickerFormat!
  stickerHeightMm: Int
  stickerWidthMm: Int
}

Fields​

DeliverySettingsGql.autoDeliverFromCarrier ● Boolean! deprecated non-null 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.

DeliverySettingsGql.configured ● Boolean! non-null scalar​

False until the settings are saved. Until then the older flat-fee sources still apply.

DeliverySettingsGql.customerEmailOnDelivered ● Boolean! non-null scalar​

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

DeliverySettingsGql.customerEmailOnShipped ● Boolean! non-null scalar​

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

DeliverySettingsGql.defaultParcel ● DeliveryParcelGql deprecated object​

DEPRECATED

The fallback parcel is the Default box (deliveryPackingSettings.boxes[].isDefault). Read only until the boxes are saved again.

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

DeliverySettingsGql.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.

DeliverySettingsGql.feeMode ● DeliveryFeeMode! non-null enum​

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

DeliverySettingsGql.flatFee ● String scalar​

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

DeliverySettingsGql.freeDeliveryThreshold ● String scalar​

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

DeliverySettingsGql.liveQuoteFreeThreshold ● String scalar​

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

DeliverySettingsGql.stickerFormat ● ShipmentStickerFormat! non-null enum​

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

DeliverySettingsGql.stickerHeightMm ● Int scalar​

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

DeliverySettingsGql.stickerWidthMm ● Int scalar​

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

Returned By​

deliverySettings query ● updateDeliverySettings mutation