Update Shipment by Source ID

put

https://us2-api.bringg.com/v2/orders/source_id/{order_source_id}/fulfillments/source_id/{fulfillment_source_id}/shipments/source_id/{shipment_source_id}

Update the details of a shipment using its source ID.

Path Params

order_source_id

string

required

fulfillment_source_id

string

required

shipment_source_id

string

required

Body Params

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.

label_type

string

enum

The label file type.

Allowed:

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

It's possible to update the packages if the shipment is in the "New" status only.

packages

force

boolean

Headers

Authorization

string

required

Responses

Language

Response

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

application/json

200Success

400Bad Request

403Forbidden