Easypost Shipping OCA

Step 1: Configure Delivery Carrier

• Go to Inventory → Configuration → Delivery Methods
• Create a new delivery method or edit an existing one
• Set Provider to Easypost OCA
• In the Easypost Configuration tab, configure the following fields:
• Easypost Test API Key: Your test API key from EasyPost dashboard (for development and testing)
• Easypost Production API Key: Your production API key (for live shipments)
• Label Format: Choose the label format according to your printer:
• PDF (default): Standard format, works with all printers
• ZPL: For Zebra thermal printers (direct thermal printing)
• EPL2: For legacy Eltron/Zebra thermal printers
• Delivery Multiple Packages: Select the shipping strategy for orders with multiple packages:
• Shipments (default): Create individual shipment for each package, charged separately
• Batch: Create batch shipment with all packages in a single transaction
• Configure Pricing tab as needed (fixed price, percentage, or formula-based)
• Enable the Test Environment checkbox during development to use test API key
• Save the delivery method

Step 2: Configure Product Packaging (Optional)

For accurate shipping calculations using carrier-specific package types:

• Go to Inventory → Configuration → Product Packagings
• Create or edit a product packaging
• Set Carrier to Easypost OCA
• Configure package dimensions: Length, Width, Height (in inches)
• Set Shipper Package Code for carrier-specific packaging (e.g., "Parcel", "FedExBox", "FlatRateEnvelope")
• Set Carrier Prefix to filter by specific carrier if needed (e.g., "USPS", "FedEx")
• Save the packaging

Step 3: Configure Warehouse Address

Ensure your warehouse has a complete address that will be used as the shipper address:

• Go to Inventory → Configuration → Warehouses
• Edit your warehouse
• Set complete Address with all required fields:
• Street address
• City
• State/Province
• ZIP/Postal code
• Country
• Verify the address is accurate - this will be the "Ship From" address on all labels

Step 4: Enable API Logging (Optional)

For debugging API interactions and troubleshooting issues:

• Edit the delivery carrier configured in Step 1
• Go to the Advanced Options tab
• Enable Log XML checkbox
• Check API request/response logs at Settings → Technical → Logging

Important Configuration Notes

• Test vs Production Mode: Toggle the Test Environment checkbox to switch between test and production API keys. Always test thoroughly in test mode before going live.
• Weight Units: The module automatically converts product weights to ounces (EasyPost requirement). Ensure all products have weight configured.
• Currency Conversion: EasyPost returns rates in USD. The module automatically converts to the order's currency using Odoo's currency rates.
• USPS/UPS End Shipper: These carriers require an end shipper ID for certain services. The module automatically creates and manages this - no manual configuration needed.
• API Keys Security: Keep your production API key secure. Never commit API keys to version control or share them publicly.
• Rate Caching: EasyPost rates are calculated in real-time. Rates shown at quotation time may differ slightly at shipping time if time has passed.

Workflow 1: Calculate Shipping Rates on Sale Order

• Create a new Sale Order: Go to Sales → Orders → Quotations → Create
• Add products to the order (ensure products have weight configured)
• Set the Customer with a complete shipping address
• Click the Add Shipping button
• In the Add a shipping method wizard:
• Select your Easypost OCA delivery method from the list
• Click Get Rate button
• The system will:
• Query EasyPost API with order details (weight, origin/destination addresses)
• Automatically select the lowest rate from all available carriers
• Add a shipping line to the order with the carrier name (e.g., "Easypost - USPS Priority")
• The Sale Order now shows:
• Shipping line with carrier name and calculated price
• Stored data: shipment_id, rate_id, carrier_name (for later shipment creation)
• Confirm the order when ready to proceed

Workflow 2: Generate Shipping Labels (Single Package)

• After confirming the sale order, a Delivery Order is automatically created
• Go to Inventory → Delivery Orders and open the delivery order
• Click Check Availability to reserve stock
• Set the Done quantities for each product line
• Click Validate button - the system will automatically:
• Create an EasyPost shipment using the stored rate (or calculate a new rate if expired)
• Purchase the shipment (charges your EasyPost account)
• Download the shipping label in your configured format (PDF/ZPL/EPL2)
• Attach the label to the picking in the Chatter messages
• Set the tracking number on the delivery order
• Find the shipping label in the Chatter section at the bottom
• Click the attachment to download and print the label
• Attach the printed label to your package and ship

Workflow 3: Multi-Package Shipments

If your delivery order contains multiple packages:

• In the delivery order, after setting Done quantities
• Use the Put in Pack button to create packages:
• Select products for the first package
• Click Put in Pack - creates Package 1
• Repeat for additional packages
• Click Validate - behavior depends on your carrier configuration: Shipments Mode (default):
• Creates individual EasyPost shipment for each package
• Each package gets its own tracking number
• Each package is charged separately
• System generates a single merged PDF/ZPL with all labels in sequence Batch Mode:
• Creates a batch shipment containing all packages
• Packages are purchased together in a single transaction
• May provide better rates for bulk shipping
• Single merged label file with all package labels
• All tracking numbers are displayed in the delivery order (comma-separated)
• The merged label file contains all package labels - print and attach to corresponding packages

Workflow 4: Track Shipments

After shipment creation:

• Open the Delivery Order
• Click the Tracking button/link in the form
• Opens the EasyPost tracking page in a new browser tab
• View real-time shipment status, location history, and delivery confirmation

Using Product Packaging for Accurate Rates

To use carrier-specific package types (flat rate boxes, envelopes, etc.):

• In the delivery order, after using Put in Pack
• Edit the created Package record
• Set the Packaging field to a product packaging configured for EasyPost (see CONFIGURE.rst)
• The packaging dimensions and shipper package code are sent to EasyPost
• Results in more accurate rates and ensures carrier compatibility

Label Format Guide

Choose the appropriate label format for your printing setup:

• PDF Format:
• Works with all standard printers
• Can preview in browser before printing
• Best for offices with regular laser/inkjet printers
• Label size: typically 8.5"x11" or 4"x6"
• ZPL Format:
• For Zebra thermal label printers
• Direct thermal printing (no ink/toner required)
• Common in warehouses and shipping departments
• Requires ZPL-compatible thermal printer
• EPL2 Format:
• For legacy Eltron and older Zebra thermal printers
• Use only if your printer doesn't support ZPL
• Less common in modern shipping operations

Important Usage Notes

• Product Weight Required: All products in the order must have weight configured. Orders without weight cannot calculate shipping rates.
• Complete Addresses Required: Both warehouse address (ship from) and customer address (ship to) must be complete with street, city, state/province, ZIP, and country.
• Test Mode Shipments: Shipments created in test mode (with test API key) are not actually shipped. They are mock shipments for testing purposes and no charges apply.
• Cannot Cancel Shipments: EasyPost shipments cannot be cancelled through Odoo. Some carriers allow refunds within 24 hours - use the EasyPost dashboard for refund requests.
• Rate Expiration: Shipping rates may change between quotation and shipment if significant time has passed. The system will automatically recalculate rates at shipping time if the stored rate has expired.
• Multiple Carriers: EasyPost automatically compares rates from multiple carriers (USPS, UPS, FedEx, etc.) and selects the lowest rate. You can see the selected carrier name in the shipping line (e.g., "Easypost - USPS Priority").
• Tracking Updates: Tracking information is available immediately after shipment creation. Real tracking events (scans, delivery) appear as the carrier processes the shipment.