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 " ></p><p class="slate-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 class="slate-bold">Rate Request</strong></a> page for more details and parameters.</p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Minimum Shipment Details (JSON Example)</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">   &quot;shipment&quot;:{</div><div class="slate-code_line">      &quot;to_location&quot;:{</div><div class="slate-code_line">         &quot;first_name&quot;:&quot;string&quot;, // or company</div><div class="slate-code_line">         &quot;address1&quot;:&quot;string&quot;,</div><div class="slate-code_line">         &quot;city&quot;:&quot;string&quot;,</div><div class="slate-code_line">         &quot;state&quot;:&quot;string&quot;, // for a US state use the two-digit state code</div><div class="slate-code_line">         &quot;country&quot;:&quot;string&quot;, // two-digit country code</div><div class="slate-code_line">         &quot;postal_code&quot;:&quot;string&quot;,</div><div class="slate-code_line">         &quot;phone&quot;:&quot;string&quot;</div><div class="slate-code_line">      },      </div><div class="slate-code_line">      &quot;from_location&quot;:{</div><div class="slate-code_line">         &quot;company&quot;:&quot;Test Test&quot;, // or first_name</div><div class="slate-code_line">         &quot;address1&quot;:&quot;string&quot;,</div><div class="slate-code_line">         &quot;city&quot;:&quot;string&quot;,</div><div class="slate-code_line">         &quot;state&quot;:&quot;string&quot;,</div><div class="slate-code_line">         &quot;country&quot;:&quot;string&quot;,</div><div class="slate-code_line">         &quot;postal_code&quot;:&quot;string&quot;,</div><div class="slate-code_line">         &quot;phone&quot;:&quot;string&quot;</div><div class="slate-code_line">      },</div><div class="slate-code_line">      &quot;parcels&quot;:[</div><div class="slate-code_line">         {</div><div class="slate-code_line">            &quot;length&quot;:6.0, // inches</div><div class="slate-code_line">            &quot;width&quot;:2.0, // inches</div><div class="slate-code_line">            &quot;height&quot;:2.0, // inches</div><div class="slate-code_line">            &quot;weight&quot;:36.0, // ounces</div><div class="slate-code_line">            &quot;package_type&quot;:&quot;string&quot;,</div><div class="slate-code_line">         }</div><div class="slate-code_line">      ]</div><div class="slate-code_line">   }</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " >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.</p><p class="slate-p " >If you wish to narrow the results, you can include one of the following parameters within the shipment object.</p><p class="slate-p " ></p><p class="slate-p " ></p><h2 class="slate-h2 " >Service Filters</h2><p class="slate-p " >You can specify desired services using the <code class="slate-code">include_services</code> 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.</p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Service Filter Example (JSON)</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">	&quot;include_services&quot;: [</div><div class="slate-code_line">		1172, // USPS Ground Advantage</div><div class="slate-code_line">		&quot;686&quot; // USPS Parcel Select</div><div class="slate-code_line">	]</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " >Including this array in your request will limit the response to rates for USPS Ground Advantage and USPS Parcel Select only.</p><p class="slate-p " ></p><p class="slate-p " ></p><h2 class="slate-h2 " >Carrier Filters</h2><p class="slate-p " >To include services from specific carriers only, use the <code class="slate-code">include_carriers</code> field:</p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Carrier Filter Example (JSON)</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{
  &quot;include_carriers&quot;: [
    &quot;usps&quot;,
    &quot;fed_ex&quot;,
    &quot;dhl_ecommerce&quot;
  ]
}</div></code></pre></div><p class="slate-p " >To exclude services from specific carriers, use the <code class="slate-code">exclude_carriers</code> field:</p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Exclude Carrier Example (JSON)</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{
  &quot;exclude_carriers&quot;: [
    &quot;ups&quot;,
    &quot;dhl_express&quot;
  ]
}</div></code></pre></div><p class="slate-p " >If you omit filtering parameters, all available services will be available for the given shipment, as no specific services or carriers are excluded.</p><p class="slate-p " ></p><h2 class="slate-h2 " >Warnings</h2><p class="slate-p " >If there are any issues retrieving rates, warnings or error messages from the carrier&apos;s API will be relayed back and stored in the <code class="slate-code">warnings</code>  array of the response body. This allows for a successful response even if one carrier encounters an issue while others return rates successfully.</p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Warning Example (JSON)</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{
  &quot;warnings&quot;: [
    &quot;FedEx returned error: Destination postal code missing or invalid&quot;
  ]
}</div></code></pre></div><p class="slate-p " ></p><h2 class="slate-h2 " >How to Get FedEx OneRate Rates</h2><p class="slate-p " ></p><p class="slate-p " >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:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Make a</strong> <code class="slate-code">GET /services</code> <strong class="slate-bold">Call</strong></div></li></ol><p class="slate-p " >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. </p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Example</strong> <code class="slate-code">GET /services</code> <strong class="slate-bold">Response:</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">   &quot;services&quot;: [</div><div class="slate-code_line">      ...</div><div class="slate-code_line">      {</div><div class="slate-code_line">         &quot;service_id&quot;: 393, // &lt;------</div><div class="slate-code_line">         &quot;service&quot;: &quot;FEDEX_2_DAY&quot;,</div><div class="slate-code_line">         &quot;service_code&quot;: &quot;fedex_2day&quot;,</div><div class="slate-code_line">         &quot;carrier_code&quot;: &quot;fed_ex&quot;,</div><div class="slate-code_line">         &quot;category&quot;: &quot;shipping&quot;,</div><div class="slate-code_line">         &quot;package_types&quot;: [</div><div class="slate-code_line">            {</div><div class="slate-code_line">               &quot;type&quot;: &quot;fedex_pak&quot;, // &lt;------</div><div class="slate-code_line">               &quot;name&quot;: &quot;FedEx Pak&quot;</div><div class="slate-code_line">            }</div><div class="slate-code_line">         ],</div><div class="slate-code_line">         &quot;sort_order&quot;: null</div><div class="slate-code_line">      }</div><div class="slate-code_line">      ...</div><div class="slate-code_line">   ]</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " >In the service object, check the <code class="slate-code">package_types</code> array to find the package type specific to the FedEx OneRate contract. Note the <code class="slate-code">services[i].package_types[i].type</code>, as it will be needed later.</p><div class="slate-code_line"></div><p class="slate-p " ><strong class="slate-bold">2. Use the</strong> <code class="slate-code">service_id</code> <strong class="slate-bold">and</strong> <code class="slate-code">package_type</code> <strong class="slate-bold">in the Rating Request</strong></p><p class="slate-p " >The <code class="slate-code">shipments.parcels[i].package_type</code> should be set to the package type agreed upon in the FedEx OneRate contract, such as <code class="slate-code">fedex_pak</code></p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Example Rating Request:</strong></h3><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">   &quot;shipment&quot;: {</div><div class="slate-code_line">      &quot;to_location&quot;: {...},</div><div class="slate-code_line">      &quot;return_location&quot;: {...},</div><div class="slate-code_line">      &quot;from_location&quot;: {...},</div><div class="slate-code_line">      &quot;parcels&quot;: [</div><div class="slate-code_line">         {</div><div class="slate-code_line">            &quot;length&quot;: 2.0,</div><div class="slate-code_line">            &quot;width&quot;: 2.0,</div><div class="slate-code_line">            &quot;height&quot;: 2.0,</div><div class="slate-code_line">            &quot;weight&quot;: 3.0,</div><div class="slate-code_line">            &quot;package_type&quot;: &quot;fedex_pak&quot;, // &lt;------</div><div class="slate-code_line">            &quot;parcel_items&quot;: [...]</div><div class="slate-code_line">         }</div><div class="slate-code_line">      ],</div><div class="slate-code_line">      &quot;include_services&quot;: [393] // &lt;------ fedex_2day</div><div class="slate-code_line">   }</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " ></p><p class="slate-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 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 class="slate-p " ></p><p class="slate-p " >Quickly retrieve rates from your connected carrier accounts. Filter by service or carrier, and provide detailed shipment information for the most accurate results.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p>

Quickly retrieve rates from your connected carrier accounts. Filter by service or carrier, and provide detailed shipment information for the most accurate results.

Sections

Rate Request

Body Parameters

Response

Response Attributes

Response

Sections

Rate Request

Body ParametersExpand all

ResponseExpand all

Response Attributes

Response

Body Parameters

Response