What's in the Shipment CSV Report?
You can access the Shipment Report in a .csv
format through our Reports Object, which you can get via the API or download from the dashboard. The .csv
file contains the fields listed below with their definitions.
Field | Definition or Sample Data |
---|---|
created_at | The timestamp the Shipment was created |
id | shp_…. |
tracking_code | Tracking code of the Shipment |
status | current tracker status, such as "pre-transit" or "delivered" |
from_address_id | adr_... |
from_name | Name of the "From Address" (origin) |
from_company | Company of the "From Address" (origin) |
from_street1 | Street 1 of the "From Address" (origin) |
from_street2 | Street 2 of the "From Address" (origin) |
from_city | City of the "From Address" (origin) |
from_state | State of the "From Address" (origin) |
from_zip | ZIP of the "From Address" (origin) |
from_country | Two-letter country code of the "From Address" (origin) |
from_residential | true or false, if the "From Address" (origin) is residential |
to_address_id | adr_... |
to_name | Name of the "To Address" (destination) |
to_company | Company of the "To Address" (destination) |
to_street1 | Street 1 of the "To Address" (destination) |
to_street2 | Street 2 of the "To Address" (destination) |
to_city | City of the "To Address" (destination) |
to_state | State of the "To Address" (destination) |
to_zip | ZIP of the "To Address" (destination) |
to_country | Two-letter country code of the "To Address" (destination) |
to_residential | true or false, if the "To Address" (destination) is residential |
parcel_id | prcl_... |
length | Length in inches |
width | Width in inches |
height | Height in inches |
weight | Weight in ounces |
predefined_package | Populated if a predefined package was used |
postage_label_created_at | The timestamp the Shipment was created |
rate_id | rate_... |
service | Service level of the carrier of the purchased rate (Postage Label) |
carrier | Carrier of the purchased rate (Postage Label) |
rate | Your cost of the specified rate |
insured_value | Insured value of your shipment, if insurance was purchased |
is_return | true or false, if the Shipment was specified to be a return |
refund_status | "refunded" if the refund was granted, "rejected", or "submitted" |
reference | Reference of the Shipment, if specified |
label_fee | The transactional amount EasyPost charged to purchase the Label |
postage_fee | The amount EasyPost charged for the actual cost of the Label |
insurance_fee | The amount EasyPost charged for insuring the Shipment |
options | Array of other relevant options for the Shipment |
Additional Columns
Field | Definition or Sample Data |
---|---|
to_phone | Phone number of the "To Address" (destination) |
to_email | Email address of the "To Address" (destination) |
usps_zone | Zone used for the rate calculation |
carbon_offset_grams | The estimated amount of grams of Carbon emitted from the Shipment. Only populated if Carbon Offset is purchased on the Shipment. Note: Beginning 11/1/2023, EasyPost retired the for-purchase version of the Carbon Offset program and is committed to 100% carbon-neutral shipping at no cost to our customers. |
carbon_offset_fee | The amount EasyPost charged for offsetting the Carbon emitted from the Shipment |
user_id | user_...., the user that created the Shipment. Useful if you use Child Users. |