eHub

API Reference

API Versioning

Authentication

Accounts

Test

A successful pong will indicate that eHub is up and running

Ping

Rates

Quickly retrieve rates for your connected carrier accounts. You can filter based on service or carrier. Include as much information as possible for the most accurate results.

Rate Request

Create, update, retrieve, and cancel shipments.

Shipments

Guides for eHub's Shipment Functionality

Create a shipment in the system and ship it all at once. You will buy and get a label from this endpoint.

Create and Ship a Shipment

Create multiple shipments in the system and ship them all at once. This endpoint will buy and return labels. Maximum number of shipments in the request body is 10.

Create and Ship Multiple Shipments

Retrieve a Shipment

Cancel a shipment that has been created. This will void the label. If the label is still received by the carrier and scanned, your account will still be charged. Since USPS is prepay they will hold funds for 30 days to confirm the label was not used before issuing a refund. If you need to cancel a shipment that has already been shipped, you will need to contact the carrier directly.

Cancel a Shipment

Search for a list of shipments based on the provided filters.

List Shipments

Validate an address

GDE shipments can have long periods of time between label creation and being inducted into the USPS postal stream. To keep your customers informed, this endpoint will allow you to create tracking events for the shipment to show package movement to your customer.\n\n Only tracking events for USPS tracking codes 80, 81, and 82 are supported.

Create Tracking Events for a Shipment

GDE shipments can have long periods of time between label creation and being inducted into the USPS postal stream. To keep your customers informed, this endpoint will allow you to create tracking events for multiple shipments to show package movement to your customer.\n\n Only tracking events for USPS tracking codes 80, 81, and 82 are supported.

Create Tracking Events for Multiple Shipments

Manage batches, manifests, and end of day scan forms.

Batches and Manifests

List Shipment Batches

Use this endpoint to generate a daily manifest or scan form. Some carriers have up to a 15 minute delay generating the physical file. If a pdf isn't returned in the response but it was successful, wait a few minutes and try a GET. Only include shipment_ids for a single carrier at a time.

Create a Shipments Batch

Creates a separate batch for each shipping service provider that supports daily batches. Shipments that are already part of a batch are not included.

Create Batches for a Specific Date

Retrieve a Batch

Pickups

List Pickups

Check Pickup Availability for Location

Request a New Pickup

Retrieve a Scheduled Pickup

Cancel a Pickup

Retrieve orders, order updates, and mark orders shipped in their eCommerce system.

Order Stores

Use this endpoint to list of all the order stores connected to your eHub account.

List Order Stores

Retrieve a list of orders for a specific order store. The status filter allows you to filter by the order's shipment_status.

List Orders From an Order Store

Retrieve a single order for an order store. You must provide the order_number.

Retrieve an Order From an Order Store

Marks the order as shipped/fulfilled. Some integrations allow us to mark the order fulfilled in the e-commerce system and send across shipment information. Check the order store in the eHub portal to see if this functionality is supported.

Ship an Order

Marks the order shipment as not shipped/fulfilled. Some integrations allow us to mark the order unfulfilled in the e-commerce system. Check the order store in the eHub portal to see if this functionality is supported.

Cancel an Order's Shipment

This endpoint allows you to create orders saved to eHub's database. This is only allowed with "Custom" order stores.

Create Custom Orders

This endpoint allows you to update an order saved to eHub's database. This is only allowed with "Custom" order stores created with the POST endpoint. You must provide the order_number

Update a Custom Order

See what services your account has access to.

Services

Get a list of services and their IDs. service_id is a required field when trying to create a shipping label.

Retrieve Services

Find out zone information for a USPS service when you provide the to and from postal codes.

Find Zone

Check the status of connected carrier APIs.

Status

See the status of connected carrier services.

Service Statuses

Get reports about meter transactions and shipment adjustments.

Reports

When the Post Office finds discrepancies from the information reported to them when generating the label and the physical package they will create adjustments to refund or charge your meter. This report will show you the adjustments the USPS has reported for your shipments.

Shipment Adjustments

Meter Transactions

Subscribe to webhooks to receive notifications about tracking events or payment statuses.

Webhook Subscriptions

List Subscriptions

### Tracking event payload example
```
{
  "subscription_type": "shipment_tracking",
  "status": "active",
  "payload": [
    {
      "shipment_id": 115,
      "tracking_number": "9400109205328003425036",
      "tracking_event_id": 539,
      "parcel_id": 115,
      "code": "01",
      "secondary_code": "01",
      "description": "Delivered, In/At Mailbox",
      "event_timestamp": "2018-11-13T00:00:00.000Z",
      "city": "New Oceane",
      "state": "CA",
      "postal_code": "34668-2801",
      "country": "US"
    },
    {
      "shipment_id": 115,
      "tracking_number": "9400109205328003425036",
      "tracking_event_id": 540,
      "parcel_id": 115,
      "code": "OF",
      "secondary_code": null,
      "description": "Out for Delivery",
      "event_timestamp": "2018-11-12T19:00:24.000Z",
      "city": "Lake Jett",
      "state": "LA",
      "postal_code": "91251-7728",
      "country": "US"
    }
  ]
}
```

**code** and **secondary_code** vary by carrier. For USPS the codes are documented in Publication 199, Appendix G-4 (https://postalpro.usps.com/impbimplementationguide).


### Payment status event payload example
```
{
  "subscription_type": "payment_status",
  "payload": [
    {
      "payment_method_id": 0,
      "payment_transaction_id": 0,
      "gateway_txn_reference": "string",
      "transaction_time": "2020-05-14T15:56:58.550Z",
      "amount": 0,
      "type": "string",
      "status": "string"
    }
  ]
}
```


Create a Subscription

Update a Subscription

Retrieve a Subscription

Delete a Subscription

Payment Methods

List Payment Methods

Create a New Payment Method

Update a Payment Method

Retrieve a Payment Method

Customers

List Customers

Retrieve a Customer

Default

eHub API

Token

Production

Sandbox

<h3 class="slate-h3 " >Introduction</h3><p class="slate-p " >eHub is built to help systems optimize order fulfillment with powerful API functionality. Key features include checking shipping rates, purchasing labels, generating manifests, and consolidating orders from multiple ecommerce platforms.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h3 class="slate-h3 " >API Overview</h3><p class="slate-p " >The eHub API follows REST principles, making it accessible and easy to use through standard HTTP methods. This guide will walk you through available endpoints, request and response formats, and best practices to help you get the most out of the API.</p><h3 class="slate-h3 " ></h3><h3 class="slate-h3 " >Supported Request Body Content Types</h3><p class="slate-p " >The eHub API supports multiple content types for request bodies, ensuring flexibility and compatibility with different data formats. Ensure the Content-Type header in your requests matches the format of your request body.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Accepted Content Types:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">application/json</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">application/xml</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">application/x-www-form-urlencoded</code></div></li></ul></li></ul><p class="slate-p " >Depending on the endpoint, the required content type may vary.  Check the corresponding endpoint documentation for correct usage.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Rate Limiting and Throttling</h3><p class="slate-p " >The eHub API is optimized to handle high volumes of requests with minimal rate limiting or throttling. </p><p class="slate-p " >While no strict caps are enforced, for optimal performance, it's recommended to limit parallel requests to a maximum of 10 per API token. Following this guideline helps ensure efficient operation and system reliability.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " >By following these guidelines, you can ensure the best performance and reliability when using the eHub API.</p><p class="slate-p " ></p><p class="slate-p " ></p>

eHub is built to help systems optimize order fulfillment with powerful API functionality. Key features include checking shipping rates, purchasing labels, generating manifests, and consolidating orders from multiple ecommerce platforms.

The eHub API follows REST principles, making it accessible and easy to use through standard HTTP methods. This guide will walk you through available endpoints, request and response formats, and best practices to help you get the most out of the API.

The eHub API supports multiple content types for request bodies, ensuring flexibility and compatibility with different data formats. Ensure the Content-Type header in your requests matches the format of your request body.

Depending on the endpoint, the required content type may vary.  Check the corresponding endpoint documentation for correct usage.

The eHub API is optimized to handle high volumes of requests with minimal rate limiting or throttling. 

While no strict caps are enforced, for optimal performance, it's recommended to limit parallel requests to a maximum of 10 per API token. Following this guideline helps ensure efficient operation and system reliability.

By following these guidelines, you can ensure the best performance and reliability when using the eHub API.

<p class="slate-p " >The eHub API uses versioning to maintain backward compatibility, allowing new features and updates to be introduced without disrupting existing integrations. Each version is embedded within the URL path, enabling developers to target specific API versions for their applications. </p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h3 class="slate-h3 " >Current Version</h3><p class="slate-p " >The latest available version is <strong class="slate-bold">v2</strong>. You can access this version by appending the following path to the base URL:</p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block" data-content=''><code class="language- keep-markup drop-tokens"><div class="slate-code_line">/api/v2/</div></code></pre></div><p class="slate-p " >For example, API request URL would look something like this:</p><p class="slate-p " ><code class="slate-code">https://api.ehub.com/api/v2/{specific_endpoint}</code></p><p class="slate-p " ></p><h3 class="slate-h3 " >Versioning Strategy</h3><p class="slate-p " >When a new version is released, the previous version remains available to ensure the continuity of your current integration. This approach allows flexibility to upgrade to the latest version when you're ready, allowing you to leverage new features and improvements without disrupting your existing processes. </p><p class="slate-p " ></p>

The eHub API uses versioning to maintain backward compatibility, allowing new features and updates to be introduced without disrupting existing integrations. Each version is embedded within the URL path, enabling developers to target specific API versions for their applications. 

. You can access this version by appending the following path to the base URL:

For example, API request URL would look something like this:

https://api.ehub.com/api/v2/{specific_endpoint}

When a new version is released, the previous version remains available to ensure the continuity of your current integration. This approach allows flexibility to upgrade to the latest version when you're ready, allowing you to leverage new features and improvements without disrupting your existing processes. 

All requests to the eHub API require authentication via Bearer Token, referred to as an API key in this documentation. each user receives a unique API key, ensuring individual access. If multiple users have API access within the same account, each user will have their own API key.

To be assigned an API key, your user account must have the 

. To view the API keys for other users within the eHub account, your account must have the 

You can copy the API key with one click using the copy button to the right of the key.

Once you have obtained your API key, include it in the 

 header of your HTTP requests. The token must be prefixed with the word 

 followed by a space, formatted like this:

<p class="slate-p " ></p><p class="slate-p " >eHub offers a flexible <strong class="slate-bold">parent-child account structure</strong> that enables users with the appropriate permissions on a parent account to make API requests on behalf of child accounts. This is particularly advantageous for businesses such as 3PLs that manage multiple customers, each with its own shipping carriers and eCommerce platform integrations.</p><p class="slate-p " ></p><h2 class="slate-h2 " ><strong class="slate-bold">API Request Using Parent-Child Relationship</strong></h2><p class="slate-p " ></p><p class="slate-p " >By leveraging the parent-child relationship, the parent account can make API requests on behalf of the child account using <strong class="slate-bold">the parent account's API key</strong>, but targeting the <strong class="slate-bold">child account's unique ID</strong>. This avoids the hassle of managing multiple API keys for each child account. </p><p class="slate-p " ></p><h2 class="slate-h2 " ><strong class="slate-bold">Benefits of the Parent-Child Structure</strong></h2><p class="slate-p " ></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Separation of Data</strong>: Each child account maintains its own set of connections and data, keeping customer-specific data isolated.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Centralized Management</strong>: The parent account can easily manage all child accounts using a single API key.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Simplified API Requests</strong>: You can execute API requests for child accounts by simply specifying the child account's ID.</div></li></ul><p class="slate-p " ></p><h2 class="slate-h2 " ><strong class="slate-bold">Endpoints Available for Parent-Child API Requests</strong></h2><p class="slate-p " ></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><a href="rates" target="_top">Rates</a></div></li><li class="slate-li " ><div style="position:relative"><a href="shipments" target="_top">Shipments</a></div></li><li class="slate-li " ><div style="position:relative"><a href="order-stores" target="_top">Order Stores</a></div></li></ul><p class="slate-p " ></p><h2 class="slate-h2 " ><strong class="slate-bold">Use Case Example</strong></h2><p class="slate-p " ></p><p class="slate-p " >For instance, if your customer "Child Company A" uses <strong class="slate-bold">WooCommerce</strong> and has its own <strong class="slate-bold">UPS</strong> shipping account, you can set up a child account in eHub specifically for that customer. This ensures that <strong class="slate-bold">all of the data and integrations remain exclusive</strong> to that child account, creating a clean separation between different customer setups.</p><p class="slate-p " ></p><p class="slate-p " >If the child account's customer ID is <strong class="slate-bold">452</strong>, then the parent would make their API request like this: </p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">CURL</div><pre class="slate-CodeBlockElement slate-code_block" data-content=''><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">curl --request GET \</div><div class="slate-code_line">	--url https://api.ehub.com/api/v2/cusotmers/452/order_stores \</div></code></pre></div><p class="slate-p " >The response to this request will show all eCommerce integration connections for child customer 452.</p>

 that enables users with the appropriate permissions on a parent account to make API requests on behalf of child accounts. This is particularly advantageous for businesses such as 3PLs that manage multiple customers, each with its own shipping carriers and eCommerce platform integrations.

API Request Using Parent-Child Relationship

By leveraging the parent-child relationship, the parent account can make API requests on behalf of the child account using 

. This avoids the hassle of managing multiple API keys for each child account. 

Endpoints Available for Parent-Child API Requests

For instance, if your customer "Child Company A" uses 

 shipping account, you can set up a child account in eHub specifically for that customer. This ensures that 

all of the data and integrations remain exclusive

 to that child account, creating a clean separation between different customer setups.

, then the parent would make their API request like this: 

The response to this request will show all eCommerce integration connections for child customer 452.

<p class="slate-p " ></p><h3 class="slate-h3 " >Ping-Pong Test</h3><p class="slate-p " ></p><p class="slate-p " >The Ping Pong Test is a straightforward method used to check the health and availability of an API or system. By sending a "ping" request, the client asks the server if it's operational. If the server is functioning properly, it responds with a "pong." This lightweight request-response mechanism allows for quick diagnostics to confirm that the API is up and running.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Benefits of the Ping Pong Test:</h3><p class="slate-p " ></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">System Health Checks</strong>: Ensures the API is operational.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Connectivity Tests</strong>: Verifies successful communication between the client and server.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Troubleshooting</strong>: Quickly identifies whether an issue is related to system downtime or connectivity problems.</div></li></ul><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " >For eHub, the Ping Pong Test helps users ensure the API is online and responsive before moving forward with more complex API calls.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The Ping Pong Test is a straightforward method used to check the health and availability of an API or system. By sending a "ping" request, the client asks the server if it's operational. If the server is functioning properly, it responds with a "pong." This lightweight request-response mechanism allows for quick diagnostics to confirm that the API is up and running.

For eHub, the Ping Pong Test helps users ensure the API is online and responsive before moving forward with more complex API calls.

<p class="slate-p " ></p><p class="slate-p " >A successful pong will indicate that eHub is up and running</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

ping

<p></p><p>To successfully retrieve rates, you must provide key details. While the shipament object can include additional parameters, the following example highlights the minimum information required to generate accurate rates. The more specific your shipment details are, the more precise your rate results will be. For more information, please refer to the <a href="rates/rate-request" target="_self"><strong>Rate Request</strong></a> page for</p>

To successfully retrieve rates, you must provide key details. While the shipament object can include additional parameters, the following example highlights the minimum information required to generate accurate rates. The more specific your shipment details are, the more precise your rate results will be. For more information, please refer to the 

A request containing only this data will return rates for all enabled services your account qualifies for.  For example, FedEx Ground and FedEx Home Delivery will not return for the same shipment since they are mutually exclusive depending on whether the destination (to_location) is residential or commercial.

If you wish to narrow the results, you can include one of the following parameters within the shipment object.

You can specify desired services using the 

 field, an array containing service IDs. The service IDs can be either an integer or a string that represents the ID of the service you want to retrieve rates for.

Including this array in your request will limit the response to rates for USPS Ground Advantage and USPS Parcel Select only.

To include services from specific carriers only, use the 

To exclude services from specific carriers, use the 

If you omit filtering parameters, all available services will be available for the given shipment, as no specific services or carriers are excluded.

If there are any issues retrieving rates, warnings or error messages from the carrier's API will be relayed back and stored in the 

  array of the response body. This allows for a successful response even if one carrier encounters an issue while others return rates successfully.

To receive FedEx OneRate rates, you need to specify both the eligible package type and service based on the contract in the rating or shipment request. Follow these steps:

In the response, find the service object relevant to the FedEx service that qualifies for FedEx OneRate under the OneRate contract. The service is usually FedEx 2Day but may vary depending on the contract. 

 array to find the package type specific to the FedEx OneRate contract. Note the 

 should be set to the package type agreed upon in the FedEx OneRate contract, such as 

<p>Fill here with a summary of what can be done with eHub Shipment functionality.</p><p></p><div><hr /></div><p></p><h3>Guides for eHub's Shipment Functionality</h3><p></p><h3><a href="shipments/guides-for-ehub-s-shipment-functionality/domestic-shipping" target="_self"><strong>Domestic Shipping</strong></a></h3>

Fill here with a summary of what can be done with eHub Shipment functionality.

eHub's Shipment API provides a powerful and flexible platform for managing all aspects of your shipping operations. With this functionality, you can:

eHub’s Shipment functionality empowers businesses to streamline their shipping operations, manage high-volume orders, and ensure a smooth customer experience across domestic and international shipments.

<p></p><p>eHub's API offers powerful tools for managing and organizing shipment batches, allowing users to streamline end-of-day processes, manifest shipments, and ensure that all packages are ready for carrier pickup. Below is a high-level summary of the available features:</p><div><hr /></div><h3><a href="batches-and-manifests/list-shipment-batches" target="_self">1. </a></h3>

eHub's API offers powerful tools for managing and organizing shipment batches, allowing users to streamline end-of-day processes, manifest shipments, and ensure that all packages are ready for carrier pickup. Below is a high-level summary of the available features:

With this endpoint, users can access a comprehensive list of 

. This feature enables tracking and reviewing past shipment batches, ensuring that records are easily accessible for auditing or management purposes.

To manifest shipments, this endpoint allows customers to create a new batch, grouping together all shipments they want processed. By generating a batch, all related shipments are documented and prepared for pickup by the designated carriers.

This endpoint lets users create batches specifically for shipments scheduled on a particular date. It automatically includes all unmanifested shipments connected to the eHub account for that date, simplifying the batch creation process for time-sensitive deliveries.

If users need to view details of a previously created batch, this endpoint allows for easy retrieval of a batch's information. Whether for verification, troubleshooting, or record-keeping, retrieving a batch ensures transparency and accessibility of shipment data.

<p></p><p>The <strong>Pickups</strong> API endpoints allow users to manage the scheduling, retrieval, and cancellation of <strong>USPS</strong> pickups within the eHub system. These endpoints provide a seamless way to request and manage pickups for shipments, ensuring timely and efficient delivery processes. Whether you're scheduling a USPS pickup or checking availability, these endpoints cover the entire lifecycle of a pi</p>

 API endpoints allow users to manage the scheduling, retrieval, and cancellation of 

 pickups within the eHub system. These endpoints provide a seamless way to request and manage pickups for shipments, ensuring timely and efficient delivery processes. Whether you're scheduling a USPS pickup or checking availability, these endpoints cover the entire lifecycle of a pickup request.

The following endpoints enable users to create, retrieve, and cancel pickups, providing control over the logistics of moving shipments:

<p></p><p>eHub empowers users to connect a wide range of eCommerce services, which we refer to as <strong>Order Stores</strong>. These connections allow customers to seamlessly consolidate and manage orders through a Transportation Management System (TMS). Below is a summary of how Order Stores work and the endpoints available for managing orders within eHub's system.</p><p></p><h2>Order Store Integration</h2>

eHub empowers users to connect a wide range of eCommerce services, which we refer to as 

. These connections allow customers to seamlessly consolidate and manage orders through a Transportation Management System (TMS). Below is a summary of how Order Stores work and the endpoints available for managing orders within eHub's system.

 from connected eCommerce systems, as well as 

 back into those systems. This ensures a streamlined order management process from creation to shipping.

To view existing Order Stores or to add a new one, users can follow these steps:

 page, users can select the type of store they want to connect. The page will guide them through the connection process, which varies by store type—some use OAuth 2.0, while others require keys, URLs, or tokens. The page also shows a table listing the 

 for each store type, as not all stores support full eHub functionality. Clicking 

It is not possible to successfully interact with the Order endpoints without first specifying the Order Store in the request URL. Therefore we have the List Order Stores endpoint to retrieve all the store connections you have created through your eHub account and their IDs. You will specify the store ID in your request URL.

To interact with Order Stores, you need to retrieve their details using the 

 endpoint, which shows all connected stores and their unique IDs. These IDs will be used in requests to perform actions on specific stores. Below are the key endpoints available:

, which are useful for integrating custom software platforms with eHub’s Order Store API. This allows for the storage and management of custom order data that can be accessed by partner software, such as eHub Ship. Custom Order Stores must be created in the eHub portal before using their associated endpoints.

<p></p><h2>1. Provider/Service Information</h2><p></p><p>When interacting with eHub’s shipment services, two primary fields are essential:</p><ul><li><div><strong>service_id</strong>: An integer that helps identify the service and is required when creating a shipment.</div></li><li><div></div></li></ul>

When interacting with eHub’s shipment services, two primary fields are essential:

2. USPS Zone Information: Find Zone Endpoint

The Find Zone endpoint helps retrieve USPS zone information based on the provided "to" and "from" postal codes. This is essential for determining the shipping zone for a specific USPS service depending on the origin and destination locations.

<p></p><p>This page provides information on how to retrieve the current status of USPS carrier services connected to your eHub account. </p><p>By using the provided endpoint, you can monitor the real-time status of USPS services, ensuring that your shipping operations remain efficient and uninterrupted. </p><p>This tool is essential for tracking USPS service availability, helping to address any potential issues promptly.</p>

This page provides information on how to retrieve the current status of USPS carrier services connected to your eHub account. 

By using the provided endpoint, you can monitor the real-time status of USPS services, ensuring that your shipping operations remain efficient and uninterrupted. 

This tool is essential for tracking USPS service availability, helping to address any potential issues promptly.

<p>eHub provides a suite of robust reporting tools designed to help you effectively monitor and manage your shipping activities. These reports offer insights into postage meter transactions, shipment adjustments, and potential discrepancies, providing the transparency needed for smooth and efficient shipping operations.</p><div><hr /></div><p></p><h3></h3>

eHub provides a suite of robust reporting tools designed to help you effectively monitor and manage your shipping activities. These reports offer insights into postage meter transactions, shipment adjustments, and potential discrepancies, providing the transparency needed for smooth and efficient shipping operations.


Retrieve detailed information about your postage meter transactions, including purchases, usage, refunds, and current balances. This report ensures you maintain a close watch on your postage usage and balance for optimal financial management.


Track any discrepancies reported by USPS between the information provided during label creation and the physical package received. This report highlights adjustments made by USPS, whether they result in a refund or additional charge.

These reports are essential for maintaining accurate records of your postage usage and adjustments, ensuring transparency and efficiency in your shipping operations.

<p>eHub allows you to subscribe to webhooks to receive real-time notifications about shipment tracking events and payment statuses. These webhooks ensure that you stay informed and can automate workflows based on the latest updates from your shipments and payments.</p><div><hr /></div><h2><strong>Subscription Types</strong></h2><p></p>

eHub allows you to subscribe to webhooks to receive real-time notifications about shipment tracking events and payment statuses. These webhooks ensure that you stay informed and can automate workflows based on the latest updates from your shipments and payments.

Webhooks can return the following statuses:

Note: After 5 consecutive failed responses from the receiving system the webhook will automatically be updated to have a disabled status.

If a webhook request times out (fails to receive a successful response within 30 seconds), it will be marked as disabled after consecutive failures. You can avoid this by saving the payload locally, responding with success, and then processing the payload asynchronously.

 vary by carrier. For USPS the codes are documented in Publication 199, Appendix G-4 (

By subscribing to webhooks, you gain visibility into important shipment and payment activities, enabling you to take immediate action as needed.

<p>The payment method endpoints allow you to create, update, and view the payment methods associated with your account. You'll be able to see if any are set to expire and identify which one is the default payment method on file.</p><p></p><p>eHub provides a comprehensive set of endpoints to manage your payment methods efficiently. Whether you need to list all payment methods, create a new one, update existing details, retrieve specific inform</p>

The payment method endpoints allow you to create, update, and view the payment methods associated with your account. You'll be able to see if any are set to expire and identify which one is the default payment method on file.

eHub provides a comprehensive set of endpoints to manage your payment methods efficiently. Whether you need to list all payment methods, create a new one, update existing details, retrieve specific information, or delete a payment method, these tools ensure smooth payment operations and financial management. Below are the key functionalities available for managing payment methods.

Use this endpoint to retrieve a list of all payment methods associated with your eHub account. It provides details such as account numbers, billing information, payment types, and default status.

This endpoint allows you to add a new payment method to your eHub account. Specify billing location, account type, and other necessary details to integrate a new payment method.

If you need to modify details of an existing payment method, such as updating billing information or changing the default status, this endpoint allows you to update the necessary fields without recreating the payment method.