EasyPost

List all API keys for the authenticated user and child accounts.

Create a new API key. Requires a Production API Key.

Permanently delete an API key. This cannot be undone.

Disable an API key. The key can be re-enabled later.

Re-enable a disabled API key.

Create a new address in EasyPost. Returns an Address object that can be used for shipments.

Create and verify an address in one request. Combines address creation with strict verification. Returns an error if verification fails.

Retrieve an address by its ID.

List all addresses with pagination.

Verify an existing address. Performs address verification and returns updated address with verification results.

Retrieve a webhook by its ID.

Create a new batch for bulk shipment operations. It is recommended to keep each batch under 1,000 shipments to avoid timeout errors.

Retrieve a batch by its ID.

List batches with pagination.

Add shipments to an existing batch.

Remove shipments from a batch.

Purchase all shipments in a batch. This is an asynchronous operation. Check the batch status for completion.

Generate consolidated labels for all shipments in a batch. All shipments must have "postage_purchased" status.

Create a scan form manifest for a batch.

List all carrier accounts associated with your account.

Retrieve a carrier account by its ID.

Create a new carrier account. Requires a Production API Key. Some carriers require a custom workflow through the UI.

Update an existing carrier account.

Delete a carrier account.

Get metadata about carriers including service levels, predefined packages, and features.

Create customs information for international shipments.

Retrieve customs information by its ID.

Create a standalone customs item.

Retrieve a customs item by its ID.

Create a new end shipper for third-party billing. At least one of name or company is required.

Retrieve an end shipper by its ID.

List end shippers with pagination.

Update an existing end shipper.

Retrieve an event by its ID.

List events with pagination. Events are webhook notifications triggered by object changes.

Create standalone insurance for a package purchased outside EasyPost.

Retrieve an insurance record by its ID.

List insurance records with pagination.

Refund standalone insurance. Only eligible if tracking status is pre_transit, cancelled, or unknown.

Create a new order for multi-parcel shipping. Works with select carriers: AustraliaPost, DHLExpress, DPD, DPDUK, Fastway, FedEx, UPS, Purolator, LoomisExpress. Maximum of 100 shipments per order.

Retrieve an order by its ID.

Purchase an order with a specified carrier and service. This will purchase all shipments in the order with the same carrier/service.

Create a new parcel in EasyPost. Dimensions are in inches, weight is in ounces. Either provide dimensions (length, width, height) OR a predefined_package.

Retrieve a parcel by its ID.

List all webhooks associated with your API key.

Create a new pickup request. Requires an existing purchased Shipment or Batch. Supported carriers: UPS, USPS, FedEx, DHL Express, Canada Post, and others.

Retrieve a pickup by its ID.

List pickups with pagination.

Purchase a pickup with a selected carrier and service.

Cancel a scheduled pickup.

Get shipping rates without creating a shipment (Beta). This is ideal for displaying or comparing rates without persisting Shipment objects. Note: Rate objects returned do NOT include IDs.

Create refunds for one or more tracking codes. Returns an array of Refund objects for bulk processing.

Retrieve a refund by its ID.

List refunds with pagination.

Generate a new report. Reports are generated asynchronously. Check the report status for completion. Date range must be no more than 31 days.

Retrieve a report by its ID. Use this to check report status and get the download URL when ready.

List reports of a specific type with pagination.

Create a scan form (manifest) for multiple shipments. A scan form allows you to hand over multiple packages to the carrier with a single barcode scan.

Retrieve a scan form by its ID.

List scan forms with pagination.

Update user account settings.

Create a new shipment in EasyPost. Creates a shipment and automatically retrieves available rates. Use existing IDs or provide full address/parcel data. For one-call buy, include service and optionally carrier_accounts.

Retrieve a shipment by its ID.

List shipments with pagination and filters.

Purchase a shipment with a selected rate. This will generate the shipping label and tracking code.

Request a refund for a purchased shipment.

Regenerate rates for an existing shipment. Use this to refresh rates if time has passed since shipment creation.

Convert a shipping label to a different format.

Get SmartRate predictions for a shipment. Returns transit time predictions across various percentiles for all rates. Only available for US domestic shipments.

Get estimated delivery dates based on a planned ship date.

Get optimal ship dates to meet a desired delivery date.

Create a tracker for a package. Note: Trackers are automatically created when purchasing shipments through EasyPost. Use this for tracking packages purchased outside of EasyPost.

Retrieve a tracker by its ID.

List trackers with pagination and filters.

Delete a tracker. This will stop webhook events for this tracker.

Retrieve user account information. Without an ID, returns the authenticated user's information.

Create a new webhook for event notifications. Webhooks require HTTPS URLs with valid TLS certificates.

Update a webhook's settings. Can be used to update the secret or re-enable a disabled webhook.

Delete a webhook.