Create Shipment

post

https://us2-api.bringg.com/v2/orders/{order_id}/fulfillments/{fulfillment_id}/shipments

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

Path Params

order_id

double

required

fulfillment_id

double

required

Body Params

label_type

string

enum

The label file type.

Allowed:

disable_shipping_rules

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.

source_id

string

Your source system's ID for this shipment.

service

string

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

shipping_account_id

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.

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.

pickup_start

string

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

pickup_end

string

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

delivery_start

string

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

delivery_end

string

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

created_by

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

Authorization

string

required

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

403Forbidden