Drusoft Shipping for Speedy

Description

Drusoft Shipping for Speedy is a high-performance, conflict-free WooCommerce integration for Speedy delivery services in Bulgaria. Designed for speed, reliability, and ease of use, it provides a seamless shipping experience for both merchants and customers.

Important Compatibility Note

This plugin is currently not compatible with the WooCommerce Block Cart and Block Checkout pages. Please ensure your store uses the classic shortcode-based Cart ([woocommerce_cart]) and Checkout ([woocommerce_checkout]) pages.

For Your Customers

• Dynamic Checkout Experience — Real-time city and office selection directly on the checkout page.
• Multiple Delivery Types — Choose between delivery to Address, Speedy Office, or Speedy Automat (APS).
• Smart Street Search — Built-in autocomplete for Bulgarian street names with intelligent prefix handling (e.g., stripping “ул.”, “бул.”).
• Live Service Selection — Customers can choose between available services (Economy, Express, etc.) with real-time price updates.
• Region Mapping — Automated city filtering based on the selected Bulgarian province.

For Merchants

• HPOS Compatible — Fully supports WooCommerce High-Performance Order Storage.
• Automated Data Sync — Uses Action Scheduler to keep Bulgarian cities and Speedy offices up-to-date in the background.
• Credential Validation — Validates API credentials in real-time before saving.
• Custom Pricing — Support for custom pricing CSV files for specialized shipping rates.
• Advanced Order Management — Dedicated metabox in the order edit screen, integrated waybill generation, and bulk actions for managing multiple Speedy orders.
• Clean Codebase — Built with modern PHP standards and conflict-free architecture.

External Services

This plugin relies on the Speedy REST API, a third-party service provided by Speedy AD (Speedy Bulgaria), to deliver its shipping functionality. The plugin cannot operate without a valid Speedy API account.

What the service is

Speedy AD is a courier and logistics company operating in Bulgaria. Their REST API allows merchants to calculate shipping rates, create shipments (waybills), manage deliveries, and retrieve location data (cities, offices, automats, streets).

What data is sent and when

• API credentials (username and password) — sent with every API request for authentication.
• Recipient address data (city, street, office ID) — sent when calculating shipping rates at cart/checkout and when creating a waybill after order placement.
• Shipment details (weight, dimensions, COD amount, service type, sender/recipient info) — sent when generating a waybill.
• Waybill ID — sent when cancelling a shipment, requesting a courier pickup, or printing a waybill label.
• Location queries (city name, street name) — sent when the customer or admin searches for cities, offices, or streets.

Data is transmitted only when the corresponding action is triggered (e.g., a customer proceeds to checkout, a merchant generates a waybill, or the background sync runs).

Service links

• Speedy API base URL: https://api.speedy.bg/v1/
• Speedy Terms and Conditions: https://www.speedy.bg/en/general-conditions
• Speedy Privacy Policy: https://www.speedy.bg/en/privacy-policy
• Speedy API Documentation: https://api.speedy.bg/

Speedy API Endpoints

This plugin communicates with the Speedy REST API v1 (https://api.speedy.bg/v1/). All requests are authenticated using the userName and password fields configured in the shipping method settings. Below is a summary of every endpoint used, along with its purpose and where it is called in the plugin.

Authentication & Account

• POST /v1/client/contract — Validates API credentials and retrieves the list of client contracts (sender accounts). Used during credential validation when the merchant saves settings, and to populate the “Sender (Object)” dropdown in the shipping method configuration.
• POST /v1/client/contract/info — Retrieves detailed contract information, including special delivery requirements (e.g., mandatory open-on-test, two-way receipt). Used to populate the “Special Requirements” multi-select in the shipping method settings.

Location Data

• POST /v1/location/site — Searches for cities/sites by name within Bulgaria (countryId: 100). Used by the admin Select2 city search when configuring the sender city, and for the public-facing city autocomplete on checkout.
• POST /v1/location/site/csv/100 — Downloads the complete list of Bulgarian cities in CSV format. Used by the background syncer (Drushfo_Syncer) to populate and update the wp_drushfo_cities database table via Action Scheduler.
• POST /v1/location/office — Retrieves all Speedy offices and automats for Bulgaria. Used in two contexts: (1) the background syncer updates the wp_drushfo_offices table, and (2) the admin Select2 office search for configuring the sender office.
• POST /v1/location/street — Searches for streets within a specific city (siteId). Used on the checkout page to provide street autocomplete when the customer selects “Delivery to Address.”

Services & Pricing

• POST /v1/services — Retrieves the list of available shipping services (e.g., Standard 505, Express 501) for the authenticated account. Used to populate the “Active Services” multi-select in the shipping method settings.
• POST /v1/calculate — Calculates the shipping price for a specific service, weight, destination, and delivery type. Used at cart/checkout time when the pricing method is set to “Speedy Calculator” or “Calculator + Surcharge.”

Shipment Management

• POST /v1/shipment/ — Creates a new shipment (waybill) with the Speedy system. Includes sender/recipient details, service, weight, COD amount, and delivery type. Used by the waybill generator, either automatically on order status change or manually from the order metabox.
• POST /v1/shipment/cancel — Cancels an existing shipment by its waybill ID. Used from the “Cancel Shipment” button in the Speedy order metabox or the Speedy Orders bulk action.
• POST /v1/pickup — Requests a courier pickup for one or more shipments. Accepts a visit end time and auto-adjusts the pickup date. Used from the “Request Courier” button in the order metabox.
• POST /v1/print — Generates a printable waybill label (PDF) for a shipment. Supports A4, A6, and label formats with optional additional barcode copy. Used from the “Print Waybill” button in the order metabox and the Speedy Orders page.

Rate Limiting & Caching

The plugin minimizes API calls through several strategies:

• Local database tables — Cities and offices are synced periodically via Action Scheduler and queried locally, avoiding per-request API calls for location data.
• Transient caching — Service lists, contract data, and client information are cached using WordPress transients to reduce redundant API calls.
• Session storage — Cart selections (city, delivery type, office) are stored in the WooCommerce session, so shipping calculations reuse the customer’s choices without extra lookups.