UPS APIs Configuration

Owned by Megan Stanage
Jun 21, 2024
3 min read

The carrier configuration page allows you to view and configure settings for UPS APIs.

The page is divided into two sections:

  1. Carrier configurations for carrier-level settings and default settings.

  2. Service configurations that allow the administrator to enable/disable individual services and to override any header values.

1| UPS APIs Configurations

You can configure the fields in this section at the carrier level.

Note

  • You must have edit permissions to edit these fields.
  • Several of these fields are used when packing within Supply Chain Cloud; they are not used if you are connecting to Supply Chain Cloud from an external system.
 General Tab

FIELDDESCRIPTION
Manifest Trigger

Select when containers should be manifested (tracking number is assigned, label is printed):

  • Close Container
  • Confirm Shipment
API CredentialsSelect whether Production or Test credentials are used when interacting with the carrier's API.
Manage Carrier Credentials

Click this button to manage your UPS API credentials.

See UPS APIs Credentials for more information.

 Document Tab

FIELDDESCRIPTION
Shipping Label Document Format

Select the format for shipping labels:

  • PDF
  • ZPL 

Note

This field defaults to ZPL.

Enable Label Alias Address

Turn on this toggle to specify a different (alias) return address on the label than where it is actually shipped from.

This feature passes the shipper address as the return address and the ship from address as the pickup address.

Important

  • UPS supports this by default. For UPS APIs, you need to turn on this toggle.
  • You need to make a modification to use this feature in D365 F&SCM. See Alias Address on Shipping Label for more information.
 Special Services Tab

Click New to open the Create Special Service Configuration window.

See UPS Mail Innovations for more information.


2| Service Configurations

You can configure the fields in this section at the carrier-service level.

Important

Values specified at the carrier-service level override those at the carrier level.

FIELDDESCRIPTION
Enable

Select this checkbox to enable a carrier service for use. 

This narrows the list of services to only those the administrator allows.

Service

Displays the service name.

Manifest Trigger

Select when containers are manifested (tracking number is assigned, label is printed):

  • Use Carrier Configuration
  • Close Container
  • Confirm Shipment

Carrier Information

See Carrier Information for details about supported carriers.

Custom Carriers

See Custom Carriers for information about creating carriers that do not come with the system.

Advanced Options

See Advanced for additional configuration options.

Feedback

Submit feedback.