Categories in Urbantz: Complete Guide

This article explains what Categories are, what their role is, and how they can help different users in Urbantz. 

Content:

• What are Categories?
• Setup and Configuration
• Display and Usage
• Common Use Cases
• API Reference
• Troubleshooting
• Best Practices
• Integration with other Features

What are Categories?

Categories are labels assigned to tasks in Urbantz that serve as structured properties to communicate important delivery information. They act as tags that help drivers, dispatchers, and recipients understand specific requirements or characteristics of a task.

Setup and Configuration

Creating Categories

1. Navigate to Platform > General > Categories
2. Add category name and description
3. Select an icon to represent the category visually

Category Properties

• Name: The identifier used in API calls and displayed to users
• Description: Additional context about the category
• Icon: Visual representation shown in the mobile app

Data Structure

Display and Usage

Mobile App

• Categories appear as icons or text when drivers open tasks
• Provide immediate visual identification of special requirements

Tracking Page

• Can be configured to show as additional service options

Platform Interface

• Used for task filtering and search

Common Use Cases

Delivery Requirements:

• Fragile items requiring special handling
• Heavy items needing multiple people
• Assembly required services
• Packaging removal requests

Customer Classifications:

• VIP customers requiring special attention
• Contactless delivery preferences

Operational Needs:

• Asset management (leave cage vs. unload)
• Return requirements

API Reference

Data Structure

Categories are stored in two formats:

• categories: Array of category names (recommended)
• categoriesDetails: Array of objects with name, description, and icon

Troubleshooting

Common Issues

Task Announcement Errors:

• Verify category exists on the platform before announcing
• Check spelling and case sensitivity of category names
• Ensure proper API payload format

Categories Not Displaying:

• Confirm category has an assigned icon
• Check mobile app version compatibility
• Verify the task assignment to the driver

Best Practices

1. Naming Convention: Use clear, descriptive names. Be mindful that Category names are case-sensitive!
2. Icon Selection: Choose intuitive visual representations
3. Documentation: Maintain internal documentation of category meanings and populate their description section
4. Testing: Validate categories in your tests before implementing them in production
5. Training: Ensure drivers understand category meanings and icons

Integration with Other Features

Categories work seamlessly with:

• Conditional Scripts: Filter tasks based on category presence
• Tracking Page: Display as additional service options
• Mobile App: Visual indicators for drivers
• Webhooks: Include category information in event payloads
• Reporting: Filter and analyze tasks by categories

Categories provide a powerful way to structure and communicate delivery requirements across your entire operation, from initial task announcement through final delivery completion.

If you have questions regarding any of the information provided above, feel free to reach out to your CSM or to the support team for details.