FedEx block

Retrieve information about FedEx shipments in Oomnitza such as the delivery status of a laptop that you ordered for an employee.

Before you start

Information that you need to create the workflow

To create FedEx workflows,  you must enter the following authorization credentials:

1. Authentication key
2. Password
3. Account number
4. Meter number

Complete this procedure: 

 Go to FedEx - How to get the API key  

Before you complete the request for your API Key, you get:

• Your authentication key
• Your meter number

Remember
Keep a copy of the authentication key safe. You’ll need it when you create the FedEx workflow.

When you submit your request, you get an email from FedEx with the following information:

• Web services password
• Account number 
• Meter number

Add custom fields to Oomnitza

To capture the FedEx shipment information, you must create two custom asset fields.

FedEx Tracking Number

The tracking number that is either manually entered or populated using an asset feed will be stored in this field.   

1. From the Assets page, click Customizations.
2. To add a new custom field, click Add.
3. Make these changes:
   1. You must enter Fedex Tracking Number as the name.  
   2. Select Short text as the data type.
   3. Select the Editable and Add updates to History check boxes. To avoid associating a tracking number with more than one asset, consider selecting Unique.
4. Click SAVE.

FedEx response

Create a custom field to display the delivery status of the asset. When you create the workflow, you'll select this field to map the status value of the FedEx delivery.   

1. From the Assets page, click Customizations.
2. To add a new custom field, click Add.
3. Make these changes:
   1. Enter a name such as FedEx Response or Delivery Status.
   2. Select Long text as the data type.
   3. Select Add updates to History.
4. Click SAVE.

  Learn more about custom fields

Add the workflow

1. From the menu, select Configuration>Workflows>Assets.
2. To add a workflow, click +.  
3. Enter a unique name and a description.
4. Click Add new. The Begin and End blocks are automatically added.
5. Drag and drop the API block into the sandbox.

Add a rule to trigger the workflow

You add a rule to the Begin block to trigger the workflow.  

1. On the Begin block, click Edit.
2. From the Actions list, select Schedule.
3. To add rule the rule, click Add Rule, and add the following rule: FedEx Tracking Number is not Empty.
4. Click SAVE.

Configure the API block

1. On the API block, click Edit.
2. Enter FedEx in the Search field.
3. Select FedEx Track by Number, and click the right arrow (>).
4. Enter the following authorization credentials:
   1. Authentication key
   2. Password
   3. Account number
   4. Meter number
5. Click Advanced Mode and then click the RESPONSE tab.
6. Enter this code in the Response field: {{response['SOAP-ENV:Envelope']['SOAP-ENV:Body']['TrackReply']['CompletedTrackDetails']['TrackDetails']['StatusDetail']['Description']}}
7. Select the Oomnitza field that you created to capture the status of the shipment. 
8. Connect the Begin, FedEx API, and the End blocks. See the illustration above.
9. Click SAVE.
10. Validate, launch, and save your workflow.

FedEx responses
FedEx always returns a status code of 200, regardless whether the workflow request for the status update is successful or not. For more information, read the HTTP status codes section in FedEx APIs Integration Best Practices.

Links

See Workflow best practices

Result

When a new FedEx tracking number is added to an asset or when the status of a FedEx shipment changes, the delivery status of the asset is updated.