API Documentation – PNGWORLDWIDE

3PL Client XML New API – Documentation

Test Connection
Method Name: TestConnection

You can verify your access/credentials using TestConnection method. Provided credentials will have two categories;

Test Environment
Production Environment

In the first step, test environment credentials will be provided to you by 3PL team. After successfully completing your testing, you can ask credentials for production environment and 3PL will give you access for production environment.

If the TestConnection method returns true, your credentials are verified else verify that you are using correct credentials or contact 3PL staff.

TestConnection method

Parameter Name:

Type:

Required:

Expected Value:

Definition:

ssid

string

Yes

string value

Takes your SSID to validate authentication

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Function Return Type:

Function Definition:

bool

It will response that a user is valid or not

XML Accessorials List
Method Name: GetXMLAccessorialList

3PL Client XML New API provides support of various XML accessorials that you can use/add in your request when creating request for XML rate quote. To get the list of supported XML accessorials, call the function GetXMLAccessorialList.

GetXMLAccessorialList method

Parameter Name:

Type:

Required:

Expected Value:

Definition:

ssid

string

Yes

string value

Takes your SSID to validate authentication

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Function Return Type:

Function Definition:

string[]

Returns 3PL supported XML accessorials list

Rate Quote
Method Name: GetRates

3PL API offers you to get rate quotations with multiple commodities, supplementals and XML accessorials on very reasonable prices with quality/guaranteed services. To get the best carriers’ rates, you just need to follow up the code procedure defined below. Create a rate request with commodity, supplementals and XML accessorials and it using GetRates method and get the best rates offers.

ShipmentRateRequest class

Property Name:

Type:

Required:

Expected Value:

Definition:

ReferenceId

string

No (Optional)

string value

Takes reference id or keep empty

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

OriginZip

string

Yes

string value

Takes the origin zip code

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

DestinationZip

string

Yes

string value

Takes the destination zip code

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

ExcessiveLength

string

No (Optional)

string value

Takes the excessive lenght value (if requested)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Cube

double

No (Optional)

double value

Takes the cubic length of shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

DimWeight

int

No (Optional)

int value

Takes the dimension weight of shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Pallets

int

Yes

int value

Takes the number of pallets

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Pallet Size

int

No(Optional)

int(0-5) value

Takes Pallet Size of Shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

LinearFeet

int

No (Optional)

int value

Takes the linear feet

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

SupplementalCharges

string[]

No (Optional)

string[] object

Takes the supplementals items to request

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Commodity

Commodity[]

Yes

Commodity[] object

Takes the commodity line items of the shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

XMLAccessorials

XMLAccessorialsItems[]

No (Optional)

XMLAccessorialsItems[] object

Takes the XML accessorials items to request

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

EquipmentType

EquipmentTypes

No(Optional)

EquipmentTypes value

Takes Equipment Type of Shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

RequestCarrierDetail

bool

No(Optional)

bool value

to request carrier contact detail set this flag to true,default value is false

Commodities
Method Name: GetRates

Part of: Rate Quote Section

3PL API allows you to send upto 6 commodities (maximum) online in several packaging type with multiple and various types of classes including package size. To request commodities in rate quote, create an array of commodity items and set your desired commodity detail in each item and assign it to the rate request property named CommodityList.

Commodity class Related property: CommodityList

Property Name:

Type:

Required:

Expected Value:

Definition:

Reference

string

No (Optional)

string value

Takes the commodity number

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Description

string

No (Optional)

string value

Takes the definition of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

NMFC

string

No (Optional)

string value

Takes the NMFC code associated to your account

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Pieces

int

Yes

int value

Takes the number of pieces in commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Weight

double

Yes

double value

Takes the weight of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Density

double

No (Optional)

double value

Takes the density of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Length

double

No (Optional)

double value

Takes the length of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Width

double

No (Optional)

double value

Takes the width of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Height

double

No (Optional)

double value

Takes the height of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Packaging

Package

Yes

Package value

Takes the packaging of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Class

ClassType

Yes

ClassType value

Takes the class of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

UnitsWeight

Units

No (Optional)

Units value

Takes the weight measuring unit

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

UnitsDim

Units

No (Optional)

Units value

Takes the dimension measuring unit

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

UnitsDensity

Units

No (Optional)

Units value

Takes the density measuring unit

Package enumerator Related property: Packaging

none
Pallets
Bags
Boxes
Bundles
Cartons
Cases
Crates
Drums
Pails
Rolls
Stacks
Totes
Wheels
FTL
LTL
Pieces

ClassType enumerator Related property: Class

none
c50
c55
c60
c65
c70
c77_5
c85
c92_5
c100
c110
c125
c150
c175
c200
c250
c300
c400
c500

Units enumerator Related property: UnitsWight, UnitsDim & UnitsDensity

Feet
Inches
Meters
Yards
cm
PCF
kgm
lbs
kg

// Creating a list of commodities for rate quote request

// ‘count’ is a number of commodities that you want to create

Commodity[] commodityItems = new Commodity[count];

for (int iCommodity = 0; iCommodity < count; iCommodity++)

{

commodityItems[iCommodity] = new Commodity()

{

commodityItems[iCommodity].Reference = i.ToString();

commodityItems[iCommodity].Pieces = 2;

commodityItems[iCommodity].Packaging = Package.Pallets;

commodityItems[iCommodity].Description = “Material”;

commodityItems[iCommodity].NMFC = “NMFC Code here”;

commodityItems[iCommodity].Weight = 1500;

commodityItems[iCommodity].Class = ClassType.c65;

commodityItems[iCommodity].Density = 0;

commodityItems[iCommodity].Length = 0;

commodityItems[iCommodity].Width = 0;

commodityItems[iCommodity].Height = 0;

commodityItems[iCommodity].UnitsWeight = Units.lbs;

commodityItems[iCommodity].UnitsDim = Units.Feet;

commodityItems[iCommodity].UnitsDensity = Units.PCF;

};

}

// Assigning the array of commodity items to rate quote request

rateRequest.CommodityList = commodityItems;

Accessorials
Method Name: GetRates

Part of: Rate Quote Section

3PL offers you to send accessorials in rate quote request like ‘Residentials Deliver’, ‘Liftgate Pickup’, ‘Notify Before Call’ etc… for XML carriers’ rates. To request accessorials in rate quote, create an array of accessorial items and set your desired accessorial in each item of accessorial items array and assign it to the rate request property named XMLAccessorials.

AccessorialItem enumerator Related property: XMLAccessorials

MiscCharge
ExcessiveLength
HazardousMaterialsCharge
InsideDelivery
InsidePickUp
LiftGateDelivery
LiftGatePickUp
LimitedAccessDelivery
LimitedAccessPickUp
NotifyBeforeDelivery
ResidentialDelivery
ResidentialPickup
StorageFacilityDelivery
StorageFacilityPickUp
TradeShowDelivery
TradeShowPickup

Rate Quote Response
Method Name: GetRates

Part of: Rate Quote Section

Rate quotes response returns following information that are structured below;

ShipmentRateResponse class

Property Name:

Type:

Definition:

ReferenceId

string

Returns the reference number of rate response

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Status

Returns the status of rate quotes object

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

SMCRateList

SMCRates

Returns the SMC carriers’ rate quotes response

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

XMLRateList

XMLRates

Returns the XML carriers’ rate quotes response

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

EquipmentType

EquipmentTypes

Get Equipment Type of shipment as sent in request

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

RequestCarrierDetail

bool

get Carrier Details

SMCRates classRelated property: SMCRateList

Property Name:

Type:

Definition:

Billed

Rate[]

Returns the SMC carriers’ billed rates

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Cost

Rate[]

Returns the SMC carriers’ base rates

XMLRates classRelated property: XMLRateList

Property Name:

Type:

Definition:

Billed

Rate[]

Returns the XML carriers’ billed rates

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Cost

Rate[]

Returns the XML carriers’ base rates

Rate class Related properties: Billed & Cost

Property Name:

Type:

Definition:

Reference

string

Returns the tariff id

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

TariffName

string

Returns the tariff name

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

CarrierName

string

Returns the carrier name

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

WeightActual

int

Returns the actual requested weight

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

WeightBilled

int

Returns the billed weight

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

WeightDeficit

int

Returns the deficit weight (if any)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

CharghesMinimum

double

Returns the minimum commodity charges

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ChargesTotal

double

Returns the total shipment charges

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ChargesDiscounted

double

Returns the total discounted shipment charges

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

TransitDays

int

Returns the total transit days

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

TransitType

string

Returns the transit type

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

IsGuaranteedRate

bool

Returns true for guaranteed rate otherwise false

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

PriorityText

string

Priority Text for guaranteed rates

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Deficit

RateDetail[]

Returns the deficit weight details (if any)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

CommodityList

RateDetail[]

Returns the commodity(s) details

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

SupplementalCharges

RateDetail[]

Returns the supplemental(s) details (if any)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

XMLAccessorialCharges

RateDetail[]

Returns the XML accessorial(s) details (if any)

RateDetail class

Related properties:

Deficit
CommodityList
SupplementalCharges
XMLAccessorialCharges

Property Name:

Type:

Definition:

Reference

string

Returns the reference number

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Rate

double

Returns the average rate of charge

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Charge

double

Returns the net charges

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Discounted

double

Returns the discounted charges

CurrentStatus class Related property: Status

Property Name:

Type:

Definition:

int

Returns the status code/error code

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Description

string

Returns the status of rate quote response

Track Shipment
Method Name: GetTrackingInfo

You may now easily track your shipment online. Provide some related shipment information like pro number, pickup date etc. in your shipment tracking request and track your shipment. To use this feature, call the function GetTrackingInfo.

Note: You are required to provide to provide any one or more information about shipment to track.

TrackingRequest class

Property Name:

Type:

Required:

Expected Value:

Definition:

LoadId

string[]

No (Optional)

string[] value

Takes single or multiple load id(s)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

ProNumber

string[]

No (Optional)

string[] value

Takes single or multiple pro number(s)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

ShipperNo

string[]

No (Optional)

string[] value

Takes single or multiple shipper number(s)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

PickUpNo

string[]

No (Optional)

string[] value

Takes single or multiple pickup number(s)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

POReference

string[]

No (Optional)

string[] value

Takes single or multiple po reference(s)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Format:

Definition:

PickupDateBegin

string

No (Optional)

string value

MM/dd/yyyy

Takes pickup start date (with open time)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Format:

Definition:

PickupDateEnd

string

No (Optional)

string value

MM/dd/yyyy

Takes pickup end date (with close time)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Format:

Definition:

RecentActivityDate

string

No (Optional)

string value

MM/dd/yyyy

Takes recent activity date

Call Method
Method Name: GetTrackingInfo

Part of: Track Shipment Section

Calling the GetTrackingInfo method will return you the shipment(s) tracking response according to your requested criterion.

GetTrackingInfo method

Parameter Name:

Type:

Required:

Expected Value:

Definition:

ssid

string

Yes

string value

Takes your SSID to validate authentication

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Parameter Name:

Type:

Required:

Expected Value:

Definition:

trackingRequest

TrackingRequest

Yes

TrackingRequest object

Takes the shipment information to track

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Function Return Type:

Function Definition:

TrackingResponse

Returns the tracking response object

Track Shipment Response Object
Method Name: GetTrackingInfo

Part of: Track Shipment Section

Shipment tracking response returns following information of single or multiple shipment(s) (as requested) are structured below;

TrackingResponse class

Property Name:

Type:

Definition:

ShipmentList

TrackingDetail[]

Returns the tracking details of each shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Status

CurrentStatus

Returns the shipment tracking response status

TrackingDetail class Related property: ShipmentList

Property Name:

Type:

Definition:

LoadId

string

Returns the load numberrateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ProNumber

string

Returns the pro numberrateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ShipperNo

string

Returns the shipper numberrateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

PickUpNo

string

Returns the pickup numberrateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

POReference

string

Returns the po referencerateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

PickupDate

string

Returns the pickup daterateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

DeliveryDate

string

Returns the delivery daterateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Pieces

int

Returns the piecesrateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Weight

double

Returns the weightrateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Status

string

Returns the statusrateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Destination

string

Returns the destination zip coderateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Origin

string

Returns the origin zip coderateRequest

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ActivityDate

string

Returns the last activity date

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ActivityDescription

string

Returns the last activity description

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ActivityDatePrev

string

Returns the older activity date

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ActivityDescriptionPrev

string

Returns the older activity description

CurrentStatus class Related property: Status

Property Name:

Type:

Definition:

int

Returns the status/error code

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Description

string

Returns the status of shipment tracking response

Call Method
Method Name: TrackShipmentByProNumber

Part of: Track Shipment via Carrier Section

Calling the TrackShipmentByProNumber method will return you the shipment current status directly from carrier.

TrackShipmentByProNumber method

Parameter Name:

Type:

Required:

Expected Value:

Definition:

ssid

string

Yes

string value

Takes your SSID to validate authentication

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Parameter Name:

Type:

Required:

Expected Value:

Definition:

proNumber

string

Yes

string value

Takes the shipment pro number

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Parameter Name:

Type:

Required:

Expected Value:

Definition:

carrierSCAC

string

Yes

string value

Takes the shipment carrier SCAC

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Function Return Type:

Function Definition:

TrackingShipmentResponse

Returns tracking via carrier response object

Track Shipment via Carrier Response Object
Method Name: TrackShipmentByProNumber

Part of: Track Shipment via Carrier Section

Shipment tracking via carrier response returns following information of shipment is structured below;

TrackingShipmentResponse class

Property Name:

Type:

Definition:

ResponseStatus

string

Returns the response status (success/fail)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ShipmentStatus

string

Returns shipment tracking status via carrier

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

DeliveryDate

string

Returns the shipment delivery date via carrier

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ActualDeliveryDate

string

Returns shipment actual delivery date via carrier

Create Shipment
Method Name: CreateShipment

You may now easily create your shipment online. Provide some related shipment information like Origin, Destination, Commodity Details etc. in your shipment. To use this feature, call the function CreateShipment.

CreateLoadRequest class

Property Name:

Type:

Required:

Expected Value:

Definition:

ReferenceId

string

No (Optional)

string value

Takes ReferenceId

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

POReference

string

No (Optional)

string value

Takes POReference

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

ShipperNo

string

No (Optional)

string value

Takes shipper number

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

PickUpNo

string

No (Optional)

string value

Takes pickup number

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

ProNumber

string

No (Optional)

string value

Takes multiple pro number

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

PickupDate

string

No (Optional)

string value

Takes pickup start date (with open time)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

PickupDockCloseTime

string

No (Optional)

string value

Takes pickup close time

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

DeliveryDate

string

No (Optional)

string value

Takes Delivery date

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

OriginAddress

ShipAddress

Yes

ShipAddress value

Takes shipper(s) Address

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

DestinationAddress

ShipAddress

Yes

ShipAddress value

Takes Destination Address

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

AdditionalStops

ShipAddress

No(Optional)

ShipAddress[] value

Takes Additional Stops

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

CommodityList

Yes

CommodityList[] value

Commodity List Details

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Palletized

bool

No(Optional)

bool value

Used if Rate Request is Palletized

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Pallet Size

int

No(Optional)

int(0-5) value

Takes Pallet Size of Shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Pallets

int

No(Optional)

int value

Total Pallets Count

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Stackable

bool

No(Optional)

bool value

Used if Rate Request is Stackable

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

LinearFeet

int

No(Optional)

int value

Used if Rate Request Contains LinearFeet

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

ShipmentValue

double

No(Optional)

double value

ShipmentValue

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

TBValue

double

No(Optional)

double value

Total Bill Value

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

TCValue

double

No(Optional)

double value

Total Cost Value

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Comments

string

No(Optional)

string value

Comments text

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

SupplementalCharges

No(Optional)

SupplementalCharges[] value

Supplemental Charges

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

CarrierName

string

No(Optional)

string value

Carrier Name

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

CarrierSCAC

string

No(Optional)

string value

Carrier SCAC Code

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

PayerDescription

string

No(Optional)

string value

Takes Payer Description

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

CreatedByName

string

No(Optional)

string value

Takes user(s) name

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Notes

string

No(Optional)

string value

Takes shipment Notes

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

EquipmentType

EquipmentTypes

No(Optional)

EquipmentTypes value

Takes Equipment Type of Shipment

ShipAddress class Related property: AdditionalStops

Property Name:

Type:

Required:

Definition:

Company

string

No(Optional)

Takes Company Name

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

ShipperName

string

No(Optional)

Put shipper name (if OriginAddress)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

ConsigneeName

string

No(Optional)

Put consignee name (if DestinationAddress)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Address1

string

No(Optional)

Takes Address1 of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Address2

string

No(Optional)

Takes Address2 of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

City

string

No(Optional)

Takes City of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

State

string

No(Optional)

Takes State of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Zip

string

yes

Takes Zip of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Country

string

No(Optional)

Takes Country of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Contact

string

No(Optional)

Takes Contact of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

string

No(Optional)

Takes Email of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Phone

string

No(Optional)

Takes Phone of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Fax

string

No(Optional)

Takes Fax of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Notes

string

No(Optional)

Takes Notes for shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

LocationType

AddressType

No(Optional)

Takes LocationType of Company

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Stop

StopType

No(Optional)

Takes LocationType of Company

AddressType class Related property: AddressType

Property Name:

Type:

Required:

Definition:

BussinessWithDock

int

No(Optional)

Takes BussinessWithDock

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

BusinessWithoutDock

int

No(Optional)

Takes BusinessWithoutDock

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Residential

int

No(Optional)

Takes Residential

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

TradeShow

int

No(Optional)

Takes TradeShow

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

ConstructionSite

int

No(Optional)

Takes ConstructionSite

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Terminal

int

No(Optional)

Takes Terminal

StopType class Related property: Stop

Property Name:

Type:

Required:

Definition:

Pickup

int

No(Optional)

Takes Pickup

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Drop

int

No(Optional)

Takes Drop

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Definition:

Both

int

No(Optional)

Takes Both

Commodities
Method Name: CreateShipment

Part of: Create Shipment Section

3PL API allows you to book upto 6 commodities (maximum) online in several packaging type with multiple and various types of classes including package size. To request commodities on create shipment, create an array of commodity items and set your desired commodity detail in each item and assign it to the create shipment request property named CommodityList.

Commodity class Related property: CommodityList

Property Name:

Type:

Required:

Expected Value:

Definition:

Reference

string

No (Optional)

string value

Takes the commodity number

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Description

string

No (Optional)

string value

Takes the definition of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

NMFC

string

No (Optional)

string value

Takes the NMFC code associated to your account

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Pieces

int

Yes

int value

Takes the number of pieces in commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Weight

double

Yes

double value

Takes the weight of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Density

double

No (Optional)

double value

Takes the density of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Length

double

No (Optional)

double value

Takes the length of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Width

double

No (Optional)

double value

Takes the width of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Height

double

No (Optional)

double value

Takes the height of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Packaging

Package

Yes

Package value

Takes the packaging of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

Class

ClassType

Yes

ClassType value

Takes the class of commodity

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

UnitsWeight

Units

No (Optional)

Units value

Takes the weight measuring unit

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

UnitsDim

Units

No (Optional)

Units value

Takes the dimension measuring unit

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Required:

Expected Value:

Definition:

UnitsDensity

Units

No (Optional)

Units value

Takes the density measuring unit

Package enumerator Related property: Packaging

none
Pallets
Bags
Boxes
Bundles
Cartons
Cases
Crates
Drums
Pails
Rolls
Stacks
Totes
Wheels
FTL
LTL
Pieces

ClassType enumerator Related property: Class

none
c50
c55
c60
c65
c70
c77_5
c85
c92_5
c100
c110
c125
c150
c175
c200
c250
c300
c400
c500

Units enumerator Related property: UnitsWight, UnitsDim & UnitsDensity

Feet
Inches
Meters
Yards
cm
PCF
kgm
lbs
kg

// Creating a list of commodities for create shipment request

// ‘count’ is a number of commodities that you want to create

Commodity[] commodityItems = new Commodity[count];

for (int iCommodity = 0; iCommodity < count; iCommodity++)

{

commodityItems[iCommodity] = new Commodity()

{

commodityItems[iCommodity].Reference = i.ToString();

commodityItems[iCommodity].Pieces = 2;

commodityItems[iCommodity].Packaging = Package.Pallets;

commodityItems[iCommodity].Description = “Material”;

commodityItems[iCommodity].NMFC = “NMFC Code here”;

commodityItems[iCommodity].Weight = 1500;

commodityItems[iCommodity].Class = ClassType.c65;

commodityItems[iCommodity].Density = 0;

commodityItems[iCommodity].Length = 0;

commodityItems[iCommodity].Width = 0;

commodityItems[iCommodity].Height = 0;

commodityItems[iCommodity].UnitsWeight = Units.lbs;

commodityItems[iCommodity].UnitsDim = Units.Feet;

commodityItems[iCommodity].UnitsDensity = Units.PCF;

};

}

// Assigning the array of commodity items to create shipment

// request

shipmentRequest.CommodityList = commodityItems;

Call Method
Method Name: CreateShipment

Part of: Create Shipment Section

Calling the CreateShipment method will create the shipment according to your requested criterion.

CreateShipment method

Parameter Name:

Type:

Required:

Expected Value:

Definition:

ssid

string

Yes

string value

Takes your SSID to validate authentication

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Parameter Name:

Type:

Required:

Expected Value:

Definition:

request

CreateLoadRequest

Yes

CreateLoadRequest object

Takes the load information to create shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Function Return Type:

Function Definition:

CreateLoadResponse

Returns the CreateLoad Response object

Create Shipment Response
Method Name: CreateShipment

Part of: Create Shipment Section

Create Shipment response returns following information

CreateShipmentResponse class

Property Name:

Type:

Definition:

LoadId

string value

Returns the loadid for shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Status

CurrentStatus

Returns the create shipment response status

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

POReference

string value

Returns the POReference for shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ShipperNo

string value

Returns the ShipperNo for shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

PickUpNo

string value

Returns the PickUpNo for shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ReferenceId

string value

Returns the ReferenceId for shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

ChargesTotal

double value

Returns the ChargesTotal for shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

TranistDays

int value

Returns the TranistDays for shipment

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

EquipmentType

EquipmentTypes value

Returns the Equipment Type of shipment

CurrentStatus class Related property: Status

Property Name:

Type:

Definition:

int

Returns the status/error code

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Description

string

Returns the status of create shipment response

E-Dispatch
Method Name: CreateEDispatch

You can electronically dispatch your shipments by just provide shipment load number. On successful e-dispatch, pickup number will be returned to you. To electronically dispatch your shipments, call the CreateEDispatch method.

CreateEDispatch method

Parameter Name:

Type:

Required:

Expected Value:

Definition:

ssid

string

Yes

string value

Takes your SSID to validate authentication

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Parameter Name:

Type:

Required:

Expected Value:

Definition:

loadNumber

string

Yes

string value

Takes your shipment load number to e-dispatch

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Function Return Type:

Function Definition:

EDispatchResponse

Returns pickup number on successful e-dispatch

E-Dispatch Response Object
Method Name: CreateEDispatch

Part of: E-Dispatch Section

Shipment e-dispatch response returns following information (as requested) are structured below;

EDispatchResponse class

Property Name:

Type:

Definition:

PickupNumber

string

Returns the pickup number on e-dispatch

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Status

CurrentStatus

Returns the e-dispatch response status

CurrentStatus class Related property: Status

Property Name:

Type:

Definition:

int

Returns the status code/error code

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Description

string

Returns the status of rate quote response

E-Dispatch Status
Method Name: GetEDispatchStatus

You can check your shipment status that it is electronically dispatched or not by just provide shipment load number. To check electronically dispatch status your shipment, call the GetEDispatchStatus method.

GetEDispatchStatus method

Parameter Name:

Type:

Required:

Expected Value:

Definition:

ssid

string

Yes

string value

Takes your SSID to validate authentication

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Parameter Name:

Type:

Required:

Expected Value:

Definition:

loadNumber

string

Yes

string value

Takes your shipment load number to e-dispatch

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Function Return Type:

Function Definition:

CurrentStatus

Returns shipment status (if e-dispatched)

E-Document Retrieval
Method Name: Get_E_Document

You may get e-document of your shipment using load number. E-document will be retrievable only if the valid pro number is set against the shipment. To get the e-document of your shipment, call the Get_E_Document method.

Get_E_Document method

Parameter Name:

Type:

Required:

Expected Value:

Definition:

ssid

string

Yes

string value

Takes your SSID to validate authentication

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Parameter Name:

Type:

Required:

Expected Value:

Definition:

loadID

string

Yes

string value

Takes your shipment load number to get e-document

E-Document Retrieval Response Object
Method Name: Get_E_Document

Part of: E-Document Retrieval Section

Shipment’s e-document retrieval response returns following information (as requested) are structured below;

E_Document_Response class

Property Name:

Type:

Definition:

Status

CurrentStatus

Returns the e-document response status

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Response

byte[][]

Returns the e-document response in bytes (two-dimentional array)

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

DocumentFormat

docFormatType

Returns e-document response format type i.e., Image or PDF

CurrentStatus class Related property: Status

Property Name:

Type:

Definition:

int

Returns the status/error code

– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –

Property Name:

Type:

Definition:

Description

string

Returns the status of e-document retrieval response

docFormatType enumerator Related property: DocumentFormat

Image
PDF