GuidesAPI Reference
Log In
API Reference

Create Shipment by Source ID

Send the details of a new shipment to Delivery Hub from your Order Management System (OMS) using source IDs.

Path Params
string
required
string
required
Body Params
string
enum

The label file type.

Allowed:
boolean

When this field is “true” and there is no carrier information included in the payload, Delivery Hub skips shipping rules and creates an unassigned shipment.

string

Your source system's ID for this shipment.

string

The service level for the quoted booking, such as same-day.

double

The shipping account used for the quoted or actual booking. Required when service is present. This is used when the end-customer selects the carrier and service for a shipment.

string

The service levels required for this shipment, as defined by your organization and based on included products. For example, certain hazardous materials might require delivery within 72 hours.

string

Date and time when carrier arrives at shipping location to begin pickup.

string

Date and time when carrier leaves shipping location after picking up shipment.

string

Date and time when carrier arrives at recipient location to deliver shipment.

string

Date and time when carrier leaves recipient location after delivering shipment.

string
enum
Allowed:
packages
array of objects
required

The packages included in this shipment, listed as an array. Packages can be updated while in the "New" status.

packages*
Headers
string
required
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json