Carriers

The Carriers API allows you to manage information on available carriers for your account.

The Carrier Object

This section describes the different attributes available for a carrier.

Attribute	Type	Description
active	boolean	Indicates if carrier is active for an account.
available_countries	array	List of user countries carrier is available in.
carrier_id	string	Unique reference for carrier.
contact	object	Contact information for carrier.
domestic	boolean	Indicates if the carrier is available for intracity / intrastate delivery.
logo	string	URL image of carrier logo.
international	boolean	Indicates if the carrier is available for international delivery.
metadata	object	Provide additional information for a carrier.
name	string	Name of carrier.
regional	boolean	Indicates if the carrier is available for inter-city / inter-state delivery.
requires_invoice	boolean	Indicates if printout of commercial invoice is required for pickup.
requires_waybill	boolean	Indicates if printout of waybill is required for pickup.
slug	string	Unique slug to identify carrier.
supports_multi_parcels	boolean	Indicates if carrier supports multiple parcel shipments.
created_at	datetime	Time carrier created
updated_at	datetime	Time carrier last updated