Skip to main content

ConfigCarriers Object

Description

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

Declaration

type ConfigCarriers {
enabled: Boolean!
aggregator: String
credentials: ConfigCarriersCredentials
senderAddressId: String
extraRate: Float!
}

Fields

NameTypeDescription
enabledBoolean!Whether the carrier aggregator integration is enabled.
aggregatorStringEnabled aggregator. Valid values are "sendcloud" or "shippo". A single aggregator can be enabled per account.
credentialsConfigCarriersCredentialsCarrier aggregator credentials.
senderAddressIdStringProvider-side sender address identifier to ship from. Sender addresses are managed on the provider and fetched live.
extraRateFloat!Percentage added to quoted prices for handling/packaging.