EasyPost is a multi-carrier shipping and logistics API platform that lets businesses rate shop across carriers like USPS, UPS, FedEx, and DHL, buy and print labels, verify addresses, track packages in real time, insure shipments, and manage batch labels — all through one unified integration. It's built for teams needing scalable shipping infrastructure without per-carrier integrations.
Power end-to-end data operations for your EasyPost API with Nexla. Our bi-directional EasyPost connector is purpose-built for EasyPost, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to EasyPost or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your EasyPost workflows fast, secure, and fully governed.
Features
Type: API
SourceDestination
Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
EasyPost uses HTTP Basic Authentication with an API key as the username and a blank password. Before creating a credential in Nexla, you will need an active EasyPost account and an API key.
EasyPost provides two types of API keys: Test keys, which allow you to explore and test the API at no cost, and Production keys, which are used for live shipping operations. Both key types are available immediately after account creation.
Click on your account name or avatar in the top-right corner to open the account menu, and select Account Settings.
In the Account Settings page, navigate to the API Keys tab.
Your Test and Production API keys are displayed on this page. Copy the key you want to use with Nexla.
Use your Test API key during initial setup and integration testing. Switch to your Production API key only when you are ready to process live shipments. Test mode transactions do not result in real labels or charges.
To generate an additional API key, click the Add Additional API Key button and select either Production or Test from the dropdown menu.
Important
Treat your EasyPost API key with the same level of security as a password. Anyone with access to your key can perform actions on your EasyPost account, including purchasing labels. If you believe a key has been compromised, you can immediately disable it from the API Keys page in your EasyPost Dashboard.
EasyPost uses HTTP Basic Auth with the API key as the username and a blank password. Credentials are transmitted via the Authorization: Basic header.
Field
Required
Secret
Description
API Key
Yes
Yes
Your EasyPost API key. Found under Account Settings → API Keys in the EasyPost dashboard. Used as the HTTP Basic Auth username; the password is sent blank.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
EasyPost credentials in Nexla use HTTP Basic Authentication, which transmits the API key as the username via the Authorization: Basic header. No password is required—the password field is left blank automatically. Enter your EasyPost API key in the API Key field. This is the key you copied from the API Keys tab in your EasyPost Account Settings. The key authenticates all requests made by Nexla to the EasyPost API on your behalf.
The Base URL field is pre-populated with the standard EasyPost API base URL: https://api.easypost.com/v2. This value should be used for both Test and Production API keys—EasyPost uses the same base URL for both environments; the key type determines which environment is active.
The Base URL should not be changed unless EasyPost has specifically directed you to use a different endpoint, such as for regional or enterprise configurations.
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the EasyPost connector tile, then select the credential that will be used to connect to the EasyPost instance, and click Next; or, create a new EasyPost credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common EasyPost endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.
List Addresses
Retrieves a paginated list of all addresses stored in your EasyPost account. Use this endpoint to audit your address book, export address data for analysis, or sync EasyPost addresses with other systems in your data flow. EasyPost uses cursor-based pagination, automatically fetching up to 100 addresses per page.
No additional parameters are required to use this endpoint. Nexla will automatically handle pagination, fetching all available address records from your EasyPost account.
Each address record returned includes fields such as the address ID, name, street, city, state, ZIP code, country, phone, and email.
Retrieves a single address record by its unique EasyPost address ID. Use this endpoint when you need to fetch the details of a specific address—for example, to verify address information or retrieve a stored shipping destination.
Enter the unique identifier of the address to retrieve in the Address Id field. EasyPost address IDs follow the format adr_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX and can be found in the EasyPost Dashboard under Addresses, or from the response of a previous List Addresses or Create Address API call.
Returns a paginated list of all Shipment objects in your EasyPost account, using cursor-based pagination. Use this endpoint to export shipment history, analyze shipping spend across carriers, audit label purchases, or feed shipment data into downstream analytics or reporting pipelines.
No additional parameters are required to use this endpoint. Nexla will automatically handle cursor-based pagination, using the before_id parameter to walk through all shipment pages until no further results are returned.
Each shipment record includes details such as the shipment ID, status, tracking code, selected rate, carrier, service level, to/from addresses, parcel information, label URL, and timestamps.
Retrieves the complete details of a specific EasyPost shipment by its unique shipment ID. Use this endpoint when you need to fetch the current status, tracking information, selected rate, or label URL for a known shipment.
Enter the unique identifier of the shipment to retrieve in the Shipment ID field. EasyPost shipment IDs follow the format shp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX and can be found in the EasyPost Dashboard under Shipments, or from the response of a previous List Shipments or Create Shipment API call.
Retrieves a single parcel record by its unique EasyPost parcel ID. Parcels in EasyPost represent the physical package dimensions and weight associated with a shipment. Use this endpoint to look up previously created parcel definitions.
Enter the unique identifier of the parcel to retrieve in the Parcel Id field. EasyPost parcel IDs follow the format prcl_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX and can be found from the response of a previous Create Parcel API call or within a shipment record.
Retrieves the current tracking details for a specific EasyPost Tracker object by its unique tracker ID. EasyPost Trackers provide real-time package status updates and carrier scan events. Use this endpoint to pull the latest tracking status for a known tracker into your Nexla data flow.
Enter the unique identifier of the tracker to retrieve in the Id field. EasyPost tracker IDs follow the format trk_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX and can be found in your EasyPost Dashboard under Trackers, or from the response of a previous Create Tracker API call.
Each tracker record includes the tracking code, carrier, status, status detail, estimated delivery date, and a full list of carrier scan events.
Retrieves a single EasyPost Order by its unique order ID. An Order in EasyPost represents a collection of shipments that can be purchased together. Use this endpoint to fetch the full details of a specific order, including all associated shipments and available rates.
Enter the unique identifier of the order to retrieve in the Order ID field. EasyPost order IDs follow the format order_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX and can be found from the response of a previous Create Order API call or within the EasyPost Dashboard.
Retrieves a single insurance claim record by its unique claim ID. EasyPost Claims are filed for lost or damaged shipments covered by EasyPost insurance or carrier insurance. Use this endpoint to pull the status and details of a specific claim into your data flow for tracking or reporting purposes.
Enter the unique identifier of the claim to retrieve in the Claim Id field. EasyPost claim IDs follow the format clm_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX and can be found from the response of a previous Create Claim API call or within the EasyPost Dashboard under the insurance/claims section.
Each claim record includes the claim ID, status, filed amount, carrier, tracking code, and supporting documentation references.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
EasyPost data sources can also be manually configured to ingest data from any valid EasyPost API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
All EasyPost API endpoints use the base URL https://api.easypost.com/v2 followed by the resource path (e.g., /shipments, /addresses, /trackers, /insurances, /batches). EasyPost list endpoints return a top-level JSON object containing the records array plus pagination metadata (has_more, next_id)—set the Path to Data field to the array path, such as $.shipments[*] or $.addresses[*], so that each record is treated individually rather than the entire response envelope.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new EasyPost data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.
Click the + icon on the Nexset that will be sent to the EasyPost destination, and select the Send to Destination option from the menu. Select the EasyPost connector from the list of available destination connectors, then select the credential that will be used to connect to the EasyPost organization, and click Next; or, create a new EasyPost credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common EasyPost endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.
Create Address
Creates a new address record in the EasyPost system. Use this endpoint to store shipping origin or destination addresses for use in future shipments. EasyPost can also optionally verify addresses during creation to improve deliverability.
No additional URL parameters are required. The address data is supplied in the request body via the Nexset record fields. Ensure your Nexset includes the relevant address fields such as name, street1, city, state, zip, and country.
To trigger EasyPost address verification during creation, include verify or verify_strict in the request body with a value of true.
Creates a new parcel record in EasyPost with the specified dimensions and weight. Parcels define the physical characteristics of the package being shipped and are required when creating shipments in EasyPost.
No additional URL parameters are required. Parcel data is supplied through the Nexset record. Ensure your Nexset includes the required parcel fields: length, width, height (in inches), and weight (in ounces).
Alternatively, you can specify a predefined_package value (such as FlatRateBox for USPS Flat Rate packaging) instead of explicit dimensions.
Creates and immediately purchases a shipping label for a shipment in a single API call, with EasyPost automatically selecting a rate based on your account's default carrier and service settings. This is the most efficient way to generate a shipping label when you do not need to compare rates before purchasing.
No additional URL parameters are required. The complete shipment object—including to_address, from_address, parcel, and any options—is provided via the Nexset record in the request body.
To trigger the one-call buy behavior, include a service and carrier field in the shipment body, or configure a default carrier service in your EasyPost account settings.
The response includes the purchased label URL, tracking code, selected rate, and complete shipment details.
Purchases a shipping label for an existing EasyPost shipment that has already been created and rated. Use this endpoint when you have previously created a shipment, reviewed the available rates, and are now ready to purchase a label using a specific rate ID.
Enter the unique identifier of the shipment for which to purchase a label in the Shipment ID field. EasyPost shipment IDs follow the format shp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX and can be found from the response of a previous Create Shipment API call or within the EasyPost Dashboard.
The request body must include the rate object specifying which rate to purchase. At minimum, include the id field containing the rate ID (e.g., rate_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX).
Optionally, include an end_shipper_id in the request body to purchase the label on behalf of a third-party shipper configured as an End Shipper in your EasyPost account.
Requests a postage refund for a previously purchased shipment label. Use this endpoint when a shipment label is no longer needed—for example, when an order is cancelled after a label has been generated. Refund eligibility is subject to the carrier's policies.
Enter the unique identifier of the shipment to refund in the Shipment Id field. EasyPost shipment IDs follow the format shp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
No request body is required for this endpoint.
Refund processing times vary by carrier. Not all carriers support automated refunds through the EasyPost API. For additional information, refer to the EasyPost Shipments documentation.
Insure Shipment
Adds EasyPost insurance to an already-purchased shipment. EasyPost insurance provides coverage for lost or damaged packages across all carriers and service levels. Use this endpoint when you want to insure a shipment after purchase rather than during the initial shipment creation.
Enter the unique identifier of the shipment to insure in the Shipment ID field. EasyPost shipment IDs follow the format shp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
The request body must include an amount field specifying the insured value of the shipment in USD (e.g., 100.00).
Creates a new EasyPost Order, which represents a collection of shipments grouped together for multi-package or multi-carrier ordering. Use this endpoint when you need to create and rate an order containing multiple shipments before purchasing labels.
No additional URL parameters are required. The complete order object—including to_address, from_address, and a shipments array—is provided via the Nexset record in the request body.
The response includes the created order ID and a list of available rates for each shipment within the order, which can then be used with the Buy Order endpoint to purchase labels.
Purchases shipping labels for all shipments in an existing EasyPost Order in a single API call. Use this endpoint after creating an order and selecting the desired carrier and service level to purchase all labels at once.
Enter the unique identifier of the order for which to purchase labels in the Order ID field. EasyPost order IDs follow the format order_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
The request body must include the carrier and service fields specifying which carrier service to use for all shipments in the order.
Creates a new EasyPost Batch for multi-shipment label generation. Batches allow you to group many shipments together and purchase or generate labels for all of them in coordinated operations, which is useful for high-volume shipping scenarios.
No additional URL parameters are required. The batch object—including an optional shipments array containing shipment references—is provided via the Nexset record in the request body. Shipments can also be added to the batch after creation using the Add Shipments to Batch endpoint.
The response includes the created batch ID, which is required for subsequent Buy Batch, Add Shipments to Batch, and Create Batch Label operations.
Adds one or more existing shipments to an existing EasyPost Batch. Use this endpoint to build up a batch incrementally before purchasing all labels at once with the Buy Batch endpoint.
Enter the unique identifier of the batch to which shipments will be added in the Batch ID field. EasyPost batch IDs follow the format batch_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
The request body must include a shipments array containing objects with the id field for each shipment to add (e.g., [{"id": "shp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}]).
Purchases shipping labels for all shipments in an existing EasyPost Batch. After all shipments have been added to the batch, use this endpoint to trigger the bulk label purchase operation.
Enter the unique identifier of the batch to purchase in the Batch Id field. EasyPost batch IDs follow the format batch_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
No request body is required. EasyPost will process label purchases for all shipments in the batch asynchronously. Monitor the batch status via the EasyPost Dashboard or webhook events to confirm when all labels have been purchased.
Batch label purchases are processed asynchronously by EasyPost. For additional information about batch processing and status tracking, refer to the EasyPost Batches documentation.
Create Batch Label
Generates a combined label file (PDF or ZPL) containing all individual shipment labels in a purchased batch. Use this endpoint after all batch shipments have been purchased to produce a single downloadable label file for printing.
Enter the unique identifier of the purchased batch in the Batch ID field. EasyPost batch IDs follow the format batch_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
The request body must include the file_format field specifying the label output format. Supported values are:
PDF: Standard document format, suitable for most printers.
ZPL: Zebra Programming Language format, used for thermal/label printers.
The batch must be in a purchased state before generating a batch label. For additional information, refer to the EasyPost Batches documentation.
Create Insurance
Creates a standalone EasyPost insurance record for a shipment. Use this endpoint to purchase EasyPost insurance for a shipment that was created or purchased outside of EasyPost, such as a shipment made directly through a carrier portal.
No additional URL parameters are required. The insurance object—including to_address, from_address, tracker (with tracking code and carrier), amount (insured value in USD), and optional reference—is provided via the Nexset record in the request body.
Requests a refund for an existing EasyPost insurance policy by its insurance ID. Use this endpoint when a shipment covered by standalone EasyPost insurance is no longer being shipped and the insurance premium should be returned.
Enter the unique identifier of the insurance record to refund in the Insurance Id field. EasyPost insurance IDs follow the format ins_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
Files a new insurance claim for a lost or damaged shipment covered by EasyPost insurance. Use this endpoint to initiate the claims process when a package has not arrived or has arrived in a damaged condition.
No additional URL parameters are required. The claim object—including the tracking_code, amount (claimed value in USD), type (e.g., loss or damage), and email_evidence_attachments or other supporting fields—is provided via the Nexset record in the request body.
EasyPost will review and process the claim. Monitor the claim status using the Retrieve Claim endpoint or EasyPost Dashboard.
Creates a standalone EasyPost Tracker for any carrier tracking number, enabling real-time package status monitoring without requiring the shipment to have been created through EasyPost. Use this endpoint to track packages shipped via carrier portals or other systems.
No additional URL parameters are required. The tracker object—including the tracking_code and optionally a carrier name—is provided via the Nexset record in the request body. If no carrier is specified, EasyPost will attempt to automatically detect the carrier from the tracking code format.
The response includes the created tracker ID and any currently available tracking events from the carrier.
Creates a webhook subscription to receive EasyPost event notifications at a specified URL. EasyPost webhooks deliver real-time event updates for tracking status changes, batch processing completions, refund outcomes, and other shipping lifecycle events.
No additional URL parameters are required. The webhook object—including the url field specifying the endpoint that will receive event payloads—is provided via the Nexset record in the request body.
Optionally include a custom_headers array in the request body to add authentication or routing headers to webhook deliveries.
Creates a USPS scan form (also known as a manifest) for batch carrier drop-offs. A scan form consolidates multiple shipment barcodes onto a single document that a carrier pickup agent can scan at once, streamlining the handoff process for high-volume USPS drop-offs.
No additional URL parameters are required. The scan form object—including a shipments array containing the IDs of all shipments to include on the form—is provided via the Nexset record in the request body.
All shipments included in the scan form must have purchased USPS labels and must share the same from_address.
The response includes the scan form ID and a URL to download the generated PDF document.
Creates a new Carrier Account in your EasyPost account, connecting your own negotiated carrier credentials to enable rate shopping and label purchasing through your preferred carriers. Use this endpoint to programmatically register carrier accounts rather than configuring them through the EasyPost Dashboard.
No additional URL parameters are required. The carrier account object—including the type field specifying the carrier (e.g., FedExAccount, UPSAccount) and a credentials object containing carrier-specific authentication fields—is provided via the Nexset record in the request body.
Required credential fields vary by carrier. Refer to the EasyPost carrier accounts documentation for the specific fields required for each supported carrier.
Updates the credentials or settings of an existing Carrier Account in your EasyPost account. Use this endpoint when a carrier's authentication credentials change or when you need to update account configuration details.
Enter the unique identifier of the carrier account to update in the Carrier Account ID field. EasyPost carrier account IDs follow the format ca_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
The request body should include only the fields to be updated, such as credentials or description. Fields not included in the request will not be changed.
Creates an End Shipper record in EasyPost, representing a third-party entity on whose behalf shipments are purchased. End Shippers are used by platforms and marketplaces that need to purchase labels on behalf of their own seller or merchant customers while complying with carrier regulations.
No additional URL parameters are required. The End Shipper object—containing the third-party's name, company, street1, city, state, zip, country, phone, and email—is provided via the Nexset record in the request body.
Once created, the End Shipper ID can be referenced in future Buy Shipment calls using the end_shipper_id field.
Updates the address or contact details of an existing End Shipper record in your EasyPost account. Use this endpoint when a third-party shipper's contact information or address has changed and needs to be reflected in future label purchases.
Enter the unique identifier of the End Shipper to update in the End Shipper ID field. EasyPost End Shipper IDs follow the format es_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
The request body should include the updated address or contact fields. Note that all address fields are required even for partial updates—supply the complete updated address object.
EasyPost destinations can also be manually configured to send data to any valid EasyPost API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
All EasyPost API endpoints use the base URL https://api.easypost.com/v2 followed by the resource path (e.g., /shipments, /addresses, /trackers, /batches). Most EasyPost write operations use POST to create new resources, while update operations use PUT and require the resource ID to be appended to the URL path. EasyPost accepts JSON (application/json) for all API requests, and Nexla can automatically send the API response after each call to a new Nexla webhook data source to capture created resource IDs, tracking codes, or label URLs.
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured EasyPost endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to the EasyPost API until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
