Royal Mail Integration by PrismaSell

Royal Mail Integration by PrismaSell for Botble eCommerce

Royal Mail Integration by PrismaSell is a professional shipping plugin for Botble eCommerce that connects your online store with Royal Mail Click & Drop. It helps store owners reduce manual order entry by sending Botble orders directly to Royal Mail using the Click & Drop API.

This plugin is ideal for UK-based eCommerce stores using Botble CMS and Royal Mail Click & Drop for order fulfilment. Store admins can send orders manually from the order detail page or enable automatic order push when payment is completed.

Key Features

• Send Botble eCommerce orders to Royal Mail Click & Drop
• Manual Send to Royal Mail button on order pages
• Auto-send orders when payment is completed
• Supports manual bank transfer payment confirmation
• Royal Mail API key configuration
• Editable order reference prefix for each store
• Default package type and package weight settings
• Shipment records inside Botble admin
• Request and response logs for debugging
• Retry failed shipment attempts
• Duplicate protection to avoid sending the same order twice
• Pre-send validation for missing postcode, address, customer, or order data
• Supports product SKU, unit value, and package weight fields
• Includes billing and shipping address data for Royal Mail order creation

How It Works

After installation, the store owner enters their Royal Mail Click & Drop API key inside the PrismaShip settings page. The plugin then connects Botble eCommerce orders with Royal Mail.

When an order is ready, the admin can send it manually from the order detail page. If auto-push is enabled, the plugin can automatically send the order to Royal Mail when the payment status becomes completed.

Before sending the order, the plugin checks required order data such as customer name, address line, city, postcode, country, product details, and package weight. If required information is missing, PrismaShip shows a clear admin message before calling the Royal Mail API.

When the order is accepted by Royal Mail, the plugin stores the shipment record, provider reference, request payload, response payload, status, and logs inside Botble admin. This makes it easier to track sent orders and debug failed attempts.

Installation Instructions

1. Upload the plugin folder to your Botble installation:

   platform/plugins/royal-mail-integration-by-prismasell

2. Go to Admin > Plugins.
3. Activate Royal Mail Integration by PrismaSell.

4. Run migrations if required:

   php artisan migrate
   php artisan optimize:clear

5. Go to Admin > PrismaShip > Settings.
6. Enable the plugin.
7. Add your Royal Mail Click & Drop API key.

8. Set your order reference prefix, for example:

   MYSTORE

   Your Royal Mail order references will look like:

   MYSTORE-101
   MYSTORE-102
   MYSTORE-103

9. Choose the auto-push option:

   • Disabled / Manual only
   • When order is paid
   • When order is confirmed

   Recommended option: When order is paid

10. Save settings and test with a real or test order.

Royal Mail API Setup

To use this plugin, you need a Royal Mail Click & Drop API integration.

1. Log in to your Royal Mail Click & Drop account.
2. Go to Settings > Integrations.
3. Select or create Click & Drop API.
4. Copy your authorization/API key.
5. Paste the key into the plugin settings.

Recommended Royal Mail settings:

• Use shipping address for billing address: Recommended
• Create batches for imported orders: Optional
• Integration name: PrismaShip API or your store name

Required Checkout Fields

For Royal Mail UK orders, the checkout/order must include:

• Full name
• Address line 1
• City
• Postcode / ZIP code
• Country
• Email address
• Phone number

If the postcode or required address fields are missing, the plugin will stop the send action and display a clear validation message.

Current Version Scope

This version focuses on Royal Mail Click & Drop order creation.

Included:

• Order push to Royal Mail
• Manual send
• Auto-send after payment completion
• Shipment records
• Request and response logs
• Retry failed shipments
• Pre-send validation

Not included yet:

• Automatic postage/service selection
• Label download
• Tracking sync back to Botble
• Royal Mail status webhook
• Multi-carrier integrations such as FedEx, DHL, or UPS

These features may be added in future versions based on user demand.

Best For

• UK eCommerce stores using Botble CMS
• Stores using Royal Mail Click & Drop
• Store owners who want to reduce manual order entry
• Developers building Botble-based eCommerce shipping workflows
• Businesses that need a simple Royal Mail order export solution

Important Notes

• This plugin requires a Royal Mail Click & Drop account and API key.
• Royal Mail postage/service selection is handled inside Royal Mail Click & Drop in the current version.
• For UK orders, postcode must be collected during checkout.
• Each store should use a unique order reference prefix for easier order tracking.