Skydropx Pro Shipping Plugin

A comprehensive Medusa plugin for integrating with Skydropx Pro shipping services, providing multi-carrier rate calculation, shipment creation, tracking, and order management.

Overview

This plugin enables seamless integration with Skydropx Pro, a leading Latin American shipping aggregator. It provides access to multiple carriers including FedEx, DHL, and more, with comprehensive shipping management capabilities.

Features

Multi-Carrier Rate Calculation - Get real-time shipping rates from FedEx, DHL, and other carriers
Shipment Creation - Create shipments with automatic tracking and label generation
Real-Time Tracking - Track shipments in real-time with status updates
Shipment Protection - Optional insurance and shipment protection
Product Catalog Management - Manage product shipping information
Label Printing - Configure label printing formats (PDF, ZPL, etc.)
Order Management - Comprehensive order and shipment management
OAuth Authentication - Secure authentication with Skydropx Pro API
MedusaJS v2 Compatible - Built for Medusa v2 architecture

Requirements

MedusaJS v2
Node.js (latest LTS recommended)
Active Skydropx Pro account

Installation

Install the plugin using npm:

npm install @zaamx/medusa-skydropxpro

Configuration

Environment Variables

Add your Skydropx Pro credentials to your .env file:

SKYDROPX_API_KEY=your_api_key
SKYDROPX_API_TOKEN=your_api_token
SKYDROPX_ENVIRONMENT=production # or 'sandbox' for testing

Plugin Configuration

Add the plugin to your medusa-config.js:

const plugins = [
  // ... other plugins
  {
    resolve: "@zaamx/medusa-skydropxpro",
    options: {
      api_key: process.env.SKYDROPX_API_KEY,
      api_token: process.env.SKYDROPX_API_TOKEN,
      environment: process.env.SKYDROPX_ENVIRONMENT,
      // Label format configuration
      label_format: "pdf", // or 'zpl' for thermal printers
      // Default carrier preferences
      carriers: ["fedex", "dhl", "ups"],
    },
  },
]

Usage

Rate Calculation

The plugin automatically calculates shipping rates during checkout:

// Rates are calculated based on:
// - Package dimensions and weight
// - Origin and destination addresses
// - Selected carrier preferences
// - Real-time carrier pricing

Creating Shipments

When an order is fulfilled, the plugin can automatically:

Create a shipment in Skydropx Pro
Generate shipping labels
Provide tracking information
Update order status

Tracking Shipments

Real-time tracking features include:

Automatic tracking number generation
Status updates from carriers
Delivery notifications
Exception handling

Shipment Protection

Enable shipment insurance:

{
  resolve: "@zaamx/medusa-skydropxpro",
  options: {
    // ... other options
    enable_insurance: true,
    default_insurance: true, // Auto-insure all shipments
  },
}

Supported Carriers

Skydropx Pro provides access to multiple carriers:

FedEx - Express and ground shipping
DHL - International and domestic delivery
UPS - Package delivery services
Estafeta - Mexican carrier
Paquetexpress - Latin American carrier
And many more regional carriers

Label Formats

The plugin supports various label formats:

PDF - Standard format for regular printers
ZPL - Zebra Programming Language for thermal printers
EPL - Eltron Programming Language
PNG/JPG - Image formats

Product Catalog Management

Manage shipping information for your products:

Set default dimensions and weights
Configure HS codes for international shipping
Define origin addresses
Set shipping restrictions

API Integration

Latest Updates (v0.0.6)

The plugin now includes:

Updated OAuth authentication flow
New field naming conventions aligned with Skydropx Pro API
Expanded functionality for orders management
Improved product catalog integration
Enhanced error handling

Development & Testing

Use sandbox mode for testing:

SKYDROPX_ENVIRONMENT=sandbox

This allows you to:

Test rate calculations without charges
Create test shipments
Generate test labels
Verify tracking functionality

Shipping Workflow

Customer Checkout - Real-time rate calculation
Order Creation - Order details sent to Medusa
Fulfillment - Admin creates shipment in Skydropx Pro
Label Generation - Automatic label creation
Tracking - Real-time tracking updates
Delivery - Automatic notification on delivery

Best Practices

Address Validation - Ensure accurate addresses for rate calculation
Package Dimensions - Configure accurate product dimensions
Carrier Selection - Choose appropriate carriers for your market
Label Format - Select format compatible with your printer
Insurance - Consider insurance for high-value items

Links

See all guides