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

POST/addresses

Create and Verify Addresses

Depending on your use case an Address can be used in many different ways. Certain carriers allow rating between two zip codes, but full addresses are required to purchase postage. It is recommended to provide as much information as possible during creation and to reuse these objects whenever possible.

Address objects can also be created inline while creating another object, for example during Shipment Creation.

Verify an Address

Verifying an Address before you ship is a great way to reduce issues with delivery.

Creating a verified Address is as simple as providing verify or verify_strict in the parameters. If any of the strict verification checks fail, an error will be returned from the API. The example below demonstrates verifying delivery, which checks that the address is deliverable and sets its residential delivery indicator.

The most effective time to perform address verification is when your customer, or the person entering the delivery address, is present. When designing a shopping cart it is recommended to ask the shopper for their address and verify it on the spot. If verification fails, ask them to double check their input; if they confirm that their data is correct, assume they know their address more correctly than the verification process.

Request Parameters

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	example@example.com	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	true	Include to perform verifications on delivery and zip code. verify_strict takes precedence if also included.
verify_strict	true	Include to perform strict verifications on delivery and zip code. The failure of any of these verifications causes the whole request to fail.

Example

curl -X POST https://api.easypost.com/v2/addresses \
  -u "$EASYPOST_API_KEY": \
  -H 'Content-Type: application/json' \
  -d '{
    "address": {
      "street1": "417 MONTGOMERY ST",
      "street2": "FLOOR 5",
      "city": "SAN FRANCISCO",
      "state": "CA",
      "zip": "94104",
      "country": "US",
      "company": "EasyPost",
      "phone": "415-123-4567"
    }
  }'

{
  "id": "adr_5dacbea44e3f11ed90f5ac1f6bc72124",
  "object": "Address",
  "created_at": "2022-10-17T17:15:57+00:00",
  "updated_at": "2022-10-17T17:15:57+00:00",
  "name": null,
  "company": "EasyPost",
  "street1": "417 MONTGOMERY ST",
  "street2": "FLOOR 5",
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104",
  "country": "US",
  "phone": "4151234567",
  "email": null,
  "mode": "test",
  "carrier_facility": null,
  "residential": null,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {}
}

curl -X POST https://api.easypost.com/v2/addresses/create_and_verify \
  -u "$EASYPOST_API_KEY": \
  -H 'Content-Type: application/json' \
  -d '{
    "address": {
      "street1": "417 Montgomery Street",
      "street2": "FL 5",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94104",
      "country": "US",
      "company": "EasyPost",
      "phone": "415-123-4567"
    }
  }'

{
  "address": {
    "id": "adr_5e891acf4e3f11edb1a1ac1f6bc7bdc6",
    "object": "Address",
    "created_at": "2022-10-17T17:15:59+00:00",
    "updated_at": "2022-10-17T17:15:59+00:00",
    "name": null,
    "company": "EASYPOST",
    "street1": "417 MONTGOMERY ST FL 5",
    "street2": "",
    "city": "SAN FRANCISCO",
    "state": "CA",
    "zip": "94104-1129",
    "country": "US",
    "phone": "4151234567",
    "email": null,
    "mode": "test",
    "carrier_facility": null,
    "residential": false,
    "federal_tax_id": null,
    "state_tax_id": null,
    "verifications": {
      "zip4": {
        "success": true,
        "errors": [
          {
            "code": "E.SECONDARY_INFORMATION.INVALID",
            "field": "street2",
            "message": "Invalid secondary information(Apt/Suite#)",
            "suggestion": null
          }
        ],
        "details": null
      },
      "delivery": {
        "success": true,
        "errors": [
          {
            "code": "E.SECONDARY_INFORMATION.INVALID",
            "field": "street2",
            "message": "Invalid secondary information(Apt/Suite#)",
            "suggestion": null
          }
        ],
        "details": {
          "latitude": 37.79342,
          "longitude": -122.40288,
          "time_zone": "America/Los_Angeles"
        }
      }
    }
  }
}

curl -X POST https://api.easypost.com/v2/addresses \
  -u "$EASYPOST_API_KEY": \
  -H 'Content-Type: application/json' \
  -d '{
    "address": {
      "street1": "417 MONTGOMERY ST",
      "street2": "FLOOR 5",
      "city": "SAN FRANCISCO",
      "state": "CA",
      "zip": "94104",
      "country": "US",
      "company": "EasyPost",
      "phone": "415-123-4567"
    },
    "verify": true
  }'

{
  "id": "adr_5eed63904e3f11eda352ac1f6bc7b362",
  "object": "Address",
  "created_at": "2022-10-17T17:16:00+00:00",
  "updated_at": "2022-10-17T17:16:00+00:00",
  "name": null,
  "company": "EASYPOST",
  "street1": "417 MONTGOMERY ST FL 5",
  "street2": "",
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104-1129",
  "country": "US",
  "phone": "4151234567",
  "email": null,
  "mode": "test",
  "carrier_facility": null,
  "residential": false,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {
    "zip4": {
      "success": true,
      "errors": [
        {
          "code": "E.SECONDARY_INFORMATION.INVALID",
          "field": "street2",
          "message": "Invalid secondary information(Apt/Suite#)",
          "suggestion": null
        }
      ],
      "details": null
    },
    "delivery": {
      "success": true,
      "errors": [
        {
          "code": "E.SECONDARY_INFORMATION.INVALID",
          "field": "street2",
          "message": "Invalid secondary information(Apt/Suite#)",
          "suggestion": null
        }
      ],
      "details": {
        "latitude": 37.79342,
        "longitude": -122.40288,
        "time_zone": "America/Los_Angeles"
      }
    }
  }
}

curl -X POST https://api.easypost.com/v2/addresses \
  -u "$EASYPOST_API_KEY": \
  -H 'Content-Type: application/json' \
  -d '{
    "address": {
      "street1": "UNDELIVERABLE ST",
      "city": "SAN FRANCISCO",
      "state": "CA",
      "zip": "94104",
      "country": "US",
      "company": "EasyPost",
      "phone": "415-123-4567"
    }
  }'

{
  "id": "adr_20a96bfd554911ed9551ac1f6bc72124",
  "object": "Address",
  "created_at": "2022-10-26T16:13:28+00:00",
  "updated_at": "2022-10-26T16:13:28+00:00",
  "name": null,
  "company": "EasyPost",
  "street1": "UNDELIVERABLE ST",
  "street2": null,
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104",
  "country": "US",
  "phone": "4151234567",
  "email": null,
  "mode": "test",
  "carrier_facility": null,
  "residential": null,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {
    "zip4": {
      "success": false,
      "errors": [
        {
          "code": "E.ADDRESS.NOT_FOUND",
          "field": "address",
          "message": "Address not found",
          "suggestion": null
        },
        {
          "code": "E.HOUSE_NUMBER.MISSING",
          "field": "street1",
          "message": "House number is missing",
          "suggestion": null
        }
      ],
      "details": null
    },
    "delivery": {
      "success": false,
      "errors": [
        {
          "code": "E.ADDRESS.NOT_FOUND",
          "field": "address",
          "message": "Address not found",
          "suggestion": null
        },
        {
          "code": "E.HOUSE_NUMBER.MISSING",
          "field": "street1",
          "message": "House number is missing",
          "suggestion": null
        }
      ],
      "details": {}
    }
  }
}

curl -X POST https://api.easypost.com/v2/addresses \
  -u "$EASYPOST_API_KEY": \
  -H 'Content-Type: application/json' \
  -d '{
    "address": {
      "street1": "417 MONTGOMERY ST",
      "street2": "FLOOR 5",
      "city": "SAN FRANCISCO",
      "state": "CA",
      "zip": "94104",
      "country": "US",
      "company": "EasyPost",
      "phone": "415-123-4567"
    },
    "verify_strict": true
  }'

{
  "id": "adr_5f4e008e4e3f11eda36cac1f6bc7b362",
  "object": "Address",
  "created_at": "2022-10-17T17:16:00+00:00",
  "updated_at": "2022-10-17T17:16:00+00:00",
  "name": null,
  "company": "EASYPOST",
  "street1": "417 MONTGOMERY ST FL 5",
  "street2": "",
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104-1129",
  "country": "US",
  "phone": "4151234567",
  "email": null,
  "mode": "test",
  "carrier_facility": null,
  "residential": false,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {
    "zip4": {
      "success": true,
      "errors": [
        {
          "code": "E.SECONDARY_INFORMATION.INVALID",
          "field": "street2",
          "message": "Invalid secondary information(Apt/Suite#)",
          "suggestion": null
        }
      ],
      "details": null
    },
    "delivery": {
      "success": true,
      "errors": [
        {
          "code": "E.SECONDARY_INFORMATION.INVALID",
          "field": "street2",
          "message": "Invalid secondary information(Apt/Suite#)",
          "suggestion": null
        }
      ],
      "details": {
        "latitude": 37.79342,
        "longitude": -122.40288,
        "time_zone": "America/Los_Angeles"
      }
    }
  }
}

curl -X GET https://api.easypost.com/v2/addresses/adr_.../verify \
  -u "$EASYPOST_API_KEY":

{
  "address": {
    "id": "adr_5fdd21764e3f11edadebac1f6b0a0d1e",
    "object": "Address",
    "created_at": "2022-10-17T17:16:01+00:00",
    "updated_at": "2022-10-17T17:16:01+00:00",
    "name": null,
    "company": "EASYPOST",
    "street1": "417 MONTGOMERY ST FL 5",
    "street2": "",
    "city": "SAN FRANCISCO",
    "state": "CA",
    "zip": "94104-1129",
    "country": "US",
    "phone": "4151234567",
    "email": null,
    "mode": "test",
    "carrier_facility": null,
    "residential": false,
    "federal_tax_id": null,
    "state_tax_id": null,
    "verifications": {
      "zip4": {
        "success": true,
        "errors": [
          {
            "code": "E.SECONDARY_INFORMATION.INVALID",
            "field": "street2",
            "message": "Invalid secondary information(Apt/Suite#)",
            "suggestion": null
          }
        ],
        "details": null
      },
      "delivery": {
        "success": true,
        "errors": [
          {
            "code": "E.SECONDARY_INFORMATION.INVALID",
            "field": "street2",
            "message": "Invalid secondary information(Apt/Suite#)",
            "suggestion": null
          }
        ],
        "details": {
          "latitude": 37.79342,
          "longitude": -122.40288,
          "time_zone": "America/Los_Angeles"
        }
      }
    }
  }
}

param	example	info
page_size	30	The number of records to return on each page. The maximum value is 100, and default is 20.

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 width and/or height are present
height	float(inches)	Required if width and/or height 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 destination of the package to be insured.
from_address	Address	The 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	string	The associated Insurance amount
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 status of the shipment, possible values are "unknown", "pre_transit", "in_transit", "out_for_delivery", "delivered", "available_for_pickup", "return_to_sender", "failure", "cancelled" or "error"
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 status 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

attribute	type	specification
id	string	Unique, begins with "pl_"
object	string	"PostageLabel"
label_date	datetime	The date that appears on the postage label
label_epl2_url	string	The URL of the EPL2 label file
label_file_type	string	File type of the label
label_pdf_url	string	The URL of the PDF label file
label_resolution	integer	The resolution of the label
label_size	string	The size of the label
label_type	string	The type of the label
label_url	string	The URL of the label file
label_zpl_url	string	The URL of the ZPL label file
created_at	datetime
updated_at	datetime

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"

attribute	type	specification
grams	integer	the estimated amount of carbon grams emitted by the shipment
price	string	price to offset the amount of carbon grams
currency	string	currency of the price (currently always USD)
object	string	"CarbonOffset"

param	example	info
carbon_offset	true	Whether you want to buy a shipment with carbon offset.

param	example	info
carbon_offset	true	Whether you want to buy a shipment with carbon offset.

param	example	info
carbon_offset	true	Whether you want to buy a shipment with carbon offset.

attribute	type	specification
id	string	Unique, begins with "form_"
object	string	"Form"
mode	string	"test" or "production"
form_type	string	The type of form, can be one of "cn22", "cod_return_label", "commercial_invoice", "high_value_report", "label_qr_code", "nafta_certificate_of_origin", "order_summary", "return_packing_slip", "rma_qr_code"
form_url	string	The URL that a form can be downloaded from
submitted_electronically	boolean	If we have submitted the form to the carrier on behalf of the user
created_at	datetime	When the form was created
updated_at	datetime	When the form was updated

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 by Carriers who support this option. Alternatively, see Carbon Offset which is provided by EasyPost and works with all Carriers.
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.
content_description	string	A description of the content of the shipment.
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. "NO_SIGNATURE" is equivalent to releasing liability. Some options may be limited for international shipments. Carrier specific delivery confirmation options are listed below: FedEx - "INDIRECT_SIGNATURE" - Requires the signature of someone at the delivery address or from somebody nearby, such as a neighbor. USPS - additional options ADULT_SIGNATURE_RESTRICTED" - Requires the signature of the addressee only, who must be 21 years of age or older. SIGNATURE_RESTRICTED" - Requires the signature of the recipient or a responsible party. Canada Post - "DO_NOT_SAFE_DROP" - Tells the carrier to not hide the package ("safe drop"). GSO - "STANDARD_SIGNATURE". DHL Express - option mapping SIGNATURE" - DHL Express Direct Signature NO_SIGNATURE" - DHL Express Signature Release
delivery_min_datetime	string	The earliest a package should be delivered. Supported carriers vary.
delivery_max_datetime	string	The latest a package should be delivered. Supported carriers vary.
dropoff_type	string	Method the customer will use to transfer the package to the carrier. Supported dropoff types and their corresponding carrier dropoff codes are below: FedEx REGULAR_PICKUP" - Customer to transfer package during regular pickup (default) SCHEDULED_PICKUP" - Customer to transfer package during scheduled pickup RETAIL_LOCATION" - Customer to transfer package at FedEx retail location STATION" - "STATION DROP_BOX" - Customer to use carrier drop box for package transfer
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	boolean	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
duty_payment	object	Setting duty_payment type to bill the correct account for purchasing postage. This option is only available with FedEx and UPS. type - (string) Supported values are "THIRD_PARTY", and "RECEIVER". account - (string) Setting account number. country - (string) Setting country code that the account is based in. postal_code - (string) Setting postal code that the account is based in.
endorsement	string	Possible values "ADDRESS_SERVICE_REQUESTED", "FORWARDING_SERVICE_REQUESTED", "CHANGE_SERVICE_REQUESTED", "RETURN_SERVICE_REQUESTED", "LEAVE_IF_NO_RESPONSE"
end_shipper_id	string	Specify the responsible EndShipper for the shipment by passing in an EndShipper ID.
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. THIRD_PARTY is only supported on passthrough billed carriers. 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.
pickup_min_datetime	string	The earliest a package should be picked up. Supported carriers vary.
pickup_max_datetime	string	The latest a package should be picked up. Supported carriers vary.
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` to make your shipment eligible for Saturday delivery.
special_rates_eligibility	string	This option allows you to request the following USPS mail classes: Media Mail and Library Mail. Set to 'USPS.MEDIAMAIL' or 'USPS.LIBRARYMAIL' respectively to return those rates. These mail classes have restrictions that must be followed. See the DMM for eligibility rules.
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.

Rates 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.
billing_type	string	Billing type of the rate
carbon_offset	CarbonOffset	the associated CarbonOffset object, if requested
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

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
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

NEXT_DAY

DeliveredTonight
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

RoadExpress
AggExpAtlP10
AggExpAtlP25
AggExpAtlBaseandKilo
AggExpAtlP0
AggExpAtlP1
AggExpAtlP3
AggExpAtlP5
AggDropOffHubbedBaseandKilo
AggDropOffHubbedP0
AggDropOffHubbedP1
AggDropOffHubbedP3
AggDropOffHubbedP5
AggStdAtlP10
AggStdAtlBaseandKilo
AggStdAtlP0
AggStdAtlP1
AggStdAtlP3
AggStdAtlP5
AggEcomBaseandKilo
AggEcomP0
AggEcomP1
AggEcomP3
AggEcomP5
AggDropOffHubbedP10
AggDropOffHubbedP25
AggStdAtlP25
AggEcomP10
AggEcomP25
AustralianCityExpress
DropShip500GramParcel
DropShip1KgParcel
DropShip3KgParcel
DropShip5KgParcel
DomesticPriority
DropShip10KgParcel
DropShip20KgParcel
DomesticPrioritySignature
GoldDomestic
RoadExpressNoDelivery
RoadExpressNoPickUp
500GramParcel
500GramParcelATL
1KgParcel
10KgParcel
10KgParcelATL
15KgParcel
15KgParcelATL
1KgParcelATL
2KgParcel
25KgParcel
25KgParcelATL
2KgParcelATL
3KgParcel
3KgParcelATL
5KgParcel
5Kg Parcel ATL
AustralianCityExpressSignature
DomesticSaverSignature
DomesticOffPeak
DomesticSaver
DomesticOffPeakSignature
GoldDomesticSignature
1KgSatchelATL
1KgSatchel
3KgSatchel
5KgSatchel
3KgSatchelATL
5KgSatchelATL
500GramSatchelATL
500GramSatchel
5KSatchel
ExpressInternationalPriority
InternationalSaver
InternationalExpressImport
InternationalExpress

ParcelMax
InternationalEconomy
InternationalStandard
InternationalExpress
DomesticTracked

Afternoon
Early-It
Economy
Noon-It
Saturday

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

EuroPaket
Paket
PaketConnect
PaketInternational
Retoure

No service levels for DHL SmartMail.

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
ParcelReturnToShop
ParcelSaturday
ParcelSaturday12
ParcelSaturday10
ParcelSunday12
FreightParcelDpdClassic
FreightParcelSunday12
ExpresspakDpdNextDay
ExpresspakDpd12
ExpresspakDpd10
ExpresspakSaturday
ExpresspakSaturday12
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

Courier2Home
Courier2HomeNextDay
Shop2Home
Shop2HomeNextDay
Shop2Shop
Shop2ShopNextDay

Parcel
Satchel

FEDEX_2_DAY_AM
FEDEX_2_DAY
FEDEX_DISTANCE_DEFERRED
FEDEX_EXPRESS_SAVER
FEDEX_FIRST_OVERNIGHT
FEDEX_GROUND_HOME_DELIVERY
FEDEX_GROUND
FEDEX_INTERNATIONAL_CONNECT_PLUS
FEDEX_INTERNATIONAL_ECONOMY
FEDEX_INTERNATIONAL_FIRST
FEDEX_INTERNATIONAL_PRIORITY
FEDEX_PRIORITY_OVERNIGHT
FEDEX_STANDARD_OVERNIGHT

CBEC
CBECL
CBECP

No service levels for FedEx Mailview.

SMART_POST

XParcelGround
XParcelExpedited
XParcelExpeditedPlus
XParcelPriority
XParcelReturns

EarlyPriorityOvernight
PriorityOvernight
CaliforniaParcelService
SaturdayDeliveryService
EarlySaturdayService
Ground
Overnight

Xpress

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

Standard

ParcelSelect
ParcelSelectLightweight
Ground
Express
FirstClassMail
PriorityMail
BoundPrintedMatter

Sunrise
Gold
OnTracGround
SameDay
PalletizedFreight

NxtDay

First
ParcelSelectLightweight
Priority
BPM
ParcelSelect
MediaMail
MarketingParcel
MarketingParcelTracked

Express9
Express9Secure
Express9CourierPack
Express10
Express10Secure
Express10Exchange
Express10SecureExchange
Express10CourierPack
ExpressAM
ExpressAMSecure
ExpressAMExchange
ExpressAMSecureExchange
ExpressAMCourierPack
ExpressPM
ExpressPMSecure
Express24
Express24Large
Express24Secure
Express24Exchange
Express24SecureExchange
Express24CourierPack
Express48
Express48Large
ParcelRiderPlus
GlobalBulkDirect
GlobalExpress
GlobalExpressEnvelopeDelivery
GlobalExpressPackDelivery
GlobalValue
GlobalPriority
GlobalPriorityReturns
EuroPriorityHome
EuroPriorityBusiness
IrelandExpress

ECOWE (Economy West)
ECOCE (Economy Central)
ECONE (Economy Northeast)
ECOEA (Economy East)
ECOSO (Economy South)
EXPWE (Expedited West)
EXPBNE (Expedited Northeast)
REGWE (Regional West)
REGCE (Regional Central)
REGNE (Regional Northeast)
REGEA (Regional East)
REGSO (Regional South)
CAECOWE (US to CA Economy)
CAECOCE (US to CA Economy)
CAECONE (US to CA Economy)
EUECOWE (US to Europe Economy)

No service levels for Passport.

No service levels for PostNL.

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

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

Standard
Express

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

NEXTDAY
SAMEDAY

SpeeDeeDelivery

NEXTDAY
SAMEDAY

NextDay
Return

IPEC Direct
IPEC Fashion
IPEC Local
IPEC Priority
IPEC Road Express
IPEC Sensitive
IPEC VicEXP

DeliveryService

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

No service levels for UPS iParcel.

First
Priority
ExpeditedMailInnovations
PriorityMailInnovations
EconomyMailInnovations

First
Priority
Express
ParcelSelect
LibraryMail
MediaMail
FirstClassMailInternational
FirstClassPackageInternationalService
PriorityMailInternational
ExpressMailInternational

nextDay
sameDay

No service levels for Yanwen.

POST/shipments/:id/rerate

Regenerate Rates for a Shipment

You can regenerate the Rates of a Shipment at any time. This is ideal when shipments aren't bought the same day as they were created and you want the most up-to-date rates available. This operation respects the carrier_accounts attribute.

Example

curl -X POST https://api.easypost.com/v2/shipments/shp_.../rerate \
  -u "$EASYPOST_API_KEY":

{
  "rates": [
    {
      "id": "rate_a3e303af85f44ec99ee59a6fe6ecdf67",
      "object": "Rate",
      "created_at": "2022-10-17T17:17:47Z",
      "updated_at": "2022-10-17T17:17:47Z",
      "mode": "test",
      "service": "Priority",
      "carrier": "USPS",
      "rate": "10.07",
      "currency": "USD",
      "retail_rate": "13.45",
      "retail_currency": "USD",
      "list_rate": "10.07",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 2,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": 2,
      "shipment_id": "shp_156e61f4875f4b07bba0a2fc8a31382a",
      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
    },
    {
      "id": "rate_9f9e6fb60b6d4677b71780c915458ec4",
      "object": "Rate",
      "created_at": "2022-10-17T17:17:47Z",
      "updated_at": "2022-10-17T17:17:47Z",
      "mode": "test",
      "service": "Express",
      "carrier": "USPS",
      "rate": "44.55",
      "currency": "USD",
      "retail_rate": "51.30",
      "retail_currency": "USD",
      "list_rate": "44.55",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": null,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": null,
      "shipment_id": "shp_156e61f4875f4b07bba0a2fc8a31382a",
      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
    },
    {
      "id": "rate_858f18770784480ea5d9252d0cff178f",
      "object": "Rate",
      "created_at": "2022-10-17T17:17:47Z",
      "updated_at": "2022-10-17T17:17:47Z",
      "mode": "test",
      "service": "ParcelSelect",
      "carrier": "USPS",
      "rate": "9.16",
      "currency": "USD",
      "retail_rate": "9.16",
      "retail_currency": "USD",
      "list_rate": "9.16",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 5,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": 5,
      "shipment_id": "shp_156e61f4875f4b07bba0a2fc8a31382a",
      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
    }
  ]
}

POST/beta/rates

Retrieve Rates for a Shipment

BETA: This feature is in Beta and subject to change. For feedback or questions, please contact Support.

You can retrieve Rates without creating a Shipment object using this endpoint. This endpoint is ideal when wanting to display or compare rates without creating Shipment objects. The Rate objects returned by this endpoint do not include IDs.

Request Parameters

param	example	info
reference	"my-reference"	An optional field that may be used in place of id in other API endpoints
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_..."]	List of carrier accounts
service	"Priority"	The service of carrier

Example

$ curl -X POST "https://api.easypost.com/beta/rates" \
  -u "$EASYPOST_API_KEY": \
  -H "Content-Type: application/json" \
  -d '{
  "shipment": {
    "to_address": {
      "name": "Dr. Steve Brule",
      "street1": "179 N Harbor Dr",
      "city": "Redondo Beach",
      "state": "CA",
      "zip": "90277",
      "country": "US",
      "phone": "8573875756",
      "email": "dr_steve_brule@gmail.com",
    },
    "from_address": {
      "name": "EasyPost",
      "street1": "417 Montgomery Street",
      "street2": "5th Floor",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94104",
      "country": "US",
      "phone": "4153334445",
      "email": "support@easypost.com"
    },
    "parcel": {
      "length": "20.2",
      "width": "10.9",
      "height": "5",
      "weight": "65.0"
    }
  }
}'

{
  "from_address": {
    "object": "Address",
    "name": "EasyPost",
    "street1": "417 Montgomery Street",
    "street2": "5th Floor",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94104",
    "country": "US",
    "phone": "4153334445",
    "email": "support@easypost.com"
  },
  "to_address": {
    "object": "Address",
    "name": "Dr. Steve Brule",
    "street1": "179 N Harbor Dr",
    "city": "Redondo Beach",
    "state": "CA",
    "zip": "90277",
    "country": "US",
    "phone": "8573875756",
    "email": "dr_steve_brule@gmail.com"
  },
  "rates": [
    {
      "object": "Rate",
      "mode": "production",
      "service": "Express",
      "carrier": "USPS",
      "rate": "44.55",
      "currency": "USD",
      "retail_rate": "51.30",
      "retail_currency": "USD",
      "list_rate": "44.55",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": null,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": null,
      "carrier_account_id": "ca_fe6c4f1489b545d49b698d4712fd4b95"
    },
    {
      "object": "Rate",
      "mode": "production",
      "service": "ParcelSelect",
      "carrier": "USPS",
      "rate": "9.16",
      "currency": "USD",
      "retail_rate": "9.16",
      "retail_currency": "USD",
      "list_rate": "9.16",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 5,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": 5,
      "carrier_account_id": "ca_fe6c4f1489b545d49b698d4712fd4b95"
    },
    {
      "object": "Rate",
      "mode": "production",
      "service": "Priority",
      "carrier": "USPS",
      "rate": "10.07",
      "currency": "USD",
      "retail_rate": "13.45",
      "retail_currency": "USD",
      "list_rate": "10.07",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 2,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": 2,
      "carrier_account_id": "ca_fe6c4f1489b545d49b698d4712fd4b95"
    },
    {
      "object": "Rate",
      "mode": "production",
      "service": "3DaySelect",
      "carrier": "UPSDAP",
      "rate": "11.38",
      "currency": "USD",
      "retail_rate": "30.21",
      "retail_currency": "USD",
      "list_rate": "31.89",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 3,
      "delivery_date": "2022-11-28T23:00:00Z",
      "delivery_date_guaranteed": false,
      "est_delivery_days": 3,
      "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
    },
    {
      "object": "Rate",
      "mode": "production",
      "service": "NextDayAirEarlyAM",
      "carrier": "UPSDAP",
      "rate": "78.35",
      "currency": "USD",
      "retail_rate": "154.49",
      "retail_currency": "USD",
      "list_rate": "161.74",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 1,
      "delivery_date": "2022-11-23T08:00:00Z",
      "delivery_date_guaranteed": true,
      "est_delivery_days": 1,
      "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
    },
    {
      "object": "Rate",
      "mode": "production",
      "service": "2ndDayAirAM",
      "carrier": "UPSDAP",
      "rate": "17.00",
      "currency": "USD",
      "retail_rate": "43.99",
      "retail_currency": "USD",
      "list_rate": "47.57",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 2,
      "delivery_date": "2022-11-25T23:00:00Z",
      "delivery_date_guaranteed": false,
      "est_delivery_days": 2,
      "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
    },
    {
      "object": "Rate",
      "mode": "production",
      "service": "Ground",
      "carrier": "UPSDAP",
      "rate": "9.25",
      "currency": "USD",
      "retail_rate": "15.05",
      "retail_currency": "USD",
      "list_rate": "16.04",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 2,
      "delivery_date": "2022-11-25T23:00:00Z",
      "delivery_date_guaranteed": false,
      "est_delivery_days": 2,
      "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
    },
    {
      "object": "Rate",
      "mode": "production",
      "service": "NextDayAirSaver",
      "carrier": "UPSDAP",
      "rate": "42.79",
      "currency": "USD",
      "retail_rate": "115.11",
      "retail_currency": "USD",
      "list_rate": "120.97",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 1,
      "delivery_date": "2022-11-23T23:00:00Z",
      "delivery_date_guaranteed": true,
      "est_delivery_days": 1,
      "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
    },
    {
      "object": "Rate",
      "mode": "production",
      "service": "NextDayAir",
      "carrier": "UPSDAP",
      "rate": "48.35",
      "currency": "USD",
      "retail_rate": "118.71",
      "retail_currency": "USD",
      "list_rate": "125.96",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 1,
      "delivery_date": "2022-11-23T10:30:00Z",
      "delivery_date_guaranteed": true,
      "est_delivery_days": 1,
      "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
    },
    {
      "object": "Rate",
      "mode": "production",
      "service": "2ndDayAir",
      "carrier": "UPSDAP",
      "rate": "15.49",
      "currency": "USD",
      "retail_rate": "39.28",
      "retail_currency": "USD",
      "list_rate": "42.92",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 2,
      "delivery_date": "2022-11-25T23:00:00Z",
      "delivery_date_guaranteed": false,
      "est_delivery_days": 2,
      "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
    }
  ],
  "options": {
    "currency": "USD",
    "payment": {
      "type": "SENDER"
    },
    "date_advance": 0
  },
  "parcel": {
    "object": "Parcel",
    "length": 20.2,
    "width": 10.9,
    "height": 5,
    "weight": 65
  },
  "messages": []
}

"In summer 2022, EasyPost updated its FedEx Webservices to version 31. This enabled new FedEx service levels and required users to update their FedEx Ship Request to at least version 26 or higher, so they are able to successfully rate and buy labels on version 31. EasyPost users can upgrade by re-adding their FedEx account through their EasyPost Dashboard or through the API using the Carrier Accounts endpoint."

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

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)

Carrier	String Representation
AmazonMws	AmazonMws
APC	APC
Asendia USA	AsendiaUsa
Australia Post	AustraliaPost
AxlehireV3	AxlehireV3
Better Trucks	BetterTrucks
Canada Post	CanadaPost
Canpar	Canpar
CDL Last Mile Solutions	ColumbusLastMile
Chronopost	Chronopost
CloudSort	CloudSort
Courier Express	CourierExpress
CouriersPlease	CouriersPlease
Dai Post	DaiPost
DeliverIt	DeliverIt
Deutsche Post	DeutschePost
Deutsche Post UK	DeutschePostUK
DHL eCommerce Asia	DHLEcommerceAsia
DHL eCommerce Solutions	DhlEcs
DHL Express	DHLExpress
DHL Paket	DHLPaket
DHL SmartMail	DHLSmartmail
DPD	DPD
DPD UK	DPDUK
ePost Global	ePostGlobal
Estafeta	Estafeta
Evri	Evri
Fastway	Fastway
FedEx	FedEx
FedEx Cross Border	FedExCrossBorder
FedEx Mailview	FedExMailview
FedEx SmartPost	FedexSmartPost
FirstMile	FirstMile
GSO	GSO
Hailify	Hailify
Interlink Express	InterlinkExpress
JP Post	JPPost
Kuroneko Yamato	KuronekoYamato
La Poste	LaPoste
LaserShip	LaserShipV2
Loomis Express	LoomisExpress
LSO	LSO
Maergo	Maergo
Newgistics	Newgistics
OnTrac	OnTrac
Optima	Optima
Osm Worldwide	OsmWorldwide
Parcelforce	Parcelforce
PARCLL	Parcll
Passport	PassportGlobal
PostNL	PostNL
Purolator	Purolator
Royal Mail	RoyalMail
SEKO OmniParcel	OmniParcel
Sendle	Sendle
SF Express	SFExpress
SmartKargo	SmartKargo
Sonic	Sonic
Spee-Dee	SpeeDee
Swyft	Swyft
TForce Logistics	TForce
Toll	Toll
UDS	UDS
UPS	UPS
UPS i-parcel	UPSIparcel
UPS Mail Innovations	UPSMailInnovations
USPS	USPS
Veho	Veho
Yanwen	Yanwen

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

API Documentation

Authenticationlink

EasyPost Objectslink

Errorslink

Error Objectlink

FieldError Objectlink

Common HTTP Status Codeslink

Paginationlink

Addresseslink

Address Objectlink

Verifications Objectlink

Verification Objectlink

VerificationDetails Objectlink

Address Verification by Countrylink

Create and Verify Addresseslink

Verify an Address

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Retrieve a list of Addresseslink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Retrieve an Addresslink

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Parcelslink

Parcel Objectlink

Predefined Packageslink

Create a Parcellink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Retrieve a Parcellink

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Insuranceslink

Insurance Objectlink

Create an Insurancelink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Retrieve a list of Insuranceslink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Retrieve an Insurancelink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Shipmentslink

Shipment Objectlink

Form Objectlink

PostageLabel Objectlink

Create a Shipmentlink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Retrieve a list of Shipmentslink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Retrieve a Shipmentlink

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Buy a Shipmentlink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Buy a Shipment without rating (One-Call Buy)link

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Convert the Label format of a Shipmentlink

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Carbon Offsetlink

Carbon Offset Objectlink

Create Shipment with Carbon Offsetlink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Buy Shipment with Carbon Offsetlink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

One-Call Buy Shipment with Carbon Offsetlink

Request Parameters

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Formslink

Forms that may be returned with Shipment objects depending on the carrier and data passed:link

Forms that can be created after a Shipment has been bought:link

Form Objectlink

Create Formlink

Please see Form guide for request parameter.

ExamplecURLcURLC#/.NETGoJavaNode.jsPHPPythonRuby

Authentication

EasyPost Objects

Errors

Error Object

FieldError Object

Common HTTP Status Codes

Pagination

Addresses

Address Object

Verifications Object

Verification Object

VerificationDetails Object

Address Verification by Country

Create and Verify Addresses

Example

Retrieve a list of Addresses

Example

Retrieve an Address

Example

Parcels

Parcel Object

Predefined Packages

Create a Parcel

Example

Retrieve a Parcel

Example

Insurances

Insurance Object

Create an Insurance

Example

Retrieve a list of Insurances

Example

Retrieve an Insurance

Example

Shipments

Shipment Object

Form Object

PostageLabel Object

Create a Shipment

Example

Retrieve a list of Shipments

Example

Retrieve a Shipment

Example

Buy a Shipment

Example

Buy a Shipment without rating (One-Call Buy)

Example

Convert the Label format of a Shipment

Example

Carbon Offset

Carbon Offset Object

Create Shipment with Carbon Offset

Example

Buy Shipment with Carbon Offset

Example

One-Call Buy Shipment with Carbon Offset

Example

Forms

Forms that may be returned with Shipment objects depending on the carrier and data passed:

Forms that can be created after a Shipment has been bought:

Form Object

Create Form

Example

Options

Options Object

Create a Shipment with Options

Example

Rates

Rates Object

Service Levels

Regenerate Rates for a Shipment

Example

Retrieve Rates for a Shipment

Example

Messages

Message Object

SmartRate

Time in Transit Object

Retrieve Time in Transit statistics across all Rates for a Shipment