ShipRush
ADO: Fields ReferenceShipRush
ADO: Fields Reference
Quick Links:
Read Fields (aka Contact Info)
|
SQL Field Name |
|
Description |
|
RecordID |
Optional |
Order number, Contact ID, Account ID or any identifier. Not used by ShipRush, but crucial for passing into the INSERT/UPDATE statement when writing history. |
|
CompanyName |
See Desc |
Ship-To Company Name (optional if ContactName is supplied) |
|
ContactName |
See Desc |
Ship-To Contact Name (optional if CompanyName is supplied) |
|
ContactType |
Optional |
Contact type, currently not used |
|
Address1-Address3 |
See Desc |
Ship-To Address info. Only pull data into Address1 and Address2 (pulling into Address3 causes the data to be fed into 1 and 2). At least Address1 must be returned |
|
City |
Required |
Ship-To City |
|
State |
Required for countries that have states |
Ship-To State |
|
ZIP |
Required |
Ship-To Postal Code |
|
Country |
Optional |
Ship-To Country Defaults to USA |
|
Phone |
Required |
Ship-To Phone Some shipping services require a phone number. It is advised to return a static value (perhaps the shipper's phone number) if the Ship To phone number is not available. |
|
Fax |
Optional |
Ship-To Fax |
|
|
Optional |
Ship-To Email |
|
Notes |
Optional |
Contact notes, currently not used |
|
ShippingTemplate |
Optional |
Full path to the ShipRush shipping template file (XML with full shipment/package info). Notes: You need to use shipping template if you want to control more details of the new shipment. Package weight, shipping service, payment type, COD, packaging, etc. Refer to the ShipRush documentation on how to create shipping templates. |
|
CarrierType |
Optional |
Shipping Carrier Type, as a string. If not specified then default carrier used. Options:
The value is case-insensitive. Any other value returned in this field will be ignored. |
|
Reference |
Optional |
Package reference for Package1 |
|
PackageWeight |
Optional |
Package weight for Package1 |
Write Fields (aka History)
|
SQL Field Name |
Description |
|
RecordID |
RecordID from incoming XML file. Empty if incoming XML did not exist. |
|
FromCity |
Ship-From Conact/Address info |
|
FromCompanyName |
|
|
FromCountry |
|
|
FromName |
|
|
FromStateOrProvince |
|
|
FromStreet1 |
|
|
FromZip |
|
|
ToCity |
Ship-To Conact/Address info |
|
ToCountry |
|
|
ToName |
|
|
ToStateOrProvince |
|
|
ToStreet1 |
|
|
ToZip |
|
|
ShippingCarrier |
Shipping Carrier that was used. “USP”, “FEDEX”, “ENDICIA” or “USPS” |
|
ShippingService |
Shipping service that was used “Next Day”, “2 Day”, etc |
|
TrackingNumber |
Carrier tracking number |
|
ShippingCharges |
Total Shipping Charges |
|
ShippingWeight |
Total Shipment Weight |
|
HistoryNotes |
Full shipment details in human-readable format. Multiline CRLF separated. |
|
SmallHistoryNotes |
Short shipment details in human-readable format. Multiline CRLF separated |
|
HistoryReference |
Very short shipment details. Single line. |
Merge Codes
|
%GUID% |
Causes ShipRush to generate a new GUID |
|
%RecordID% |
Available only when writing history |
|
%EnvVar(<varname>)% |
Reads environment variables from the local PC. For example, if the user's login name, or PC name needs to be merged into a SQL statement, this merge code can be used.
Example:
%EnvVar(ComputerName)% |
|
%Today(format)% |
Current date formatted as specified.
Example:
%Today(mmddyy)%
See below for available format options. |
|
%SEARCHPARAM% |
The element searched for or scanned with a bar code scanner |
Date Formatting:
c Displays the short date, followed by the long time.
d Displays the day as a number without a leading zero (1-31).
dd Displays the day as a number with a leading zero (01-31).
ddd Displays the day as an abbreviation (Sun-Sat).
dddd Displays the day as a full name (Sunday-Saturday).
m Displays the month as a number without a leading zero (1-12).
mm Displays the month as a number with a leading zero (01-12).
mmm Displays the month as an abbreviation (Jan-Dec).
mmmm Displays the month as a full name (January-December).
yy Displays the year as a two-digit number (00-99).
yyyy Displays the year as a four-digit number (0000-9999).
h Displays the hour without a leading zero (0-23).
hh Displays the hour with a leading zero (00-23).
n Displays the minute without a leading zero (0-59).
nn Displays the minute with a leading zero (00-59).
s Displays the second without a leading zero (0-59).
ss Displays the second with a leading zero (00-59).
z Displays the millisecond without a leading zero (0-999).
zzz Displays the millisecond with a leading zero (000-999).
t Displays the time using short format.
tt Displays the time using long format.
am/pm Uses the 12-hour clock for the preceding h or hh specifier, and displays 'am' for any hour before noon, and 'pm' for any hour after noon.
a/p Uses the 12-hour clock for the preceding h or hh specifier, and displays 'a' for any hour before noon, and 'p' for any hour after noon.
ampm Uses the 12-hour clock for the preceding h or hh specifier.
/ Displays the date separator.
: Displays the time separator.
'xx'/"xx" Characters enclosed in single or double quotes are displayed as-is, and do not affect formatting.