Introduction:
FreightWise supports in addition to our Public API rate quoting via files. These can be either in text CSV (*.txt) or Excel (*.xlsx) formats.
The process is that FreightWise parses a request file from the client and creates a response file back for the client to parse. In this exchange there are two files that are defined in more detail below.
Rate Quoting Process:
The following is brief overview of the rate quoting process via CSV or Excel file details:
- Client initiates creating a request file (xlsx or csv) per the "Request File" format described below.
- Client saves file on server for FreightWise to capture for processing
- Once FreightWise has completed processed the request file a response file is created per the "Response File" format described below and saved on client's server.
- Client retrieves response file and processed accordingly.
Request File:
Group |
Position |
Name |
Required |
Example |
Description |
|
| LTL | Parcel | |||||
|
Info
|
1 |
Group ID |
Y |
Y |
123aBc |
See details below. |
|
2 |
PO Number |
N |
N |
po12aB |
PO Number |
|
|
3 |
SO Number |
N |
N |
so12aB |
SO Number |
|
|
4 |
Delivery Number |
N |
N |
de43aB |
Delv. Number |
|
|
Origin
|
5 |
Org. Name 1 |
N |
Y |
||
|
6 |
Org. Name 2 |
N |
N |
|||
|
7 |
Org. Addr. 1 |
N |
Y |
|||
|
8 |
Org. Addr. 2 |
N |
N |
|||
|
9 |
Org. City |
N |
Y |
|||
|
10 |
Org. State |
Y |
Y |
TN | Only two letter abbreviation | |
|
11 |
Org. Postal Code |
Y |
Y |
37027 | The ZIP or Postal Code | |
|
12 |
Org. Country |
Y |
Y |
USA | Country: USA or CAN or MEX | |
|
Destination
|
13 |
Dest. Name 1 |
N |
Y |
||
|
14 |
Dest. Name 2 |
N |
N |
|||
|
15 |
Dest. Addr. 1 |
N |
Y |
|||
|
16 |
Dest. Addr. 2 |
N |
N |
|||
|
17 |
Dest. City |
N |
Y |
|||
|
18 |
Dest. State |
Y |
Y |
TN | Only two letter abbreviation | |
|
19 |
Dest. Postal Code |
Y |
Y |
37064 | The ZIP or Postal Code | |
| 20 |
Dest. Country |
Y |
Y |
USA | Country: USA or CAN or MEX | |
| Commodity | 21 |
NMFC Class |
Y |
N |
65 | Default "50" if left blank |
| 22 |
Weight |
Y |
Y |
123 | Pounds (lbs.) | |
| 23 |
Pallets / Skids / Boxes |
N |
Y |
Default 1 if left blank | ||
| 24 |
Pieces |
N |
N |
Default 1 if left blank | ||
| 25 |
Dim L |
N |
Y |
Only used for Parcel | ||
| 26 |
Dim W |
N |
Y |
Only used for Parcel | ||
| 27 |
Dim H |
N |
Y |
Only used for Parcel | ||
| 28 |
Accessorials |
N |
N |
RES1, LG01 | See details below. | |
| 29 |
Get PRO# |
N |
N/A |
YES / NO | See details below. | |
Response File:
| Position | Name | Example | Description |
| 1 | Group ID | 123ABC | See details below |
| 2 | Status Code | 200 | See details below |
| 3 | Mode ID | 1 | See details below |
| 4 | Carrier SCAC | RCLA | SCAC of LCC |
| 5 | Carrier Name | R+L Carrier Inc. | Carrier Name |
| 6 | Est. Cost | 123.45 | The estimated cost of the LCC (USD) |
| 7 | Est. Cost + Markup | 135.80 | Added MU per Client setting (Expl. is 10%) |
| 8 | Est. Transit Days | 3 | Est. Transit days |
| 9 | PRO# | I0099887766 | Blank PRO# per SCAC |
| 10 | Resp. Message | See details below |
Field Details:
Group ID:
The Group ID is used if there are multiple commodities that need to be rated. It allows the system to group multiple lines together so a single quote can be created with one or more commodities. In addition the Group Id is also used for the response file return so the client can match the rate request file to the rate response file.
Mode ID:
The mode id designates if LTL or parcel is the mode to transport on. The following are valid modes:
- LTL = 1
- TL = 2
- Parcel = 18
LLC:
The LCC stands for Least Cost Carrier - In essence the most economical carrier the rate quote finds.
Accessorials:
If accessorials are need for quoting then these can be set by "comma" separating ACC-Codes in the field. Example of commonly used codes are:
- RES1 = Residential Delivery
- LG01 = Liftgate Delivery
- ID02 = Inside Delivery
Get PRO#:
If the "Get PRO#" field is true then FreightWise will once the carrier is selected checkout a PRO# on LTL modes for the specified carrier's SCAC.
Resp. Message (Response Message):
Status Code:
FreightWise generally follows HTTP status codes by assigning these:
- 200 = All good
File Naming:
Generally the file names can be anything. When operating on sFTP servers it is usually good to keep them unique.
Supported File Formats:
There are two types of files that FreigthWise supports for rate quotes. Excel (xlsx) and CSV (pipe delimited). Details of the file structure can be found below.
Text CSV:
A text CSV (*.txt) format. This is essentially a text file that uses a "|" (pipe character - ascii code 124) as delimiter. The line breaks are delimited by a "\n" or "\r" or "\r\n". All CSV files should be in UTF-8 format.
Excel (*.xlsx):
Excel files are also supported. No header line is required and only xlsx files are supported.
0 Comments