To Set Up Integration with FedEx

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

To configure integration between MYOB Advanced and FedEx—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.

FedEx provides the ability to use their services via FedEx Web Services API V10 and via FedEx REST API. To configure the integration with FedEx via Web Services API V10, you need to use the PX.FedExCarrier.FedExCarrier plug-in. To configure the integration with FedEx via REST API, you need to use the PX.FedExRestCarrier.FedExRestCarrier plug-in.

To Set Up Integration with FedEx

  1. Open the Carriers (CS207700) form.
  2. In the Carrier ID box, type a name for FedEx.
  3. Provide a description for this carrier.
  4. In the Plug-in (Type) box, select one of the following plug-ins:
    • PX.FedExCarrier.FedExCarrier: To use FedEx via Web Services API V10.
    • PX.FedExRestCarrier.FedExRestCarrier: To use FedEx via REST API
  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:
    • For the ACCOUNTID parameter, enter the ID or number of the account your organization has with the carrier.
    • For the EXTERNAL APP ID parameter, enter the external app ID generated on the External Applications (SM301000) form. For details on integration of an external application, see To Integrate an External Application.

      This parameter appears only for the PX.FedExRestCarrier.FedExRestCarrier plug-in.

    • For the DROPOFF parameter, select the appropriate method to be used by FedEx to pick up the packages:
      • BUSINESS_SERVICE_CENTER
      • DROP_BOX
      • REGULAR_PICKUP
      • REQUEST COURIER
      • STATION
    • For the ENDPOINT parameter, type or copy and paste the URL of the FedEx rate service according to your service agreement.

      This parameter appears only for the PX.FedExCarrier.FedExCarrier plug-in.

    • For the RATE ENDPOINT parameter, type or copy and paste the URL of the FedEx rate service according to your service agreement.

      This parameter appears only for the PX.FedExRestCarrier.FedExRestCarrier plug-in.

    • For the LBL FORMAT parameter, select the format to be used for printing labels on the printer you have (DOC, DPL, EPL2, PDF, PNG, RTF, TEXT, or ZPLII).
    • For the LBL STOCK TYPE parameter, select the stock type of the labels to be used.
    • For the LBL PRINT ORT parameter, select one of the available options:
      • BOTTOM_EDGE_OF_TEXT_FIRST
      • TOP_EDGE_OF_TEXT_FIRST
    • For the LOGIN parameter, enter the login to be used to sign in to your organization's FedEx account.

      This parameter appears only for the PX.FedExCarrier.FedExCarrier plug-in.

    • For the METERID parameter, enter no value.

      This parameter appears only for the PX.FedExCarrier.FedExCarrier plug-in.

    • For the NOTIFY parameter, select the check box if you want a notification to be sent to the recipient. 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.

      This parameter appears only for the PX.FedExCarrier.FedExCarrier plug-in.

    • For the POST ENDORS parameter, select the appropriate endorsement type for FedEx SmartPost shipments from the following options:
      • ADDRESS_CORRECTION
      • CARRIER_LEAVE_IF_NO_RESPONSE
      • CHANGE_SERVICE
      • FORWARDING_SERVICE
      • RETURN_SERVICE
    • For the POST HUBID parameter, type the four-digit number that is an identifier of the USPS or FedEx hub to be used for delivery by FedEx SmartPost.
    • For the POST INDICIA parameter, select the appropriate indicia type to be used by SmartPost:
      • PARCEL_SELECT
      • MEDIA_MAIL
      • PRESORTED_BOUNDED_PRINTED_MATTER
      • PRESORTED_STANDARD
    • For the SA ENDPOINT parameter, type or copy and paste the URL of the FedEx availability service according to your service agreement.

      This parameter appears only for the PX.FedExCarrier.FedExCarrier plug-in.

    • For the CANCEL ENDPOINT parameter, type or copy and paste the URL of the FedEx canceling service according to your service agreement.

      This parameter appears only for the PX.FedExRestCarrier.FedExRestCarrier plug-in.

    • For the SHIP ENDPOINT parameter, type or copy and paste the URL of the FedEx 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 SIGN RELZ NO parameter, enter the signature release number according to your service agreement.
    • For the SIGNATURE parameter, select the appropriate signature requesting option according to your service agreement:
      • ADULT
      • DIRECT
      • INDIRECT
      • NO_SIGNATURE_REQUIRED
      • SERVICE DEFAULT
    • For the ALCOHOL parameter, select the check box if your company is a FedEx-approved shipper of alcohol.
    • For the ALCOHOL RECIPIENT TYPE parameter, select the license type of the recipient of the alcohol shipments, which is one of the following options:
      • CONSUMER
      • LICENSEE
    • For the ALCOHOL CONTENT ON LABEL parameter, indicate on which label the information about alcohol shipment must be printed by selecting one of the following options:
      • CONTENT_ON_SHIPPING_LABEL_ONLY
      • CONTENT_ON_SHIPPING_LABEL_PREFERRED
      • CONTENT_ON_SUPPLEMENTAL_LABEL_ONLY
  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 the PX.FedExCarrier.FedExCarrier and PX.FedExRestCarrier.FedExRestCarrier Plug-Ins
CAUTION: Do not use the values used in this example for production. The sensitive data is partially or completely masked by asterisks.
ID Description
ACCOUNTID Account Number 51*******4
EXTERNAL APP ID

The application ID of the FedEx carrier service on the External Applications (SM301000) form.

This parameter appears only for the PX.FedExRestCarrier.FedExRestCarrier plug-in.

1
DROPOFF Identifies the method by which the package is to be tendered to FedEx BUSINESS_SERVICE_CENTER
ENDPOINT

The URL of the FedEx rate service according to your service agreement.

This parameter appears only for the PX.FedExCarrier.FedExCarrier plug-in.

https://wsbeta.fedex.com:443/web-services/rate
SA ENDPOINT

The URL of the FedEx availability service according to your service agreement.

This parameter appears only for the PX.FedExCarrier.FedExCarrier plug-in.

https://wsbeta.fedex.com:443/web-services
RATE ENDPOINT

The URL of the FedEx rate service according to your service agreement.

This parameter appears only for the PX.FedExRestCarrier.FedExRestCarrier plug-in.

https://apis-sandbox.fedex.com/rate/v1/rates/quotes
CANCEL ENDPOINT

The URL of the FedEx canceling service according to your service agreement.

This parameter appears only for the PX.FedExRestCarrier.FedExRestCarrier plug-in.

https://apis-sandbox.fedex.com/ship/v1/shipments/cancel
SHIP ENDPOINT The URL of the FedEx ship service according to your service agreement.

https://wsbeta.fedex.com:443/web-services/ship for the PX.FedExCarrier.FedExCarrier plug-in

https://apis-sandbox.fedex.com/ship/v1/shipments for the PX.FedExRestCarrier.FedExRestCarrier plug-in

LOGIN

The login to be used to sign in to your organization’s FedEx account.

This parameter appears only for the PX.FedExCarrier.FedExCarrier plug-in.

mIVMda*********J
PASSWORD

The password to be used with the login to sign in to the account.

This parameter appears only for the PX.FedExCarrier.FedExCarrier plug-in.

******************
METERID

The meter number.

This parameter appears only for the PX.FedExCarrier.FedExCarrier plug-in.

118******4
LBL FORMAT Provides the type of data stream or bitmap to be returned DOC
LBL PRINT ORT Label Printing Orientation BOTTOM_EDGE_OF_TEXT_FIRST
LBL STOCK TYPE Label Stock Type PAPER_4X6
NOTIFY Send Notification to Recipient Cleared
POST ENDORS Smart Post endorsement type ADDRESS_CORRECTION
POST HUBID The Smart post HubID (use the four-digit numeric value)
POST INDICIA Smart Post indicia type MEDIA_MAIL
SHIPPER FROM Shipper Contact information source Company Branch
SIGN RELZ NO Signature Release Number
SIGNATURE Signature option SERVICE_DEFAULT
ALCOHOL Special service type – Alcohol Selected
ALCOHOL RECIPIENT TYPE Alcohol Recipient Type LICENSEE
ALCOHOL CONTENT ON LABEL Alcohol content on the shipping label CONTENT_ON_SHIPPING_LABEL_ONLY