Carrier data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNoUnique identifier for this carrier object
created_atstring (date-time)NoThe date that this carrier object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this carrier object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the carrier
codestringNoCarrier code (e.g., "usps", "fedex", "ups")
is_activebooleanNoWhether the carrier is currently active
logo_urlstringNoCarrier logo URL
website_urlstringNoCarrier website

TypeScript

TypeScript
export type ShippingCarrier = {
	id?: string; // Unique identifier for this carrier object
	created_at?: string-time; // The date that this carrier object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this carrier object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // The name of the carrier
	code?: string; // Carrier code (e.g., "usps", "fedex", "ups")
	is_active?: boolean; // Whether the carrier is currently active
	logo_url?: string; // Carrier logo URL
	website_url?: string; // Carrier website
	raw?: any; // The raw data returned by the integration for this carrier
} 

Zod

Zod
import { z } from 'zod';

export const ZodShippingCarrier = z.object({
	id: z.string().optional().describe("Unique identifier for this carrier object"),
	created_at: z.string-time().optional().describe("The date that this carrier object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this carrier object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("The name of the carrier"),
	code: z.string().optional().describe("Carrier code (e.g., "usps", "fedex", "ups")"),
	is_active: z.boolean().optional().describe("Whether the carrier is currently active"),
	logo_url: z.string().optional().describe("Carrier logo URL"),
	website_url: z.string().optional().describe("Carrier website"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class ShippingCarrier:
	"""Unique identifier for this carrier object"""
	id: Optional[str]
	"""The date that this carrier object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this carrier object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The name of the carrier"""
	name: Optional[str]
	"""Carrier code (e.g., "usps", "fedex", "ups")"""
	code: Optional[str]
	"""Whether the carrier is currently active"""
	is_active: Optional[bool]
	"""Carrier logo URL"""
	logo_url: Optional[str]
	"""Carrier website"""
	website_url: Optional[str]
Are we missing anything? Let us know
Was this page helpful?