Automating with the NRGship URL Type
An easy way to integrate NRGship Mac into an existing web-based solutions or other external Mac applications is via the nrgship:// URL type.
SAMPLE URL
Below is an example of a sample shipping URL. You must have NRGship UPS installed on your workstation for this to work. This particular URL will create a ship record in NRGship, it will NOT print a shipping label.
nrgups://newShipment/?Service=UPS 3 Day Select;User_Field01=40;ShipTo_Name=ZYZ Co.;ShipTo_AttentionName=Mike Smith;ShipTo_AddressLine1=4100 S Avon;ShipTo_City=New Berlin;ShipTo_StateProvinceCode=WI;ShipTo_PostalCode=53151;ShipTo_EmailAddress=user@domain.com; Package_Weight=5
HOW TO MAKE YOUR OWN URL
Simply construct a URL that starts with nrgups://newShipment/? and append any of the elements from the list below.
Make sure you URL encode any values you send over (like spaces, line feeds, etc). Most languages have built-in support for this, for example, in PHP you can use rawurlencode() and Objective-C/Cocoa you can use
-[NSString stringByAddingPercentEscapesUsingEncoding:]. All escaped characters are interpreted using UTF8 encoding.
When a user clicks on a URL link, NRGship will activate and populate the screen with the information contained in the URL without the need to copy and paste.
SHIPMENT ELEMENTS LIST
ShipTo_Name
ShipTo_AttentionName
ShipTo_AddressLine1
ShipTo_AddressLine2
ShipTo_AddressLine3
ShipTo_City
ShipTo_StateProvinceCode
ShipTo_PostalCode
ShipTo_Country
ShipTo_PhoneNumber
ShipTo_ResidentialAddress [1 if true]
ShipTo_LocationID
ShipTo_EmailAddress
Service [see list for valid service types]
SaturdayDelivery [1 if true]
BillToRadio [My UPS Account, Receiver, Consignee, Third Party]
BillToUPSAccountNumber
BillToPostalCode
Package_Packaging [See list for valid packaging types]
Package_Weight
Package_Dim_Length
Package_Dim_Height
Package_Dim_Width
Package_InvoiceNumber
Package_ReferenceNumber
Package_InsuredValue
Package_AddlHandling [1 if true]
Package_CODAmount
Package_CODCashiersCheckMoneyOrderOnly [1 if true]
Package_DeliveryConfirmationType [Blank, No Signature, Signature Required, Adult Signature Required]
Package_ShipperRelease [1 if true]
Package_VerbalConfirmation [1 if true]
AUTO CAPTURE WEIGHT
Append ";autoWeight=true" to automatically capture the weight off a digital scale
AUTO SHIP
Append ";autoShip=true" to the URL to invoke automatic shipping
