Creating workflows for ShipEngine assets

Let Oomnitza be your single source of truth!

You'll get complete visibility of your assets as data from ShipEngine is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and ShipEngine in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key asset and software information
• Configurable reports to share information about assets and software with your colleagues and management such as corporate-wide reports that detail the distribution and status of the assets and software in your environment
• Configurable workflows that you can easily create to make shipping tasks easier, such as:
  • validating and properly formatting an address
  • creating shipment labels. These labels can be created in a variety of scenarios, such as when an employee returns equipment to the company and you need to track its shipment.
  • tracking shipment details

Navigation

Adding the credentials

Creating workflows

Creating asset workflows with the API block

Create shipping label

Track shipment details

Validate address

Parse single line address

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

ShipEngine uses API key authentication, which requires an API secret key. 

To use these APIs you need to sign up on Shipengine.com and create an API key. Please keep in mind that ShipEngine is a pay for service.

For further information consult the ShipEngine: API keys.

Adding the credentials

To stream ShipEngine user data into Oomnitza, complete the following steps:

1. In Oomnitza, go to Configuration>Security>Credentials.
2. Click Add new credential (+).
3. Add the information details.
4. Click the AUTHORIZATION tab.
5. Ensure that API Key is selected as the authorization type.
6. Enter api-key as the name of the token. 
7. Enter the API key.
8. Ensure that Add to Header is selected.
9. Save your changes.

Next

You use the credentials that you added to create and customize your ShipEngine integrations with Oomnitza.

Creating workflows

Creating asset workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create workflows with the API block by following the steps in Creating asset workflows with the API block. The ShipEngine API block workflow comes with the following presets for assets:

Create shipping label
Track shipment details
Validate address
Parse single line address

Using the ShipEngine Create Shipping Label Preset

The Create Shipping Label preset allows you to create a shipping label in ShipEngine. To configure the preset, complete the following actions:

1. Select the preset from the API block and the credentials you created in Adding the credentials.
2. Click the Advanced Mode button located in the upper right of the window.
3. Select the Body tab.
4. Specify the information about the shipping label that you want to create in the <<your details>> tag, similar to the example below.

   {
   *"label_layout": "letter", 
     "shipment": {
       "service_code": "ups_ground",
       "ship_to": {
         "name": "Jane Doe",
         "address_line1": "525 S Winchester Blvd",
         "city_locality": "San Jose",
         "state_province": "CA",
         "postal_code": "95128",
         "country_code": "US",
         "address_residential_indicator": "yes"
       },
       "ship_from": {
         "name": "John Doe",
         "company_name": "Example Corp",
         "phone": "555-555-5555",
         "address_line1": "4009 Marathon Blvd",
         "city_locality": "Austin",
         "state_province": "TX",
         "postal_code": "78756",
         "country_code": "US",
         "address_residential_indicator": "no"
       },
       "packages": [
         {
           "weight": {
             "value": 20,
             "unit": "ounce"
           },
           "dimensions": {
             "height": 6,
             "width": 12,
             "length": 24,
             "unit": "inch"
           }
         }
       ]
     }
   }

5. Use the curly brackets to the right of the window to reference an Oomnitza field. You can find a complete list of fields in Assets > Customization.
6. Select the Response tab.
7. Select an Oomnitza field to store the tracking number and label URLs which will be returned by the API.

*The label_layout: letter is used to create labels in US letter size (8.5 inches x 11 inches). Alternatively, you can specify label_layout:4x6 (4 inches x 6 inches) - this is the preferred layout for printing labels with thermal printers. For further information refer to the ShipEngine documentation: Label formats and sizes.

For further information see ShipEngine REST API documentation: Create a label.

Using the ShipEngine Track Shipment Details Preset

The Track Shipment Details preset allows you to track a shipment in ShipEngine. To configure the preset, complete the following actions:

1. Select the preset from the API block and the credentials you created in Adding the credentials.
2. Click the Advanced Mode button located in the upper right of the window.
3. Select the Params tab.
4. Select the curly brackets to the right of the window to reference an Oomnitza field for your carrier code and tracking number. You can find a complete list of fields in Assets > Customization. Refer to ShipEngine Supported Carriers for a list of supported carrier codes.
5. Select the Response tab.
6. Select an Oomnitza field to store status description which will be returned by the API.

For further information see ShipEngine REST API documentation: Track a package.

Using the ShipEngine Validate Address Preset

The Validate Address preset allows you to validate an address in ShipEngine. To configure the preset, complete the following actions:

1. Select the preset from the API block and the credentials you created in Adding the credentials.
2. Select the Body tab.
3. Specify the information about the address that you want to validate in the <<your details>> tag, similar to the example below.

    {
       "address_line1": "525 S Winchester Blvd",
       "city_locality": "San Jose",
       "state_province": "CA",
       "postal_code": "95128",
       "country_code": "US"
     }

4. Use the curly brackets to the right of the window to reference an Oomnitza field. You can find a complete list of fields in Assets > Customization.
5. Select the Response tab.
6. Select an Oomnitza field to store the address information which will be returned by the API.

For further information see ShipEngine REST API documentation: Validate an Address

Using the ShipEngine Parse Single Address Preset

The Parse Single Address preset allows you to parse a single line into a properly structured address. To configure the preset, complete the following actions:

1. Select the preset from the API block and the credentials you created in Adding the credentials.
2. Click the Advanced Mode button located in the upper right of the window.
3. Select the Body tab.
4. Specify your single line address details in the <<your details>> tag, similar to the example below.

    {
    "text": "I need to ship a 17lb package thats 36x12x24in. Its going to Amanda Millers house at 525 Winchester Blvd in San Jose California. The zip code is 95128. Its really valuable, so insure it for $400 and require an adult signature please."
   }

5. Use the curly brackets to the right of the window to reference an Oomnitza field. You can find a complete list of fields in Assets > Customization.
6. Select the Response tab.
7. Select an Oomnitza field to store the address information which will be returned by the API.

For further information see ShipEngine REST API documentation: Parse Shipment Info from Text.

For further information on workflows see:
 Understanding workflows
 Workflow block overview

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started for more information.