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

Orchestrate

Create Order, Rate Shop and Ship

Rate Shop and Ship an existing Order

Rate Shop and Ship a Shipment

Default

eHub API

Token

Production

Sandbox

Additional Tips

Domestic Shipping

International Shipping

Tracking

<p class="slate-p " >The payment method endpoints allow you to create, update, and view the payment methods associated with your account. You&apos;ll be able to see if any are set to expire and identify which one is the default payment method on file.</p><p class="slate-p " ></p><p class="slate-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 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.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h2 class="slate-h2 " >Payment Methods Endpoints</h2><p class="slate-p " ></p><h1 class="slate-h1 " ><a href="66a7c81ff9d1d947f54084c3/66a7c81ff9d1d947f54084c5" target=""><strong class="slate-bold">List All Payment Methods</strong></a></h1><p class="slate-p " >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.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Method</strong>: <code class="slate-code">GET /api/v2/payment_methods</code></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Use Case</strong>: Quickly view and manage all the payment methods available under your account for review or updates.</div></li></ul><h2 class="slate-h2 " ></h2><h2 class="slate-h2 " ><a href="66a7c81ff9d1d947f54084c3/66a7c81ff9d1d947f54084c7" target=""><strong class="slate-bold">Create a New Payment Method</strong></a></h2><p class="slate-p " >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.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Method</strong>: <code class="slate-code">POST /api/v2/payment_methods</code></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Use Case</strong>: Add a new credit card, ACH, or other payment method to your account to ensure uninterrupted payment processing.</div></li></ul><p class="slate-p " ></p><h2 class="slate-h2 " ><a href="payment-methods/update-a-payment-method" target="_top"><strong class="slate-bold">Update a Payment Method</strong></a></h2><p class="slate-p " >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.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold"> Method</strong>: <code class="slate-code">PUT /api/v2/payment_methods/{id}</code></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Use Case</strong>: Keep your payment methods up-to-date, such as updating expiry dates or modifying billing addresses, without creating a new payment method.</div></li></ul><p class="slate-p " ></p><h2 class="slate-h2 " ><a href="66a7c81ff9d1d947f54084c3/66a7c81ff9d1d947f54084cd" target=""><strong class="slate-bold">Retrieve a Payment Method</strong></a></h2><p class="slate-p " >This endpoint allows you to retrieve detailed information for a specific payment method using its unique ID. It is useful when you need to review a specific account&apos;s details, such as payment type, billing location, or account number.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Method</strong>: <code class="slate-code">GET /api/v2/payment_methods/{id}</code></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Use Case</strong>: Get detailed information about a single payment method, such as verifying the billing address or checking the account number on file.</div></li></ul><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Summary</h2><p class="slate-p " ></p><p class="slate-p " >The Payment Methods API gives you full control over managing the financial aspects of your eHub account, from adding new payment methods to updating or retrieving existing ones. By using these tools, you can ensure your payment processes are efficient, secure, and up-to-date.</p><p class="slate-p " ></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.

This endpoint allows you to retrieve detailed information for a specific payment method using its unique ID. It is useful when you need to review a specific account's details, such as payment type, billing location, or account number.

The Payment Methods API gives you full control over managing the financial aspects of your eHub account, from adding new payment methods to updating or retrieving existing ones. By using these tools, you can ensure your payment processes are efficient, secure, and up-to-date.

<p class="slate-p " ></p><p class="slate-p " >The <strong class="slate-bold">Create a New Payment Method</strong> endpoint enables you to securely add a new payment method to your eHub account. This allows for flexibility in managing various payment methods such as ACH or credit cards, ensuring smooth transactions and payment processing for your shipments.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

 endpoint enables you to securely add a new payment method to your eHub account. This allows for flexibility in managing various payment methods such as ACH or credit cards, ensuring smooth transactions and payment processing for your shipments.

Sections

Create a New Payment Method

Body Parameters

Response

Response Attributes

Response

Sections

Create a New Payment Method

Body ParametersExpand all

ResponseExpand all

Response Attributes

Response

Body Parameters

Response