Custom Address Source Ultimate Guide Docs

Introduction

The custom address source is a junction object where you can map all information required to create a shipment as smoothly as possible. You can create different custom address sources for different carriers, for different use cases, or just create one with many fields and formulas to suit all your needs.

In this guide we explain all the different sections of the custom address source in details. Please note that the API values mentioned in this guide may vary by carrier. For the most accurate information please visit the carrier specific pages.

Create an Object Lookup

Before setting up a Custom Address Source, you will need to create a lookup relationship to the object from which you want to create the shipment.

NOTE: if you have several different use cases for one object please make sure to create a separate lookup relationship for each custom address source.

Go to Setup > Object Manager and find the Zenkraft Shipment object.

Under Fields & Relationships click New.

Select Lookup Relationship and click Next.

Choose the object to look up to. This object should be the one you need to create the shipment from. We will be using the Case object for this example. Once selected, click Next.

Enter the field label and name for this lookup field. Click Next until you reach the last setup page, then click Save.

Once saved, the new relationship will appear under the Shipment object.

When you create the Custom Address this lookup relationship will appear in the Shipment Object Lookup Field list.

Create a test Custom Address Source

v1.113 and below: If you are not ready to create a live Custom Address Source, you can generate a test CAS by going to Zenkraft Settings > Setup tools. Please note, that you will need to create a lookup relationship to the Case object first, as following the steps described above.

Scroll down to Custom Address Source and click Create Case Custom Address Source.

This will generate a test CAS linked to the Case object.

v1.118 and above: You can import a CAS template.

Custom Address Source Name

Enter a name to uniquely identify this record. For example "Return Case shipments".

Shipment Object Lookup Field

This is the object that you will be shipping to. Zenkraft supports both standard and custom objects.

Our most common standard objects include Case, Order, Contact, Lead and Account.

Make sure you have created your lookup from the Shipment object as described above.

Multiple use cases on the same object

If you have several different use cases or scenarios for one object you can choose from the below options. This is to make sure that when your user clicks on the New Shipment icon on the related list, the correct Custom Address Source mapping is used.

1. Use one lookup relationship with Custom Address Source ID logic

Create a formula field or a picklist to select the correct custom address source ID.

Example formula field:

Example picklist:

Once the logic or the picklist is set up map it under the Origin Custom Address Source Id Field.

2. Create separate lookup relationships for each use case

You might want to use this option if you want to keep your different shipments separate from each other, for example having one lookup relationship for outbound shipments and one for returns.

Sender Address Fields

You should only fill in this section if you need to specify a different sender address than what is specified on your preference. If this section is blank then the sender fields will be automatically populated with the Shipping Address from your preference.

For return shipments the application wil automatically use the sender address as the Return Shipments To address.

Recipient Address Fields

This section is required (unless you are setting up the Custom Address Source for B2B Cart). The majority of carriers require all these details to be filled in. Below we detail any specifics of each field:

Name Field

Most carriers limit this to 35 characters.

Email Field

Make sure this is a valid email address

Company Name Field

Most carriers limit this to 35 characters.

Phone Field

The phone number usually must be at least 10 characters long. You can also include the country code. For example +44 for the United Kingdom.

Street (TextArea option)

If you have your Street lines all in 1 text area use this field. Most carriers limit each street line to be 35 characters long.

City Field

Most carriers limit this to 35 characters.

Street Line 1 (TextLine option)

If you have your Street lines all separated into individual lines then use these fields. Most carriers limit each street line to be 35 characters long.

State Field

We generally recommend using the two letter state code or the Standard Salesforce State Code Picklist for this field. For non-US and non-CA shipments the state is not generally required

Street Line 2 (TextLine option)

If you have your Street lines all separated into individual lines then use these fields. Most carriers limit each street line to be 35 characters long.

Postal Code Field

Most countries use the Postal / Zip code so please ensure you populate this information correctly. Some carriers validate the city and postal code match and won't allow you to ship unless they are correct.

Country Field

We generally recommend using the two letter country code or the Standard Salesforce Country Code Picklist for this field.

Is Residential

This is a checkbox type field. True or False.

Note: For return shipments the application wil automatically use the Recipient Address as the Return Shipments From address.

Wizard Mode

There are 4 Wizard Modes to choose from:

Default - this is the standard shipping wizard.

Pick and Pack - this mode loads the Pick and Pack interface.

Outbound and Return - this loads the default looking wizard and allows you to specify the return Custom Address Source to use. The wizard has separate tabs for Outbound and Return shipments.

Outbound and Return (Pick and Pack) - this loads the Pick and Pack wizard and allows you to specify the return Custom Address Source to use.

Packages

Use Child Object - use this checkbox if you want to use your child objects to specify the size and amount of the packages that will be included in this shipment. Good example of this are from the Order -> Order Items, Opportunity -> Opportunity Line Items use case.

Packages - This is where you can specify the fields for the Weight and Dimensions of the packages.

Link Shipment Packages to Original Object - Utilize this field if you want to record which items went into which package. This is used in conjunction with the Pick and Pack interface or if you utilize the Boxing Algorithm checkbox below. To set this up please create a Lookup from the Packages Object to your Child Object Item. For example your Order Line item or Opportunity Line Item.

Boxing Algorithm - If you want us to automatically calculate the best packages to use for adding your products into your boxes you can select this checkbox. For more information please visit our Boxing Algorithm guide.

Package level references

You can add up to two package level references to each label. Go to the searchbox on the right and type reference and you will see ALL CARRIERS: REFERENCE #1.

Example: on a UPS label the Package ID reference will look like this:

Products / Customs Items

This section is where you can pre-define the items you will be shipping internationally, or if you are using the Pick and Pack interface.

For international shipping, the carriers generally require you to specify the Description, Quantity, Weight, Value, Country of Manufacture and Harmonized code.

Use Child Object - use this checkbox if you want to use your child objects to specify the items that will be included in this shipment. A good example of this is from the Order -> Order Items or Opportunity -> Opportunity Line Items use case

Packages - This is where you can specify the fields for the Weight and Dimensions of the packages

Link Customs Items to Original Object - Utilize this field if you want to link back to your product object. This then allows you to easily create reports of most ordered items. To set this up please create a Lookup from the Customs Items Object to your Child Object Item. For example your Order Line item or Opportunity Line Item.

Preference

We recommend you always specify the Preference you will be using here even if you don't have multiple preferences, so that in the future if you ever add a new preference then the current configuration will not break.

Preference Name Field

Set the Shipping Preference that you will be using most often in case you have multiple preferences. You can even set up a formula field to use a certain preference based on a given criteria. For example, for US orders use the US preference, while for UK shipments use the UK one.

Label Image Type Field

By default the label type will be set on your preference, but you might have a use case where you want to create label in a different format using the same shipping preference. For example your outbound labels will be using the ZPL thermal type, but your return labels will be sent in an email to your clients as a PDF.

Dates

This field is not required, but if you do need to specify a future date you can set it here.

Ship Date Field

The field must be of type Date

Shipment / Package Type

Shipment Type Field

The default value for this field is OUTBOUND for outbound shipments, but if you need to create return shipments then you can specify RETURN.

Package Type Field

This is a required field if you want to automate shipments. The values for this field differ depending on the carrier. All carriers have your_packaging as a value that can be set. To get the list of other packaging types for your specific carrier please follow this link.

Service Type

Service Type Field

This is a required field if you want to automate shipments. The values for this field differ depending on the carrier. To get the list of service types available for your specific carrier please follow this link.

International Service Type Field

This is a required field if you want to automate international shipments. The values for this field differ depending on the carrier. To get the list of service types available for your specific carrier please follow this link.

Reference Field

If you want to pass a reference to the carrier then populate this field. Depending on the carrier the reference will show up on the label. If you want to add more references (dependent on carrier), then you can add these later on in the Specific Carrier Fields section.

Billing Field

You may need to bill the shipment costs to the recipient or even a third party on occasion. This section allows you to set these values.

Billing Account Number Field

Enter the account number that you want to charge this shipment to.

Payment Type Field

This is required if you want to set the billing as recipient or third party. The billing is set to sender by default.
Values may vary by carrier, please always check the carrier specific documentation for the correct information.

Billing Email Field

Some carriers want to have the email populated.

Billing Name Field

Some carriers want to have the name populated.

Billing Phone Field

Some carriers want to have the phone populated.

Billing Company Name Field

Some carriers want to have the company name populated

Billing City Field

Some carriers require the city field to be populated as they use that to authenticate you are using the correct account for third party billing.

Billing Street Field

Some carriers require the street field to be populated as they use that to authenticate you are using the correct account for third party billing

Billing State Field

Some carriers require the state field to be populated as they use that to authenticate you are using the correct account for third party billing

Billing Country Field

For third party billing the carriers usually want to know the country of the associated account. This is true for FedEx and UPS.

Billing Postal Code Field

For third party billing the carriers usually want to know the country of the associated account. This is true for UPS.

Specific Carrier Fields

Most carriers have specific fields that are required to be populated. A good example is for creating return shipments with UPS. You need to specify the return type such as Print and Mail, Pickup Attempt 1 or Print.

Some carriers require quite a few fields to be populated so we have created the Template section for you to choose these grouping to automatically populate the required fields. Example templates are shown here:

For one off specific carrier fields you can click on the Add button and search for the carrier, and it will give you a list of all the available options.

A commonly used specific field is the Package Contents. This field is required by FedEx, UPS, USPS and some other carriers for international shipments. The possible options are:

Documents - DOCUMENTS_ONLY
Commodities - NON_DOCUMENTS

If you have multiple carriers you can add multiple carrier related fields to one Custom Address Source, and as long as you set the Preference correctly in the preference section you will not hit any issues.

For other carrier specific fields please see our carrier specific guides.

Output for Rate Request

Use this section only when you are specifically creating a Custom Address Source for getting rates.

Set which field on your lookup object should be populated by the response from the carriers using the fields specified in this section:

International Section

You can set the international documents section on the wizard by adding the Salesforce IDs for the required documents.

Update Original Object after Ship Success

You may have the requirement to copy information from the Shipment object back up to your lookup related object. For example the tracking number or shipment costs.

You could write a process builder, if you need specific logic, or you can use this section to specify the field that you would like to copy.

From v1.107 you can update and field three levels up. For example, you can update the account related to the case you created the shipment from.

Enhanced Functionality Settings

Most commonly this setting is used when you need to generate a packing slip with your shipment.

Packing Slip

For more information on generating packing slips please see the Additional Documents guide.

Always use International Details

From v1.96 it is possible to add Customs information to a shipment, even if is created for domestic consignment. Click Add, then select All Carriers: International Details and set a static true value.

This can be especially useful when implementing the Windsor Framework, where international details need to be enabled when shipping from Great Britain to Northern Ireland (UK Domestic Shipment).

Smart Service Settings

From v1.104.2 it is possible to quote with multiple carriers based on the fastest or cheapest services type, or based on a deliver by date.

For more information on Smart Services please refer to our Fastest, Cheapest, Delivered By Quoting guide.

Error Handler

If you are automating your shipments via Process Builder Tasks, you might have a situation where the shipment doesn't get created due to any number of reasons, but mainly due to incorrect address information. This section allows you to specify which field on your lookup record should store any error messages. This then allows you to write a report on any shipments which failed so that you can manually edit the address fields, for example, to then allow the shipment to successfully get created.

Branding settings

If you are using Branded Tracking and you have multiple brands this sections allows you to specify the name of the Branded Tracking tab to use.

Automation settings

These fields can be set to help with some of the automation.

Auto Create Shipment

This checkbox is used when you are using the Shipment wizard and you want to automatically try to create the shipment if all fields are set correctly. This is known as One Click Shipping.

Auto Print

Once the shipment has ben created via process builder tasks or via the wizard, if this checkbox is set to true, we will attempt to print the labels out to your printer. Make sure that you have set the printer default for your user so the labels come out of the correct printer!

Export a Custom Address Source

Exporting a custom address source can be especially useful when migrating tested solutions from one sandbox to another, or to a production org.

Go to Custom Address Sources and select All view. Check the box of the CAS you want to export and click on Export Custom Address Source.

On the next screen there is an option to rename the file. Once that is done click on Export.

A JSON file will be downloaded. You can store this file for importing later.

Troubleshooting

If the buttons are not there, you can add them under Edit Object > Search Layouts for Salesforce Classic > List View.

Import a Custom Address Source

Once you have the JSON file available as explained above go to Custom Address Sources and All view again, then click on Import Custom Address Source.

On the next screen click on Upload Template. Select the file you want to upload.

Once the file is uploaded you again have the option to rename the CAS. Then you can click Import.

You will receive a message when the import is successfully completed.

Now if you go back to All view you should see the recently imported CAS in the list.

Custom Address Source templates

Cloud / Product	Object	Details	Download
Salesforce	Account	This will create a FedEx Ground shipment with 1 LB.	Download
Salesforce	Campaign	This will create a FedEx Ground shipment with 1 LB.	Download
Salesforce	Case	This will create a FedEx Ground shipment with 1 LB.	Download
Salesforce	Contact	This will create a FedEx Ground shipment with 1 LB.	Download
Salesforce	Lead	This will create a FedEx Ground shipment with 1 LB.	Download
Salesforce	Opportunity	This will create a FedEx Ground shipment with 1 LB.	Download
Salesforce	Fulfillment Order	This will create a FedEx Ground shipment with 1 LB.	Download
Salesforce	Order	This will create a FedEx Ground shipment with 1 LB.	Download
Salesforce	Order Summary	This will create a return FedEx Ground shipment with 1 LB.	Download
AvSight	Release	This will create a FedEx Ground shipment with 1 LB.	Download
Rootstock	Shipper Header	This will create a FedEx Ground shipment with 1 LB.	Download