API Docs

attribute	type	specification
code	string	Machine readable description of the problem
message	string	Human readable description of the problem
errors	FieldError array	Breakdown of errors for specific fields in the request

attribute	type	specification
field	string	Field of the request that the error describes
message	string	Human readable description of the problem

code	reason-phrase	description
200	OK	The request was successful
201	Created	The request was successful and one or more resources was created
400	Bad Request	Request not processed due to client error
401	Unauthorized	Authentication is required and has failed
402	Payment Required	Lack of billing information or insufficient funds
404	Not Found	The requested resource could not be found
422	Unprocessable Entity	The request was well-formed but unable to process the contained instructions

attribute	type	specification
id	string	Unique identifier, begins with "adr_"
object	string	"Address"
mode	string	Set based on which api-key you used, either "test" or "production"
street1	string	First line of the address
street2	string	Second line of the address
city	string	City the address is located in
state	string	State or province the address is located in
zip	string	ZIP or postal code the address is located in
country	string	ISO 3166 country code for the country the address is located in
residential	boolean	Whether or not this address would be considered residential
carrier_facility	string	The specific designation for the address (only relevant if the address is a carrier facility)
name	string	Name of the person. Both name and company can be included
company	string	Name of the organization. Both name and company can be included
phone	string	Phone number to reach the person or organization
email	string	Email to reach the person or organization
federal_tax_id	string	Federal tax identifier of the person or organization
state_tax_id	string	State tax identifier of the person or organization
verifications	Verifications	The result of any verifications requested

attribute	type	specification
zip4	Verification	Only applicable to US addresses - checks and sets the ZIP+4
delivery	Verification	Checks that the address is deliverable and makes minor corrections to spelling/format. US addresses will also have their "residential" status checked and set.

attribute	type	specification
success	boolean	The success of the verification
errors	FieldError array	All errors that caused the verification to fail
details	VerificationDetails	Extra data related to the verification

attribute	type	specification
latitude	number	The latitude
longitude	number	The longitude
time_zone	TZ(string)	The time zone the address is located in, IE: America/Los_Angeles

param	example	info
street1	417 Montgomery St	First line of the address
street2	Floor 5	Second line of the address
city	San Francisco	Full city name
state	CA	State or province
zip	94104	ZIP or postal code
country	US	ISO 3166 country code for the country the address is located in
name	Hiro Protagonist	Name of attention, if person. Both name and company can be included
company	EasyPost	Name of attention, if organization. Both name and company can be included
phone	415-123-4567	Phone number to reach the person or organization
email	[email protected]	Email to reach the person or organization
residential	false	Residential delivery indicator
carrier_facility	ONDC	The specific designation for the address (only relevant if the address is a carrier facility)
federal_tax_id	1234567890	Federal tax identifier of the person or organization
state_tax_id	9876543210	State tax identifier of the person or organization
verify	[delivery, zip4, true]	The verifications to perform when creating. verify_strict takes precedence. true will perform both delivery and zip4.
verify_strict	[delivery, zip4, true]	The verifications to perform when creating. The failure of any of these verifications causes the whole request to fail. true will perform both delivery and zip4

attribute	type	specification
id	string	Unique, begins with "prcl_"
object	string	"Parcel"
mode	string	"test" or "production"
length	float (inches)	Required if width and/or height are present
width	float (inches)	Required if length and/or height are present
height	float (inches)	Required if length and/or width are present
predefined_package	string	Optional, one of our predefined_packages
weight	float (oz)	Always required
created_at	datetime
updated_at	datetime

param	example
length	20.2
width	10.9
height	5
weight	65.9

attribute	type	specification
id	string	Unique identifier, begins with "ins_"
object	string	"Insurance"
mode	string	"test" or "production"
reference	string	The unique reference for this Insurance, if any
amount	string	USD value of insured goods with sub-cent precision
provider	string	The insurance provider used by EasyPost
provider_id	string	An identifying number for some insurance providers used by EasyPost
shipment_id	string	The ID of the Shipment in EasyPost, if postage was purchased via EasyPost
tracking_code	string	The tracking code of either the shipment within EasyPost, or provided by you during creation
status	string	The current status of the insurance, possible values are "new", "pending", "purchased", "failed", or "cancelled"
tracker	Tracker	The associated Tracker object
to_address	Address	The associated Address object for destination
from_address	Address	The associated Address object for origin
fee	Fee	The associated InsuranceFee object if any
messages	Array of strings	The list of errors encountered during attempted purchase of the insurance
created_at	datetime
updated_at	datetime

param	example	info
to_address	Address	The actual destination of the package to be insured
from_address	Address	The actual origin of the package to be insured
tracking_code	9400110898825022579493	The tracking code associated with the non-EasyPost-purchased package you'd like to insure
reference	external-order-493	Optional. A unique value that may be used in place of ID when doing Retrieve calls for this insurance
amount	"$100.00"	The USD value of contents you would like to insure. Currently the maximum is $5000
carrier	USPS	The carrier associated with the tracking_code you provided. The carrier will get auto-detected if none is provided

param	example	info
before_id	ins_...	Optional pagination parameter. Only records created before the given ID will be included. May not be used with after_id
after_id	ins_...	Optional pagination parameter. Only records created after the given ID will be included. May not be used with before_id
start_datetime	2016-01-02T00:00:00Z	Only return records created after this timestamp. Defaults to 1 month ago, or 1 month before a passed end_datetime
end_datetime	2016-01-02T00:00:00Z	Only return records created before this timestamp. Defaults to end of the current day, or 1 month after a passed start_datetime
page_size	30	The number of records to return on each page. The maximum value is 100, and default is 20.

param	example	info
id	ins_...	Unique, starts with "ins_"

attribute	type	specification
id	string	Unique, begins with "shp_"
object	string	"Shipment"
reference	string	An optional field that may be used in place of id in other API endpoints
mode	string	"test" or "production"
to_address	Address	The destination address
from_address	Address	The origin address
return_address	Address	The shipper's address, defaults to from_address
buyer_address	Address	The buyer's address, defaults to to_address
parcel	Parcel	The dimensions and weight of the package
customs_info	CustomsInfo	Information for the processing of customs
scan_form	ScanForm	Document created to manifest and scan multiple shipments
forms	Form array	All associated Form objects
insurance	Insurance	The associated Insurance object
rates	Rate array	All associated Rate objects
selected_rate	Rate	The specific rate purchased for the shipment, or null if unpurchased or purchased through another mechanism
postage_label	PostageLabel	The associated PostageLabel object
messages	Message array	Any carrier errors encountered during rating, discussed in more depth below
options	Options	All of the options passed to the shipment, discussed in more depth below
is_return	boolean	Set `true` to create as a return, discussed in more depth below
tracking_code	string	If purchased, the tracking code will appear here as well as within the Tracker object
usps_zone	integer	The USPS zone of the shipment, if purchased with USPS
status	string	The current tracking status of the shipment
tracker	Tracker	The associated Tracker object
fees	Fee array	The associated Fee objects charged to the billing user account
refund_status	string	The current status of the shipment refund process. Possible values are "submitted", "refunded", "rejected".
batch_id	string	The ID of the batch that contains this shipment, if any
batch_status	string	The current state of the associated BatchShipment
batch_message	string	The current message of the associated BatchShipment
created_at	datetime
updated_at	datetime

attribute	type	specification
id	string	Unique, begins with "form_"
object	string	"Form"
mode	string	"test" or "production"
form_type	string	The type of form that we returned, can be one of "high_value_report", "commercial_invoice", "cod_return_label", "order_summary", "cn22"
form_url	string	The address we return the form back at
submitted_electronically	boolean	If we have submitted the form to the carrier on behalf of the customer
created_at	datetime
updated_at	datetime

param	example	info
reference	"my-reference"
to_address	<Address>	Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
from_address	<Address>	Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
parcel	<Parcel>
carrier_accounts	["ca_...", ...]

param	example	info
before_id	shp_...	Optional pagination parameter. Only shipments created before the given ID will be included. May not be used with after_id
after_id	shp_...	Optional pagination parameter. Only shipments created after the given ID will be included. May not be used with before_id
start_datetime	2016-01-02T00:00:00Z	Only return Shipments created after this timestamp. Defaults to 1 month ago, or 1 month before a passed end_datetime
end_datetime	2016-01-02T00:00:00Z	Only return Shipments created before this timestamp. Defaults to end of the current day, or 1 month after a passed start_datetime
page_size	20	The number of Shipments to return on each page. The maximum value is 100
purchased	true	Only include Shipments that have been purchased. Default is `true`
include_children	false	Also include Shipments created by Child Users. Defaults to `false`

param	example
rate	<Rate>
insurance	"100.00"

param	example	info
reference	"my-reference"
to_address	<Address>	Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
from_address	<Address>	Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
parcel	<Parcel>
carrier_accounts	["ca_..."]
service	"Priority"

attribute	type	specification
additional_handling	boolean	Setting this option to `true`, will add an additional handling charge. An Additional Handling charge may be applied to the following: Any article that is encased in an outside shipping container made of metal or wood. Any item, such as a barrel, drum, pail or tire, that is not fully encased in a corrugated cardboard shipping container. Any package with the longest side exceeding 60 inches or its second longest side exceeding 30 inches. Any package with an actual weight greater than 70 pounds.
address_validation_level	string	Setting this option to "0", will allow the minimum amount of address information to pass the validation check. Only for USPS postage.
alcohol	boolean	Set this option to `true` if your shipment contains alcohol. UPS - only supported for US Domestic shipments FedEx - only supported for US Domestic shipments Canada Post - Requires adult signature 19 years or older. If you want adult signature 18 years or older, instead use delivery_confirmation: ADULT_SIGNATURE
bill_receiver_account	string	*This field is deprecated. Use the 'payment' option object instead.
bill_receiver_postal_code	string	*This field is deprecated. Use the 'payment' option object instead.
bill_third_party_account	string	*This field is deprecated. Use the 'payment' option object instead.
bill_third_party_country	string	*This field is deprecated. Use the 'payment' option object instead.
bill_third_party_postal_code	string	*This field is deprecated. Use the 'payment' option object instead.
by_drone	boolean	Setting this option to `true` will indicate to the carrier to prefer delivery by drone, if the carrier supports drone delivery.
carbon_neutral	boolean	Setting this to `true` will add a charge to reduce carbon emissions.
cod_amount	string	Adding an amount will have the carrier collect the specified amount from the recipient.
cod_method	string	Method for payment. "CASH", "CHECK", "MONEY_ORDER"
cod_address_id	string	The ID of the Address to which the COD payment should be returned. Defaults to the origin address. Only available on FedEx shipments.
currency	string	Which currency this shipment will show for rates if carrier allows.
delivery_confirmation	string	If you want to request a signature, you can pass "ADULT_SIGNATURE" or "SIGNATURE". You may also request "NO_SIGNATURE" to leave the package at the door. All - some options may be limited for international shipments FedEx - "INDIRECT_SIGNATURE" is also an option USPS - additional options "ADULT_SIGNATURE_RESTRICTED" "SIGNATURE_RESTRICTED" Canada Post - "DO_NOT_SAFE_DROP"
dropoff_type	string	Method the customer will use to transfer the package to the carrier. "REGULAR_PICKUP", "SCHEDULED_PICKUP", "RETAIL_LOCATION", "STATION" or "DROP_BOX". Supported carriers and their corresponding carrier dropoff codes: FedEx "REGULAR_PICKUP" - "REGULAR_PICKUP" (default) "SCHEDULED_PICKUP" - "REQUEST_COURIER" "RETAIL_LOCATION" - "BUSINESS_SERVICE_CENTER" "STATION" - "STATION" "DROP_BOX" - "DROP_BOX"
dry_ice	boolean	Package contents contain dry ice. UPS - Need dry_ice_weight to be set UPS MailInnovations - Need dry_ice_weight to be set FedEx - Need dry_ice_weight to be set
dry_ice_medical	string	If the dry ice is for medical use, set this option to `true`. UPS - Need dry_ice_weight to be set UPS MailInnovations - Need dry_ice_weight to be set
dry_ice_weight	string	Weight of the dry ice in ounces. UPS - Need dry_ice to be set UPS MailInnovations - Need dry_ice to be set FedEx - Need dry_ice to be set
endorsement	string	Possible values "ADDRESS_SERVICE_REQUESTED", "FORWARDING_SERVICE_REQUESTED", "CHANGE_SERVICE_REQUESTED", "RETURN_SERVICE_REQUESTED", "LEAVE_IF_NO_RESPONSE"
freight_charge	double	Additional cost to be added to the invoice of this shipment. Only applies to UPS currently.
handling_instructions	string	This is to designate special instructions for the carrier like "Do not drop!".
hazmat	string	Dangerous goods indicator. Possible values are "PRIMARY_CONTAINED", "PRIMARY_PACKED", "PRIMARY", "SECONDARY_CONTAINED", "SECONDARY_PACKED", "SECONDARY", "ORMD", "LIMITED_QUANTITY", "LITHIUM". Applies to USPS, FedEx and DHL eCommerce.
hold_for_pickup	boolean	Package will wait at carrier facility for pickup.
incoterm	string	Incoterm negotiated for shipment. Supported values are "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP", "FAS", "FOB", "CFR", and "CIF". Setting this value to anything other than "DDP" will pass the cost and responsibility of duties on to the recipient of the package(s), as specified by Incoterms rules
invoice_number	string	This will print an invoice number on the postage label.
label_date	string	Set the date that will appear on the postage label. Accepts ISO 8601 formatted string including time zone offset. EasyPost stores all dates as UTC time.
label_format	string	Supported label formats include "PNG", "PDF", "ZPL", and "EPL2". "PNG" is the only format that allows for conversion.
machinable	boolean	Whether or not the parcel can be processed by the carriers equipment.
payment	object	Setting payment type to bill the correct account for purchasing postage. type - (string) Supported values are "SENDER", "THIRD_PARTY", "RECEIVER", "COLLECT". Defaults to SENDER. account - (string) Setting account number. Required for RECEIVER and THIRD_PARTY. country - (string) Setting country code that the account is based in. Required for THIRD_PARTY. postal_code - (string) Setting postal code that the account is based in. Required for RECEIVER and THIRD_PARTY.
print_custom_1	string	You can optionally print custom messages on labels. The locations of these fields show up on different spots on the carrier's labels.
print_custom_2	string	An additional message on the label. Same restrictions as print_custom_1
print_custom_3	string	An additional message on the label. Same restrictions as print_custom_1
print_custom_1_barcode	boolean	Create a barcode for this custom reference if supported by carrier.
print_custom_2_barcode	boolean	Create a barcode for this custom reference if supported by carrier.
print_custom_3_barcode	boolean	Create a barcode for this custom reference if supported by carrier.
print_custom_1_code	string	Specify the type of print_custom_1. FedEx (null) - If `print_custom_1_code` is not provided it defaults to Customer Reference PO - Purchase Order Number DP - Department Number RMA - Return Merchandise Authorization UPS AJ - Accounts Receivable Customer Account AT - Appropriation Number BM - Bill of Lading Number 9V - Collect on Delivery (COD) Number ON - Dealer Order Number DP - Department Number 3Q - Food and Drug Administration (FDA) Product Code IK - Invoice Number MK - Manifest Key Number MJ - Model Number PM - Part Number PC - Production Code PO - Purchase Order Number RQ - Purchase Request Number RZ - Return Authorization Number SA - Salesperson Number SE - Serial Number ST - Store Number TN - Transaction Reference Number EI - Employer’s ID Number TJ - Federal Taxpayer ID No.
print_custom_2_code	string	See print_custom_1_code.
print_custom_3_code	string	See print_custom_1_code.
saturday_delivery	boolean	Set this value to `true` for delivery on Saturday. When setting the saturday_delivery option, you will only get rates for services that are eligible for saturday delivery. If no services are available for saturday delivery, then you will not be returned any rates. You may need to create 2 shipments, one with the saturday_delivery option set on one without to get all your eligible rates.
special_rates_eligibility	string	This option allows you to request restrictive rates from USPS. Can set to 'USPS.MEDIAMAIL' or 'USPS.LIBRARYMAIL'.
smartpost_hub	string	You can use this to override the hub ID you have on your account.
smartpost_manifest	string	The manifest ID is used to group SmartPost packages onto a manifest for each trailer.
billing_ref	string	A reference ID for aggregating DHL eCommerce billing data.
certified_mail	boolean	Certified Mail provides the sender with a mailing receipt and, upon request, electronic verification that an article was delivered or that a delivery attempt was made.
registered_mail	boolean	Registered Mail is the most secure service that the USPS offers. It incorporates a system of receipts to monitor the movement of the mail from the point of acceptance to delivery
registered_mail_amount	double	The value of the package contents
return_receipt	boolean	An electronic return receipt may be purchased at the time of mailing and provides a shipper with evidence of delivery (to whom the mail was delivered and date of delivery), and information about the recipient's actual delivery address. Only applies to the USPS.

Rates

After a Shipment is successfully created, it will automatically fetch Rates. You can limit the CarrierAccounts to use for rating by passing the carrier_accounts parameter upon Shipment creation.

There are three rate types: the actual rate that will be purchased, rate and currency, the published non-discounted rate, list_rate and list_currency, and the rate if purchased from the post office, retail_rate and retail_currency.

Rate Object

attribute	type	specification
id	string	unique, begins with 'rate_'
object	string	"Rate"
mode	string	"test" or "production"
service	string	service level/name
carrier	string	name of carrier
carrier_account_id	string	ID of the CarrierAccount record used to generate this rate
shipment_id	string	ID of the Shipment this rate belongs to
rate	string	the actual rate quote for this service
currency	string	currency for the rate
retail_rate	string	the retail rate is the in-store rate given with no account
retail_currency	string	currency for the retail rate
list_rate	string	the list rate is the non-negotiated rate given for having an account with the carrier
list_currency	string	currency for the list rate
delivery_days	integer	delivery days for this service
delivery_date	string	date for delivery
delivery_date_guaranteed	boolean	indicates if delivery window is guaranteed (true) or not (false)
est_delivery_days*	integer	*This field is deprecated and should be ignored.
created_at	datetime
updated_at	datetime

Service Levels

UPS Rates
USPS Rates
FedEx Rates
UPS Labels
USPS Labels
FedEx Labels
UPS Tracking
USPS Tracking
FedEx Tracking

parcelConnectBookService
parcelConnectExpeditedDDP
parcelConnectExpeditedDDU
parcelConnectPriorityDDP
parcelConnectPriorityDDPDelcon
parcelConnectPriorityDDU
parcelConnectPriorityDDUDelcon
parcelConnectPriorityDDUPQW
parcelConnectStandardDDU
parcelConnectStandardDDUPQW
parcelConnectPacketDDU

PMI
ePacket
IPA
ISAL

ADS
AirFreightInbound
AirFreightOutbound
AsendiaDomesticBoundPrinterMatterExpedited
AsendiaDomesticBoundPrinterMatterGround
AsendiaDomesticFlatsExpedited
AsendiaDomesticFlatsGround
AsendiaDomesticParcelGroundOver1lb
AsendiaDomesticParcelGroundUnder1lb
AsendiaDomesticParcelMAXOver1lb
AsendiaDomesticParcelMAXUnder1lb
AsendiaDomesticParcelOver1lbExpedited
AsendiaDomesticParcelUnder1lbExpedited
AsendiaDomesticPromoParcelExpedited
AsendiaDomesticPromoParcelGround
BulkFreight
BusinessMailCanadaLettermail
BusinessMailCanadaLettermailMachineable
BusinessMailEconomy
BusinessMailEconomyLPWholesale
BusinessMailEconomySPWholesale
BusinessMailIPA
BusinessMailISAL
BusinessMailPriority
BusinessMailPriorityLPWholesale
BusinessMailPrioritySPWholesale
MarketingMailCanadaPersonalizedLCP
MarketingMailCanadaPersonalizedMachineable
MarketingMailCanadaPersonalizedNDG
MarketingMailEconomy
MarketingMailIPA
MarketingMailISAL
MarketingMailPriority
PublicationsCanadaLCP
PublicationsCanadaNDG
PublicationsEconomy
PublicationsIPA
PublicationsISAL
PublicationsPriority
ePAQElite
ePAQEliteCustom
ePAQEliteDAP
ePAQEliteDDP
ePAQEliteDDPOversized
ePAQEliteDPD
ePAQEliteDirectAccessCanadaDDP
ePAQEliteOversized
ePAQPlus
ePAQPlusCustom
ePAQPlusCustomsPrepaid
ePAQPlusDAP
ePAQPlusDDP
ePAQPlusEconomy
ePAQPlusWholesale
ePAQPlusePacket
ePAQPlusePacketCanadaCustomsPrePaid
ePAQPlusePacketCanadaDDP
ePAQReturnsDomestic
ePAQReturnsInternational
ePAQReturnsInternational
ePAQSelect
ePAQSelectCustom
ePAQSelectCustomsPrepaidByShopper
ePAQSelectDAP
ePAQSelectDDP
ePAQSelectDDPDirectAccess
ePAQSelectDirectAccess
ePAQSelectDirectAccessCanadaDDP
ePAQSelectEconomy
ePAQSelectOversized
ePAQSelectOversizedDDP
ePAQSelectPMEI
ePAQSelectPMEICanadaCustomsPrePaid
ePAQSelectPMEIPCPostage
ePAQSelectPMI
ePAQSelectPMICanadaCustomsPrepaid
ePAQSelectPMICanadaDDP
ePAQSelectPMINonPresort
ePAQSelectPMIPCPostage
ePAQStandard
ePAQStandardCustom
ePAQStandardEconomy
ePAQStandardIPA
ePAQStandardISAL
ePaqSelectPMEINonPresort

ExpressPost
ExpressPostSignature
ParcelPost
ParcelPostSignature
ParcelPostExtra
ParcelPostWinePlusSignature

AxleHireDelivery

No service levels for Better Trucks.

Standard

No service levels for Cainiao.

RegularParcel
ExpeditedParcel
Xpresspost
XpresspostCertified
Priority
LibraryBooks
ExpeditedParcelUSA
PriorityWorldwideEnvelopeUSA
PriorityWorldwidePakUSA
PriorityWorldwideParcelUSA
SmallPacketUSAAir
TrackedPacketUSA
TrackedPacketUSALVM
XpresspostUSA
XpresspostInternational
InternationalParcelAir
InternationalParcelSurface
PriorityWorldwideEnvelopeIntl
PriorityWorldwidePakIntl
PriorityWorldwideParcelIntl
SmallPacketInternationalAir
SmallPacketInternationalSurface
TrackedPacketInternational

Ground
SelectLetter
SelectPak
Select
OvernightLetter
OvernightPak
Overnight
SelectUSA
USAPak
USALetter
USA
International

DISTRIBUTION
Same Day

No service levels for Chronopost.

No service levels for CloudSort.

BASIC_PARCEL

DomesticPrioritySignature
DomesticPriority
DomesticOffPeakSignature
DomesticOffPeak
GoldDomesticSignature
GoldDomestic
AustralianCityExpressSignature
AustralianCityExpress
DomesticSaverSignature
DomesticSaver
RoadExpress
5KgSatchel
3KgSatchel
1KgSatchel
5KgSatchelATL
3KgSatchelATL
1KgSatchelATL
500GramSatchel
500GramSatchelATL
25KgParcel
10KgParcel
5KgParcel
3KgParcel
1KgParcel
500GramParcel
500GramParcelATL
ExpressInternationalPriority
InternationalSaver
InternationalExpressImport
ExpressInternationalPriority
InternationalExpress

DomesticTracked
InternationalEconomy
InternationalStandard
InternationalExpress

PacketPlus

PriorityPacketPlus
PriorityPacket
PriorityPacketTracked
BusinessMailRegistered
StandardPacket
BusinessMailStandard

Packet
PacketPlus
ParcelDirect
ParcelDirectExpedited

DHLParcelExpedited
DHLParcelExpeditedMax
DHLParcelGround
DHLBPMExpedited
DHLBPMGround
DHLParcelInternationalDirect
DHLParcelInternationalStandard
DHLPacketInternational
DHLParcelInternationalDirectPriority
DHLParcelInternationalDirectStandard

BreakBulkEconomy
BreakBulkExpress
DomesticEconomySelect
DomesticExpress
DomesticExpress1030
DomesticExpress1200
EconomySelect
EconomySelectNonDoc
EuroPack
EuropackNonDoc
Express1030
Express1030NonDoc
Express1200NonDoc
Express1200
Express900
Express900NonDoc
ExpressEasy
ExpressEasyNonDoc
ExpressEnvelope
ExpressWorldwide
ExpressWorldwideB2C
ExpressWorldwideB2CNonDoc
ExpressWorldwideECX
ExpressWorldwideNonDoc
FreightWorldwide
GlobalmailBusiness
JetLine
JumboBox
LogisticsServices
SameDay
SecureLine
SprintLine

DPDCLASSIC
DPD8:30
DPD10:00
DPD12:00
DPD18:00
DPDEXPRESS
DPDPARCELLETTER
DPDPARCELLETTERPLUS
DPDINTERNATIONALMAIL

AirExpressInternationalAir
AirClassicInternationalAir
ParcelSunday
FreightParcelSunday
PalletSunday
PalletDpdClassic
ExpresspakDpdClassic
ExpresspakSunday
ParcelDpdClassic
ParcelDpdTwoDay
ParcelDpdNextDay
ParcelDpd12
ParcelDpd10
ParcelDpd10
ParcelReturnToShop
ParcelSaturday
ParcelSaturday12
ParcelSaturday10
ParcelSaturday10
ParcelSunday12
FreightParcelDpdClassic
FreightParcelSunday12
ExpresspakDpdNextDay
ExpresspakDpd12
ExpresspakDpd10
ExpresspakDpd10
ExpresspakSaturday
ExpresspakSaturday12
ExpresspakSaturday10
ExpresspakSaturday10
ExpresspakSunday12
PalletSunday12
PalletDpdTwoDay
PalletDpdNextDay
PalletDpd12
PalletDpd10
PalletSaturday
PalletSaturday12
PalletSaturday10
FreightParcelDpdTwoDay
FreightParcelDpdNextDay
FreightParcelDpd12
FreightParcelDpd10
FreightParcelSaturday
FreightParcelSaturday12
FreightParcelSaturday10

CourierServiceDDP
CourierServiceDDU
DomesticEconomyParcel
DomesticParcelBPM
DomesticPriorityParcel
DomesticPriorityParcelBPM
EMIService
EconomyParcelService
IPAService
ISALService
PMIService
PriorityParcelDDP
PriorityParcelDDU
PriorityParcelDeliveryConfirmationDDP
PriorityParcelDeliveryConfirmationDDU
ePacketService

NextDayBy930
NextDayBy1130
NextDay
Ground
TwoDay
LTL

Parcel
Satchel

FEDEX_GROUND
FEDEX_2_DAY
FEDEX_2_DAY_AM
FEDEX_EXPRESS_SAVER
STANDARD_OVERNIGHT
FIRST_OVERNIGHT
PRIORITY_OVERNIGHT
INTERNATIONAL_ECONOMY
INTERNATIONAL_FIRST
INTERNATIONAL_PRIORITY
GROUND_HOME_DELIVERY
SMART_POST

CBEC
CBECL
CBECP

No service levels for FedEx Mailview.

EconomyService
StandardService
PriorityService
LastMile

SMART_POST

No service levels for FirstMile.

PMEI
PMI
eComDomestic
eComEurope
eComExpress
eComExtra
eComIPA
eComISAL
eComPMEIDutyPaid
eComPMIDutyPaid
eComPacket
eComPacketDDP
eComPriority
eComStandard
eComTrackedDDP
eComTrackedDDU

EarlyPriorityOvernight
PriorityOvernight
CaliforniaParcelService
SaturdayDeliveryService
EarlySaturdayService
Ground
Overnight

DomesticDelivery
DomesticDeliverySigned
InternationalDelivery
InternationalDeliverySigned

InterlinkAirClassicInternationalAir
InterlinkAirExpressInternationalAir
InterlinkExpresspak1By10:30
InterlinkExpresspak1By12
InterlinkExpresspak1NextDay
InterlinkExpresspak1Saturday
InterlinkExpresspak1SaturdayBy10:30
InterlinkExpresspak1SaturdayBy12
InterlinkExpresspak1Sunday
InterlinkExpresspak1SundayBy12
InterlinkExpresspak5By10
InterlinkExpresspak5By10:30
InterlinkExpresspak5By12
InterlinkExpresspak5NextDay
InterlinkExpresspak5Saturday
InterlinkExpresspak5SaturdayBy10
InterlinkExpresspak5SaturdayBy10:30
InterlinkExpresspak5SaturdayBy12
InterlinkExpresspak5Sunday
InterlinkExpresspak5SundayBy12
InterlinkFreightBy10
InterlinkFreightBy12
InterlinkFreightNextDay
InterlinkFreightSaturday
InterlinkFreightSaturdayBy10
InterlinkFreightSaturdayBy12
InterlinkFreightSunday
InterlinkFreightSundayBy12
InterlinkParcelBy10
InterlinkParcelBy10:30
InterlinkParcelBy12
InterlinkParcelDpdEuropeByRoad
InterlinkParcelNextDay
InterlinkParcelReturn
InterlinkParcelReturnToShop
InterlinkParcelSaturday
InterlinkParcelSaturdayBy10
InterlinkParcelSaturdayBy10:30
InterlinkParcelSaturdayBy12
InterlinkParcelShipToShop
InterlinkParcelSunday
InterlinkParcelSundayBy12
InterlinkParcelTwoDay
InterlinkPickupParcelDpdEuropeByRoad

No service levels for JP Post.

No service levels for Kuroneko Yamato.

No service levels for La Poste.

SameDay
NextDay
Weekend

LoomisGround
LoomisExpress1800
LoomisExpress1200
LoomisExpress900

GroundEarly
GroundBasic
PriorityBasic
PriorityEarly
PrioritySaturday
Priority2ndDay
SameDay

ParcelSelect
ParcelSelectLightweight
Ground
Express
FirstClassMail
PriorityMail
BoundPrintedMatter

Sunrise
Gold
OnTracGround
SameDay
PalletizedFreight

First
Expedited
ParcelSelectLightweight
Priority
BPM
ParcelSelect
MediaMail
MarketingParcel
MarketingParcelTracked

No service levels for Parcelforce.

No service levels for Passport.

No service levels for PCF Final Mile.

No service levels for PostNL.

PurolatorExpress
PurolatorExpress12PM
PurolatorExpressPack12PM
PurolatorExpressBox12PM
PurolatorExpressEnvelope12PM
PurolatorExpress1030AM
PurolatorExpress9AM
PurolatorExpressBox
PurolatorExpressBox1030AM
PurolatorExpressBox9AM
PurolatorExpressBoxEvening
PurolatorExpressBoxInternational
PurolatorExpressBoxInternational1030AM
PurolatorExpressBoxInternational1200
PurolatorExpressBoxInternational9AM
PurolatorExpressBoxUS
PurolatorExpressBoxUS1030AM
PurolatorExpressBoxUS1200
PurolatorExpressBoxUS9AM
PurolatorExpressEnvelope
PurolatorExpressEnvelope1030AM
PurolatorExpressEnvelope9AM
PurolatorExpressEnvelopeEvening
PurolatorExpressEnvelopeInternational
PurolatorExpressEnvelopeInternational1030AM
PurolatorExpressEnvelopeInternational1200
PurolatorExpressEnvelopeInternational9AM
PurolatorExpressEnvelopeUS
PurolatorExpressEnvelopeUS1030AM
PurolatorExpressEnvelopeUS1200
PurolatorExpressEnvelopeUS9AM
PurolatorExpressEvening
PurolatorExpressInternational
PurolatorExpressInternational1030AM
PurolatorExpressInternational1200
PurolatorExpressInternational9AM
PurolatorExpressPack
PurolatorExpressPack1030AM
PurolatorExpressPack9AM
PurolatorExpressPackEvening
PurolatorExpressPackInternational
PurolatorExpressPackInternational1030AM
PurolatorExpressPackInternational1200
PurolatorExpressPackInternational9AM
PurolatorExpressPackUS
PurolatorExpressPackUS1030AM
PurolatorExpressPackUS1200
PurolatorExpressPackUS9AM
PurolatorExpressUS
PurolatorExpressUS1030AM
PurolatorExpressUS1200
PurolatorExpressUS9AM
PurolatorGround
PurolatorGround1030AM
PurolatorGround9AM
PurolatorGroundDistribution
PurolatorGroundEvening
PurolatorGroundRegional
PurolatorGroundUS

InternationalSigned
InternationalStandard
InternationalTracked
InternationalTrackedAndSigned
1stClass
1stClassSignedFor
2ndClass
2ndClassSignedFor
RoyalMail24
RoyalMail24SignedFor
RoyalMail48
RoyalMail48SignedFor
SpecialDeliveryGuaranteed1pm
SpecialDeliveryGuaranteed9am
StandardLetter1stClass
StandardLetter1stClassSignedFor
StandardLetter2ndClass
StandardLetter2ndClassSignedFor
Tracked24
Tracked24HighVolume
Tracked24HighVolumeSignature
Tracked24Signature
Tracked48
Tracked48HighVolume
Tracked48HighVolumeSignature
Tracked48Signature

eCommerce Standard Tracked
eCommerce Express Tracked
Domestic Express
Domestic Standard

International Standard Express - Doc
International Standard Express - Parcel
International Economy Express - Pilot
International Economy Express - Doc

SpeeDeeDelivery

StartrackExpress
StartrackPremium
StartrackFixedPricePremium

SameDay
SameDayWhiteGlove
NextDay
NextDayWhiteGlove

DeliveryService

Ground
UPSStandard
UPSSaver
Express
ExpressPlus
Expedited
NextDayAir
NextDayAirSaver
NextDayAirEarlyAM
2ndDayAir
2ndDayAirAM
3DaySelect

No service levels for UPS i-parcel.

First
Priority
ExpeditedMailInnovations
PriorityMailInnovations
EconomyMailInnovations

First
Priority
Express
ParcelSelect
LibraryMail
MediaMail
FirstClassMailInternational
FirstClassPackageInternationalService
PriorityMailInternational
ExpressMailInternational

nextDay
sameDay

No service levels for Yanwen.

GET /shipments/:id/rates

Regenerate Rates for a Shipment

You can update the Rates of a Shipment at any time. This operation respects the carrier_accounts attribute.

Regenerate Rates for Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

curl -X GET https://api.easypost.com/v2/shipments/shp_.../rates \
  -u <YOUR_TEST/PRODUCTION_API_KEY>:

{
  "id": "shp_...",
  "object": "Shipment",
  "mode": "test",
  "to_address": {
    "id": "adr_...",
    "object": "Address",
    "name": "Dr. Steve Brule",
    "company": null,
    "street1": "179 N Harbor Dr",
    "street2": null,
    "city": "Redondo Beach",
    "state": "CA",
    "zip": "90277",
    "country": "US",
    "phone": "4153334444",
    "mode": "test",
    "carrier_facility": null,
    "residential": null,
    "email": "[email protected]",
    "created_at": "2013-04-22T05:39:56Z",
    "updated_at": "2013-04-22T05:39:56Z"
  },
  "from_address": {
    "id": "adr_...",
    "object": "Address",
    "name": "EasyPost",
    "company": null,
    "street1": "417 Montgomery Street",
    "street2": "5th Floor",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94104",
    "country": "US",
    "phone": "4153334444",
    "email": "[email protected]",
    "mode": "test",
    "carrier_facility": null,
    "residential": null,
    "created_at": "2013-04-22T05:39:57Z",
    "updated_at": "2013-04-22T05:39:57Z"
  },
  "parcel": {
    "id": "prcl_...",
    "object": "Parcel",
    "length": 20.2,
    "width": 10.9,
    "height": 5.0,
    "predefined_package": null,
    "weight": 140.8,
    "created_at": "2013-04-22T05:39:57Z",
    "updated_at": "2013-04-22T05:39:57Z"
  },
  "customs_info": {
    "id": "cstinfo_...",
    "object": "CustomsInfo",
    "created_at": "2013-04-22T05:39:57Z",
    "updated_at": "2013-04-22T05:39:57Z",
    "contents_explanation": null,
    "contents_type": "merchandise",
    "customs_certify": false,
    "customs_signer": null,
    "eel_pfc": null,
    "non_delivery_option": "return",
    "restriction_comments": null,
    "restriction_type": "none",
    "customs_items": [
      {
        "id": "cstitem_...",
        "object": "CustomsItem",
        "description": "Many, many EasyPost stickers.",
        "hs_tariff_number": "123456",
        "origin_country": "US",
        "quantity": 1,
        "value": 879,
        "weight": 140,
        "created_at": "2013-04-22T05:39:57Z",
        "updated_at": "2013-04-22T05:39:57Z"
      }
    ]
  },
  "rates": [
    {
      "id": "rate_...",
      "object": "Rate",
      "carrier_account_id": "ca_...",
      "service": "FirstClassPackageInternationalService",
      "rate": "9.50",
      "carrier": "USPS",
      "shipment_id": "shp_...",
      "delivery_days": 4,
      "delivery_date": "2013-04-26T05:40:57Z",
      "delivery_date_guaranteed": false,
      "created_at": "2013-04-22T05:40:57Z",
      "updated_at": "2013-04-22T05:40:57Z"
    }, {
      "id": "rate_...",
      "object": "Rate",
      "carrier_account_id": "ca_...",
      "service": "PriorityMailInternational",
      "rate": "27.40",
      "carrier": "USPS",
      "shipment_id": "shp_...",
      "delivery_days": 2,
      "delivery_date": "2013-04-24T05:40:57Z",
      "delivery_date_guaranteed": false,
      "created_at": "2013-04-22T05:40:57Z",
      "updated_at": "2013-04-22T05:40:57Z"
    }, {
      "id": "rate_...",
      "object": "Rate",
      "carrier_account_id": "ca_...",
      "service": "ExpressMailInternational",
      "rate": "35.48",
      "carrier": "USPS",
      "shipment_id": "shp_...",
      "delivery_days": 1,
      "delivery_date": "2013-04-23T05:40:57Z",
      "delivery_date_guaranteed": true,
      "created_at": "2013-04-22T05:40:57Z",
      "updated_at": "2013-04-22T05:40:57Z"
    }
  ],
  "scan_form": null,
  "selected_rate": null,
  "postage_label": null,
  "tracking_code": null,
  "refund_status": null,
  "insurance": null,
  "created_at": "2013-04-22T05:40:57Z",
  "updated_at": "2013-04-22T05:40:57Z"
}

attribute	type	specification
carrier	string	the name of the carrier generating the error, e.g. "UPS"
type	string	the category of error that occurred. Most frequently "rate_error"
message	string	the string from the carrier explaining the problem
carrier_account_id	string	the account id of the carrier. Useful if you have multiple accounts with the same carrier

attribute	type	specification
percentile_50	integer	expected transit days at the 50th percentile
percentile_75	integer	expected transit days at the 75th percentile
percentile_85	integer	expected transit days at the 85th percentile
percentile_90	integer	expected transit days at the 90th percentile
percentile_95	integer	expected transit days at the 95th percentile
percentile_97	integer	expected transit days at the 97th percentile
percentile_99	integer	expected transit days at the 99th percentile

param	example
amount	200.00

param	example
is_return	true
to_address	the original Shipment's to_address
from_address	the original Shipment's from_address

attribute	type	specification
id	string	Unique identifier, begins with "trk_"
object	string	"Tracker"
mode	string	"test" or "production"
tracking_code	string	The tracking code provided by the carrier
status	string	The current status of the package, possible values are "unknown", "pre_transit", "in_transit", "out_for_delivery", "delivered", "available_for_pickup", "return_to_sender", "failure", "cancelled" or "error"
signed_by	string	The name of the person who signed for the package (if available)
weight	float	The weight of the package as measured by the carrier in ounces (if available)
est_delivery_date	datetime	The estimated delivery date provided by the carrier (if available)
shipment_id	string	The id of the EasyPost Shipment object associated with the Tracker (if any)
carrier	string	The name of the carrier handling the shipment
tracking_details	TrackingDetail array	Array of the associated TrackingDetail objects
carrier_detail	CarrierDetail	The associated CarrierDetail object (if available)
public_url	string	URL to a publicly-accessible html page that shows tracking details for this tracker
fees	Fee array	Array of the associated Fee objects
created_at	datetime
updated_at	datetime

attribute	type	specification
object	string	"TrackingDetail"
message	string	Description of the scan event
status	string	Status of the package at the time of the scan event, possible values are "unknown", "pre_transit", "in_transit", "out_for_delivery", "delivered", "available_for_pickup", "return_to_sender", "failure", "cancelled" or "error"
datetime	datetime	The timestamp when the tracking scan occurred
source	string	The original source of the information for this scan event, usually the carrier
tracking_location	TrackingLocation	The location associated with the scan event

attribute	type	specification
object	string	"TrackingLocation"
city	string	The city where the scan event occurred (if available)
state	string	The state where the scan event occurred (if available)
country	string	The country where the scan event occurred (if available)
zip	string	The postal code where the scan event occurred (if available)

attribute	type	specification
object	string	"CarrierDetail"
service	string	The service level the associated shipment was shipped with (if available)
container_type	string	The type of container the associated shipment was shipped in (if available)
est_delivery_date_local	date	The estimated delivery date as provided by the carrier, in the local time zone (if available)
est_delivery_time_local	time	The estimated delivery time as provided by the carrier, in the local time zone (if available)
origin_location	string	The location from which the package originated, stringified for presentation (if available)
origin_tracking_location	TrackingLocation	The location from which the package originated, broken down by city/state/country/zip (if available)
destination_location	string	The location to which the package is being sent, stringified for presentation (if available)
destination_tracking_location	TrackingLocation	The location to which the package is being sent, broken down by city/state/country/zip (if available)
guaranteed_delivery_date	datetime	The date and time the carrier guarantees the package to be delivered by (if available)
alternate_identifier	string	The alternate identifier for this package as provided by the carrier (if available)
initial_delivery_attempt	datetime	The date and time of the first attempt by the carrier to deliver the package (if available)

tracking_code	status
EZ1000000001	pre_transit
EZ2000000002	in_transit
EZ3000000003	out_for_delivery
EZ4000000004	delivered
EZ5000000005	return_to_sender
EZ6000000006	failure
EZ7000000007	unknown

Carrier	String Representation
AmazonMws	AmazonMws
APC	APC
Asendia	Asendia
Asendia USA	AsendiaUsa
Australia Post	AustraliaPost
AxlehireV3	AxlehireV3
Better Trucks	BetterTrucks
Bond	Bond
Cainiao	Cainiao
Canada Post	CanadaPost
Canpar	Canpar
CDL Last Mile Solutions	ColumbusLastMile
Chronopost	Chronopost
CloudSort	CloudSort
Courier Express	CourierExpress
CouriersPlease	CouriersPlease
Dai Post	DaiPost
Deutsche Post	DeutschePost
Deutsche Post UK	DeutschePostUK
DHL eCommerce Asia	DHLEcommerceAsia
DHL eCommerce Solutions	DhlEcs
DHL Express	DHLExpress
DPD	DPD
DPD UK	DPDUK
ePost Global	ePostGlobal
Estafeta	Estafeta
Fastway	Fastway
FedEx	FedEx
FedEx Cross Border	FedExCrossBorder
FedEx Mailview	FedExMailview
FedEx SameDay City	FedExSameDayCity
FedEx SmartPost	FedexSmartPost
FirstMile	FirstMile
Globegistics	Globegistics
GSO	GSO
Hermes	Hermes
Interlink Express	InterlinkExpress
JP Post	JPPost
Kuroneko Yamato	KuronekoYamato
La Poste	LaPoste
LaserShip	LaserShipV2
Loomis Express	LoomisExpress
LSO	LSO
Newgistics	Newgistics
OnTrac	OnTrac
Osm Worldwide	OsmWorldwide
Parcelforce	Parcelforce
Passport	PassportGlobal
PCF Final Mile	PcfFinalMile
PostNL	PostNL
Purolator	Purolator
Royal Mail	RoyalMail
SEKO OmniParcel	OmniParcel
SF Express	SFExpress
Spee-Dee	SpeeDee
StarTrack	StarTrack
TForce	TForce
UDS	UDS
UPS	UPS
UPS i-parcel	UPSIparcel
UPS Mail Innovations	UPSMailInnovations
USPS	USPS
Veho	Veho
Yanwen	Yanwen

param	example	info
tracking_code	9400110898825022579493	The tracking code associated with the package you'd like to track
carrier	USPS	The carrier associated with the tracking_code you provided. The carrier will get auto-detected if none is provided

param	example	info
before_id	trk_...	Optional pagination parameter. Only trackers created before the given ID will be included. May not be used with after_id
after_id	trk_...	Optional pagination parameter. Only trackers created after the given ID will be included. May not be used with before_id
start_datetime	2016-01-02T00:00:00Z	Only return Trackers created after this timestamp. Defaults to 1 month ago, or 1 month before a passed end_datetime
end_datetime	2016-01-02T00:00:00Z	Only return Trackers created before this timestamp. Defaults to end of the current day, or 1 month after a passed start_datetime
page_size	30	The number of Trackers to return on each page. The maximum value is 100
tracking_code	9400110898825022579493	Only returns Trackers with the given tracking_code. Useful for retrieving an individual Tracker by tracking_code rather than by ID
carrier	USPS	Only returns Trackers with the given carrier value

param	example	info
id	trk_...	Unique, starts with "trk_"

attribute	type	specification
id	string	Unique, begins with "batch_"
reference	string	An optional field that may be used in place of ID in some API endpoints
object	string	"Batch"
mode	string	"test" or "production"
state	string	The overall state. Possible values are "creating", "creation_failed", "created", "purchasing", "purchase_failed", "purchased", "label_generating", and "label_generated"
num_shipments	integer	The number of shipments added
shipments	BatchShipment array
status	object	A map of BatchShipment statuses to the count of BatchShipments with that status. Valid statuses are "postage_purchased", "postage_purchase_failed", "queued_for_purchase", and "creation_failed"
label_url	string	The label image url
scan_form	ScanForm	The created ScanForm
pickup	Pickup	The created Pickup
created_at	datetime
updated_at	datetime

attribute	type	specification
id	string	The id of the Shipment. Unique, begins with "shp_"
reference	string	An optional field that may be used in place of ID in some API endpoints
batch_status	string	The current status. Possible values are "postage_purchased", "postage_purchase_failed", "queued_for_purchase", and "creation_failed"
batch_message	string	A human readable message for any errors that occurred during the Batch's life cycle

param	example
shipments	[<Shipment>,<Shipment>,...]

param	example
shipments	[<Shipment>,<Shipment>,...]

param	example
file_format	ZPL

attribute	type	specification
id	string	Unique, begins with 'cstinfo_'
object	string	'CustomsInfo'
eel_pfc	string	"EEL" or "PFC" value less than $2500: "NOEEI 30.37(a)"; value greater than $2500: see Customs Guide
contents_type	string	"documents", "gift", "merchandise", "returned_goods", "sample", or "other"
contents_explanation	string	(max 255 characters) Human readable description of content. Required for certain carriers and always required if contents_type is "other"
customs_certify	boolean	Electronically certify the information provided
customs_signer	string	Required if customs_certify is true
non_delivery_option	string	"abandon" or "return", defaults to "return"
restriction_type	string	"none", "other", "quarantine", or "sanitary_phytosanitary_inspection"
restriction_comments	string	Required if restriction_type is not "none"
customs_items	CustomItem array	Describes to products being shipped
created_at	datetime
updated_at	datetime

param	example
customs_certify	true
customs_signer	"Steve Brule"
contents_type	"merchandise"
restriction_type	"none"
eel_pfc	"NOEEI 30.37(a)"
customs_items	[<CustomsItem>,<CustomsItem>,...]

attribute	type	specification
id	string	Unique, begins with 'cstitem_'
object	string	'CustomsItem'
description	string	Required, description of item being shipped
quantity	float	Required, greater than zero
value	float (USD)	Required, greater than zero, total value (unit value * quantity)
weight	float (oz)	Required, greater than zero, total weight (unit weight * quantity)
hs_tariff_number	string	Harmonized Tariff Schedule, e.g. "6109.10.0012" for Men's T-shirts
code	string	SKU/UPC or other product identifier
origin_country	string	Required, 2 char country code
currency	string	3 char currency code, default USD
created_at	datetime
updated_at	datetime

param	example
description	"T-Shirt"
quantity	1
weight	5
value	10
hs_tariff_number	"123456"
origin_country	"US"

attribute	type	specification
object	string	"Event"
id	string	Unique identifier, begins with "evt_"
mode	string	"test" or "production"
description	string	Result type and event name, see the "Possible Event Types" section for more information
previous_attributes	object	Previous values of relevant result attributes
result	object	The object associated with the Event. See the "object" attribute on the result to determine its specific type. This field will not be returned when retrieving events directly from the API
status	string	The current status of the event. Possible values are "completed", "failed", "in_queue", "retrying", or "pending" (deprecated)
pending_urls	string array	Webhook URLs that have not yet been successfully notified as of the time this webhook event was sent. The URL receiving the Event will still be listed in pending_urls, as will any other URLs that receive the Event at the same time
completed_urls	string array	Webhook URLs that have already been successfully notified as of the time this webhook was sent
created_at	datetime
updated_at	datetime

attribute	type	specification
object	string	"Fee"
type	string	The name of the category of fee. Possible types are "LabelFee", "PostageFee", "InsuranceFee", and "TrackerFee"
amount	string	USD value with sub-cent precision
charged	boolean	Whether EasyPost has successfully charged your account for the fee
refunded	boolean	Whether the Fee has been refunded successfully

attribute	type	specification
id	string	Unique, begins with "order_"
object	string	"Order"
reference	string	An optional field that may be used in place of id in other API endpoints
mode	string	"test" or "production"
to_address	Address	The destination address
from_address	Address	The origin address
return_address	Address	The shipper's address, defaults to from_address
buyer_address	Address	The buyer's address, defaults to to_address
shipments	Shipment array	All associated Shipment objects. Maximum of 100.
rates	Rate array	All associated Rate objects
messages	Message array	Any carrier errors encountered during rating
is_return	boolean	Set `true` to create as a return
created_at	datetime
updated_at	datetime

param	example	info
reference	"my-reference"
to_address	<Address>	Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
from_address	<Address>	Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
shipments	[<Shipment>, <Shipment>, ...]
carrier_accounts	[{"id": "ca_..."}, ...]

GET /orders/:id

Retrieve an Order

An Order can be retrieved by either its id or reference. However it is recommended to use EasyPost's provided identifiers because uniqueness on reference is not enforced.

Retrieve Order Example

cURL Ruby Python PHP Java C-Sharp Node.js

curl -X GET https://api.easypost.com/v2/orders/order_... \
  -u <YOUR_TEST/PRODUCTION_API_KEY>:

{
  "id": "order_...",
  "mode": "test",
  "reference": null,
  "is_return": false,
  "options": {"currency": "USD","label_date": null},
  "messages": [],
  "created_at": "2016-02-17T02:51:04Z",
  "updated_at": "2016-02-17T02:51:04Z",
  "customs_info": null,
  "to_address": {
    "id": "adr_...",
    "object": "Address",
    "name": "Dr. Steve Brule",
    "company": null,
    "street1": "179 N Harbor Dr",
    "street2": null,
    "city": "Redondo Beach",
    "state": "CA",
    "zip": "90277",
    "country": "US",
    "phone": "4153334444",
    "mode": "test",
    "carrier_facility": null,
    "residential": null,
    "email": "[email protected]",
    "created_at": "2013-04-22T05:39:56Z",
    "updated_at": "2013-04-22T05:39:56Z"
  },
  "from_address": {
    "id": "adr_...",
    "object": "Address",
    "name": "EasyPost",
    "company": null,
    "street1": "417 Montgomery Street",
    "street2": null,
    "city": "San Francisco",
    "state": "CA",
    "zip": "94104",
    "country": "US",
    "phone": "4153334444",
    "email": "[email protected]",
    "mode": "test",
    "carrier_facility": null,
    "residential": null,
    "created_at": "2013-04-22T05:39:57Z",
    "updated_at": "2013-04-22T05:39:57Z"
  },
  "buyer_address": {
    "id": "adr_...",
    "object": "Address",
    "name": "Dr. Steve Brule",
    "company": null,
    "street1": "179 N Harbor Dr",
    "street2": null,
    "city": "Redondo Beach",
    "state": "CA",
    "zip": "90277",
    "country": "US",
    "phone": "4153334444",
    "mode": "test",
    "carrier_facility": null,
    "residential": null,
    "email": "[email protected]",
    "created_at": "2013-04-22T05:39:56Z",
    "updated_at": "2013-04-22T05:39:56Z"
  },
  "return_address": {
    "id": "adr_...",
    "object": "Address",
    "name": "EasyPost",
    "company": null,
    "street1": "417 Montgomery Street",
    "street2": null,
    "city": "San Francisco",
    "state": "CA",
    "zip": "94104",
    "country": "US",
    "phone": "4153334444",
    "email": "[email protected]",
    "mode": "test",
    "carrier_facility": null,
    "residential": null,
    "created_at": "2013-04-22T05:39:57Z",
    "updated_at": "2013-04-22T05:39:57Z"
  },
  "shipments": [
    {
      "id": "shp_...",
      "created_at": "2016-02-17T02:51:04Z",
      "updated_at": "2016-02-17T02:51:10Z",
      "is_return": false,
      "messages": [],
      "mode": "test",
      "options": {"currency": "USD", "label_date": null},
      "reference": null,
      "status": "unknown",
      "tracking_code": null,
      "batch_id": null,
      "batch_status": null,
      "batch_message": null,
      "parcel": {
        "id": "prcl_...",
        "object": "Parcel",
        "length": 20.2,
        "width": 10.9,
        "height": 5.0,
        "predefined_package": null,
        "weight": 17.5,
        "created_at": "2013-04-22T05:39:57Z",
        "updated_at": "2013-04-22T05:39:57Z"
      },
      "customs_info": null,
      "to_address": {
        "id": "adr_...",
        "object": "Address",
        "name": "Dr. Steve Brule",
        "company": null,
        "street1": "179 N Harbor Dr",
        "street2": null,
        "city": "Redondo Beach",
        "state": "CA",
        "zip": "90277",
        "country": "US",
        "phone": "4153334444",
        "mode": "test",
        "carrier_facility": null,
        "residential": null,
        "email": "[email protected]",
        "created_at": "2013-04-22T05:39:56Z",
        "updated_at": "2013-04-22T05:39:56Z"
      },
      "from_address": {
        "id": "adr_...",
        "object": "Address",
        "name": "EasyPost",
        "company": null,
        "street1": "417 Montgomery Street",
        "street2": null,
        "city": "San Francisco",
        "state": "CA",
        "zip": "94104",
        "country": "US",
        "phone": "4153334444",
        "email": "[email protected]",
        "mode": "test",
        "carrier_facility": null,
        "residential": null,
        "created_at": "2013-04-22T05:39:57Z",
        "updated_at": "2013-04-22T05:39:57Z"
      },
      "buyer_address": {
        "id": "adr_...",
        "object": "Address",
        "name": "Dr. Steve Brule",
        "company": null,
        "street1": "179 N Harbor Dr",
        "street2": null,
        "city": "Redondo Beach",
        "state": "CA",
        "zip": "90277",
        "country": "US",
        "phone": "4153334444",
        "mode": "test",
        "carrier_facility": null,
        "residential": null,
        "email": "[email protected]",
        "created_at": "2013-04-22T05:39:56Z",
        "updated_at": "2013-04-22T05:39:56Z"
      },
      "return_address": {
        "id": "adr_...",
        "object": "Address",
        "name": "EasyPost",
        "company": null,
        "street1": "417 Montgomery Street",
        "street2": null,
        "city": "San Francisco",
        "state": "CA",
        "zip": "94104",
        "country": "US",
        "phone": "4153334444",
        "email": "[email protected]",
        "mode": "test",
        "carrier_facility": null,
        "residential": null,
        "created_at": "2013-04-22T05:39:57Z",
        "updated_at": "2013-04-22T05:39:57Z"
      },
      "postage_label": null,
      "rates": [
        {
          "id": "rate_...",
          "object": "Rate",
          "created_at": null,
          "updated_at": null,
          "mode": "test",
          "service": "PRIORITY_OVERNIGHT",
          "carrier": "FedEx",
          "rate": "47.36",
          "currency": "USD",
          "retail_rate": null,
          "retail_currency": null,
          "list_rate": null,
          "list_currency": null,
          "delivery_days": 1,
          "delivery_date": "2016-02-18T10:30:00Z",
          "delivery_date_guaranteed": true,
          "est_delivery_days": null,
          "shipment_id": "shp_...",
          "carrier_account_id": "ca_..."
        },
        {
          "id": "rate_...",
          "object": "Rate",
          "created_at": null,
          "updated_at": null,
          "mode": "test",
          "service": "STANDARD_OVERNIGHT",
          "carrier": "FedEx",
          "rate": "118.00",
          "currency": "USD",
          "retail_rate": null,
          "retail_currency": null,
          "list_rate": null,
          "list_currency": null,
          "delivery_days": 1,
          "delivery_date": "2016-02-18T15:00:00Z",
          "delivery_date_guaranteed": true,
          "est_delivery_days": null,
          "shipment_id": "shp_...",
          "carrier_account_id": "ca_..."
        },
        {
          "id": "rate_...",
          "object": "Rate",
          "created_at": null,
          "updated_at": null,
          "mode": "test",
          "service": "FEDEX_GROUND",
          "carrier": "FedEx",
          "rate": "17.96",
          "currency": "USD",
          "retail_rate": null,
          "retail_currency": null,
          "list_rate": null,
          "list_currency": null,
          "delivery_days": 4,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": null,
          "shipment_id": "shp_...",
          "carrier_account_id": "ca_..."
        },
      ],
      "refund_status": null,
      "scan_form": null,
      "selected_rate": null,
      "tracker": null,
      "forms": [],
      "fees": [],
      "object": "Shipment"
    },
    {
      "id": "shp_...",
      "created_at": "2016-02-17T02:51:04Z",
      "updated_at": "2016-02-17T02:51:10Z",
      "is_return": false,
      "messages": [],
      "mode": "test",
      "options": {"currency": "USD", "label_date": null},
      "reference": null,
      "status": "unknown",
      "tracking_code": null,
      "batch_id": null,
      "batch_status": null,
      "batch_message": null,
      "parcel": {
        "id": "prcl_...",
        "object": "Parcel",
        "length": 7.2,
        "width": 1.9,
        "height": 1.0,
        "predefined_package": null,
        "weight": 10.8,
        "created_at": "2013-04-22T05:39:57Z",
        "updated_at": "2013-04-22T05:39:57Z"
      },
      "customs_info": null,
      "to_address": {
        "id": "adr_...",
        "object": "Address",
        "name": "Dr. Steve Brule",
        "company": null,
        "street1": "179 N Harbor Dr",
        "street2": null,
        "city": "Redondo Beach",
        "state": "CA",
        "zip": "90277",
        "country": "US",
        "phone": "4153334444",
        "mode": "test",
        "carrier_facility": null,
        "residential": null,
        "email": "[email protected]",
        "created_at": "2013-04-22T05:39:56Z",
        "updated_at": "2013-04-22T05:39:56Z"
      },
      "from_address": {
        "id": "adr_...",
        "object": "Address",
        "name": "EasyPost",
        "company": null,
        "street1": "417 Montgomery Street",
        "street2": null,
        "city": "San Francisco",
        "state": "CA",
        "zip": "94104",
        "country": "US",
        "phone": "4153334444",
        "email": "[email protected]",
        "mode": "test",
        "carrier_facility": null,
        "residential": null,
        "created_at": "2013-04-22T05:39:57Z",
        "updated_at": "2013-04-22T05:39:57Z"
      },
      "buyer_address": {
        "id": "adr_...",
        "object": "Address",
        "name": "Dr. Steve Brule",
        "company": null,
        "street1": "179 N Harbor Dr",
        "street2": null,
        "city": "Redondo Beach",
        "state": "CA",
        "zip": "90277",
        "country": "US",
        "phone": "4153334444",
        "mode": "test",
        "carrier_facility": null,
        "residential": null,
        "email": "[email protected]",
        "created_at": "2013-04-22T05:39:56Z",
        "updated_at": "2013-04-22T05:39:56Z"
      },
      "return_address": {
        "id": "adr_...",
        "object": "Address",
        "name": "EasyPost",
        "company": null,
        "street1": "417 Montgomery Street",
        "street2": null,
        "city": "San Francisco",
        "state": "CA",
        "zip": "94104",
        "country": "US",
        "phone": "4153334444",
        "email": "[email protected]",
        "mode": "test",
        "carrier_facility": null,
        "residential": null,
        "created_at": "2013-04-22T05:39:57Z",
        "updated_at": "2013-04-22T05:39:57Z"
      },
      "postage_label": null,
      "rates": [],
      "refund_status": null,
      "scan_form": null,
      "selected_rate": null,
      "tracker": null,
      "forms": [],
      "fees": [],
      "object": "Shipment"
    },
  ],
  "rates": [
    {
      "id": "rate_...",
      "object": "Rate",
      "created_at": null,
      "updated_at": null,
      "mode": "test",
      "service": "PRIORITY_OVERNIGHT",
      "carrier": "FedEx",
      "rate": "47.36",
      "currency": "USD",
      "retail_rate": null,
      "retail_currency": null,
      "list_rate": null,
      "list_currency": null,
      "delivery_days": 1,
      "delivery_date": "2016-02-18T10:30:00Z",
      "delivery_date_guaranteed": true,
      "est_delivery_days": null,
      "shipment_id": "shp_...",
      "carrier_account_id": "ca_..."
    },
    {
      "id": "rate_...",
      "object": "Rate",
      "created_at": null,
      "updated_at": null,
      "mode": "test",
      "service": "STANDARD_OVERNIGHT",
      "carrier": "FedEx",
      "rate": "118.00",
      "currency": "USD",
      "retail_rate": null,
      "retail_currency": null,
      "list_rate": null,
      "list_currency": null,
      "delivery_days": 1,
      "delivery_date": "2016-02-18T15:00:00Z",
      "delivery_date_guaranteed": true,
      "est_delivery_days": null,
      "shipment_id": "shp_...",
      "carrier_account_id": "ca_..."
    },
    {
      "id": "rate_...",
      "object": "Rate",
      "created_at": null,
      "updated_at": null,
      "mode": "test",
      "service": "FEDEX_GROUND",
      "carrier": "FedEx",
      "rate": "17.96",
      "currency": "USD",
      "retail_rate": null,
      "retail_currency": null,
      "list_rate": null,
      "list_currency": null,
      "delivery_days": 4,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": null,
      "shipment_id": "shp_...",
      "carrier_account_id": "ca_..."
    },
  ],
  "object": "Order"
}

Authentication

EasyPost Objects

Errors

Error Object

FieldError Object

Common HTTP Status Codes

Addresses

Address Object

Verifications Object

Verification Object

VerificationDetails Object

Address Verification by Country

Create and Verify Addresses

Verify an Address

Create Address Request Parameters

Create Address Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve an Address

Retrieve Address Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Parcels

Parcel Object

Predefined Packages

Create a Parcel

Create Parcel Request Parameters

Create Parcel Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve a Parcel

Retrieve Parcel Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Insurances

Insurance Object

Create an Insurance

Create Insurance Request Parameters

Create Insurance Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve a list of Insurances

Retrieve a list of Insurances Request Parameters

Retrieve a list of Insurance Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve an Insurance

Retrieve Insurance Request Parameters

Retrieve Insurance Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Shipments

Shipment Object

Form Object

Create a Shipment

Create Shipment Request Parameters

Create Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve a list of Shipments

Retrieve a list of Shipment Request Parameters

Retrieve a list of Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve a Shipment

Retrieve Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Buy a Shipment

Buy Shipment Request Parameters

Buy Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Buy a Shipment without rating (One-Call Buy)

One-Call Buy Shipment Request Parameters

One-Call Buy Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Convert the Label format of a Shipment

Label Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Options

Options Object

FedEx

FedEx

UPS

Create a Shipment with Options

Create Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Rates

Rate Object

Service Levels

Regenerate Rates for a Shipment

Regenerate Rates for Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Messages

Message Object

SmartRate

Time in Transit Object

Retrieve Time in Transit statistics across all Rates for a Shipment

Retrieve Time in Transit statistics across all Rates for Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Shipping Insurance

Insure a Shipment

Insure Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Refunds

Refund a Shipment

Refund Shipment Example cURL cURL Ruby Python PHP Java C-Sharp Node.js

Create Address Example

cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve Address Example

cURL Ruby Python PHP Java C-Sharp Node.js

Create Parcel Example

cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve Parcel Example

cURL Ruby Python PHP Java C-Sharp Node.js

Create Insurance Example

cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve a list of Insurance Example

cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve Insurance Example

cURL Ruby Python PHP Java C-Sharp Node.js

Create Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve a list of Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Buy Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

One-Call Buy Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Label Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Create Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Regenerate Rates for Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve Time in Transit statistics across all Rates for Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Insure Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Refund Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Create Return for Shipment Example

cURL Ruby Python PHP Java C-Sharp Node.js

Create Tracker Example

cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve a list of Tracker Example

cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve a Tracker Example

cURL Ruby Python PHP Java C-Sharp Node.js

Create Batch Example

cURL Ruby Python PHP Java C-Sharp Node.js

Add Shipments to Batch Example

cURL Ruby Python PHP Java C-Sharp Node.js

Remove Shipments from Batch Example

cURL Ruby Python PHP Java C-Sharp Node.js

Buy Batch Example

cURL Ruby Python PHP Java C-Sharp Node.js

Generate Label for Batch Example

cURL Ruby Python PHP Java C-Sharp Node.js

Generate Manifest for Batch Example

cURL Ruby Python PHP Java C-Sharp Node.js

Create CustomsInfo Example

cURL Ruby Python PHP Java C-Sharp Node.js

Create CustomsItem Example

cURL Ruby Python PHP Java C-Sharp Node.js

Create Order Example

cURL Ruby Python PHP Java C-Sharp Node.js

Retrieve Order Example

cURL Ruby Python PHP Java C-Sharp Node.js

Buy Order Example

cURL Ruby Python PHP Java C-Sharp Node.js