Skip to main content

CarrierCreateInput

Input data for creating a new shipping carrier.

Contains all required and optional information needed to establish a new carrier including service details, coverage areas, pricing, and integration settings.

input CarrierCreateInput {
  name: String!
  type: CarrierType!
  descriptions: [LocalizedStringInput!]!
  shippingCost: Float!
  trackAndTraceURL: String
  logo: String
  warehouseIds: [Int!]
}

Fields​

CarrierCreateInput.name ● String! non-null scalar​

Unique name identifying the shipping carrier within your organization.

Official name of the shipping company or service provider used for display in shipping options and logistics management.

Validation requirements:

  • Must be unique within the organization
  • Cannot exceed 64 characters
  • Cannot be empty or contain only whitespace

CarrierCreateInput.type ● CarrierType! non-null enum​

Type of shipping service offered by this carrier.

Defines the delivery method and service characteristics provided by this carrier. Determines how customers receive their orders and affects shipping calculations.

CarrierCreateInput.descriptions ● [LocalizedStringInput!]! non-null input​

Localized descriptions of the carrier service for different languages and markets.

Collection of carrier service descriptions in various languages for international shipping options and multilingual storefronts.

Validation requirements:

  • Each description must have a unique 2-character language code (e.g., EN, DE, FR)
  • Language codes must be uppercase
  • Text values can contain up to 255 characters
  • Array must contain unique language codes only

CarrierCreateInput.shippingCost ● Float! non-null scalar​

Base shipping cost for this carrier (deprecated).

Fixed shipping cost associated with this carrier. This field is deprecated in favor of business rule builder for more flexible and complex pricing logic.

Validation requirements:

  • Must be a positive decimal value
  • Supports up to 5 decimal places

CarrierCreateInput.trackAndTraceURL ● String scalar​

URL template for package tracking and 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.

Validation requirements:

  • Must be a valid HTTPS URL
  • Cannot exceed 255 characters
  • Must include protocol and host
  • Query parameters are allowed

CarrierCreateInput.logo ● String scalar​

Public URL to the carrier's logo image for branding in shipping interfaces.

URL pointing to the carrier's logo image used for branding in shipping options and customer-facing interfaces.

Validation requirements:

  • Must be a valid URL
  • Cannot exceed 255 characters
  • Recommended: Maximum file size of 200kB
  • Recommended: Dimensions of 200x200px

CarrierCreateInput.warehouseIds ● [Int!] list scalar​

Identifiers of warehouses where this carrier provides shipping services.

Array of warehouse IDs that this carrier can service for shipping operations. Used to determine shipping availability and calculate shipping options based on fulfillment location.

Validation requirements:

  • All warehouse IDs must be positive integers
  • Array must contain unique values only
  • Warehouse IDs will be validated against the warehouse service

Member Of​

carrierCreate mutation