Address
Use these methods to manage shipper addresses
API | Description |
---|---|
POST api/Address |
Search the list of addresses |
POST api/Address/Create |
Create a new address |
POST api/Address/Update |
Update an address |
POST api/Address/Delete |
Delete an adress |
Authorization
Used to provide authenication services for the Open API
API | Description |
---|---|
POST api/authorization |
Use this method to get security authorization to use the Open API. The auth field in the response is required on all calls to the web API methods. |
POST api/authorization/EncodedPassword |
EncodedPassword |
POST api/authorization/DecodedPassword |
DecodedPassword |
Commodity
API | Description |
---|---|
GET api/Commodity/{auth} |
Retrive a list of commodities (with UN#) |
ContactList
API | Description |
---|---|
GET api/ContactList/{auth} |
Select the list of contact for user |
Contents
Method to retrieve contents list
API | Description |
---|---|
GET api/Contents/{auth} |
Retrieve a list of contents items for drop down |
Currency
API | Description |
---|---|
GET api/Currency/{auth} |
Retrieve a list of currencies |
Dashboard
Methods used to provide Dashboard data to the customer(shipper)
API | Description |
---|---|
GET api/Dashboard/{DashboardGUID}?DestAirport={DestAirport}&ServiceCodeList={ServiceCodeList} |
Get the raw data for active shipments that can be displayed on a Dashboard |
Distance
Use these methods to calculate distance
API | Description |
---|---|
POST api/Distance/ToFromAirport |
Use to calculate distance to/from an airport (drop or recover) |
POST api/Distance/PointToPoint |
Use to calculate distance to/from an airport (drop or recover) |
Document
Use to manage documents
API | Description |
---|---|
GET api/Document/Shipment/Detail/{auth}/{ShipmentDocumentID} |
Used to select a single shipment document including raw file data |
POST api/Document/Shipment/Create |
Use this method to attach a document to a shipment |
GET api/Document/BatchPrint/{auth} |
Retrieve a list of batch print items |
POST api/Document/BatchPrint/FileData |
Retrieve the combined batch print file |
DocumentType
API | Description |
---|---|
GET api/DocumentType/{auth} |
Retrieve a list of document types |
ExportData
API | Description |
---|---|
GET api/ExportData/{auth} |
Retrieve a list of Export Data reports for user |
POST api/ExportData/RunReport/Order |
Retrieve the Export Data file (when ExportSourceID=10001) |
POST api/ExportData/RunReport/User |
Retrieve the Export Data file (when ExportSourceID=10009) |
Invoice
API | Description |
---|---|
POST api/Invoice |
Retrieve a list of invoices for user |
GET api/Invoice/Detail/{auth}/{InvoiceGUID} |
Retrieve the details for an invoice including file data |
ItemMaster
Use the manage the item master list
API | Description |
---|---|
POST api/ItemMaster |
Search the master item list |
POST api/ItemMaster/Create |
Create a new item |
POST api/ItemMaster/Update |
Update an existing item |
POST api/ItemMaster/Delete |
Delete an item |
OntimePerformance
Use method to manage the Ontime Performance reporting
API | Description |
---|---|
POST api/OntimePerformance/Data |
Retrieve the Ontime Performance data |
POST api/OntimePerformance/Report |
Retrieve the Ontime Performance report (pdf) |
PackagingType
API | Description |
---|---|
GET api/PackagingType/{auth} |
Retrieve a list of packaging type items for drop down |
PostalCode
API | Description |
---|---|
GET api/PostalCode/Lookup/{auth}/{PostalCode}/{CountryID} |
Use to lookup postal code data |
Preprint
Used to manage preprinted airbills
API | Description |
---|---|
GET api/Preprint/{auth}/{TrackingNumber} |
Retrieve preprint information based on tracking number |
Rate
API | Description |
---|---|
POST api/Rate/Estimate |
Rate estimate |
ReferenceGroup
Use to manage reference group (master)
API | Description |
---|---|
GET api/ReferenceGroup/{auth} |
Retrieve the list of reference groups |
POST api/ReferenceGroup/Create |
Create a reference group |
POST api/ReferenceGroup/Update |
Update a reference group |
POST api/ReferenceGroup/Delete |
Delete a reference group |
GET api/ReferenceGroup/Values/{auth}/{ReferenceGroupGUID} |
Retrieve the list of values for this reference group |
POST api/ReferenceGroup/Values/Create |
Create a value for this reference group |
POST api/ReferenceGroup/Values/Delete |
Delete a value from the reference group |
ReferenceType
API | Description |
---|---|
GET api/ReferenceType/{auth} |
Retrieve a list of reference types available to shipper |
Report
Use to create reports
API | Description |
---|---|
GET api/Report/Shipment/{auth}/{ShipmentGUID}/{Type} |
Use this method to retrieve a predefined shipment based forms |
POST api/Report/VerificationAtPickup |
Generate the Verification At Pickup report |
Search
Used these methods to search orders
API | Description |
---|---|
POST api/Search |
Use this method to search orders in shipper web portal |
Service
Used to manage services available to the shipper
API | Description |
---|---|
POST api/Service |
Retrieve list of services for the user |
ServiceAttribute
API | Description |
---|---|
GET api/ServiceAttribute/{auth}/{ServiceID} |
Returns a list of attributes available to service |
Settings
API | Description |
---|---|
POST api/UserAccounts |
Use this method to get a list of accounts available to the shipper user |
GET api/MySettings/{auth} |
Use this method to retrieve the MySettings parameters for the user |
POST api/MySettings/Update |
Used to update MY SETTINGS |
Ship
Use these methods to create and edit shipments
API | Description |
---|---|
POST api/Ship/CreateOrder |
Used this method to create an order. If multiple piece shipment, use the PieceDetail element below to specify details, and leave the details in the root elements blank. |
POST api/Ship/UpdateOrder |
Used to Update an order (only available before courier is dispatched, on limited fields) |
POST api/Ship/ActivateOrder |
Use to activate an order from a quote status, you can also update contents |
POST api/Ship |
Use this method to create a shipment from the shipper |
GET api/Ship/Edit/{auth}/{TrackingValue} |
Use this method to retrieve order information before editing |
POST api/Ship/Edit/Update |
Use this method to updated an editable order |
Timezone
Used to retrieve a list of valid timezones
API | Description |
---|---|
GET api/Timezone/{auth} |
Retrieve a list of timezones |
Track
Use these method to get status information regarding your shipment
API | Description |
---|---|
POST api/Track |
Used to get detailed tracking information for secured connection |
GET api/Track/{TrackingNumber} |
Used to get basic tracking information, not secured so only basic information is available |
GET api/Track/{TrackingNumber}/{UserGUID} |
Used to get extended tracking information, secured so detailed information is available |
POST api/Track/SearchOrders |
Use this method to search for current and historial shipments |
POST api/ActiveOrders |
Use this method to retrieve a list of active orders |
POST api/RecentDeliveries |
Use this method to retrieve a list of recent deliveries |
Watch
API | Description |
---|---|
POST api/Watch |
Retrieve a list of items on users watch list |
GET api/Watch/Add/{auth}/{ShipmentGUID} |
Add shipment to watch list |
GET api/Watch/Remove/{auth}/{ShipmentGUID} |
Remove shipment from watch list |