carrier

object

The carrier attached to this quote or shipment.

delivery_cost

number (double)

The delivery cost that the customer pays at checkout. Formatted to include cents. For example, a value of 25000 using USD as currency would appear as $250.00 in the Delivery Hub UI.

deliver_by

string

The date and time by which the shipment should be delivered.

estimated_delivery_cost

number (double)

The quoted cost for delivery from the carrier. Compare this quote to the actual delivery_cost once a shipment is confirmed.

fulfillment_id

number (double)

Bringg's ID for this fulfillment.

Required

id

number (double)

The ID of this object in Delivery Hub.

Valid uuid

label_type

string

The label file type.

Possible values: PDF PNG ZPL JPG

order_id

number (double)

ID of the order associated with the shipment.

Required

packages

array of objects

The packages included in this shipment, listed as an array. It's possible to update the packages if the shipment is in the New status only.

Required

packages_count

number (double)

The number of packages included in a shipment.

required_service_level

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.

1-225 characters

service

object

An object containing information about the service used to fulfill the shipment.

Required if shipping_account_id is present,
1-225 characters

shipping_account_id

number (double)

The shipping account used for the quoted or actual booking.

Required when service is present,
Positive integer

source_id

string

Your source system's ID for this shipment.

Required shipping_account_id is present,
1-225 characters.

type

string

Designates if this is a delivery or return.

Possible values:
delivery return

base_charge

number (double)

The base cost of the shipment, without additional fees, as charged by the carrier

billing_address_id

number (double)

Delivery Hub's ID for the order's billing address.

carrier_reference_number

string

The carrier's ID for this shipment.

commercial_invoice

string

(For international orders) The commercial invoice associated with the shipment, encoded using base64.

customer

object

The contact specifications for the customer. Includes:

• name
• email
• allow_email
• phone
• allow_sms
• id
• account_id
• created_at
• updated_at

created_at

string

The date and time when this shipment was created in Delivery Hub.

delete_at

string

The date and time when this shipment will be deleted from Delivery Hub.

discounts

number (double)

Service discounts based on your contract with the carrier.

label_url

string

Delivery Hub's URL for the shipping label.

net_charge

number (double)

The net charge of the shipment, formatted to include cents. For example, a value of 25000 using USD as currency would appear as $250.00 in the Delivery Hub UI.

quote_id

string

ID for the quote selected at checkout.

shipment_events

array of objects

An array of shipment events associated with the shipment. See Shipment Event.

shipment_id

string

Delivery Hub's ID for this shipment.

status

string

Current status of the fulfillment. Possible values:
Quoted New PartiallyFulfilled ReadyToShip PickedUp InTransit OutForDelivery Delivered Exception CanceledByCarrier Canceled

subcharges

number (double)

Extra costs charged by the carrier, such as for fuel or special handling. Formatted to include cents. For example, a value of 25000 using USD as currency would appear as $250.00 in the Delivery Hub UI.

taxes

number (double)

Taxes attached to charges from carrier., formatted to include cents. For example, a value of 25000 using USD as currency would appear as $250.00 in the Delivery Hub UI.

tracking_number

string

The tracking number provided by the carrier.

tracking_url

string

Delivery Hub's tracking URL for this order. Learn more.

updated_at

string

The date and time when this shipment was updated in Delivery Hub.