Skip to main content

Custom Scripts

S
Written by Shipwell TMS Support
Updated over 3 weeks ago

Automate Your Workflow with Custom Scripts

What Are Shipwell API Scripts?

Think of API scripts as smart assistants that can automatically handle repetitive tasks in your Shipwell account. Just like you might set up email rules to automatically sort your inbox, you can create scripts to automatically process shipments, update data, and respond to shipping events without manual intervention.

Built-in Visibility: Scripts can write status information directly back into Shipwell, so you always know if automation is working correctly. You'll see clear indicators in your shipment records showing whether a script ran successfully, what actions it took, or if any issues occurred that need attention.

When Should You Consider Custom Scripts?

Scripts are perfect for solving problems that fall outside Shipwell's standard features. Here are common scenarios where custom scripts shine:

Bulk Operations & Data Management

  • Mass shipment updates: Update hundreds of shipments at once based on specific criteria

  • Automated data imports: Pull shipment data from your warehouse system into Shipwell daily

  • Custom reporting: Generate weekly reports that combine Shipwell data with your internal systems

  • Data synchronization: Keep your ERP system and Shipwell perfectly in sync

Event-Driven Automation

  • Smart notifications: Send custom alerts to different teams based on shipment status

  • Automatic responses: Update your inventory system when deliveries are confirmed

  • Exception handling: Flag unusual shipping patterns or delays for immediate attention

  • Customer updates: Automatically send personalized delivery updates to your customers

Workflow Enhancement

  • Custom routing logic: Apply complex business rules when selecting carriers

  • Dynamic pricing: Adjust shipping costs based on your internal calculations

  • Compliance automation: Ensure all shipments meet regulatory requirements automatically

  • Performance monitoring: Track and alert on carrier performance metrics

Real-World Examples

Example 1: Smart Date Estimation for Orders

The Challenge: When creating new shipments, your team manually estimates pickup and delivery dates based on drive times between states, leading to inconsistent scheduling and customer expectations.

The Script Solution: An automated system that:

  • Uses state-to-state drive time data to calculate realistic transit times

  • Automatically sets pickup dates based on your warehouse scheduling

  • Calculates delivery dates accounting for weekends and holidays

  • Updates orders with accurate dates before they're dispatched to carriers

Example 2: Smart Shipment Routing

The Challenge: You have complex business rules for carrier selection based on destination, weight, and seasonal factors that change throughout the year.

The Script Solution: A webhook script that automatically:

  • Receives notification when new shipments are created

  • Applies your custom logic to recommend the best carrier

  • Updates the shipment with the recommended routing

  • Alerts your team if manual review is needed

Example 3: Customer Service Automation

The Challenge: Your customer service team spends hours manually updating customers about delivery status changes.

The Script Solution: An automated system that:

  • Monitors shipment status changes in real-time

  • Sends personalized notifications to customers

  • Updates your CRM system with delivery confirmations

  • Creates follow-up tasks for your sales team

Example 4: Automated GL Code Assignment

The Challenge: Your accounting team requires specific General Ledger codes on every shipment for proper cost allocation, but manual entry is time-consuming and error-prone, especially when codes vary by product type, destination, or customer.

The Script Solution: A smart coding system that:

  • References your master GL code table to automatically assign codes

  • Applies codes at the shipment, stop, or line item level based on your business rules

  • Uses logic like "Electronics to West Coast = GL Code 4200" or "Hazmat shipments = GL Code 7500"

  • Validates codes against your accounting system before finalizing shipments

Types of Scripts You Can Create

Google Sheets Integration Scripts

Perfect for teams already using Google Sheets for data management. These scripts can:

  • Import shipment data directly into your spreadsheets

  • Upload bulk shipment information from sheets to Shipwell

  • Create automated dashboards with live data

  • Generate custom reports and analytics

  • Write execution status back to Shipwell showing successful data updates or any errors

Best For: Teams comfortable with spreadsheets who want to enhance their existing workflows.

Webhook Processing Scripts

Ideal for real-time automation that responds to shipping events. These scripts can:

  • React instantly when shipments change status

  • Process delivery confirmations automatically

  • Trigger actions in other business systems

  • Send immediate notifications to relevant parties

  • Log processing results directly in Shipwell for audit trails

Best For: Businesses needing immediate responses to shipping events.

Scheduled Automation Scripts

Great for regular, recurring tasks that happen on a schedule. These scripts can:

  • Run daily data synchronization between systems

  • Generate weekly performance reports

  • Perform monthly billing reconciliation

  • Clean up old or duplicate shipment data

  • Record completion status and timestamps in Shipwell for monitoring

Best For: Operations teams managing regular, predictable processes.

Getting Started: What You Need

For Your Team

  • A clear problem definition: What manual task do you want to automate?

  • Business process documentation: How do you currently handle this task?

  • Success criteria: How will you know the script is working correctly?

For Implementation

  • API access: Your Shipwell API credentials (we'll help you set these up)

  • Basic tool access: Usually just a Google account for Google Sheets/Apps Script

  • Testing environment: A safe space to test before going live

Technical Support

  • Implementation partner: Many customers work with technical consultants for initial setup

  • Shipwell support: Our team helps with API questions and best practices

  • Documentation: Step-by-step guides for common script patterns

Implementation Approach

Phase 1: Planning

  • Document your current manual process

  • Identify which parts can be automated

  • Define success metrics and testing criteria

  • Set up necessary accounts and permissions

Phase 2: Development

  • Create a simple version of your script

  • Test with sample data in a safe environment

  • Refine the logic based on test results

  • Add error handling and monitoring

Phase 3: Deployment

  • Run final tests with real data

  • Deploy to your production environment

  • Train your team on the new automated process

  • Monitor closely for the first few days

Phase 4: Optimization

  • Gather feedback from your team

  • Make improvements based on real usage

  • Add new features as needs evolve

  • Scale to additional use cases

  • Monitor script execution logs in Shipwell to identify optimization opportunities

Script Monitoring and Transparency

One of the key advantages of Shipwell's API integration is full visibility into script execution through the built-in Script Log feature. When scripts run, they write detailed status information directly back into your Shipwell account, providing:

Script Log Interface: A dedicated "Script Log" button appears on shipment records where you can view detailed execution information in an easy-to-read JSON format

Execution Details: See exactly what data the script processed, including:

  • Level information (TRACE, INFO, ERROR)

  • Specific messages about actions taken

  • Timestamps showing when operations occurred

  • Data values that were updated or processed

Success and Error Tracking: Clear indicators showing successful completion or detailed error information when issues occur

Real-Time Updates: Status information appears immediately after script execution, so you always know the current state

This built-in monitoring means you never have to wonder if your automation is working. The Script Log provides complete transparency into every automated process, making it easy for your team to verify results, troubleshoot issues, and maintain confidence in your automated workflows.

Success Stories

Mid-Size Logistics Company

"We were spending 8 hours every week manually updating shipment statuses across three different systems. Now our script handles it automatically in minutes, and our team can focus on customer service instead of data entry."

E-commerce Retailer

"Our custom notification script has improved customer satisfaction scores by 15% because customers get personalized updates exactly when they want them, not generic status emails."

Manufacturing Company

"The automated reporting script saves us 2 full days of work every month and gives us insights we never had before by combining Shipwell data with our production schedules."

Next Steps

Ready to Explore Scripts?

  1. Identify your use case: Start with your biggest manual task or most frequent pain point

  2. Review the technical documentation: Check out our detailed integration guides

  3. Connect with support: Our team can help assess if scripts are right for your situation

  4. Consider a pilot project: Start small with one simple automation to prove the concept

Need Help Getting Started?

  • Shipwell Customer Success: We can help identify good script opportunities in your workflow

  • Implementation Partners: We can recommend technical partners who specialize in Shipwell integrations if your technical team doesn’t have the time or we can discuss a potential Statement of Work if we performed this work on your behalf

  • Community Resources: Join our user community to learn from other customers' automation successes

Custom scripts transform Shipwell from a great shipping platform into a perfectly tailored solution for your unique business needs. The investment in automation pays dividends through reduced manual work, fewer errors, and insights that drive better business decisions.

Did this answer your question?