Carrier
Shipping carrier configuration for logistics and delivery operations.
Represents a shipping company or service provider including service details, coverage areas, pricing information, and integration settings. Used for shipping calculations, order fulfillment, and logistics management.
type Carrier {
id: Int!
name: String!
type: CarrierType!
descriptions: [LocalizedString!]
shippingCost: Float! @deprecated
trackAndTraceURL: String
logo: String
createdAt: DateTime!
lastModifiedAt: DateTime!
createdBy: Int
lastModifiedBy: Int
trackAndTraces: [TrackAndTrace!]!
warehouses: [Warehouse!]
}
Fields
Carrier.id
● Int!
non-null scalar
Unique identifier for the shipping carrier.
Primary key used to reference this carrier throughout the system and for shipping operations.
Carrier.name
● String!
non-null scalar
Shipping carrier company name.
Official name of the shipping company or service provider used for display in shipping options and logistics management.
Constraints:
- Must be unique within the organization
- Cannot exceed 64 characters
Carrier.type
● CarrierType!
non-null enum
Type of shipping service offered by the carrier.
Defines the delivery method and service characteristics provided by this carrier (e.g., pickup, delivery, express).
Carrier.descriptions
● [LocalizedString!]
list object
Localized carrier descriptions for different languages.
Collection of carrier service descriptions in various languages for international shipping options and multilingual storefronts.
Constraints:
- Each description must have a unique 2-character language code
- Language codes must be uppercase (e.g., EN, DE, FR)
- Text values can contain up to 255 characters
Carrier.shippingCost
● Float!
deprecated non-null scalar
Deprecated in favour of Propeller's business rule builder, where logic can be set up for carriers and more complex use cases
Base shipping cost for this carrier (deprecated).
Fixed shipping cost associated with this carrier. This field is deprecated in favor of Propeller's business rule builder for more flexible and complex pricing logic.
Constraints:
- Decimal precision: 10 digits total, 5 decimal places
- Must be a positive value
Carrier.trackAndTraceURL
● String
scalar
Package tracking URL template for shipment monitoring.
URL template used to generate tracking links for packages shipped with this carrier. May include placeholders for tracking numbers and other shipment details.
Constraints:
- Must be a valid HTTPS URL
- Cannot exceed 255 characters
- May include query parameters and placeholders
Carrier.logo
● String
scalar
Carrier logo URL for branding in shipping options.
URL pointing to the carrier's logo image used for branding in shipping options and customer-facing interfaces.
Constraints:
- Must be a valid URL
- Cannot exceed 255 characters
- Recommended: Maximum file size of 200kB
- Recommended: Dimensions of 200x200px
Carrier.createdAt
● DateTime!
non-null scalar
Date and time when the carrier was created.
Timestamp indicating when this carrier was first added to the system. Used for auditing, filtering, and tracking carrier lifecycle. Always in UTC format.
Carrier.lastModifiedAt
● DateTime!
non-null scalar
Date and time when the carrier was last modified.
Timestamp indicating when this carrier was most recently updated in the system. Used for auditing, filtering, and tracking carrier changes. Always in UTC format.
Carrier.createdBy
● Int
scalar
Unique identifier of the user who created this carrier.
References the user account that originally created this carrier record. Used for auditing and tracking carrier ownership. May be null for system-created carriers.
Carrier.lastModifiedBy
● Int
scalar
Unique identifier of the user who last modified this carrier.
References the user account that most recently updated this carrier record. Used for auditing and tracking carrier changes. May be null for system-updated carriers.
Carrier.trackAndTraces
● [TrackAndTrace!]!
non-null object
Get all track and traces for a carrier
Carrier.warehouses
● [Warehouse!]
list object
Returned By
carrier
query ● carrierAssignWarehouseAndReturnCarrier
mutation ● carrierCreate
mutation ● carrierUnassignWarehouseAndReturnCarrier
mutation ● carrierUpdate
mutation
Member Of
CarriersResponse
object ● TrackAndTrace
object