Skip to main content

EasyPost Data Source

The EasyPost connector enables you to ingest shipping data—including shipments, addresses, parcels, trackers, orders, and insurance claims—directly into Nexla data flows. Follow the instructions below to create a new data flow that ingests data from an EasyPost source in Nexla.
easypost_api.png

EasyPost

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the EasyPost connector tile from the list of available connectors. 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.

  3. In Nexla, EasyPost data sources can be created using pre-built endpoint templates, which expedite source setup for common EasyPost endpoints. Each template is designed specifically for the corresponding EasyPost endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    EasyPost sources can also be configured manually, allowing you to ingest data from EasyPost endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common EasyPost endpoints. Each template is designed specifically for the corresponding EasyPost endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

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.

For additional information about the EasyPost Addresses API, refer to the EasyPost Addresses documentation.

Retrieve Address

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.

For additional information about the EasyPost Addresses API, refer to the EasyPost Addresses documentation.

List Shipments

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.

For additional information about the EasyPost Shipments API, refer to the EasyPost Shipments documentation.

Retrieve Shipment

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.

For additional information about the EasyPost Shipments API, refer to the EasyPost Shipments documentation.

Retrieve Parcel

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.

For additional information about the EasyPost Parcels API, refer to the EasyPost Parcels documentation.

Retrieve Tracker

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.

For additional information about EasyPost Trackers, refer to the EasyPost Trackers documentation.

Get Order

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.

For additional information about the EasyPost Orders API, refer to the EasyPost Orders documentation.

Retrieve Claim

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.

For additional information about EasyPost Claims, refer to the EasyPost Claims documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

EasyPost data sources can be manually configured to ingest data from any valid EasyPost API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates—such as listing trackers, retrieving carrier accounts, or querying insurance records—or when you need custom API configurations.

With manual configuration, you can also create more complex EasyPost sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the EasyPost API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the EasyPost API (used for all read operations such as listing shipments, addresses, and trackers)
    • POST: For creating new EasyPost objects or triggering actions
    • PUT: For updating existing EasyPost objects

API Endpoint URL​

  1. Enter the URL of the EasyPost API endpoint from which this source will fetch data in the Set API URL field. All EasyPost API endpoints use the base URL https://api.easypost.com/v2 followed by the resource path.

    Some commonly used EasyPost source endpoints include:

    • https://api.easypost.com/v2/shipments — List all shipments
    • https://api.easypost.com/v2/addresses — List all addresses
    • https://api.easypost.com/v2/trackers — List all trackers
    • https://api.easypost.com/v2/insurances — List all insurance records
    • https://api.easypost.com/v2/batches — List all batches

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For a full reference of available EasyPost API endpoints, refer to the EasyPost API documentation.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for EasyPost endpoints that support date-range query parameters, enabling you to filter results to a specific time window on each data ingestion run.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful for EasyPost endpoints that require a specific ID in the path—for example, to retrieve a shipment using an ID stored in another Nexla data source.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the EasyPost API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response.

For example, EasyPost list endpoints typically return a top-level JSON object containing an array of records along with pagination metadata. By specifying a path such as $.shipments[*] or $.addresses[*], you can configure Nexla to treat each element in that array as an individual record rather than treating the entire response envelope as a single record.

Specifying the correct Path to Data is important for EasyPost list endpoints, as responses are wrapped in a top-level object. Without it, Nexla will treat the entire response (including pagination metadata) as a single record rather than individual resource objects.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.shipments[*] to access the shipments array in a List Shipments response).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data.

    Path to Data Example:

    For the EasyPost List Shipments endpoint, the response returns a JSON object with a top-level shipments array. To treat each shipment as an individual record, enter the path as $.shipments[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the EasyPost response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. For example, EasyPost list responses include pagination fields such as has_more and next_id at the top level. You can capture these values as metadata on each record by specifying a path to that section of the response.

Metadata paths are useful for preserving EasyPost pagination context, request identifiers, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for EasyPost API versioning or other customizations.

    You do not need to include any headers already present in the credentials. The EasyPost Authorization header is automatically handled by Nexla based on your credential configuration.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, 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.