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 " >Fill here with a summary of what can be done with eHub Shipment functionality.</p><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h3 class="slate-h3 " >Guides for eHub&apos;s Shipment Functionality</h3><p class="slate-p " ></p><h3 class="slate-h3 " ><a href="66a7c81ff9d1d947f54084cf/66d22453e0afc0ab4a75c81a/66d22460e0afc0ab4a75c86b" target=""><strong class="slate-bold">Domestic Shipping</strong></a></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Create a Shipment</strong>: Initiates a new domestic shipment by providing the destination, origin, parcel details, and selecting a shipping service.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Multi-Parcel Shipments</strong>: Supports splitting a shipment into multiple parcels. Multiple labels will be returned, each with different tracking numbers.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Label Customization</strong>: Customize the label format (jpeg, png, zpl, etc.), size (4x6, 8.5x11, etc.), and add custom text or images.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Cancel a Shipment</strong>: Cancel the shipment and void the label before it’s manifested by the carrier. If successful, the status will return as <code class="slate-code">cancel_pending</code>.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " ><a href="66a7c81ff9d1d947f54084cf/66d22453e0afc0ab4a75c81a/66d22469e0afc0ab4a75c8c0" target=""><strong class="slate-bold">International Shipping</strong></a></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Customs Information</strong>: When shipping internationally, you must include HS codes, EEL/PFC codes, and detailed customs data to comply with regulations.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Retrieve Customs PDF</strong>: Retrieve a customs document in PDF format, supported by certain carriers. Check for carrier availability of this feature.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " ><a href="66a7c81ff9d1d947f54084cf/66d22453e0afc0ab4a75c81a/66d2247ce0afc0ab4a75c923" target=""><strong class="slate-bold">Additional Tips</strong></a></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Dangerous Goods</strong>: Specify hazmat codes in the parcel object to handle hazardous materials. Each parcel can contain only one type of hazardous material.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Advanced Labeling Features</strong>: Create custom tracking events for GDE shipments to show package movement even with long periods between label creation and USPS induction.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Rates Overview</strong>: Retrieve simplified and organized rates for created shipments, with options to filter by carrier and service level.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " ><a href="66a7c81ff9d1d947f54084cf/66d22453e0afc0ab4a75c81a/66d22484e0afc0ab4a75c980" target=""><strong class="slate-bold">Tracking</strong></a></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Track Shipments</strong>: Retrieve tracking information manually via GET requests or set up a webhook for real-time updates.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Tracking Events</strong>: Create tracking events for GDE shipments to reflect package progress.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Retrieve Shipment Status</strong>: Check the status of shipments using eHub’s shipment ID.</div></li></ul><p class="slate-p " >Endorsements</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">For USPS shipments ONLY.</div></li><li class="slate-li " ><div style="position:relative">Direct the driver on what to do if the package is undeliverable.</div></li><li class="slate-li " ><div style="position:relative">Enum Values:</div></li></ul><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">ADDRESS_CORRECTION - Package is returned to sender with the recipient&apos;s correct address. </div></li><li class="slate-li " ><div style="position:relative">CARRIER_LEAVE_IF_NO_RESPONSE - Package is left at the doorstep if the door is not answered. (does not require signature or recipient presence)</div></li><li class="slate-li " ><div style="position:relative">CHANGE_SERVICE - Sender is notified of an address change for the recipient.</div></li><li class="slate-li " ><div style="position:relative">FORWARDING_SERVICE - Redirect the package with a recipient&apos;s mail forwarding order if one has been filed.</div></li><li class="slate-li " ><div style="position:relative">RETURN_SERVICE - Return the package to the sender with the reason why the package couldn&apos;t be delivered.</div></li></ol><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Shipment Features</strong></h3><p class="slate-p " ></p><p class="slate-p " >eHub&apos;s Shipment API provides a powerful and flexible platform for managing all aspects of your shipping operations. With this functionality, you can:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><a href="66a7c81ff9d1d947f54084cf/66a7c81ff9d1d947f54084d3" target=""><strong class="slate-bold">Create and Ship Shipments</strong>:</a> Seamlessly create and process shipments by providing key details like addresses, parcel dimensions, and service levels. Easily generate shipping labels and track each shipment’s progress.</div></li><li class="slate-li " ><div style="position:relative"><a href="66a7c81ff9d1d947f54084cf/66a7c81ff9d1d947f54084d1" target=""><strong class="slate-bold">Create and Ship Multiple Shipments</strong>:</a> Efficiently manage high-volume shipping with the ability to create and ship multiple parcels at once, streamlining your workflow and reducing manual effort.</div></li><li class="slate-li " ><div style="position:relative"><a href="66a7c81ff9d1d947f54084cf/66a7c81ff9d1d947f54084e3" target=""><strong class="slate-bold">Retrieve a Shipment</strong>: </a>Access detailed information on any shipment with the shipment ID, providing visibility into shipping status and tracking events.</div></li><li class="slate-li " ><div style="position:relative"><a href="shipments/cancel-a-shipment" target="_self"><strong class="slate-bold">Cancel a Shipment</strong>:</a> Cancel shipments before they are processed by the carrier and void labels to avoid unnecessary charges. For USPS, manage refunds based on prepay conditions.</div></li><li class="slate-li " ><div style="position:relative"><a href="66a7c81ff9d1d947f54084cf/66a7c81ff9d1d947f54084d7" target="">Create a Shipment:</a> Create a shipment</div></li><li class="slate-li " ><div style="position:relative"><a href="66a7c81ff9d1d947f54084cf/66a7c81ff9d1d947f54084d5" target=""><strong class="slate-bold">List Shipments:</strong></a><strong class="slate-bold"> </strong>Discover how to retrieve a list of shipments using filters, making it easy to track, audit, and manage high-volume shipping operations.</div></li><li class="slate-li " ><div style="position:relative"><a href="66a7c81ff9d1d947f54084cf/66a7c81ff9d1d947f54084e5" target=""><strong class="slate-bold">Validate an Address</strong>:</a> Ensure addresses are accurate with address validation, preventing delivery issues and reducing the risk of returns or failed shipments.</div></li><li class="slate-li " ><div style="position:relative"><a href="66a7c81ff9d1d947f54084cf/66a7c81ff9d1d947f54084e1" target=""><strong class="slate-bold">Customs and International Shipping</strong>:</a> Simplify international shipping with support for customs data, including HS codes and customs PDF document retrieval for select service providers.</div></li><li class="slate-li " ><div style="position:relative"><a href="66a7c81ff9d1d947f54084cf/66a7c81ff9d1d947f54084d9" target=""><strong class="slate-bold">Track Shipments and Create Tracking Events</strong>:</a> Keep your customers informed with real-time tracking updates through GET requests or webhooks. Create custom tracking events for specific shipments like GDE, ensuring transparency even during long postal induction periods.</div></li><li class="slate-li " ><div style="position:relative"><a href="66a7c81ff9d1d947f54084cf/66a7c81ff9d1d947f54084db" target=""><strong class="slate-bold">Rate Management</strong>:</a> Retrieve and compare simplified shipping rates from various carriers, helping you make cost-effective decisions for each shipment.</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 " >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 class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

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 class="slate-p " ></p><h3 class="slate-h3 " >Domestic Shipping</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Key requirements for creating a domestic shipment:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Vital details like destination and origin addresses.</div></li><li class="slate-li " ><div style="position:relative">Parcel dimensions and service ID selection.</div></li><li class="slate-li " ><div style="position:relative">Tips for retrieving rates when service ID is unknown.</div></li></ul></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >International Shipping</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Extra steps required for international shipments:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Importance of HS Codes and EEL/PFC codes.</div></li><li class="slate-li " ><div style="position:relative">Providing accurate customs data for compliance with regulations.</div></li><li class="slate-li " ><div style="position:relative">How to calculate declared value and handle shipments to U.S. territories and military locations.</div></li></ul></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Additional Tips</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Advanced features and best practices:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Handling hazardous materials with hazmat codes.</div></li><li class="slate-li " ><div style="position:relative">Customizing labels with formats, sizes, text, and images.</div></li><li class="slate-li " ><div style="position:relative">Managing multi-parcel shipments and creating USPS test labels.</div></li></ul></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Tracking</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">How to track shipments using the API:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Manual tracking through GET requests.</div></li><li class="slate-li " ><div style="position:relative">Automated tracking through webhooks for real-time updates.</div></li><li class="slate-li " ><div style="position:relative">Examples of tracking event arrays.</div></li></ul></li></ul><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h3 class="slate-h3 " >Conclusion</h3><p class="slate-p " >eHub’s Shipment API makes shipping simple, whether you're sending domestic or international packages. With advanced features like label customization, hazmat handling, and real-time tracking, you can streamline your entire shipping process. Whether you're just starting out or handling complex shipments, these guides give you everything you need to succeed.</p><p class="slate-p " ></p>

eHub’s Shipment API makes shipping simple, whether you're sending domestic or international packages. With advanced features like label customization, hazmat handling, and real-time tracking, you can streamline your entire shipping process. Whether you're just starting out or handling complex shipments, these guides give you everything you need to succeed.

Sections

Guides for eHub's Shipment Functionality

Domestic Shipping

International Shipping

Additional Tips

Tracking

Conclusion

On this page