ConfigCarriers Object

Description

Carrier aggregator configuration for live shipping rates (Sendcloud/Shippo).

Declaration

type ConfigCarriers {
    enabled: Boolean!
    aggregator: String
    credentials: ConfigCarriersCredentials
    senderAddressId: String
    extraAmount: Float!
    extraRate: Float
    methods: [String!]!
    boxes: [ConfigCarriersBox!]!
}

Fields

Name	Type	Description
enabled	Boolean!	Whether the carrier aggregator integration is enabled.
aggregator	String	Enabled aggregator. Valid values are "sendcloud" or "shippo". A single aggregator can be enabled per account.
credentials	ConfigCarriersCredentials	Carrier aggregator credentials.
senderAddressId	String	Provider-side sender address identifier to ship from. Sender addresses are managed on the provider and fetched live.
extraAmount	Float!	Fixed amount in the shop currency added to quoted prices for handling/packaging.
extraRate ⚠️	Float	Always 0. Superseded by extraAmount, which is a fixed amount rather than the percentage this was — so the stored value cannot be carried across and reading it would misprice a shipment. Kept in the schema only so that a backoffice tab still running a bundle from before the rename goes on working: a removed field fails validation for the whole query, which took the entire settings page down rather than one input. Remove once those bundles are gone. ⚠️ Deprecated: Renamed to extraAmount, and now a fixed amount rather than a percentage.
methods	[String!]!	Allowlist of provider method codes to offer at checkout. Empty = offer every method the carrier returns.
boxes	[ConfigCarriersBox!]!	Named box presets, used to pass parcel dimensions to the carrier at label purchase.