To Set Up Integration with UPS

Before you configure integration with UPS, your organization should have an account with the carrier and a signed service agreement. The SurePost service requires an additional service contract signed with USPS. The settings for the plug-in are specified in accordance with the information available in the agreement.

To configure integration between MYOB Advanced and UPS—a carrier that provides shipping services nationwide—you use the Carriers (CS207700) form. On this form, specify a name to be used for this carrier in your system, select the appropriate plug-in developed for this integration, and enter the values for the plug-in parameters. Some parameters are used for authentication with the carrier's system, while others are used for printing carrier labels or enabling recipient notifications.

To Specify Plug-in Settings for UPS

  1. Open the Carriers (CS207700) form.
  2. In the Carrier ID box, type an easy-to-remember name for the carrier to be integrated.
  3. Provide a description for this carrier.
  4. In the Plug-in (Type) box, select PX.UpsCarrier.UpsCarrier.
  5. In the Carrier Units box, select the measuring system used by the carrier: SI Units (Kilogram/Centimeter) or US Units (Pound/Inch). Based on the selected option, one of the following pairs of boxes is shown on the form: Kilogram and Centimeter, or Pound and Inch.
  6. In the Kilogram and Centimeter boxes (or in the Pound and Inch boxes, depending on the measuring system selected for the carrier), select the units of measure defined in the system that correspond to the weight and linear units of measure used by the carrier.
    Note: If you select a UOM other than the default weight or linear UOM, which is specified in the Weight UOM box or Linear UOM box on the Companies (CS101500) form, use the Units of Measure (CS203100) form to specify the conversion from the default weight or linear UOM of the company to the unit you have selected as the equivalent to the UOM used by the carrier.
  7. Optional: In the Warehouse box, specify a particular warehouse for which the carrier's rates are applicable, or leave the box empty if the carrier’s rates are applicable for all warehouses.
  8. On the Plug-in Parameters tab, do the following:
    • If you need to get certification from UPS to use its API in production, prepare the certification files. To generate the files for certification with this carrier, click Prepare Certification Files on the table toolbar of the Plug-in Parameters tab.
    • For the ACCESSNUM parameter, enter the value according to your service agreement.
    • For the ACCOUNTID parameter, enter the identifier of the account your company has with the carrier.
    • For the ENDPOINT parameter, type or copy and paste the URL of the UPS service from your agreement.
    • For the LABEL FORMAT parameter, select the format (EPL, SPL, ZPL, GIF, or STARPL) to be used for printing labels on your printer.
    • For the LOGIN parameter, enter the login to be used to sign in to this account.
    • For the LOGTRACE parameter, select the check box to indicate to the carrier service that the request and results of the web calls will be saved in the trace.
    • For the NEGOTIATED parameter, select the check box if your organization has special rates that should be used for calculating freight costs.
    • For the NOTIFY parameter, select the check box if you want notifications to be sent to the recipients. Then on release of each shipment, the carrier's online service will generate a notification email to the email address of the contact specified for the shipment on the Shipping tab of the Shipments (SO302000) form.
    • For the PASSWORD parameter, enter the password to be used with the login to sign in to the account.
    • For the PICKUP TYPE parameter, select the appropriate option according to the agreement:
      • Daily Pickup
      • Customer Counter
      • One-Time Pickup
      • On-Call Air
      • Suggested Retail Rates
      • Letter Center
      • Air Service Center
    • For the SIGN RELZ NO parameter, enter the signature release (DCIS) number according to your service agreement.
    • For the SHIP ENDPOINT parameter, type or copy and paste the URL of the UPS ship service according to your service agreement.
    • For the SHIPPER FROM parameter, leave the default Company Branch value if you want the system to get the shipper information from the company branch, or select Warehouse to make the system get the shipper information from the warehouse.
    • For the SIGNATURE parameter, select the appropriate signature request option according to the agreement:
      • System Default
      • Delivery Confirmation
      • Delivery Confirmation Signature Required
      • Delivery Confirmation Adult Signature Required
    • For the SUREPOST END parameter, select one of the following USPS endorsement options for SurePost shipments delivered by the USPS:
      • Return Service Requested
      • Forwarding Service Requested
      • Address Service Requested
      • Change Service Requested
    • For the SUREPOST SUB parameter, select the appropriate type of packages (less than 1 lb) for shipments by SurePost:
      • Irregular
      • Machinable
    • For the TEST MODE parameter, select the check box to test the integration.
    • For the TNT ENDPOINT parameter, type or copy and paste the URL of the UPS time-in-transit service according to your service agreement.
    • For the VOID ENDPOINT parameter, type or copy and paste the URL of the UPS void service according to your service agreement.
  9. On the Customer Accounts tab, add all customers that have accounts with the carrier and should be billed for the shipments they receive via this carrier. For each customer you add, do the following:
    • In the Customer ID column, select the customer by its ID.
    • Make sure the Active check box is selected.
    • In the Location column, select the customer location to receive shipments via the carrier.
    • In the Carrier Account column, enter the customer's account number with the carrier.
    • In the Postal Code column, type the postal code for locations.
  10. Click Save on the form toolbar.

For an example of filling in the plug-in parameters, see the table below.

Table 1. Parameters of plug-in PX.UpsCarrier.UpsCarrier
CAUTION: Do not use the values used in this example for production. The sensitive data is partially or completely masked by asterisks.
ID Description
ACCESSNUM *****************
ACCOUNTID Account Number R88A72
ENDPOINT UPS Service URL https://wwwcie.ups.com/webservices/Rate
LABEL FORMAT Provides the type of data stream or bitmap to be returned GIF
LOGIN *****************
LOGTRACE If checked, the requests and results of the web calls will be saved in trace. Cleared
NEGOTIATED Use Negotiated Rates. Cleared
NOTIFY Send Notification to Recipient. Cleared
PASSWORD ***************
PICKUP TYPE Pickup Type Code Daily Pickup
SHIP ENDPOINT UPS Ship Service URL https://wwwcie.ups.com/webservices/Ship
SHIPPER FROM Shipper Contact information source Company Branch
SIGN RELZ NO DCIS number.
SIGNATURE Delivery Confirmation
SUREPOST END USPS endorsement is a special handling for SurePost shipments delivered by the USPS
SUREPOST SUB For UPS SurePost less than 1 lb, it should have either IR = Irregular or MA = Machineable
TEST MODE Test Mode. UPS Test mode uses preset Test Tracking Numbers in Void Shipment Service. Selected
TNT ENDPOINT UPS Time in Transit Service URL https://wwwcie.ups.com/webservices/TimeInTrans it
VOID ENDPOINT UPS Void Shipment Service URL https://wwwcie.ups.com/webservices/Void