EasyPost

Buy one rate on one shipment. This debits the postage wallet and returns the label and tracking code. It does not show whether a payment method refilled the wallet. The user should approve the carrier, service, and price first. expected_rate is that price and has to match the rate being bought. Insurance on this call covers the package at purchase. Leaving insurance off is not a decline: a default insurance amount may cover a qualifying shipment, and passing 0 declines coverage. The response shows the coverage that was applied. A shipment already bought with this rate is returned as-is when insurance is omitted or matches the coverage already on it. Passing 0 matches no coverage. A different amount is refused. insure_shipment adds coverage after purchase only when the shipment has none. A rate from an earlier turn needs a new shipment. If this buy times out, the connection drops, or the buy conflicts or returns a server error, call buy_shipment again with the same shipment_id and rate_id.

buy_shipment

Look up what EasyPost carriers support: service levels, predefined package types, shipment options, and supported features. Omit carriers to list every carrier by name, or pass carriers='usps,fedex' for the full metadata of those carriers. Narrow the answer with types, any of service_levels, predefined_packages, shipment_options, supported_features. This is the catalog of what carriers can do, not the accounts this user has connected; use list_carrier_accounts for those.

carrier_metadata

Check the status of insurance claims filed for lost, damaged, or stolen shipments. Pass claim_id (clm_) to show one claim with its full status history, which ignores every filter below. Otherwise this lists claims, filtered by status (submitted, in_review, needs_action, approved, approved_partial, rejected, cancelled) and claim_type (damage, loss, theft). Listing covers the last month unless you pass a date window, so pass start_datetime to look further back, and never read an empty list as proof the user has no claims. Use insurances for the policy a claim was filed against. This only reads; it never files or cancels a claim.

claims

Verify one address for deliverability and store it. Returns an adr_ id, verifications.delivery.success, and any delivery error messages. A failed check still returns the address with success false. Each call is billed. This checks an address before there is a parcel. create_shipment verifies the address it will deliver to, so once a parcel is known that address belongs there. Verifying and then rating the same address bills verification twice.

create_and_verify_address

Request a refund for one unused purchased label, by its tracking code. One code per call. A label the carrier has already taken may be refused. Status is read with the refunds tool, which never files a refund.

create_refund

Quote rates for one domestic US shipment. This does not buy a label. Origin, destination, and parcel are inline. country is required and must be US. parcel.weight is ounces. There is no address book and no rerate tool. Rating can be metered on a rating subscription. The destination is verified for deliverability on this call, and that check is billed. The result is to_address.verifications.delivery.success, or from_address.verifications.delivery.success when is_return is set. Do not also call create_and_verify_address for that destination. Keep the merchant in from_address and the customer in to_address, the same as the outbound label. is_return delivers to the merchant. Do not swap the addresses. It applies when the user asked for a return. Rate ids on this response are the ones a buy can use. A rate from an earlier turn needs a new shipment. messages explains an empty rate list.

create_shipment

Register one tracking number that was not bought through EasyPost. The first registration is billed. A repeat of a number that already has a tracker returns that tracker without another charge. One tracking code per call.

create_tracker

Show one stored address by address_id (adr_). The id comes from the user or from a shipment. This is not an address book, and it does not run a new deliverability check. A stored verifications.delivery result is included when the address has one.

get_address

Show one shipment with its label URLs, stored rates, and tracker summary. Pass exactly one of shipment_id (shp_) or tracking_code, preferring shipment_id.

get_shipment

Show where a package is. Pass exactly one of tracker_id (trk_) or tracking_code, preferring tracker_id, and add carrier when a tracking_code is ambiguous. Returns the most recent scans.

get_tracker