Carriers
Form ID: (CS207700)
You use this form to maintain information about integration with the carriers your company uses for shipping goods. For a carrier that provides shipping services nationally, you configure integration between MYOB Acumatica and the carrier by using a specially developed plug-in. MYOB Acumatica provides predefined plug-ins to support integration with FedEx, UPS, Stamps.com, ShipEngine, EasyPost, and Pacejet. For each integrated carrier, by using the Ship via Codes (CS207500) form, you can define multiple ship via codes that denote different service methods provided by the carrier. (The service method defines the time frame for delivery and the associated rates.) For more information, see Integration with Carriers.
Form Toolbar
The form toolbar includes only standard buttons. For the list of standard buttons, see Form Toolbar and More Menu.
Summary Area
In the Summary area, you can select a carrier and view the details of plug-in used for integration with this carrier. For a new carrier, you can specify what its name is in your system. Also, you can specify the unit of measure for weights used by the carrier and the matching unit used by your company.
Element | Description |
---|---|
Carrier ID | The unique identifier for the carrier to be integrated with MYOB Acumatica. You can use an alphanumeric string of up to 15 characters. |
Description | A description of the integrated carrier. |
Plug-In | The plug-in name. You can select one of the following plug-ins:
|
Carrier Units | The basic unit of measure used by the carrier to measure weight
for freight calculation and specify the linear dimensions of boxes
used by the carrier. You can select one of the following options,
which reflect the measuring system used by the carrier in the region
where the company operates:
|
Kilogram |
The UOM defined in the system that corresponds to a kilogram. If the UOM selected in this box differs from the weight UOM specified on the Companies (CS101500) form, you must define the conversion rules between these units of measure on the Units of Measure (CS203100) form so that shipping rates can be calculated correctly. |
Centimeter |
The UOM defined in the system that corresponds to a centimeter. If the UOM selected in this box differs from the linear UOM specified on the Companies (CS101500) form, you must define the conversion rules between these units of measure on the Units of Measure (CS203100) form so that shipping rates can be calculated correctly. |
Pound |
The UOM defined in the system that corresponds to a pound. If the UOM selected in this box differs from the weight UOM specified on the Companies (CS101500) form, you must define the conversion rules between these units of measure on the Units of Measure (CS203100) form so that shipping rates can be calculated correctly. |
Inch |
The UOM defined in the system that corresponds to an inch. If the UOM selected in this box differs from the weight UOM specified on the Companies (CS101500) form, you must define the conversion rules between these units of measure on the Units of Measure (CS203100) form so that shipping rates can be calculated correctly. |
Warehouse |
A warehouse configured in the system. If a warehouse is not selected for the carrier, the carrier’s rates are applicable for all the orders and shipments. If a warehouse is specified, the Ship Via code is applicable only to the selected warehouse. In the Shop For Rates dialog box, the system will display only rates that applicable to the selected warehouse. |
Plug-In Parameters Tab
This tab can be used to specify the values for carrier-specific plug-in parameters, which are automatically imported from the plug-in. These parameters include your company account with the carrier, password to the account, and URL of the carrier online service. For meanings of the parameters, refer to the documentation provided by the carrier. On this tab, you also can prepare certification files to get certification with the carrier.
Button | Description |
---|---|
Prepare Certification Files | Prepares the files required for certification with UPS when the PX.UpsCarrier.UpsCarrier or PX.UpsRestCarrier.UpsRestCarrier option is selected in the Plug-In box. |
Column | Description |
---|---|
ID | The parameter of the selected plug-in. |
Description | The description provided for the parameter. |
Value | The value of the plug-in parameter which you enter or select in accordance with your service agreement. |
ID | Description |
---|---|
ACCOUNTID | The ID or number of the account your organization has with the carrier. |
SA ENDPOINT | The URL of the FedEx availability service according to your service agreement. |
ENDPOINT | The URL of the FedEx rate service according to your service agreement. |
SHIP ENDPOINT | The URL of the FedEx ship service according to your service agreement. |
LOGIN | The web service authentication key to be used to sign in to your organization's FedEx account. |
SHIPPER FROM | The source of the shipper contact information. Select the
appropriate option:
|
NOTIFY | A check box that indicates (if selected) that a notification should be sent to the recipient 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. |
DROPOFF | The method by which the package is to be delivered to FedEx;
select the appropriate option according to your service
agreement:
|
LBL FORMAT | The type of data stream or bitmap to be returned. Select the format to be used for printing the shipping labels on the printer you have (DOC, DPL, EPL2, PDF, PNG, RTF, TEXT, or ZPL). |
LBL STOCK TYPE | The type of label stock to be used for printing shipping labels. |
LBL PRINT ORT | The label printing orientation. Select one of the available
options:
|
POST ENDORS | The endorsement type for FedEx SmartPost shipments. Select the
appropriate option according to your agreement (the list of
available options depends on the selected POST INDICIA option):
|
POST HUBID | The four-digit number that is an identifier of the USPS or FedEx hub to be used for delivery by FedEx SmartPost. |
POST INDICIA | The indicia type to be used by SmartPost. Select the appropriate
option according to your service agreement.
|
SIGNATURE | The signature request option for delivery. Select the appropriate
option according to your agreement:
|
SIGN RELZ NO | The signature release number. |
ALCOHOL | A check box that indicates (if selected) that your company is a FedEx-approved shipper of alcohol. |
ALCOHOL RECIPIENT TYPE | The license type of the recipient of the alcohol package. Select
one of the following options:
|
ALCOHOL CONTENT ON LABEL | The label on which the information defining the alcohol shipment
must be printed. Select the appropriate option, which is one of the
following:
|
ID | Description |
---|---|
ACCOUNTID | The ID or number of the account your organization has with the carrier. |
CLIENT ID | The client ID for generation of the OAuth token that is used to connect to your FedEx account. The client ID is generated when you create a project in FedEx Developer portal. |
CLIENT SECRET | The client secret for generation of the OAuth token that is used to connect to your FedEx account. The client secret is generated when you create a project in FedEx Developer portal. |
LOGIN ENDPOINT | The Production or Sandbox URL of the FedEx API services. |
CANCEL ENDPOINT | The URL of the FedEx canceling service according to your service agreement. |
RATE ENDPOINT | The URL of the FedEx rate service according to your service agreement. |
SHIP ENDPOINT | The URL of the FedEx ship service according to your service agreement. |
SHIPPER FROM | The source of the shipper contact information. Select the
appropriate option:
|
NOTIFY | A check box that indicates (if selected) that a notification should be sent to the recipient 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. |
DROPOFF | The method by which the package is to be delivered to FedEx;
select the appropriate option according to your service
agreement:
|
LBL FORMAT | The type of data stream or bitmap to be returned. Select the format to be used for printing the shipping labels on the printer you have (DOC, DPL, EPL2, PDF, PNG, RTF, TEXT, or ZPL). |
LBL STOCK TYPE | The type of label stock to be used for printing shipping labels. |
LBL PRINT ORT | The label printing orientation. Select one of the available
options:
|
POST ENDORS | The endorsement type for FedEx SmartPost shipments. Select the
appropriate option according to your agreement (the list of
available options depends on the selected POST INDICIA option):
|
POST HUBID | The four-digit number that is an identifier of the USPS or FedEx hub to be used for delivery by FedEx SmartPost. |
POST INDICIA | The indicia type to be used by SmartPost. Select the appropriate
option according to your service agreement.
|
SIGNATURE | The signature request option for delivery. Select the appropriate
option according to your agreement:
|
SIGN RELZ NO | The signature release number. |
ALCOHOL | A check box that indicates (if selected) that your company is a FedEx-approved shipper of alcohol. |
ALCOHOL RECIPIENT TYPE | The license type of the recipient of the alcohol package. Select
one of the following options:
|
ALCOHOL CONTENT ON LABEL | The label on which the information defining the alcohol shipment
must be printed. Select the appropriate option, which is one of the
following:
|
ID | Description |
---|---|
SHIP ENGINE ACCOUNT | The ID of the account your organization has with the ShipEngine carrier. |
SHIP ENGINE CARRIER | The carrier linked to your ShipEngine account. Select one of the available carriers (which become available after you specify the SHIP ENGINE ACCOUNT value). |
TEST MODE | A check box that applies to the Stamps.com carrier only and indicates whether you are using the carrier in test mode. In this mode, you can generate sample labels for which you are not charged. |
LOG TRACE | A check box that indicates (if selected) that the requests and results of the ShipEngine calls will be saved in the trace log. |
SHIPPER FROM | The source of the contact information of the shipper. You can
select one of the following options:
|
CONFIRMATION | The delivery confirmation type. You can select one of the
following options:
|
INSURANCE | The type of insurance. You can select one of the following
options:
|
LABEL FORMAT | The type of data stream or bitmap to be returned for printing the labels on the printer you have. Select one of the following formats: PDF, ZPL, or PNG (default). |
INTERNATIONAL NON DELIVERY | The action to be performed for the outbound shipment that cannot
be delivered. You can select one of the following:
|
DUTY BILL TO PARTY | The person that is responsible for paying international customs charges (such as duty or taxes): Recipient (default) or Shipper. |
MULTI PACKAGE SUPPORT |
A check box that indicates whether the currently selected carrier (SHIP ENGINE CARRIER) supports multi-package shipments. If the check box is selected, a user can have a consolidated label file for a group of packages. |
LABEL MESSAGE SUPPORT |
A check box that indicates whether the currently selected carrier (SHIP ENGINE CARRIER) supports custom label messages. If the check box is selected, the Custom Ref. Nbr. 1 and Custom Ref. Nbr. 2 values specified on the Packages tab of the Shipments (SO302000) form will be used as the reference numbers of internal tracking messages. |
ID | Description |
---|---|
ENDPOINT | The URL of the Stamps.com service. Specify https://swsim.stamps.com/swsim/swsimv111.asmx in this box. |
LOGIN | The login to be used to sign in to your organization's Stamps.com account. |
PASSWORD | The password to be used to sign in to your organization's Stamps.com account. |
STAMPS CUSTOMER | The customer identifier in Stamps.com, which is required for USPS audits, aviation security, and insurance purchases. |
TEST MODE | A check box that indicates (if selected) that you are using Stamps.com in test mode. In this mode, you can generate sample labels for which you are not charged. |
LOG TRACE | A check box that indicates (if selected) that requests and results of the web calls will be saved in the trace log. |
SHIPPER FROM | The source of the contact information of the shipper. You can
select one of the following:
|
NOTIFY | A check box that indicates (if selected) that a notification should be sent to the recipient on the 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. |
LABEL FORMAT | The type of data stream or bitmap to be returned for a label,
which can be one of the following formats:
|
PACKAGE TYPE | The package type in USPS, which can be one of the following:
|
ROTATION DEGREE | The degree of counter-clockwise rotation of the label. You can
select one of the following values:
|
PAPER SIZE | The paper size for labels in the PDF format. You can select one
of the following values:
|
IMAGE DPITYPE | The resolution for labels in the GIF, JPG, and PNG formats. You
can select one of the following values:
|
ELTRON DPITYPE | The resolution of labels for a thermal printer. You can select
one of the following parameters:
|
CERTIFIED MAIL | A check box that indicates (if selected) that the USPS Certified Mail service is used. |
REGISTERED MAIL | A check box that indicates (if selected) that the USPS Registered Mail service is used. |
CONFIRMATION | The delivery confirmation type. You can select the appropriate
option according to your agreement with USPS service:
|
INSURANCE | The type of insurance. You can select one of the following:
|
RETURN RECIEPT | A check box that indicates (if selected) that the USPS Return Receipt service has been requested. |
RETURN RECIEPT ELECTRONIC | A check box that indicates (if selected) that the Electronic Return Receipt service has been requested. |
RETURN RECIEPT MERCHANDISE | A check box that indicates (if selected) that the Return Receipt for Merchandise service is requested. |
INCLUDE RECEIPT | A check box that indicates (if selected) that the receipt will be included in the label. |
PAY ON PRINT | A check box that indicates (if selected) that the pay-on-print return label is used. That is, your account will not be charged until the label is rendered, which is usually the time the recipient clicks the label URL and prints the label. |
RETURN LABEL EXPIRATION DAYS | The number of days until expiration of the return label URL. This value is used only if the PAY ON PRINT check box is selected. Before the URL has expired, you can click the URL provided by the service to render the label. You can access the rendered label for 24 hours after you click the URL. |
ID | Description |
---|---|
ENDPOINT | The rate URL of the UPS service according to your service agreement. |
TNT ENDPOINT | The URL of the UPS Time-in-Transit service according to your service agreement. |
SHIP ENDPOINT | The URL of the UPS ship service according to your service agreement. |
VOID ENDPOINT | The URL of the UPS void service according to your service agreement. |
LOGIN | The login to be used to sign in to your organization's UPS account. |
PASSWORD | The password to be used with the login to sign in to the account. |
ACCESSNUM | The access code according to your agreement. |
ACCOUNTID | The identifier of the account your organization has with the carrier. |
NEGOTIATED | A check box that indicates whether or not your organization has special rates. Select the check box to u the negotiated rates. |
TEST MODE | A check box you select for the period when testing of the integration will be performed. USP Test mode uses preset Test Tracking Numbers in Void Shipment Service. |
LOGTRACE | A check box that indicates (if selected) that the request and results of the web calls will be saved in the trace. |
LABEL FORMAT | The type of data stream or bitmap to be returned as a shipping label. |
PICKUP TYPE | The pickup option to be used by UPS. Select the appropriate
option according to your agreement:
|
SUREPOST END | The USPS endorsement for SurePost shipments delivered by the
USPS. Select the appropriate option according to your agreement:
|
SUREPOST SUB | The type of packages (less than 1lb) for UPS SurePost.
|
SIGNATURE | The delivery confirmation option. Select the appropriate option
according to the agreement:
|
SIGN RELZ NO | The DCIS number. |
NOTIFY | A check box that indicates (if selected) that a notification should be sent to the recipient 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. |
SHIPPER FROM | The source of the shipper contact information. Select the
appropriate option:
|
ID | Description |
---|---|
CLIENT ID | The client ID for generation of the OAuth token that is used to connect to your UPS account. The client ID is generated when you create a project in the UPS Developer portal. |
CLIENT SECRET | The client secret for generation of the OAuth token that is used to connect to your UPS account. The client ID is generated when you create a project in the UPS Developer portal. |
LOGIN ENDPOINT | The Production or Sandbox URL of the UPS API services. |
RATE ENDPOINT | The rate URL of the UPS service. |
TNT ENDPOINT | The URL of the UPS Time-in-Transit service according to your service agreement. |
SHIP ENDPOINT | The URL of the UPS ship service according to your service agreement. |
VOID ENDPOINT | The URL of the UPS void service according to your service agreement. |
ACCOUNTID | The identifier of the account your organization has with the carrier. |
NEGOTIATED | A check box that indicates whether or not your organization has special rates. Select the check box to u the negotiated rates. |
TEST MODE | A check box you select for the period when testing of the integration will be performed. USP Test mode uses preset Test Tracking Numbers in Void Shipment Service. |
LABEL FORMAT | The type of data stream or bitmap to be returned as a shipping label. |
PICKUP TYPE | The pickup option to be used by UPS. Select the appropriate
option according to your agreement:
|
SUREPOST END | The USPS endorsement for SurePost shipments delivered by the
USPS. Select the appropriate option according to your agreement:
|
SUREPOST SUB | The type of packages (less than 1lb) for UPS SurePost.
|
SIGNATURE | The delivery confirmation option. Select the appropriate option
according to the agreement:
|
SIGN RELZ NO | The DCIS number. |
NOTIFY | A check box that indicates (if selected) that a notification should be sent to the recipient 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. |
SHIPPER FROM | The source of the shipper contact information. Select the
appropriate option:
|
ID | Description |
---|---|
EASYPOST PRODUCTION API KEY | The key of the EasyPost account to use the plug-in in the production environment. This key can be retrieved from the EasyPost portal. |
EASYPOST TEST API KEY | The key of the EasyPost account to use the plug-in in the test environment. This key can be retrieved from the EasyPost portal. |
USE TEST KEY | A check box that indicates (if selected) that the EasyPost plug-in is used in the test mode. The test mode generates sample labels without real value (applies to carriers offering test environment). In this mode, you can generate sample labels without being charged. |
EASYPOST CARRIER | Carriers linked to the EasyPost account. |
LOG TRACE | A check box that indicates (if selected) that requests and results of the web calls will be saved in the trace log. |
SHIPPER FROM | The source of the shipper's contact information. Select the
appropriate option:
|
CONFIRMATION | The delivery confirmation type. You can select one of the
following options:
|
INSURANCE | The type of insurance. You can select one of the following
options:
|
LABEL FORMAT | The type of data stream or bitmap to be returned for printing the labels on the printer you have. Select one of the following formats: PDF, ZPL, EPL2, or PNG (default). |
LABEL SIZE | The size of the shipping label (in inches). |
INTERNATIONAL NON-DELIVERY | The action to be performed for the outbound shipment that cannot
be delivered. You can select one of the following:
|
TERMS OF SALE | Terms of sale (Incoterms) that define the responsibilities for
paying for and managing the shipment, insurance, documentation,
customs clearance, and other logistical activities. You can select
one of the following:
|
USE SHIPPER TAX ID | A check box that indicates (if selected) that the tax ID of the shipper's branch will be provided to EasyPost and will be inserted to the commercial invoice. This check box is cleared by default. |
LETTERHEAD | The letterhead for the commercial invoice (applied by FedEx international shipments). |
SIGNATURE | The signature for the commercial invoice (applied by FedEx international shipments). |
FULFILLED ORDER ID FIELD | The list of sales order boxes to select the one in which the Amazon Order ID is stored. This box applies to Amazon Marketplace Web Service. |
FULFILLED ORDER ITEMID FIELD | The list of sales order line columns to select the one in which the Amazon Order ID is stored. This box applies to Amazon Marketplace Web Service. |
ENDORSEMENT SERVICE | The endorsement type for EasyPost shipments. |
SCANFORM TIMEOUT | The timeout for manifest generation (in seconds). |
NUMBER OF SHIPMENTS PER BATCH | The maximum number of shipments that can be displayed simultaneously on the Create Manifest (SO506000) form for an EasyPost carrier that has the DHL carrier specified in the EASYPOST CARRIER parameter on the current form. |
INCLUDE FREIGHT PRICE | A check box that indicates (if selected) that the freight price for international delivery of goods via EasyPost UPS and USPS is displayed in the commercial invoice. |
ID | Description |
---|---|
PACEJET URL | The URL of Pacejet's API service. |
LOCATION | The identifier of the shipper's location in Pacejet's account. |
PACEJET LICENSE | The license key required to access Pacejet's API service. |
DFLT WORKSTATION ID | The identifier of the workstation that is used in Pacejet for printing shipping documents by default if shipments are processed to completion in Pacejet. |
SITE CODE | The identifier of the shipper's warehouse in Pacejet's account. |
USAGE SCENARIO | The picking and packing scenario for shipments that are delivered by the Pacejet
carrier service. You can select one of the following options:
|
DELAY | The time before the ShipmentConfirms API call is performed when you
confirm a shipment. |
RETRY COUNT | The maximum number of times the ShipmentConfirms API call can be
performed when you confirm a shipment. |
USE FACILITY CODE | A check box that indicates (if selected) that the code of the shipper's warehouse in the Pacejet carrier service is added to the shipper's address. |
CONSIGNOR | A check box that indicates (if selected) that the system displays the consignor's price
as the amount in the Amount box in the
Shop for Rates dialog box on the Sales Orders (SO301000) or Shipments (SO302000) form in documents
with Ship Via codes that have a Pacejet external carrier. If the check box is cleared, the system uses the consignee's price as the amount in the Shop for Rates dialog box. |
UPS REF1 | The source of data for UPS reference code 1 in a shipping label. |
UPS REF2 | The source of data for UPS reference code 2 in a shipping label. |
FEDEX REF1 | The source of data for FedEx reference code 1 in a shipping label. |
FEDEX REF2 | The source of data for FedEx reference code 2 in a shipping label. |
FEDEX REF3 | The source of data for FedEx reference code 3 in a shipping label. |
Customer Accounts Tab
The tab provides information about the billing type that is applied to carrier's deliveries. You can specify a specific billing type for each customer to whom this carrier delivers shipments. You can add customer accounts here or by using the Customers (AR303000) form.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
Column | Description |
---|---|
Active | A check box that, if selected, indicates that this customer account is active and can be used for billing by the carrier for the shipping. |
Customer ID |
The identifier of the customer that has an account with the integrated carrier. The list of customers available for selection
may be limited based on the role or roles assigned to the user account to which you are
signed in if the Customer and Vendor Visibility Restriction feature is enabled on
the Enable/Disable Features (CS100000) form. In this case, the
Restrict Visibility To box appears on the
Financial tab of the Customers (AR303000) form. With the feature enabled, a
customer is available for selection if one of the following is true:
|
Customer Name | The customer, by its name, with an account with the integrated carrier. |
Location |
The applicable location of the customer. This column is displayed if the Business Account Locations feature is enabled on the Enable/Disable Features (CS100000) form. |
Carrier Account | The customer's account with the integrated carrier. |
Country |
The country ID of the carrier's account. If the Use Customer's Account check box is selected on the Sales Orders (SO301000) form (Shipping tab) for a sales order, in which a ship via code with this carrier is selected, the system sends this country ID to the carrier service. If this column is empty, the system sends the country ID specified in the Country box on the General tab of the Customers (AR303000) form. |
Postal Code | The postal code of the carrier's account. |
Carrier Billing Type |
The party which is responsible for paying shipping costs. This column can have one of the following options:
|
Territories Mapping Tab
This tab is shown only for the ShipEngine carrier. Each row in the table on this tab maps the ID of a country and state that is specified in MYOB Acumatica to a country and state ID in the format required by the carrier being used by ShipEngine.
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
Column | Description |
---|---|
Country | The ID of a country as specified on the Countries/States (CS204000) form. |
State | The ID of a state as specified on the Countries/States (CS204000) form. |
Country (For Carrier) | The ID of the country in the format required by the selected carrier. |
State (For Carrier) | The ID of the state in the format required by the selected carrier. |
Stamps.com Account Info Tab
On this tab, you can find details about your Stamps.com account.
Button | Description |
---|---|
Buy Stamps.com Postage | Opens the Specify Postage Amount dialog box. |
Get Account Info | Requests information about your Stamps.com account from the Stamps.com server and displays this information in the table. |
Column | Description |
---|---|
Account Info | A field of the Stamps.com account. |
Value | The value of this account field. |
Element | Description |
---|---|
Buy Postage Amount | The postage amount you want to buy on Stamps.com. |
The dialog box has the following buttons. | |
Buy | Sends the request to Stamps.com and closes the dialog box. |
Cancel | Closes the dialog box without sending the request to buy postage amount. |