Shipment data model

export type ShippingShipment = {
	id?: string; // Unique identifier for this shipment object
	created_at?: string-time; // The date that this shipment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this shipment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	order_id?: string; // Reference to commerce_order or accounting_order
	organization_id?: string; // ref -> accounting Organization this shipment belongs to (multi-company ERPs)
	from_address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		region_code?: string; 
		postal_code?: string; 
		country?: string; 
		country_code?: string; // ISO 2-digit country code 
		name?: string; // Recipientsender name 
		company_name?: string; // Company name (for commercial addresses) 
		telephone?: string; // Phone number (required by FedEx, UPS, DHL) 
		email?: string; // Email address (for delivery notifications) 
		is_residential?: boolean; // Alias for address_type === 'RESIDENTIAL' 
		is_validated?: boolean; // Whether address has been validated 
		delivery_instructions?: string; // Special delivery notes 
	}; // Origin address
	to_address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		region_code?: string; 
		postal_code?: string; 
		country?: string; 
		country_code?: string; // ISO 2-digit country code 
		name?: string; // Recipientsender name 
		company_name?: string; // Company name (for commercial addresses) 
		telephone?: string; // Phone number (required by FedEx, UPS, DHL) 
		email?: string; // Email address (for delivery notifications) 
		is_residential?: boolean; // Alias for address_type === 'RESIDENTIAL' 
		is_validated?: boolean; // Whether address has been validated 
		delivery_instructions?: string; // Special delivery notes 
	}; // Destination address
	packages?: []; // Array of packages in this shipment
	carrier_id?: string; // Reference to the carrier
	service_code?: string; // Code for the shipping service used
	status?: 'PENDING' | 'PROCESSING' | 'IN_TRANSIT' | 'DELIVERED' | 'EXCEPTION' | 'CANCELLED' | 'LABEL_CREATED' | 'PICKED_UP' | 'OUT_FOR_DELIVERY' | 'DELIVERY_ATTEMPTED' | 'RETURNED_TO_SENDER' | 'HELD_AT_LOCATION' | 'CUSTOMS_CLEARANCE' | 'EXCEPTION_RESOLVED'; // Current status of the shipment
	rate_id?: string; // Optional reference to the selected rate (for traceability)
	label_id?: string; // Optional reference to the shipping label
	tracking_id?: string; // Optional reference to the tracking information
	shipped_at?: string-time; // When shipment was createddispatched (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	rate_amount?: number; // The rate amount used (may differ from shipping_cost due to adjustments)
	rate_currency?: string; // Currency for rate_amount
	rate_service_name?: string; // Service name from the rate (e.g., "Priority Mail")
	rate_estimated_days?: number; // Estimated delivery days from the rate
	rate_estimated_delivery_at?: string-time; // Estimated delivery date from the rate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	is_rate_guaranteed?: boolean; // Whether delivery is guaranteed (from rate)
	return_address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		region_code?: string; 
		postal_code?: string; 
		country?: string; 
		country_code?: string; // ISO 2-digit country code 
		name?: string; // Recipientsender name 
		company_name?: string; // Company name (for commercial addresses) 
		telephone?: string; // Phone number (required by FedEx, UPS, DHL) 
		email?: string; // Email address (for delivery notifications) 
		is_residential?: boolean; // Alias for address_type === 'RESIDENTIAL' 
		is_validated?: boolean; // Whether address has been validated 
		delivery_instructions?: string; // Special delivery notes 
	}; // Return address (may differ from from_address)
	return_authorization_number?: string; // RMA number if return shipment
	warehouse_location_id?: string; // Origin warehouselocation ID; points to CommerceLocation
	warehouse_location_name?: string; // Origin warehouse location name
	customs?: {
		contents_type?: 'MERCHANDISE' | 'DOCUMENTS' | 'GIFT' | 'RETURNED_GOODS' | 'SAMPLE' | 'OTHER'; 
		description?: string; // Explanation of contents 
		amount?: number; // Customs declared value 
		currency?: string; 
		duties_paid_by?: 'SENDER' | 'RECIPIENT' | 'THIRD_PARTY'; 
		taxes_paid_by?: 'SENDER' | 'RECIPIENT' | 'THIRD_PARTY'; 
		shipper_eori?: string; // Exporter EORI number 
		recipient_eori?: string; // Importer EORI number 
		shipper_tax_number?: string; // Exporter tax ID 
		recipient_tax_number?: string; // Importer tax ID 
		items?: []; // Customs items 
		restrictions?: any; // Any restrictions 
		non_delivery_option?: 'RETURN' | 'ABANDON'; 
	}; // Customs information
	is_international?: boolean; // Whether shipment is international
	insurance?: {
		insured_value?: number; // Insured value 
		currency?: string; 
		insurance_provider?: string; // Insurance provider name 
		insurance_provider_code?: string; // Provider code 
		insurance_cost?: number; // Cost of insurance 
		insurance_cost_currency?: string; 
		coverage_type?: 'STANDARD' | 'PREMIUM' | 'CUSTOM'; 
		coverage_amount?: number; // Coverage amount (may differ from insured_value) 
	}; // Insurance details
	special_instructions?: string[]; // Array of special instructions
	is_signature_required?: boolean; // Signature required on delivery
	is_adult_signature_required?: boolean; // Adult signature required
	reference_number?: string; // Customer reference number
	is_return?: boolean; // Whether this is a return shipment
	original_shipment_id?: string; // Reference to original shipment if return; points to ShippingShipment
	return_reason?: string; // Reason for return
	return_type?: 'CUSTOMER' | 'VENDOR' | 'WARRANTY' | 'DEFECTIVE' | 'OTHER'; // Type of return
	carrier_name?: string; // Human-readable carrier/provider name when there is no carrier record to reference (e.g. commerce-platform fulfillments)
	tracking_url?: string; // Carrier tracking URL for this shipment
	lineitems?: []; // Item-level fulfillment lines (what shipped); used by commerce-platform fulfillments
	raw?: any; // The raw data returned by the integration for this shipment
} 

import { z } from 'zod';

export const ZodShippingShipment = z.object({
	id: z.string().optional().describe("Unique identifier for this shipment object"),
	created_at: z.string-time().optional().describe("The date that this shipment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this shipment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	order_id: z.string().optional().describe("Reference to commerce_order or accounting_order"),
	organization_id: z.string().optional().describe("ref -> accounting Organization this shipment belongs to (multi-company ERPs)"),
	from_address: z.object({
			address1: z.string().optional(),
			address2: z.string().optional(),
			city: z.string().optional(),
			region: z.string().optional(),
			region_code: z.string().optional(),
			postal_code: z.string().optional(),
			country: z.string().optional(),
			country_code: z.string().optional().describe("ISO 2-digit country code"),
			name: z.string().optional().describe("Recipientsender name"),
			company_name: z.string().optional().describe("Company name (for commercial addresses)"),
			telephone: z.string().optional().describe("Phone number (required by FedEx, UPS, DHL)"),
			email: z.string().optional().describe("Email address (for delivery notifications)"),
			is_residential: z.boolean().optional().describe("Alias for address_type === 'RESIDENTIAL'"),
			is_validated: z.boolean().optional().describe("Whether address has been validated"),
			delivery_instructions: z.string().optional().describe("Special delivery notes")
}).optional().describe("Origin address"),
	to_address: z.object({
			address1: z.string().optional(),
			address2: z.string().optional(),
			city: z.string().optional(),
			region: z.string().optional(),
			region_code: z.string().optional(),
			postal_code: z.string().optional(),
			country: z.string().optional(),
			country_code: z.string().optional().describe("ISO 2-digit country code"),
			name: z.string().optional().describe("Recipientsender name"),
			company_name: z.string().optional().describe("Company name (for commercial addresses)"),
			telephone: z.string().optional().describe("Phone number (required by FedEx, UPS, DHL)"),
			email: z.string().optional().describe("Email address (for delivery notifications)"),
			is_residential: z.boolean().optional().describe("Alias for address_type === 'RESIDENTIAL'"),
			is_validated: z.boolean().optional().describe("Whether address has been validated"),
			delivery_instructions: z.string().optional().describe("Special delivery notes")
}).optional().describe("Destination address"),
	packages: z.array().optional().describe("Array of packages in this shipment"),
	carrier_id: z.string().optional().describe("Reference to the carrier"),
	service_code: z.string().optional().describe("Code for the shipping service used"),
	status: z.enum("PENDING", "PROCESSING", "IN_TRANSIT", "DELIVERED", "EXCEPTION", "CANCELLED", "LABEL_CREATED", "PICKED_UP", "OUT_FOR_DELIVERY", "DELIVERY_ATTEMPTED", "RETURNED_TO_SENDER", "HELD_AT_LOCATION", "CUSTOMS_CLEARANCE", "EXCEPTION_RESOLVED").optional().describe("Current status of the shipment"),
	rate_id: z.string().optional().describe("Optional reference to the selected rate (for traceability)"),
	label_id: z.string().optional().describe("Optional reference to the shipping label"),
	tracking_id: z.string().optional().describe("Optional reference to the tracking information"),
	shipped_at: z.string-time().optional().describe("When shipment was createddispatched (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	rate_amount: z.number().optional().describe("The rate amount used (may differ from shipping_cost due to adjustments)"),
	rate_currency: z.string().optional().describe("Currency for rate_amount"),
	rate_service_name: z.string().optional().describe("Service name from the rate (e.g., "Priority Mail")"),
	rate_estimated_days: z.number().optional().describe("Estimated delivery days from the rate"),
	rate_estimated_delivery_at: z.string-time().optional().describe("Estimated delivery date from the rate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	is_rate_guaranteed: z.boolean().optional().describe("Whether delivery is guaranteed (from rate)"),
	return_address: z.object({
			address1: z.string().optional(),
			address2: z.string().optional(),
			city: z.string().optional(),
			region: z.string().optional(),
			region_code: z.string().optional(),
			postal_code: z.string().optional(),
			country: z.string().optional(),
			country_code: z.string().optional().describe("ISO 2-digit country code"),
			name: z.string().optional().describe("Recipientsender name"),
			company_name: z.string().optional().describe("Company name (for commercial addresses)"),
			telephone: z.string().optional().describe("Phone number (required by FedEx, UPS, DHL)"),
			email: z.string().optional().describe("Email address (for delivery notifications)"),
			is_residential: z.boolean().optional().describe("Alias for address_type === 'RESIDENTIAL'"),
			is_validated: z.boolean().optional().describe("Whether address has been validated"),
			delivery_instructions: z.string().optional().describe("Special delivery notes")
}).optional().describe("Return address (may differ from from_address)"),
	return_authorization_number: z.string().optional().describe("RMA number if return shipment"),
	warehouse_location_id: z.string().optional().describe("Origin warehouselocation ID; points to CommerceLocation"),
	warehouse_location_name: z.string().optional().describe("Origin warehouse location name"),
	customs: z.object({
			contents_type: z.enum("MERCHANDISE", "DOCUMENTS", "GIFT", "RETURNED_GOODS", "SAMPLE", "OTHER").optional(),
			description: z.string().optional().describe("Explanation of contents"),
			amount: z.number().optional().describe("Customs declared value"),
			currency: z.string().optional(),
			duties_paid_by: z.enum("SENDER", "RECIPIENT", "THIRD_PARTY").optional(),
			taxes_paid_by: z.enum("SENDER", "RECIPIENT", "THIRD_PARTY").optional(),
			shipper_eori: z.string().optional().describe("Exporter EORI number"),
			recipient_eori: z.string().optional().describe("Importer EORI number"),
			shipper_tax_number: z.string().optional().describe("Exporter tax ID"),
			recipient_tax_number: z.string().optional().describe("Importer tax ID"),
			items: z.array().optional().describe("Customs items"),
			restrictions: z.unknown().optional().describe("Any restrictions"),
			non_delivery_option: z.enum("RETURN", "ABANDON").optional()
}).optional().describe("Customs information"),
	is_international: z.boolean().optional().describe("Whether shipment is international"),
	insurance: z.object({
			insured_value: z.number().optional().describe("Insured value"),
			currency: z.string().optional(),
			insurance_provider: z.string().optional().describe("Insurance provider name"),
			insurance_provider_code: z.string().optional().describe("Provider code"),
			insurance_cost: z.number().optional().describe("Cost of insurance"),
			insurance_cost_currency: z.string().optional(),
			coverage_type: z.enum("STANDARD", "PREMIUM", "CUSTOM").optional(),
			coverage_amount: z.number().optional().describe("Coverage amount (may differ from insured_value)")
}).optional().describe("Insurance details"),
	special_instructions: z.array().optional().describe("Array of special instructions"),
	is_signature_required: z.boolean().optional().describe("Signature required on delivery"),
	is_adult_signature_required: z.boolean().optional().describe("Adult signature required"),
	reference_number: z.string().optional().describe("Customer reference number"),
	is_return: z.boolean().optional().describe("Whether this is a return shipment"),
	original_shipment_id: z.string().optional().describe("Reference to original shipment if return; points to ShippingShipment"),
	return_reason: z.string().optional().describe("Reason for return"),
	return_type: z.enum("CUSTOMER", "VENDOR", "WARRANTY", "DEFECTIVE", "OTHER").optional().describe("Type of return"),
	carrier_name: z.string().optional().describe("Human-readable carrier/provider name when there is no carrier record to reference (e.g. commerce-platform fulfillments)"),
	tracking_url: z.string().optional().describe("Carrier tracking URL for this shipment"),
	lineitems: z.array().optional().describe("Item-level fulfillment lines (what shipped); used by commerce-platform fulfillments"),

});

import dataclasses

@dataclasses.dataclass
class ShippingShipmentStatus(str, Enum):
	PENDING = 'PENDING'
	PROCESSING = 'PROCESSING'
	IN_TRANSIT = 'IN_TRANSIT'
	DELIVERED = 'DELIVERED'
	EXCEPTION = 'EXCEPTION'
	CANCELLED = 'CANCELLED'
	LABEL_CREATED = 'LABEL_CREATED'
	PICKED_UP = 'PICKED_UP'
	OUT_FOR_DELIVERY = 'OUT_FOR_DELIVERY'
	DELIVERY_ATTEMPTED = 'DELIVERY_ATTEMPTED'
	RETURNED_TO_SENDER = 'RETURNED_TO_SENDER'
	HELD_AT_LOCATION = 'HELD_AT_LOCATION'
	CUSTOMS_CLEARANCE = 'CUSTOMS_CLEARANCE'
	EXCEPTION_RESOLVED = 'EXCEPTION_RESOLVED'

@dataclasses.dataclass
class ShippingShipmentReturn_type(str, Enum):
	CUSTOMER = 'CUSTOMER'
	VENDOR = 'VENDOR'
	WARRANTY = 'WARRANTY'
	DEFECTIVE = 'DEFECTIVE'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PropertyShippingShipmentFrom_address:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	region: Optional[str]
	region_code: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]
	"""ISO 2-digit country code"""
	country_code: Optional[str]
	"""Recipientsender name"""
	name: Optional[str]
	"""Company name (for commercial addresses)"""
	company_name: Optional[str]
	"""Phone number (required by FedEx, UPS, DHL)"""
	telephone: Optional[str]
	"""Email address (for delivery notifications)"""
	email: Optional[str]
	"""Alias for address_type === 'RESIDENTIAL'"""
	is_residential: Optional[bool]
	"""Whether address has been validated"""
	is_validated: Optional[bool]
	"""Special delivery notes"""
	delivery_instructions: Optional[str]

@dataclasses.dataclass
class PropertyShippingShipmentTo_address:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	region: Optional[str]
	region_code: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]
	"""ISO 2-digit country code"""
	country_code: Optional[str]
	"""Recipientsender name"""
	name: Optional[str]
	"""Company name (for commercial addresses)"""
	company_name: Optional[str]
	"""Phone number (required by FedEx, UPS, DHL)"""
	telephone: Optional[str]
	"""Email address (for delivery notifications)"""
	email: Optional[str]
	"""Alias for address_type === 'RESIDENTIAL'"""
	is_residential: Optional[bool]
	"""Whether address has been validated"""
	is_validated: Optional[bool]
	"""Special delivery notes"""
	delivery_instructions: Optional[str]

@dataclasses.dataclass
class PropertyShippingShipmentReturn_address:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	region: Optional[str]
	region_code: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]
	"""ISO 2-digit country code"""
	country_code: Optional[str]
	"""Recipientsender name"""
	name: Optional[str]
	"""Company name (for commercial addresses)"""
	company_name: Optional[str]
	"""Phone number (required by FedEx, UPS, DHL)"""
	telephone: Optional[str]
	"""Email address (for delivery notifications)"""
	email: Optional[str]
	"""Alias for address_type === 'RESIDENTIAL'"""
	is_residential: Optional[bool]
	"""Whether address has been validated"""
	is_validated: Optional[bool]
	"""Special delivery notes"""
	delivery_instructions: Optional[str]

@dataclasses.dataclass
class ShippingShipmentCustomsContents_type(str, Enum):
	MERCHANDISE = 'MERCHANDISE'
	DOCUMENTS = 'DOCUMENTS'
	GIFT = 'GIFT'
	RETURNED_GOODS = 'RETURNED_GOODS'
	SAMPLE = 'SAMPLE'
	OTHER = 'OTHER'

@dataclasses.dataclass
class ShippingShipmentCustomsDuties_paid_by(str, Enum):
	SENDER = 'SENDER'
	RECIPIENT = 'RECIPIENT'
	THIRD_PARTY = 'THIRD_PARTY'

@dataclasses.dataclass
class ShippingShipmentCustomsTaxes_paid_by(str, Enum):
	SENDER = 'SENDER'
	RECIPIENT = 'RECIPIENT'
	THIRD_PARTY = 'THIRD_PARTY'

@dataclasses.dataclass
class ShippingShipmentCustomsNon_delivery_option(str, Enum):
	RETURN = 'RETURN'
	ABANDON = 'ABANDON'

@dataclasses.dataclass
class PropertyShippingShipmentCustoms:
	contents_type: Optional[ShippingShipmentCustomsContents_type]
	"""Explanation of contents"""
	description: Optional[str]
	"""Customs declared value"""
	amount: Optional[int]
	currency: Optional[str]
	duties_paid_by: Optional[ShippingShipmentCustomsDuties_paid_by]
	taxes_paid_by: Optional[ShippingShipmentCustomsTaxes_paid_by]
	"""Exporter EORI number"""
	shipper_eori: Optional[str]
	"""Importer EORI number"""
	recipient_eori: Optional[str]
	"""Exporter tax ID"""
	shipper_tax_number: Optional[str]
	"""Importer tax ID"""
	recipient_tax_number: Optional[str]
	"""Customs items"""
	items: Optional[PropertyShippingShipmentItems]
	"""Any restrictions"""
	restrictions: Optional[PropertyShippingShipmentRestrictions]
	non_delivery_option: Optional[ShippingShipmentCustomsNon_delivery_option]

@dataclasses.dataclass
class ShippingShipmentInsuranceCoverage_type(str, Enum):
	STANDARD = 'STANDARD'
	PREMIUM = 'PREMIUM'
	CUSTOM = 'CUSTOM'

@dataclasses.dataclass
class PropertyShippingShipmentInsurance:
	"""Insured value"""
	insured_value: Optional[int]
	currency: Optional[str]
	"""Insurance provider name"""
	insurance_provider: Optional[str]
	"""Provider code"""
	insurance_provider_code: Optional[str]
	"""Cost of insurance"""
	insurance_cost: Optional[int]
	insurance_cost_currency: Optional[str]
	coverage_type: Optional[ShippingShipmentInsuranceCoverage_type]
	"""Coverage amount (may differ from insured_value)"""
	coverage_amount: Optional[int]

@dataclasses.dataclass
class ShippingShipment:
	"""Unique identifier for this shipment object"""
	id: Optional[str]
	"""The date that this shipment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this shipment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Reference to commerce_order or accounting_order"""
	order_id: Optional[str]
	"""ref -> accounting Organization this shipment belongs to (multi-company ERPs)"""
	organization_id: Optional[str]
	"""Origin address"""
	from_address: Optional[PropertyShippingShipmentFrom_address]
	"""Destination address"""
	to_address: Optional[PropertyShippingShipmentTo_address]
	"""Array of packages in this shipment"""
	packages: Optional[PropertyShippingShipmentPackages]
	"""Reference to the carrier"""
	carrier_id: Optional[str]
	"""Code for the shipping service used"""
	service_code: Optional[str]
	"""Current status of the shipment"""
	status: Optional[ShippingShipmentStatus]
	"""Optional reference to the selected rate (for traceability)"""
	rate_id: Optional[str]
	"""Optional reference to the shipping label"""
	label_id: Optional[str]
	"""Optional reference to the tracking information"""
	tracking_id: Optional[str]
	"""When shipment was createddispatched (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	shipped_at: Optional[str]
	"""The rate amount used (may differ from shipping_cost due to adjustments)"""
	rate_amount: Optional[int]
	"""Currency for rate_amount"""
	rate_currency: Optional[str]
	"""Service name from the rate (e.g., "Priority Mail")"""
	rate_service_name: Optional[str]
	"""Estimated delivery days from the rate"""
	rate_estimated_days: Optional[int]
	"""Estimated delivery date from the rate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	rate_estimated_delivery_at: Optional[str]
	"""Whether delivery is guaranteed (from rate)"""
	is_rate_guaranteed: Optional[bool]
	"""Return address (may differ from from_address)"""
	return_address: Optional[PropertyShippingShipmentReturn_address]
	"""RMA number if return shipment"""
	return_authorization_number: Optional[str]
	"""Origin warehouselocation ID; points to CommerceLocation"""
	warehouse_location_id: Optional[str]
	"""Origin warehouse location name"""
	warehouse_location_name: Optional[str]
	"""Customs information"""
	customs: Optional[PropertyShippingShipmentCustoms]
	"""Whether shipment is international"""
	is_international: Optional[bool]
	"""Insurance details"""
	insurance: Optional[PropertyShippingShipmentInsurance]
	"""Array of special instructions"""
	special_instructions: Optional[List[List[str]]]
	"""Signature required on delivery"""
	is_signature_required: Optional[bool]
	"""Adult signature required"""
	is_adult_signature_required: Optional[bool]
	"""Customer reference number"""
	reference_number: Optional[str]
	"""Whether this is a return shipment"""
	is_return: Optional[bool]
	"""Reference to original shipment if return; points to ShippingShipment"""
	original_shipment_id: Optional[str]
	"""Reason for return"""
	return_reason: Optional[str]
	"""Type of return"""
	return_type: Optional[ShippingShipmentReturn_type]
	"""Human-readable carrier/provider name when there is no carrier record to reference (e.g. commerce-platform fulfillments)"""
	carrier_name: Optional[str]
	"""Carrier tracking URL for this shipment"""
	tracking_url: Optional[str]
	"""Item-level fulfillment lines (what shipped); used by commerce-platform fulfillments"""
	lineitems: Optional[PropertyShippingShipmentLineitems]