• Documentation >
• Apps >
• Commerce >
• EasyPost

EasyPost

With EasyPost modules in Ibexa Connect, you can:

• retrieve, create, and verify addresses

• create, list, retrieve, buy, one-call buy a shipments

• create parcels

• create and buy a batch, create a batch label, add and remove shipments from a batch

• create custom info and items

• create, retrieve, and buy orders

• watch new events

To get started with EasyPost, create an account at easypost.com.

Connect EasyPost to Ibexa Connect

To connect EasyPost app, you need to obtain the Production API Key value from your EasyPost account and insert them in the EasyPost module scenario.

1. Log in to your EasyPost account.

2. Click Profile Name > API Keys. Copy the Production API Key to a safe place.

   

3. Log in to your Ibexa Connect account, insert an EasyPost module scenario, and click the Add button next to the Connection field.

   

4. In the Connection name field, enter a name for the connection.

5. In the Production API Key field, enter the details copied in step 2 and click Save.

You have successfully established the connection. You can now begin editing your scenario and adding more EasyPost modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Addresses

You can retrieve, create and verify addresses using the following modules.

Get an Address

Retrieves an existing address.

Address ID	Select or map the Address ID whose details you want to retrieve.

Create and Verify an Address

Creates a new address and verifies it.

For field descriptions, see the EasyPost Addresses API reference.

Shipments

You can create, list, retrieve, buy, and one-call buy shipments using the following modules.

List Shipments

Retrieves a shipments list.

Limit	Set the maximum number of shipments Ibexa Connect will return during one execution cycle. The default value is 10.

For field descriptions, see the EasyPost Shipments API reference.

Get a Shipment

Retrieves an existing shipment.

Shipment ID	Select or map the Shipment ID whose details you want to retrieve.

Create a Shipment

Creates a new shipment.

For field descriptions, see the EasyPost Shipments API reference.

Buy a Shipment

Buys an existing shipment.

Shipment ID	Select or map the Shipment ID you want to buy.
Rate ID	Enter the Rate ID of the shipment to buy a shipment.
Insurance	Enter the insurance amount in rate currency.

One-Call Buy a Shipment

Buys a shipment without rating.

For field descriptions, see the EasyPost Shipments API reference.

Parcels

You can create parcels using the following modules.

Create a Parcel

Creates a new parcel.

For field descriptions, see the EasyPost Addresses API reference.

Batches

You can create and buy a batch, create a batch label, and add and remove shipments from a batch using the following modules.

Create a Batch

Creates a new batch.

For field descriptions, see the EasyPost Batches API reference.

Buy a Batch

Buys an existing batch of shipments.

Batch ID	Select or map the Batch ID whom you want to buy.

Create a Batch Label

Creates a label for an existing batch.

Batch ID	Select or map the Batch ID whose label you want to create.
File Format	Enter the file format of generated label.

Add Shipments to a Batch

Adds shipments to an existing batch.

Batch ID	Select or map a Batch ID whose shipments you want to add.
Shipment IDs	Enter the Shipment IDs of whom you want to add to a batch.

Remove Shipments from a Batch

Removes shipments from an existing batch.

Batch ID	Select or map a Batch ID whose shipments you want to remove.
Shipment IDs	Enter the Shipment IDs of whom you want to remove from a batch.

Custom

You can create custom info and items using the following modules.

Create a Customs Info

Creates new customs information.

For field descriptions, see the EasyPost Custom API reference.

Create a Customs Item

Creates a new customs item.

For field descriptions, see the EasyPost Custom API reference.

Orders

You can create, retrieve, and buy orders using the following modules.

Get an Order

Retrieves an existing order.

Order ID	Select or map the Order ID whose details you want to retrieve.

Create an Order

Creates a new order.

For field descriptions, see the EasyPost Orders API reference.

Buy an Order

Buys an existing order.

For field descriptions, see the EasyPost Orders API reference.

Events

You can watch new events using the following modules.

Watch New Event

Watches for a new event.

Note

Ibexa Connect automatically creates a webhook in EasyPost once you add an instant trigger to your scenario.

Webhook name	Enter a name for the webhook.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the EasyPost API documentation.

URL	Enter a path relative to https://api.easypost.com. For example, /v2/insurances.
Method	GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of use - List Batches

The following API call returns all batches from your account.

URL: /v2/batches

Method: GET

Matches of the search can be found in the module's Output under *Bundle > Body > batches. *

In our example 5 batches were returned: