Kuebix Shipment API
API docs by Redocly

Kuebix REST API Reference Documentation (1.1.0)

Kuebix Support: support@kuebix.com URL: https://www.kuebix.com Terms of Service

Introduction

Welcome to the Kuebix API reference page!

Our modern REST APIs allow our partners to interact with the Kuebix TMS in a variety of ways. These APIs are used to get quick rate quotes for shipments, add and book new shipments in your Kuebix account, retrieve shipment information, schedule pickups with your carriers, and more.

The Kuebix Shipment API is designed for CRUD operations (Create, Read, Update, and Delete) on Shipments as well as more advanced operations in the action endpoints.

Standard HTTP Definitions

The Kuebix Shipment API uses standard REST actions associated with HTTP verbs.

  • GET: Used to retrieve a resource.
  • POST: Used to create a new resource with representation sent in the HTTP Body.
  • PUT: Used to fully update an existing resource with the representation sent in the HTTP Body.
  • DELETE: Used to delete an existing resource.

Authentication

Authentication is controlled through Basic Auth over HTTPS using an Authorization Header attached to the HTTP Request consisting of “Basic Base64Encode(‘username:password’). Kuebix will provide you with a Username and an API Key password.

In addition, Kuebix will provide you with a unique 15 character Client Id that is required in most API calls. Your Client Id will serve as an identifier for each of your shipping or receiving locations.

Kuebix Rating

Base URL: https://shipment.kuebix.com/api

Kuebix rating service allows our customers to retrieve contractual or transactional quotes. Customers can generate quotes with nothing more than weights and zip codes! However, the more detailed the rate request, the more refined the quote is.

Kuebix has taken this functionality a step further and can accommodate our customer's e-commerce platforms to be the rating engine they use to give their customers shipping costs. One of the great features of Kuebix rating API is the ability for customers to turn the received quote into a shipment.

To maximize the quote to shipment experience, we require more information than the bare minimum required parameters. Each parameter that has these "conditional" requirements has been specifically identified in the parameter description.

Request Rate Quote

Request rate quotes using a simple and quick method call.

header Parameters
Authorization
required
string

Authorization

Request Body schema: application/json
required
object (Client)

Client object containing unique shipper identifiers.

shipmentId
string

15 or 18 character Salesforce ID.

Array of objects (Accessorial)

List of Accessorial objects.

When a shipment is created, included Accessorial objects each create an Accessorial record.

base64String
string

Base64 string used for shipment document retrieval.

required
object (Address)

The Address class extends the Client class.

bolNumber
string

Client bill of lading number.

booked
boolean

Indicates whether the shipment is booked with a carrier.

createdByUpload
boolean
object (CustomerSpecificFields)

Reference fields used to pass information not belonging to a specific field. These optional fields allow you to add additional information to shipments.

csxSoNumbers
string
required
object (Address)

The Address class extends the Client class.

freightPayer
string (FreightPayer)
Enum: "Sender" "Receiver" "Third Party"
generateReturnLabel
boolean
Array of objects (HandlingUnit)

List of HandlingUnit objects. When a shipment is created, included HandlingUnit objects each create a Shipment Dimension record.

Handling Unit information is required for LTL and TL shipments.

holdAtLocation
boolean
includeGWFP
boolean

Include UPS Ground with Freight Pricing.

isClientSideSellRate
boolean
lengthUnit
string (LengthUnit)
Enum: "IN" "CM" "FT" "M"

Length unit, accepts both imperial and metric units.

Array of objects (LineItem)

List of LineItem objects. When a shipment is created, included LineItem objects each create a Shipment Line Item record.

At least one Line Item is required for LTL and TL shipments.

marketRegion
string
mileage
number <BigDecimal>
moveType
string

Shipment movement data sent along to the rating engine.

required
object (Address)

The Address class extends the Client class.

originalDeliveryDate
string <date>
ownerIdString
string

Auto-populates after shipment creation with the Salesforce ID for the associated Kuebix User which owns the shipment.

Array of objects (Package)

List of Package objects. When a shipment is created, included Package objects each create a Shipment Dimension record.

Package information is required for Parcel shipments.

parcelAccountNumber
string
parcelCompare
boolean
parcelUrl
string
paymentType
required
string
Enum: "Inbound Collect" "Outbound Collect" "Outbound Prepaid" "Third Party" "Third Party Collect" "Vendor Delivered"

Payment type

pickupClose
string <date-time>

Pickup close date-time string.

pickupDate
string <date-time>

Pickup date date-time string.

pickupNumber
string
pickupReady
string <date-time>

Pickup ready date time.

poNumbers
string
proNumber
string
scheduled
boolean

Indicates whether the shipment is scheduled with a carrier.

object (SchedulingPreferences)

The SchedulingPreferences object is used to create a Kuebix order at the time of shipment creation.

service
string

Used in conjunction with the scac field. Carrier service level used for shipment booking.

serviceType
string
shipmentName
string

Auto-populated upon shipment creation.

shipmentMode
required
string (ShipmentMode)
Enum: "Air" "Bulk" "Dry Van" "Flatbed" "Intermodal" "Ocean" "OTR" "Temp Controlled"

Carrier method of transportation.

shipmentNotes
string

This field gets printed on the BOL, 255 character limit.

shipmentType
required
string (ShipmentType)
Enum: "Parcel" "LTL" "TL" "TL Multistop" "TL Multistop Delivery" "TL Multistop Pickup"

Shipment type:

  • Parcel - Small package shipment.
  • LTL - Less Than Truckload shipment.
  • TL - Truckload shipment with a single pickup and delivery stop.
  • TL Multistop - Truckload with multiple pickup and delivery stops
  • TL Multistop Delivery - Truckload with multiple delivery stops
  • TL Multistop Pickup - Truckload with multiple pickup stops
soNumbers
string

Semicolon-delimited Sales Order Numbers rolled-up from any included Shipment Line Item soNumber fields.

specialInstruction
string

This field gets printed on the BOL, 255 character limit.

totalPackages
integer

Total number of packages in the shipment.

Required when any Package object is included in the request.

totalSkids
integer

Total number of Handling Units in the shipment

weightUnit
string
Enum: "LB" "KG"

Weight unit:

  • LB - Pound
  • KG - Kilogram
x104Enabled
boolean
ignoreRQLessThan
number <BigDecimal>

Ignores rate quotes less than the specified dollar amount.

forceLoad
boolean
persist
boolean

Indicates whether the Shipment should persist in the database after creation.

scacs
Array of strings

Included carrier SCACs are returned in rating results.

Responses

Request samples

Content type
application/json
Example
{
  • "origin": {
    },
  • "destination": {
    },
  • "billTo": {
    },
  • "lineItems": [
    ],
  • "handlingUnits": [
    ],
  • "client": {
    },
  • "weightUnit": "LB",
  • "lengthUnit": "IN",
  • "shipmentType": "LTL",
  • "totalSkids": 2,
  • "totalPackages": 64,
  • "shipmentMode": "Dry Van",
  • "paymentType": "Outbound Prepaid",
  • "pickupReady": "2018-06-06T08:00:00.00Z",
  • "pickupClose": "2018-06-06T11:00:00.00Z",
  • "customerSpecificFields": {
    },
  • "schedulingPreferences": {
    }
}

Response samples

Content type
application/json
Example
{
  • "rateMap": {
    },
  • "rates": [
    ]
}

Kuebix Shipments

Base URL: https://shipment.kuebix.com/api

The Kuebix Shipments API is the customer's gateway to create, update, delete and retrieve details for Kuebix shipments. There are also endpoints for obtaining shipment documents and scheduling shipments with a carrier.

A maximum of 200 line items can be processed in a single API request.

Create a new Shipment

header Parameters
Authorization
required
string

Authorization

Request Body schema: application/json
One of
required
object (Client)

Client object containing unique shipper identifiers.

shipmentId
string

15 or 18 character Salesforce ID.

Array of objects (Accessorial)

List of Accessorial objects.

When a shipment is created, included Accessorial objects each create an Accessorial record.

base64String
string

Base64 string used for shipment document retrieval.

required
object (Address)

The Address class extends the Client class.

bolNumber
string

Client bill of lading number.

booked
boolean

Indicates whether the shipment is booked with a carrier.

createdByUpload
boolean
object (CustomerSpecificFields)

Reference fields used to pass information not belonging to a specific field. These optional fields allow you to add additional information to shipments.

csxSoNumbers
string
required
object (Address)

The Address class extends the Client class.

freightPayer
string (FreightPayer)
Enum: "Sender" "Receiver" "Third Party"
generateReturnLabel
boolean
Array of objects (HandlingUnit)

List of HandlingUnit objects. When a shipment is created, included HandlingUnit objects each create a Shipment Dimension record.

Handling Unit information is required for LTL and TL shipments.

holdAtLocation
boolean
includeGWFP
boolean

Include UPS Ground with Freight Pricing.

isClientSideSellRate
boolean
lengthUnit
string (LengthUnit)
Enum: "IN" "CM" "FT" "M"

Length unit, accepts both imperial and metric units.

Array of objects (LineItem)

List of LineItem objects. When a shipment is created, included LineItem objects each create a Shipment Line Item record.

At least one Line Item is required for LTL and TL shipments.

marketRegion
string
mileage
number <BigDecimal>
moveType
string

Shipment movement data sent along to the rating engine.

required
object (Address)

The Address class extends the Client class.

originalDeliveryDate
string <date>
ownerIdString
string

Auto-populates after shipment creation with the Salesforce ID for the associated Kuebix User which owns the shipment.

Array of objects (Package)

List of Package objects. When a shipment is created, included Package objects each create a Shipment Dimension record.

Package information is required for Parcel shipments.

parcelAccountNumber
string
parcelCompare
boolean
parcelUrl
string
paymentType
required
string
Enum: "Inbound Collect" "Outbound Collect" "Outbound Prepaid" "Third Party" "Third Party Collect" "Vendor Delivered"

Payment type

pickupClose
string <date-time>

Pickup close date-time string.

pickupDate
string <date-time>

Pickup date date-time string.

pickupNumber
string
pickupReady
string <date-time>

Pickup ready date time.

poNumbers
string
proNumber
string
scheduled
boolean

Indicates whether the shipment is scheduled with a carrier.

object (SchedulingPreferences)

The SchedulingPreferences object is used to create a Kuebix order at the time of shipment creation.

service
string

Used in conjunction with the scac field. Carrier service level used for shipment booking.

serviceType
string
shipmentName
string

Auto-populated upon shipment creation.

shipmentMode
required
string (ShipmentMode)
Enum: "Air" "Bulk" "Dry Van" "Flatbed" "Intermodal" "Ocean" "OTR" "Temp Controlled"

Carrier method of transportation.

shipmentNotes
string

This field gets printed on the BOL, 255 character limit.

shipmentType
required
string (ShipmentType)
Enum: "Parcel" "LTL" "TL" "TL Multistop" "TL Multistop Delivery" "TL Multistop Pickup"

Shipment type:

  • Parcel - Small package shipment.
  • LTL - Less Than Truckload shipment.
  • TL - Truckload shipment with a single pickup and delivery stop.
  • TL Multistop - Truckload with multiple pickup and delivery stops
  • TL Multistop Delivery - Truckload with multiple delivery stops
  • TL Multistop Pickup - Truckload with multiple pickup stops
soNumbers
string

Semicolon-delimited Sales Order Numbers rolled-up from any included Shipment Line Item soNumber fields.

specialInstruction
string

This field gets printed on the BOL, 255 character limit.

totalPackages
integer

Total number of packages in the shipment.

Required when any Package object is included in the request.

totalSkids
integer

Total number of Handling Units in the shipment

weightUnit
string
Enum: "LB" "KG"

Weight unit:

  • LB - Pound
  • KG - Kilogram
x104Enabled
boolean

Responses

Request samples

Content type
application/json
Example
{
  • "billTo": {
    },
  • "client": {
    },
  • "destination": {
    },
  • "freightPayer": "Sender",
  • "handlingUnits": [
    ],
  • "lengthUnit": "IN",
  • "lineItems": [
    ],
  • "origin": {
    },
  • "packages": [
    ],
  • "paymentType": "Outbound Prepaid",
  • "pickupDate": "2023-03-08T23:56:00.000Z",
  • "shipmentMode": "Dry Van",
  • "shipmentType": "LTL",
  • "totalPackages": 32,
  • "totalSkids": 3,
  • "weightUnit": "LB"
}

Response samples

Content type
application/json
{
  • "orgId": "00Do0000000bVmL",
  • "shipmentId": "a1HPr000001zL29MAE",
  • "client": {
    },
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Prepaid",
  • "pickupClose": "2024-03-11T20:00:00.000Z",
  • "totalSkids": 3,
  • "totalPackages": 32,
  • "shipmentMode": "Dry Van",
  • "ownerIdString": "005o0000001rmJ2AAI",
  • "weightUnit": "LB",
  • "lengthUnit": "IN",
  • "shipmentName": "KBX-17456294-24",
  • "mileage": 1086.74,
  • "origin": {
    },
  • "destination": {
    },
  • "billTo": {
    },
  • "lineItems": [
    ],
  • "handlingUnits": [
    ],
  • "packages": [
    ],
  • "ownerId": "005o0000001rmJ2AAI",
  • "links": [],
  • "pickupReady": "2024-03-11T17:00:00.000Z",
  • "pickupDate": "2023-03-08T23:56:00.000Z"
}

Create and Book Shipment

Description

Introduction

Kuebix Shipments API is the customer's gateway to create shipments in Kuebix TMS and to update the shipments that Kuebix is responsible for.

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
required
object (Client)

Client object containing unique shipper identifiers.

shipmentId
string

15 or 18 character Salesforce ID.

Array of objects (Accessorial)

List of Accessorial objects.

When a shipment is created, included Accessorial objects each create an Accessorial record.

base64String
string

Base64 string used for shipment document retrieval.

required
object (Address)

The Address class extends the Client class.

bolNumber
string

Client bill of lading number.

booked
boolean

Indicates whether the shipment is booked with a carrier.

createdByUpload
boolean
object (CustomerSpecificFields)

Reference fields used to pass information not belonging to a specific field. These optional fields allow you to add additional information to shipments.

csxSoNumbers
string
required
object (Address)

The Address class extends the Client class.

freightPayer
string (FreightPayer)
Enum: "Sender" "Receiver" "Third Party"
generateReturnLabel
boolean
Array of objects (HandlingUnit)

List of HandlingUnit objects. When a shipment is created, included HandlingUnit objects each create a Shipment Dimension record.

Handling Unit information is required for LTL and TL shipments.

holdAtLocation
boolean
includeGWFP
boolean

Include UPS Ground with Freight Pricing.

isClientSideSellRate
boolean
lengthUnit
string (LengthUnit)
Enum: "IN" "CM" "FT" "M"

Length unit, accepts both imperial and metric units.

Array of objects (LineItem)

List of LineItem objects. When a shipment is created, included LineItem objects each create a Shipment Line Item record.

At least one Line Item is required for LTL and TL shipments.

marketRegion
string
mileage
number <BigDecimal>
moveType
string

Shipment movement data sent along to the rating engine.

required
object (Address)

The Address class extends the Client class.

originalDeliveryDate
string <date>
ownerIdString
string

Auto-populates after shipment creation with the Salesforce ID for the associated Kuebix User which owns the shipment.

Array of objects (Package)

List of Package objects. When a shipment is created, included Package objects each create a Shipment Dimension record.

Package information is required for Parcel shipments.

parcelAccountNumber
string
parcelCompare
boolean
parcelUrl
string
paymentType
required
string
Enum: "Inbound Collect" "Outbound Collect" "Outbound Prepaid" "Third Party" "Third Party Collect" "Vendor Delivered"

Payment type

pickupClose
string <date-time>

Pickup close date-time string.

pickupDate
string <date-time>

Pickup date date-time string.

pickupNumber
string
pickupReady
string <date-time>

Pickup ready date time.

poNumbers
string
proNumber
string
scheduled
boolean

Indicates whether the shipment is scheduled with a carrier.

object (SchedulingPreferences)

The SchedulingPreferences object is used to create a Kuebix order at the time of shipment creation.

service
string

Used in conjunction with the scac field. Carrier service level used for shipment booking.

serviceType
string
shipmentName
string

Auto-populated upon shipment creation.

shipmentMode
required
string (ShipmentMode)
Enum: "Air" "Bulk" "Dry Van" "Flatbed" "Intermodal" "Ocean" "OTR" "Temp Controlled"

Carrier method of transportation.

shipmentNotes
string

This field gets printed on the BOL, 255 character limit.

shipmentType
required
string (ShipmentType)
Enum: "Parcel" "LTL" "TL" "TL Multistop" "TL Multistop Delivery" "TL Multistop Pickup"

Shipment type:

  • Parcel - Small package shipment.
  • LTL - Less Than Truckload shipment.
  • TL - Truckload shipment with a single pickup and delivery stop.
  • TL Multistop - Truckload with multiple pickup and delivery stops
  • TL Multistop Delivery - Truckload with multiple delivery stops
  • TL Multistop Pickup - Truckload with multiple pickup stops
soNumbers
string

Semicolon-delimited Sales Order Numbers rolled-up from any included Shipment Line Item soNumber fields.

specialInstruction
string

This field gets printed on the BOL, 255 character limit.

totalPackages
integer

Total number of packages in the shipment.

Required when any Package object is included in the request.

totalSkids
integer

Total number of Handling Units in the shipment

weightUnit
string
Enum: "LB" "KG"

Weight unit:

  • LB - Pound
  • KG - Kilogram
x104Enabled
boolean
ignoreRQLessThan
number <BigDecimal>

Ignores rate quotes less than the specified dollar amount.

forceLoad
boolean
persist
boolean

Indicates whether the Shipment should persist in the database after creation.

scacs
Array of strings

Included carrier SCACs are returned in rating results.

chooseLowestPrice
boolean

Including this field automatically books the shipment with the lowest-cost rate quote.

kuebixRefNum
string

Rate quote reference number returned in an API rate response. The kuebixRefNum can be included to book with a specific known rate quote.

scac
string

Used with the service field to specify an individual carrier SCAC for booking.

Responses

Request samples

Content type
application/json
Example
{
  • "origin": {
    },
  • "destination": {
    },
  • "billTo": {
    },
  • "client": {
    },
  • "lineItems": [
    ],
  • "handlingUnits": [
    ],
  • "packages": [
    ],
  • "accessorials": [
    ],
  • "shipmentType": "LTL",
  • "totalSkids": 1,
  • "totalPackages": 1,
  • "shipmentMode": "Dry Van",
  • "paymentType": "Outbound Prepaid",
  • "bolNumber": "Sample-BOL-Number",
  • "pickupReady": "2018-06-05T18:00:00.00Z",
  • "pickupClose": "2018-06-05T22:00:00.00Z",
  • "kuebixRefNum": 29124400,
  • "customerSpecificFields": {
    },
  • "schedulingPreferences": {
    }
}

Response samples

Content type
application/json
{
  • "shipmentId": "a1H1k000XXXXXD1EAI",
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Prepaid",
  • "bolNumber": "KBX67936721",
  • "shipmentName": "KBX-0679367-21",
  • "mileage": 294.82,
  • "success": true,
  • "webserviceScheduleEnabled": true,
  • "rateQuoteId": "a151k000XXXXXwmAAC",
  • "rateQuote": {
    },
  • "responseTime": 5583
}

Unbook a Kuebix Shipment

Pass the shipmentId as a path parameter. To specify a reason, pass an unbook reason in the body.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
reason
string (UnbookReason)
Enum: "-- Unspecified Reason --" "Buyer: Cancelled PO" "Buyer: Cancelled PO then retendered PO" "Buyer: Need freight early" "Buyer: Need freight later" "Carrier: Arrived with wrong equipment" "Carrier: Break down" "Carrier: Carrier fell off, new carrier assigned" "Carrier: Delayed at previous delivery" "Carrier: Late for delivery appointment" "Carrier: Missed pickup appointment" "Carrier: No capacity" "Carrier: No power" "Carrier: Ran out of hours" "Carrier: Weather" "CarrierStore: Dispatch error" "Vendor: Delayed carrier at pickup" "Vendor: Did not provide pickup appointment" "Vendor: Did not specify required equipment" "Vendor: Freight not ready" "Vendor: Overweight, return to vendor for rework" "Client: Dispatch Swap"

Responses

Request samples

Content type
application/json
{
  • "default": "-- Unspecified Reason --"
}

Response samples

Content type
application/json
{
  • "shipmentId": "a1XXXXXXXXXXWPiEAM",
  • "bolNumber": "KBX-XXXXXXX-19",
  • "success": true,
  • "message": "Shipment updated. Unbooking successful."
}

Delete a Kuebix Shipment

Pass the shipmentId as a path parameter. There is no request body for this operation.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
{
  • "shipmentId": "a1XXXXXXXXXXWPiEAM",
  • "bolNumber": "KBX-XXXXXXX-19",
  • "success": true,
  • "message": "Shipment updated. Unbooking successful."
}

Get JSON Representation of an Existing Shipment.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
{
  • "shipmentId": "a1XXXXXXXXXX6BkUAI",
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Collect",
  • "freightPayer": null,
  • "pickupClose": "2018-04-09T02:56:00.000Z",
  • "totalSkids": 1,
  • "totalPackages": 40,
  • "client": {
    },
  • "shipmentMode": "Dry Van",
  • "bookedRateQuote": {
    },
  • "weightUnit": "LB",
  • "lengthUnit": "IN",
  • "booked": true,
  • "bolNumber": "KBXXXXXXXX18",
  • "shipmentName": "KBX-XXXXXXX-18",
  • "origin": {
    },
  • "destination": {
    },
  • "billTo": {
    },
  • "lineItems": [
    ],
  • "handlingUnits": [
    ],
  • "pickUpDropOff": "Pick Up",
  • "forceLoad": true,
  • "links": {},
  • "pickupReady": "2018-04-09T23:56:00.000Z",
  • "pickupDate": "2018-04-09T23:56:00.000Z",
  • "customerSpecificFields": {
    },
  • "schedulingPreferences": {
    }
}

Update an existing shipment.

Please note that ids should be passed from the original shipment that was returned when the shipment was created. The ids can also be obtained by using the Get JSON Representation of an Existing Shipment.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
required
object (Client)

Client object containing unique shipper identifiers.

shipmentId
string

15 or 18 character Salesforce ID.

Array of objects (Accessorial)

List of Accessorial objects.

When a shipment is created, included Accessorial objects each create an Accessorial record.

base64String
string

Base64 string used for shipment document retrieval.

required
object (Address)

The Address class extends the Client class.

bolNumber
string

Client bill of lading number.

booked
boolean

Indicates whether the shipment is booked with a carrier.

createdByUpload
boolean
object (CustomerSpecificFields)

Reference fields used to pass information not belonging to a specific field. These optional fields allow you to add additional information to shipments.

csxSoNumbers
string
required
object (Address)

The Address class extends the Client class.

freightPayer
string (FreightPayer)
Enum: "Sender" "Receiver" "Third Party"
generateReturnLabel
boolean
Array of objects (HandlingUnit)

List of HandlingUnit objects. When a shipment is created, included HandlingUnit objects each create a Shipment Dimension record.

Handling Unit information is required for LTL and TL shipments.

holdAtLocation
boolean
includeGWFP
boolean

Include UPS Ground with Freight Pricing.

ignoreAlreadyBooked
boolean

If true the request will update a shipment that has been booked with the carrier.

isClientSideSellRate
boolean
lengthUnit
string (LengthUnit)
Enum: "IN" "CM" "FT" "M"

Length unit, accepts both imperial and metric units.

Array of objects (LineItem)

List of LineItem objects. When a shipment is created, included LineItem objects each create a Shipment Line Item record.

At least one Line Item is required for LTL and TL shipments.

marketRegion
string
mileage
number <BigDecimal>
moveType
string

Shipment movement data sent along to the rating engine.

required
object (Address)

The Address class extends the Client class.

originalDeliveryDate
string <date>
ownerIdString
string

Auto-populates after shipment creation with the Salesforce ID for the associated Kuebix User which owns the shipment.

Array of objects (Package)

List of Package objects. When a shipment is created, included Package objects each create a Shipment Dimension record.

Package information is required for Parcel shipments.

parcelAccountNumber
string
parcelCompare
boolean
parcelUrl
string
paymentType
required
string
Enum: "Inbound Collect" "Outbound Collect" "Outbound Prepaid" "Third Party" "Third Party Collect" "Vendor Delivered"

Payment type

pickupClose
string <date-time>

Pickup close date-time string.

pickupDate
string <date-time>

Pickup date date-time string.

pickupNumber
string
pickupReady
string <date-time>

Pickup ready date time.

poNumbers
string
proNumber
string
scheduled
boolean

Indicates whether the shipment is scheduled with a carrier.

object (SchedulingPreferences)

The SchedulingPreferences object is used to create a Kuebix order at the time of shipment creation.

service
string

Used in conjunction with the scac field. Carrier service level used for shipment booking.

serviceType
string
shipmentName
string

Auto-populated upon shipment creation.

shipmentMode
required
string (ShipmentMode)
Enum: "Air" "Bulk" "Dry Van" "Flatbed" "Intermodal" "Ocean" "OTR" "Temp Controlled"

Carrier method of transportation.

shipmentNotes
string

This field gets printed on the BOL, 255 character limit.

shipmentType
required
string (ShipmentType)
Enum: "Parcel" "LTL" "TL" "TL Multistop" "TL Multistop Delivery" "TL Multistop Pickup"

Shipment type:

  • Parcel - Small package shipment.
  • LTL - Less Than Truckload shipment.
  • TL - Truckload shipment with a single pickup and delivery stop.
  • TL Multistop - Truckload with multiple pickup and delivery stops
  • TL Multistop Delivery - Truckload with multiple delivery stops
  • TL Multistop Pickup - Truckload with multiple pickup stops
soNumbers
string

Semicolon-delimited Sales Order Numbers rolled-up from any included Shipment Line Item soNumber fields.

specialInstruction
string

This field gets printed on the BOL, 255 character limit.

totalPackages
integer

Total number of packages in the shipment.

Required when any Package object is included in the request.

totalSkids
integer

Total number of Handling Units in the shipment

weightUnit
string
Enum: "LB" "KG"

Weight unit:

  • LB - Pound
  • KG - Kilogram
x104Enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "orgId": "00Do0000000bVmL",
  • "shipmentId": "a1HPr000001zL29MAE",
  • "client": {
    },
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Prepaid",
  • "pickupClose": "2024-03-11T20:00:00.000Z",
  • "totalSkids": 3,
  • "totalPackages": 32,
  • "shipmentMode": "Dry Van",
  • "ownerIdString": "005o0000001rmJ2AAI",
  • "weightUnit": "LB",
  • "lengthUnit": "IN",
  • "shipmentName": "KBX-17456294-24",
  • "mileage": 1086.74,
  • "origin": {
    },
  • "destination": {
    },
  • "billTo": {
    },
  • "lineItems": [
    ],
  • "handlingUnits": [
    ],
  • "packages": [
    ],
  • "ownerId": "005o0000001rmJ2AAI",
  • "links": [],
  • "pickupReady": "2024-03-11T17:00:00.000Z",
  • "pickupDate": "2023-03-08T23:56:00.000Z"
}

Response samples

Content type
application/json
{
  • "orgId": "00Do0000000bVmL",
  • "shipmentId": "a1HPr000001zL29MAE",
  • "client": {
    },
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Prepaid",
  • "pickupClose": "2024-03-11T20:00:00.000Z",
  • "totalSkids": 3,
  • "totalPackages": 32,
  • "shipmentMode": "Dry Van",
  • "ownerIdString": "005o0000001rmJ2AAI",
  • "weightUnit": "LB",
  • "lengthUnit": "IN",
  • "shipmentName": "KBX-17456294-24",
  • "mileage": 1086.74,
  • "origin": {
    },
  • "destination": {
    },
  • "billTo": {
    },
  • "lineItems": [
    ],
  • "handlingUnits": [
    ],
  • "packages": [
    ],
  • "ownerId": "005o0000001rmJ2AAI",
  • "links": [],
  • "pickupReady": "2024-03-11T17:00:00.000Z",
  • "pickupDate": "2023-03-08T23:56:00.000Z"
}

Get a Bill of Lading

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
bolNumber
string

Client bill of lading number.

proNumber
string
shipmentId
string

Responses

Request samples

Content type
application/json
Example
{
  • "bolNumber": "KBX68855219"
}

Response samples

Content type
application/json
{
  • "shipmentId": "a1H1k00XXXXXX1EAI",
  • "bolNumber": "KBX67936721",
  • "proNumber": null,
  • "success": true,
  • "errorMessage": null,
  • "message": null,
  • "carrier": "Estes Express",
  • "weightTotal": 2000,
  • "totalSkids": 2,
  • "totalPackages": 0,
  • "bookedRateQuote": {
    },
  • "base64String": "JVBERi0xLjQ...",
  • "parcelUrl": null,
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Prepaid"
}

Get Parcel Labels

Retrieve Parcel labels for a Kuebix Parcel Shipment. Request requires any one attribute of shipmentId, bolNumber, or proNumber.

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
bolNumber
string

Client bill of lading number.

proNumber
string
shipmentId
string

Responses

Request samples

Content type
application/json
Example
{
  • "bolNumber": "KBX68855219"
}

Response samples

Content type
application/json
{
  • "shipmentId": "a1H1k00XXXXXX1EAI",
  • "bolNumber": "KBX67936721",
  • "proNumber": null,
  • "success": true,
  • "errorMessage": null,
  • "message": null,
  • "carrier": "Estes Express",
  • "weightTotal": 2000,
  • "totalSkids": 2,
  • "totalPackages": 0,
  • "bookedRateQuote": {
    },
  • "base64String": "JVBERi0xLjQ...",
  • "parcelUrl": null,
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Prepaid"
}

Get Shipping Labels

Retrieve shipping address labels for a Kuebix Shipment. Either shipmentId, bolNumber, or proNumber is required.

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
bolNumber
string

Client bill of lading number.

proNumber
string
shipmentId
string
object (DocumentParams)

The DocumentParams object contains information about how labels should be formatted in a ShipmentDocumentRequest.

Responses

Request samples

Content type
application/json
Example
{
  • "bolNumber": "KBX68855219",
  • "docParams": {
    }
}

Response samples

Content type
application/json
{
  • "shipmentId": "a1H1k00XXXXXX1EAI",
  • "bolNumber": "KBX67936721",
  • "proNumber": null,
  • "success": true,
  • "errorMessage": null,
  • "message": null,
  • "carrier": "Estes Express",
  • "weightTotal": 2000,
  • "totalSkids": 2,
  • "totalPackages": 0,
  • "bookedRateQuote": {
    },
  • "base64String": "JVBERi0xLjQ...",
  • "parcelUrl": null,
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Prepaid"
}

Schedule an Existing Booked Shipment with a Carrier.

Pass the shipmentId as a path parameter. There is no request body for this operation.

A Shipment can only be scheduled if your carrier account has API or EDI scheduling enabled.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "shipmentId": "a1XXXXXXXXXXi6tMAC",
  • "rateQuoteId": "a1XXXXXXXXXXJxsIAE",
  • "pickupConfirmation": 45111201
}

Add a Rate to an Existing Shipment.

Pass the shipmentId as a path parameter. The body should contain the necessary carrier SCAC(s) as well as a client ID.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
scac
string
object (Client)

Client object containing unique shipper identifiers.

Responses

Request samples

Content type
application/json
{
  • "scac": "EXLA",
  • "client": {
    }
}

Response samples

Content type
application/json
{
  • "rateQuoteId": "a1XXXXXXXXXXO6UQAU",
  • "rateQuoteReference": "RQ-XXXXXXXXXX-18"
}

Rate an Existing Shipment and Save Rates

Quick rate an existing shipment and persist rates. There is no request body, just pass the shipmentId as a path parameter.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
Example
{
  • "shipmentId": "a1H1k0000XXXXXEAA",
  • "rateMap": {
    },
  • "rates": [
    ],
  • "links": []
}

Save and Rate a Shipment and Persist Rates

Create a new shipment, get rates, and save the returned rates to the shipment.

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
required
object (Client)

Client object containing unique shipper identifiers.

shipmentId
string

15 or 18 character Salesforce ID.

Array of objects (Accessorial)

List of Accessorial objects.

When a shipment is created, included Accessorial objects each create an Accessorial record.

base64String
string

Base64 string used for shipment document retrieval.

required
object (Address)

The Address class extends the Client class.

bolNumber
string

Client bill of lading number.

booked
boolean

Indicates whether the shipment is booked with a carrier.

createdByUpload
boolean
object (CustomerSpecificFields)

Reference fields used to pass information not belonging to a specific field. These optional fields allow you to add additional information to shipments.

csxSoNumbers
string
required
object (Address)

The Address class extends the Client class.

freightPayer
string (FreightPayer)
Enum: "Sender" "Receiver" "Third Party"
generateReturnLabel
boolean
Array of objects (HandlingUnit)

List of HandlingUnit objects. When a shipment is created, included HandlingUnit objects each create a Shipment Dimension record.

Handling Unit information is required for LTL and TL shipments.

holdAtLocation
boolean
includeGWFP
boolean

Include UPS Ground with Freight Pricing.

isClientSideSellRate
boolean
lengthUnit
string (LengthUnit)
Enum: "IN" "CM" "FT" "M"

Length unit, accepts both imperial and metric units.

Array of objects (LineItem)

List of LineItem objects. When a shipment is created, included LineItem objects each create a Shipment Line Item record.

At least one Line Item is required for LTL and TL shipments.

marketRegion
string
mileage
number <BigDecimal>
moveType
string

Shipment movement data sent along to the rating engine.

required
object (Address)

The Address class extends the Client class.

originalDeliveryDate
string <date>
ownerIdString
string

Auto-populates after shipment creation with the Salesforce ID for the associated Kuebix User which owns the shipment.

Array of objects (Package)

List of Package objects. When a shipment is created, included Package objects each create a Shipment Dimension record.

Package information is required for Parcel shipments.

parcelAccountNumber
string
parcelCompare
boolean
parcelUrl
string
paymentType
required
string
Enum: "Inbound Collect" "Outbound Collect" "Outbound Prepaid" "Third Party" "Third Party Collect" "Vendor Delivered"

Payment type

pickupClose
string <date-time>

Pickup close date-time string.

pickupDate
string <date-time>

Pickup date date-time string.

pickupNumber
string
pickupReady
string <date-time>

Pickup ready date time.

poNumbers
string
proNumber
string
scheduled
boolean

Indicates whether the shipment is scheduled with a carrier.

object (SchedulingPreferences)

The SchedulingPreferences object is used to create a Kuebix order at the time of shipment creation.

service
string

Used in conjunction with the scac field. Carrier service level used for shipment booking.

serviceType
string
shipmentName
string

Auto-populated upon shipment creation.

shipmentMode
required
string (ShipmentMode)
Enum: "Air" "Bulk" "Dry Van" "Flatbed" "Intermodal" "Ocean" "OTR" "Temp Controlled"

Carrier method of transportation.

shipmentNotes
string

This field gets printed on the BOL, 255 character limit.

shipmentType
required
string (ShipmentType)
Enum: "Parcel" "LTL" "TL" "TL Multistop" "TL Multistop Delivery" "TL Multistop Pickup"

Shipment type:

  • Parcel - Small package shipment.
  • LTL - Less Than Truckload shipment.
  • TL - Truckload shipment with a single pickup and delivery stop.
  • TL Multistop - Truckload with multiple pickup and delivery stops
  • TL Multistop Delivery - Truckload with multiple delivery stops
  • TL Multistop Pickup - Truckload with multiple pickup stops
soNumbers
string

Semicolon-delimited Sales Order Numbers rolled-up from any included Shipment Line Item soNumber fields.

specialInstruction
string

This field gets printed on the BOL, 255 character limit.

totalPackages
integer

Total number of packages in the shipment.

Required when any Package object is included in the request.

totalSkids
integer

Total number of Handling Units in the shipment

weightUnit
string
Enum: "LB" "KG"

Weight unit:

  • LB - Pound
  • KG - Kilogram
x104Enabled
boolean
ignoreRQLessThan
number <BigDecimal>

Ignores rate quotes less than the specified dollar amount.

forceLoad
boolean
persist
boolean

Indicates whether the Shipment should persist in the database after creation.

scacs
Array of strings

Included carrier SCACs are returned in rating results.

Responses

Request samples

Content type
application/json
Example
{
  • "origin": {
    },
  • "destination": {
    },
  • "billTo": {
    },
  • "lineItems": [
    ],
  • "handlingUnits": [
    ],
  • "client": {
    },
  • "weightUnit": "LB",
  • "lengthUnit": "IN",
  • "shipmentType": "LTL",
  • "totalSkids": 2,
  • "totalPackages": 64,
  • "shipmentMode": "Dry Van",
  • "paymentType": "Outbound Prepaid",
  • "pickupReady": "2018-06-06T08:00:00.00Z",
  • "pickupClose": "2018-06-06T11:00:00.00Z",
  • "customerSpecificFields": {
    },
  • "schedulingPreferences": {
    }
}

Response samples

Content type
application/json
Example
{
  • "shipmentId": "a1H1k0000XXXXXmEAA",
  • "rateMap": {
    },
  • "rates": [
    ],
  • "links": []
}

Book an Existing Shipment with an Existing Rate

Book a previously created Kuebix Shipment with an existing rate quote by passing the shipmentId and the rateQuoteId as path parameters. There is no body for this request.

path Parameters
shipmentId
required
string
rateQuoteId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
{
  • "shipmentId": "a1H1k000XXXXXD1EAI",
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Prepaid",
  • "bolNumber": "KBX67936721",
  • "shipmentName": "KBX-0679367-21",
  • "mileage": 294.82,
  • "success": true,
  • "webserviceScheduleEnabled": true,
  • "rateQuoteId": "a151k000XXXXXwmAAC",
  • "rateQuote": {
    },
  • "responseTime": 5583
}

Get Existing Rates for a Shipment

Retrieve rate quotes for a previously created Kuebix shipment. There is no body for this request, just pass the shipmentId as a path parameter.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
Example
{
  • "rateMap": {
    },
  • "rates": [
    ]
}

Get Non-Persistent Rates for an Existing Shipment

Get new rate quotes for a previously created Kuebix shipment. There is no body for this request, just pass the shipmentId as a path parameter.

Rate quotes retrieved with this endpoint are not saved in the Salesforce database.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
Example
{
  • "shipmentId": "a1H1k0000XXXXXmEAA",
  • "rateMap": {
    },
  • "rates": [
    ],
  • "links": []
}

Book and Schedule Existing Shipment

Mark a Kuebix Shipment as booked and schedule it with a carrier by passing the shipmentId as a path parameter. There is no request body for this endpoint.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
{
  • "shipmentId": "a1H1k000XXXXXD1EAI",
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Prepaid",
  • "bolNumber": "KBX67936721",
  • "shipmentName": "KBX-0679367-21",
  • "mileage": 294.82,
  • "success": true,
  • "webserviceScheduleEnabled": true,
  • "rateQuoteId": "a151k000XXXXXwmAAC",
  • "rateQuote": {
    },
  • "responseTime": 5583
}

Create and Book a Customer Routed Shipment

Create and book an Outbound Collect or Third Party Collect shipment. Please note, when booking a customer routed shipment, there are no rate quotes in play as the freight charges will be billed to a party that is not the Kuebix customer.

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
scac
string
object (Client)

Client object containing unique shipper identifiers.

Responses

Request samples

Content type
application/json
Example
{
  • "origin": {
    },
  • "destination": {
    },
  • "billTo": {
    },
  • "lineItems": [
    ],
  • "handlingUnits": [
    ],
  • "client": {
    },
  • "weightUnit": "LB",
  • "lengthUnit": "IN",
  • "shipmentType": "LTL",
  • "totalSkids": 2,
  • "totalPackages": 64,
  • "shipmentMode": "Dry Van",
  • "paymentType": "Outbound Prepaid",
  • "pickupReady": "2018-06-06T08:00:00.00Z",
  • "pickupClose": "2018-06-06T11:00:00.00Z",
  • "scac": "EXLA",
  • "service": "Standard Transit Plus: 10AM",
  • "customerSpecificFields": {
    },
  • "schedulingPreferences": {
    }
}

Response samples

Content type
application/json
{
  • "shipmentId": "a1H1k00XXXXXX8pEAA",
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Collect",
  • "bolNumber": "KBX67936221",
  • "shipmentName": "KBX-0679362-21",
  • "mileage": 879.59,
  • "success": true,
  • "webserviceScheduleEnabled": true,
  • "rateQuoteId": "a151k000XXXXXw4AAC",
  • "rateQuote": {
    },
  • "responseTime": 3364
}

Create and Schedule a Booked Kuebix Shipment

This action allows for creating, booking, and scheduling a Kuebix Shipment with a carrier.

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
required
object (Client)

Client object containing unique shipper identifiers.

shipmentId
string

15 or 18 character Salesforce ID.

Array of objects (Accessorial)

List of Accessorial objects.

When a shipment is created, included Accessorial objects each create an Accessorial record.

base64String
string

Base64 string used for shipment document retrieval.

required
object (Address)

The Address class extends the Client class.

bolNumber
string

Client bill of lading number.

booked
boolean

Indicates whether the shipment is booked with a carrier.

createdByUpload
boolean
object (CustomerSpecificFields)

Reference fields used to pass information not belonging to a specific field. These optional fields allow you to add additional information to shipments.

csxSoNumbers
string
required
object (Address)

The Address class extends the Client class.

freightPayer
string (FreightPayer)
Enum: "Sender" "Receiver" "Third Party"
generateReturnLabel
boolean
Array of objects (HandlingUnit)

List of HandlingUnit objects. When a shipment is created, included HandlingUnit objects each create a Shipment Dimension record.

Handling Unit information is required for LTL and TL shipments.

holdAtLocation
boolean
includeGWFP
boolean

Include UPS Ground with Freight Pricing.

isClientSideSellRate
boolean
lengthUnit
string (LengthUnit)
Enum: "IN" "CM" "FT" "M"

Length unit, accepts both imperial and metric units.

Array of objects (LineItem)

List of LineItem objects. When a shipment is created, included LineItem objects each create a Shipment Line Item record.

At least one Line Item is required for LTL and TL shipments.

marketRegion
string
mileage
number <BigDecimal>
moveType
string

Shipment movement data sent along to the rating engine.

required
object (Address)

The Address class extends the Client class.

originalDeliveryDate
string <date>
ownerIdString
string

Auto-populates after shipment creation with the Salesforce ID for the associated Kuebix User which owns the shipment.

Array of objects (Package)

List of Package objects. When a shipment is created, included Package objects each create a Shipment Dimension record.

Package information is required for Parcel shipments.

parcelAccountNumber
string
parcelCompare
boolean
parcelUrl
string
paymentType
required
string
Enum: "Inbound Collect" "Outbound Collect" "Outbound Prepaid" "Third Party" "Third Party Collect" "Vendor Delivered"

Payment type

pickupClose
string <date-time>

Pickup close date-time string.

pickupDate
string <date-time>

Pickup date date-time string.

pickupNumber
string
pickupReady
string <date-time>

Pickup ready date time.

poNumbers
string
proNumber
string
scheduled
boolean

Indicates whether the shipment is scheduled with a carrier.

object (SchedulingPreferences)

The SchedulingPreferences object is used to create a Kuebix order at the time of shipment creation.

service
string

Used in conjunction with the scac field. Carrier service level used for shipment booking.

serviceType
string
shipmentName
string

Auto-populated upon shipment creation.

shipmentMode
required
string (ShipmentMode)
Enum: "Air" "Bulk" "Dry Van" "Flatbed" "Intermodal" "Ocean" "OTR" "Temp Controlled"

Carrier method of transportation.

shipmentNotes
string

This field gets printed on the BOL, 255 character limit.

shipmentType
required
string (ShipmentType)
Enum: "Parcel" "LTL" "TL" "TL Multistop" "TL Multistop Delivery" "TL Multistop Pickup"

Shipment type:

  • Parcel - Small package shipment.
  • LTL - Less Than Truckload shipment.
  • TL - Truckload shipment with a single pickup and delivery stop.
  • TL Multistop - Truckload with multiple pickup and delivery stops
  • TL Multistop Delivery - Truckload with multiple delivery stops
  • TL Multistop Pickup - Truckload with multiple pickup stops
soNumbers
string

Semicolon-delimited Sales Order Numbers rolled-up from any included Shipment Line Item soNumber fields.

specialInstruction
string

This field gets printed on the BOL, 255 character limit.

totalPackages
integer

Total number of packages in the shipment.

Required when any Package object is included in the request.

totalSkids
integer

Total number of Handling Units in the shipment

weightUnit
string
Enum: "LB" "KG"

Weight unit:

  • LB - Pound
  • KG - Kilogram
x104Enabled
boolean
ignoreRQLessThan
number <BigDecimal>

Ignores rate quotes less than the specified dollar amount.

forceLoad
boolean
persist
boolean

Indicates whether the Shipment should persist in the database after creation.

scacs
Array of strings

Included carrier SCACs are returned in rating results.

chooseLowestPrice
boolean

Including this field automatically books the shipment with the lowest-cost rate quote.

kuebixRefNum
string

Rate quote reference number returned in an API rate response. The kuebixRefNum can be included to book with a specific known rate quote.

scac
string

Used with the service field to specify an individual carrier SCAC for booking.

scheduleShipment
boolean

Indicates whether the shipment should be scheduled with a carrier.

Responses

Request samples

Content type
application/json
Example
{
  • "origin": {
    },
  • "destination": {
    },
  • "billTo": {
    },
  • "client": {
    },
  • "lineItems": [
    ],
  • "handlingUnits": [
    ],
  • "package": [
    ],
  • "accessorials": [
    ],
  • "shipmentType": "LTL",
  • "totalSkids": 1,
  • "totalPackages": 1,
  • "shipmentMode": "Dry Van",
  • "paymentType": "Outbound Prepaid",
  • "bolNumber": "Sample-BOL-Number",
  • "pickupReady": "2018-06-05T18:00:00.00Z",
  • "pickupClose": "2018-06-05T22:00:00.00Z",
  • "kuebixRefNum": 29124400,
  • "scheduleShipment": true,
  • "customerSpecificFields": {
    }
}

Response samples

Content type
application/json
{
  • "shipmentId": "a1H3b000XXXXXXXEAT",
  • "shipmentType": "LTL",
  • "paymentType": "Outbound Prepaid",
  • "bookedRateQuote": {
    },
  • "bolNumber": "Sample-BOL-Number",
  • "proNumber": "123XXX795",
  • "mileage": 18.44,
  • "success": true,
  • "webserviceScheduleEnabled": true,
  • "rateQuoteId": "a153b00XXXXXLCAA3",
  • "rateQuote": {
    }
}

Delete Existing Rate Quotes on a Shipment.

This endpoint can be used to delete published and spot rate quotes from an existing shipment.

path Parameters
shipmentId
required
string
header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
deletePublishedRates
boolean

Indicates whether Published Rate Quotes should be deleted.

deleteSpotRates
boolean

Indicates whether Spot Rates should be deleted.

Responses

Request samples

Content type
application/json
Example
{
  • "deletePublishedRates": true,
  • "deleteSpotRates": false
}

Response samples

Content type
application/json
Example
{
  • "shipmentId": "a1H1k00XXXXXis4EAC",
  • "bolNumber": "KBX67508421",
  • "message": "Existing Published RQs deleted successfully."
}

Kuebix Shipment Tracking

Base URL: https://apis.kuebix.com/v2

The Kuebix Shipment Tracking API allows users to track any booked shipments by passing a list of Kuebix shipment BOLs as a query parameter.

Track a Kuebix Shipment

Track a Kuebix Shipment with a BOL Number.

query Parameters
kuebixBOLs
required
string

List of Kuebix BOLs to be tracked, separated by commas.

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
{
  • "trackDetailMap": {
    }
}

Kuebix Order Create

Base URL: https://order.kuebix.com/api

The Kuebix Order Create API allows users to Add, Delete, and Update Orders as well as retrieve Order details.

A maximum of 200 PO line items can be processed in a single API request.

Order Create requests with orderType Inbound must have unique orderNum values, as this field is a unique identifier for Inbound orders.

Order Create requests with orderType Outbound or Third Party must have unique salesOrderNum values, as this field is a unique identifier for Outbound and Third Party orders.

Create or Update an Order

This endpoint can be used to create a new order or update an existing order. To update an order, include the salesOrderNum of your existing order in the request body.

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Request Body schema: application/json
integrationVersion
string

Integration version, currently 1.0 is used.

Array of objects (PoMasterBase)

ArrayList of PoMaster objects.

When an order is created, included PoMaster objects each create a PO Master record.

Responses

Request samples

Content type
application/json
{
  • "integrationVersion": "1.0",
  • "poMasterList": [
    ]
}

Response samples

Content type
application/json
{
  • "poMasterIds": [
    ],
  • "successfulOrderNums": [
    ],
  • "errorMap": { },
  • "warningMap": { },
  • "errorCode": 0,
  • "isSuccess": true,
  • "errorStatus": null
}

Get Order Details

Get Order Details retrieves JSON representations of orders and has no request body. To pass a query parameter, append a question mark to the end of the URL, followed by orderNumber=value pairs separated by ampersands (&), e.g. https://order.kuebix.com/api/orders?orderNumbers=987654321&123456789.

query Parameters
orderNumbers
required
Array of strings

Pass an array of strings in the query containing the Order Numbers for which to retrieve PO Details.

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
{
  • "poMasterIds": [ ],
  • "successfulOrderNums": [
    ],
  • "errorMap": { },
  • "warningMap": { },
  • "errorCode": 0,
  • "isSuccess": true,
  • "errorStatus": null
}

Remove Orders

query Parameters
orderNumbers
required
Array of strings

Remove Orders deletes an order from Kuebix and has no request body. To pass a query parameter, append a question mark to the end of the URL, followed by orderNumber=value pairs separated by ampersands (&), e.g. https://order.kuebix.com/api/orders?orderNumbers=987654321&123456789.

header Parameters
Authorization
required
string

Basic Authentication over HTTPS using an API username and key password provided by Kuebix.

Responses

Response samples

Content type
application/json
{
  • "poMasterIds": [ ],
  • "successfulOrderNums": [
    ],
  • "errorMap": { },
  • "warningMap": { },
  • "errorCode": 0,
  • "isSuccess": true,
  • "errorStatus": null
}