Docs

Create shipment

Can book a shipment in the Blueship system.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more
string

Comma-separated response fields to include.

Body

Arguments
string

The account number the shipment should be booked to.

string

Enum: "Save" "Book" "Track"

array

List of addresses that the shipment will be take. For LTL there should only be 2 addresses. The order of the list indicates the order that the shipments will be delivered (the first address is a pickup)

string

The business unit the shipment should be booked to.

string

Enum: "LTL" "TL" "Intermodal"

array

Types of trucks that can support this shipment name required string [ 0 .. 50 ] characters Name of the type of truck needed (Dry Van, Flatbed, Reefer) requiredEquipment Array of strings or null List of equipment that is needed for a given truck type (Tarp 4ft, Tarp 6ft, Tarp 8ft, Straps, Chains)

string

The primary tracking number used by BlueGrace

stringrequired

Description of the products in this line item

boolean

Indicates whether the associated item is hazardous

boolean

Indicates whether there are temp limits for this item

number

Length of the handling unit for this line item

string

Enum: "LeastCost" "RateID" "LeastTransitThreshold" "LeastTransit" "TransitDays" "Carrier" "Manual" "Collect"

string

Name of contact

string

Name of the entity that is being billed by carrier

string

Name of contact

stringrequired

Name of the reference (PO Number, Sales Order etc.)

stringrequired

Name of the type of truck needed (Dry Van, Flatbed, Reefer)

string

SCAC that is to be selected (used if method = Carrier)

string

SCAC for Bill Pay

string

integer or null <int32> Sequence order for addresses

string

First address line

string

Name of carrier for Bill Pay

object
string

Email of contact

string

Email of contact

number

Min allowable temp item can be exposed to

stringrequired

string [ 0 .. 100 ] characters Name of the location or business

string

Reference to a customer's order number for the products in this line item Used to diffrentiate several orders on a single shipment

string

Packing Group

string

ID of a rate from a previous quote. (used if method = RateID)

string

List of equipment that is needed for a given truck type (Tarp 4ft, Tarp 6ft, Tarp 8ft, Straps, Chains)

stringrequired

Value of the associated reference

number

Width of the handling unit for this line item

stringrequired

string [ 0 .. 100 ] characters First address line

string

Second address line

number

Amount for Bill Pay

number

Filter off any carriers where serviceDays are greater than number of days (used if method = TransitDays )

string

Hazard Class or Division

number

Height of the handling unit for this line item

number

Max allowable temp item can be exposed to

string

Phone number of contact

string

Phone number of contact

string

Reference to the line number of a PO that this belongs to

string

Indicates the expected service level. Can specify level based on rate response or 'All' or 'Premium' All - Rate selection criteria is applicable to all service levels Premium - Rate selection criteria is only applicable to the best service level of applicable carriers. Specific - Rate selection criteria is only applicable to if the service level exactly matches the value

string

Second address line if necessary

string

city

string

Part number or SKU number of the the product

string

Unit of dimensions (in, cm)

string

Fax of contact

string

Fax of contact

string

Temp Unit of Measure 'F' or 'C'

string

Represents the amount above the LeastCost willing to go to get faster transit (used if method = LeastTransitThreshold ) For example if LeastCost is $200 and Threshold is $50, will book the fastest carrier within $250. If more than one, will select least cost.

string

Identification Number (UN/NA)

object
stringrequired

City

string

Proper Shipping Name

string
string

The official Universal Product Code

object
string

Class or Dimension. Class: if you are explicitly passing the freight class. Freight class is required. Dimension: if the freight class should be derieved from density of the freight. If Dimension is passed, dimensions and weight are required. If nothing is passed, it will default to 'Class'

string

24-hour Emergency Contact Name

string
stringrequired

State or Province

number

Freight class of the products in this line item (50, 55, 60, 65, 70, 77.5, 85, 92.5, 100, 110, 125, 150, 175, 200, 250, 300, 400, 500)

string

24-hour Emergency Contact Phone Number

stringrequired

Country

string
string

Enum: "HazardousMaterials" "Overdimension" "PrepaidAndAdd" "FreezeProtection" "TankerEndorsement" Additional services requested for the shipment.

object

Person to contact at specified address

boolean

Indicates whether the associated item is Reportable

string

NMFC code for the products in this line item

stringrequired
string

Not Used

boolean

Indicates whether the associated item is a Marine Pollutant.

array

List of items that are being shipped as they will be displayed on BOL

string

Code that is defined by customer to identify a given address

string

Earliest date and time that the carrier can arrive

object
number

Total weight of the products in this line item including pallet.

string

Latest date and time that the carrier can arrive

array

Tags or key-value pairs on the shipment such as Sales Order, PO Number, Delivery Number etc.

stringrequired

Weight unit of measure for the products in this line item (lbs, kgs )

string

DateTime that the carrier has an appointment to be at location

numberrequired

The number of handling units to be picked up. (This is usually the number of pallets or skids)

string

Notes that need to be displayed on the BOL for the carrier to see

stringrequired

The unit of product that will be moved together. (This is usually pallets or skids)

string

DateTime that the carrier has an appointment to be at location

string

Notes that are for BlueGrace to see, but will not be on the BOL

string

Enum: "Open" "NoticeCall" "Appointment"

number

Total linear feet of truck that this shipment will take. This is required to book a Volume shipment

number

The total number of pieces or containers on the pallets

string

Identifier for the given appointment

string

Unit for the piece count. This can be boxes, cartons, jugs etc

string

Enum: "InsidePickup" "InsideDelivery" "Liftgate" "LimitedAccess" "NotifyConsignee" "MilitaryAccess" "Residential" "Tradeshow" "SchoolDelivery" "SortingAndSegregating" "Appointment" "HazardousMaterials" "Airport" "ContainerFreightStation" "GroceryWarehouse" Accessorials that apply specifically to this address

number

Value of the goods used for reporting and analysis purposes.

string

Comments that apply to the address. They will show up on the BOL.

string

GLCode associated to the products in this line item

object

Person to contact at specified address

boolean

Indicates if the products in this line item are stackable

number

Total fluid volume for the products in this line item. Will be divided by the piece count to determine the volume per container

string

Unit of the fluid volume (Gallons, Liters, Pints)

object

Dimensions of the truck that will be take up by this line item

object
object

Temperature Criteria for shipping this item

string

For multi-stop shipments, this will denote which stop (by location code) this line item will be picked up Can either specify PickupLocationCode or PickupSequenceID, but not both.

string

For multi-stop shipments, this will denote which stop (by location code) this line item will be dropped off Can either specify DropLocationCode or DropSequenceID, but not both.

number

For multi-stop shipments, this will denote which stop (by address sequence) this line item will be picked up Can either specify PickupLocationCode or PickupSequenceID, but not both.

number

For multi-stop shipments, this will denote which stop (by location code) this line item will be dropped off Can either specify DropLocationCode or DropSequenceID, but not both.

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is
One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.
Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.
Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.