1. Home
  2. Docs
  3. Multi
  4. Automated Pickups
Live Chat

Automated Pickups

Our Multi Carrier app now allows you to set up automated carrier pick ups.

You can do this from any custom or standard object, and also automate a pickup after a shipment has been created.

We will go through these two use cases below and how to set them up.

Create a Pickup from a Case when the Status Changes

The first step is to create a lookup from the Pickup object to the Case object. You can do this by going to Setup > Create > Objects and finding the Pickup object.

Click on the New button:

Select the Lookup item:

Click next and then select the object we are going to use. In this guide we are using the Case object.

Continue to click next until the relation ship has been created. Confirm this has been done by going to a Case and viewing the new related list that has been added:

Pickup Custom Address Source

The next step is to create the Pickup Custom Address Source. This is where you map all the fields needed by the carrier to create the pickup.

Click on New: 

And you will see all the Fields that are available to be populated. Not all fields are needed for all carriers, but this is easy to test later on.

Give the Pickup Custom Address Source a Name and select the Lookup Field you created earlier.

Next add the address and contact name/email/phone reference fields.

Some carriers (such as FedEx) require the Location and Building Type  to be populated. .

Here are the values:


Package Location Field: FRONT/REAR/SIDE



Package Location Field: Front Door/Back Door/Side Door/Shipping/Receiving/Reception/Office/Mailroom/Garage/Upstairs/Downstairs

Building Type Field: Floor/Room

The Shipments section allows you to automatically select all shipments related to that Case to be included in the pickup.

Shipment Selection Condition Name: Is a checkbox that determines which shipments should be included. Let say you only want the shipments of type Return included, you can specify the name of that field.

Shipment Object Lookup Field: Is the related list of Shipments you want to use.

Next make sure you reference the correct Preference that you want to initiate the pickup with. 

Most carriers also want to know the date to pickup, and the available time on that day when they are able to pickup the package. This is the Ready DateTime and Close DateTime fields.

These fields are of type DateTime.

Next we can fill in the Special Information section.

Courier Remarks Field allows you to add any instruction for the courier.

Some Carriers also require you to add the Pickup Service Category Field and Carrier Code Field.

Here are the values:


Pickup Service Category Field: SAME_DAY/SAME_DAY_CITY

Carrier Code Field: FDXE/FDXG

The next section is Error Handling. And this allows you to reference a field on your object where we can populate any error message you might get if there is an error with the pickup.

Once all these fields are setup you can now test to make sure that the information populates correctly via the Pickup Wizard screen. Go onto your Case object and click on the New Pickup button

You should now see all your field populated correctly on the Wizard screen. 

Process Builder Setup

Now we need to create a process builder task to create the pickup when the Case status changes to a certain status. In this guide we have already created a new status called "Create Pickup" which we will use as the criteria in our Process Builder.

Go to Setup > Create > Workflow & Approvals > Process Builder

Create a new process builder.

Select you object and set it to "when a record is cerated or edited".

Next set the criteria for when this process should run.

We have set it to run when the status is changed, and when the status gets set to Create Pickup.

Finally, create a new immediate action and choose Apex, and in the possible Apex Classes choose the "Create Pickup (Multi Carrier)". 

You will then have two fields that are required to be filled in.

The first on is the record id, in this guide its the Case.Id, and the customAddressId is the Salesforce of the Pickup Custom Address Source.

Save each section and then activate your process builder. 

Go back to your case and change the status field to "Create Pickup", and see the pickup get created.

If the pickup doesn't get created you can view the error under Setup > Apex jobs.

Here are some example errors:

Create Pickup After Shipment Creation

Now we will show you how to automatically create a pickup after a shipment has been created.

First make sure that you have your shipments related to your object. In our guide we are using Case, and we can see the shipments are related to the Case correctly:

Lets create the new Pickup Custom Address Source, and this time we will call it Case Pickup after Shipment Creation

Fill in the fields as we did for the first part of this guide.

Next lets go to the process builder, and create a new process builder task.

The object to choose is Shipment and start the process "when a record is created or edited".

For the Criteria make sure you set these condition on the field "Shipment Processing Completed" to be True, and ensure you utilize the Advanced dropdown to execute the actions only when specified changes are made to the record :

Set the scheduled action to run 0 Hours After CreatedDate, this means the pickup code will run after the shipment has been created and won't interfere with any other processes.

You can now Add Action and set it to Run Apex class called "Create Pickup (Multi Carrier)". Much like the first part of this guide you can add the customAddressID and recordId, you can now specify the shipmentId.

Save the process builder and run a test.

Supported Carriers:

Canada post
DPD Germany
FedEx Freight


If you have any questions please contact us and we will be glad to help.