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

string

required

fulfillment_id

string

required

Body Params

customer

object

required

label_type

string

The label file type.

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 booking.

type

string

Is not supported at the moment

sender_start

string

Is not supported at the moment. The start of the pickup time window.

sender_end

string

Is not supported at the moment. The end of the pickup time window.

recipient_start

string

Is not supported at the moment. The start of the dropoff time window.

recipient_end

string

Is not supported at the moment. The end of the dropoff time window.

packages

array of objects

required

packages*

Headers

Authorization

string

required

Responses

Response body

object

string

required

order_id

string

required

fulfillment_id

string

required

user_id

double

merchant_id

double

required

created_at

string

required

updated_at

string

required

delete_at

string

status

string

required

Quoted New PartiallyFulfilled ReadyToShip PickedUp InTransit OutForDelivery Delivered Exception CancelledByCarrier Cancelled

shipment_events

array of objects

shipment_events

object

string

required

type

string

required

status_update checkpoint carrier_assignment_failure

value

string

required

merchant_id

double

required

shipment_id

string

required

created_at

string

required

updated_at

string

required

delete_at

string

shipments_packages

array of objects

shipments_packages

object

string

required

order_id

string

required

package_id

string

required

fulfillment_id

string

required

shipment_id

string

tracking_number

string

label

string

return_label

string

created_at

string

required

updated_at

string

required

delete_at

string

delivery_cost

double

net_charge

double

taxes

double

type

string

required

Is not supported at the moment

delivery return

surcharges

double

discounts

double

tracking_number

string

deliver_by

string

carrier_reference_number

string

carrier

string

commercial_invoice

string

customer

object

string

required

merchant_id

double

required

allow_sms

boolean

required

If allow_sms is true, send notifications to customer by SMS.

allow_email

boolean

required

If allow_email is true, send notifications to customer by email.

created_at

string

required

updated_at

string

required

delete_at

string

name

string

required

The customer's first and last name.

string

The customer's email address.

phone

string

required

The customer's phone number.

label_type

string

required

The label file type.

PDF PNG ZPL JPG

tracking_url

string

required

packages_count

double

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 booking.

sender_start

string

Is not supported at the moment. The start of the pickup time window.

sender_end

string

Is not supported at the moment. The end of the pickup time window.

recipient_start

string

Is not supported at the moment. The start of the dropoff time window.

recipient_end

string

Is not supported at the moment. The end of the dropoff time window.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://us2-api.bringg.com/v2/ordersorder_id/fulfillments/fulfillment_id/shipments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200Success

400Bad Request

403Forbidden