Support and Training
Home
BrokerWare Features
Solutions
Testimonials
Alliances
Support
News
Contact Us
Support Area Links
BrokerWare Training Manual
XML Create Shipment Request and Response
Function Name: CreateLoadResponse CreateShipment(string SSID, CreateLoadRequest request)
This function is used to book a new shipment. This function will not return rates it can only be used to book new shipments. A BOL will be available imediatly after calling this function. Your SSID will be provided by customer service.
Tag
Type
Occurrences
CreateLoadRequest
Primary Request Object
1
ReferenceId
This value is used to identify the request. The value is returned exactly as it is sent.
string
0-1
POReference
PO Reference for the new shipment
string
0-1
ShipperNo
Shipper Number for the new shipment
string
0-1
PickupDate
Pickup Date and open time
string
0-1
PickupDockCloseTime
Dock closing time
string
0-1
DeliveryDate
Requested Delivery Date
string
0-1
OriginAddress
First Pickup Address
ShipAddress
1
Company
Company Name for this location
string
0-1
Address1
First Address line for this location
string
0-1
Address2
Second Address line for this location
string
0-1
Zip
Zip code for this location
string
1
Contact
Contact Name for this location
string
0-1
Email
Email address for this location
string
0-1
Phone
Phone Number for this location
string
0-1
Fax
Fax Number for this location
string
0-1
Notes
Details about loading and unloading instructions for this stop
string
0-1
LocationType
Location Type for this stop (business, residential,ect.)
AddressType
0-1
Stop
Type of stop for this address (Pickup, Drop or Both)
StopType
0-1
DestinationAddress
Final Destination Address
ShipAddress
1
Company
Company Name for this location
string
0-1
Address1
First Address line for this location
string
0-1
Address2
Second Address line for this location
string
0-1
Zip
Zip code for this location
string
1
Contact
Contact Name for this location
string
0-1
Email
Email address for this location
string
0-1
Phone
Phone Number for this location
string
0-1
Fax
Fax Number for this location
string
0-1
Notes
Details about loading and unloading instructions for this stop
string
0-1
LocationType
Location Type for this stop (business, residential,ect.)
AddressType
0-1
Stop
Type of stop for this address (Pickup, Drop or Both)
StopType
0-1
AdditionalStops
Addiontal Stops
ShipAddress
0-n
Company
Company Name for this location
string
0-1
Address1
First Address line for this location
string
0-1
Address2
Second Address line for this location
string
0-1
Zip
Zip code for this location
string
1
Contact
Contact Name for this location
string
0-1
Email
Email address for this location
string
0-1
Phone
Phone Number for this location
string
0-1
Fax
Fax Number for this location
string
0-1
Notes
Details about loading and unloading instructions for this stop
string
0-1
LocationType
Location Type for this stop (business, residential,ect.)
AddressType
0-1
Stop
Type of stop for this address (Pickup, Drop or Both)
StopType
0-1
CommodityList
Array of Commodities
Commodity
1-n
Reference
This value is used to identify the request. The value is returned exactly as it is sent.
string
0-1
Pieces
Number of items in this commodity
int
0-1
Packaging
Type of Packaging (default is none)
Package
0-1
Description
Detailed Item Description
string
0-1
NMFC
NMFC Number
string
0-1
Weight
Commodity Weight
double
0-1
Class
Commodity Class
ClassType
0-1
Density
Commodity Density
double
0-1
Length
Commodity Length
double
0-1
Width
Commodity Width
double
0-1
Height
Commodity Height
double
0-1
UnitsWeight
Unit type for the weight (default is lbs)
Units
0-1
UnitsDim
Unit type for the Dims (default is Feet)
Units
0-1
UnitsDensity
Unit Type for density (default is PCF)
Units
0-1
Palletized
True if the shipment is palletized
bool
0-1
Pallets
Total Number of pallets
int
0-1
Stackable
True if the commodities can be stacked
bool
0-1
LinearFeet
Total linear feet for the shipment
int
0-1
ShipmentValue
Total Value of the shipment
double
0-1
Comments
BOL Comments
string
0-1
SupplementalCharges
Array of Supplemental Charges
string
0-1
CarrierName
Requested Name of Carrier
string
0-1
CarrierSCAC
Requested SCAC of Carrier
string
0-1
PayerDescription
Requested Payer Name
string
0-1
CreateLoadResponse
Primary Response Object
1
CurrentStatus
Status of the Request. See status codes for details
1
Id
Code for the returned status.
int
1
Description
description of the returned status
string
1
LoadId
load id for the new shipment
string
1
POReference
PO reference Number of the new shipment
string
1
ShipperNo
Shipper Number for the new shipment
string
1
ReferenceId
ReferenceId passed in with the request.
string
1
ChargesTotal
Total Charges for the shipment (not currently supported)
double
1
TranistDays
Transit Days for the shipment (not currently supported)
int
1
3PL Support
BrokerWare Training Manual
Integration Documentation
Connect to 3PL Support
Downloads
3PL Staff Tools
Support Request
Company:
Contact:
Load #:
Category:
Accounting
BrokerWare
Computer
Email
Enhancements
Implementation
Other
Phone
Priority:
Low
Normal
Urgent
Details:
After Hrs:
Contact Information
Name
3PL Systems, Inc.
Address
5430 Trabuco Rd
Suite 150
Irvine, CA 92620
Phone
800.965.8205
714.855.3370
Fax
800.322.4439
Emails
sales@3plsystems.com
support@3plsystems.com