Laravel eCommerce Sendcloud Shipping

Bagisto Laravel eCommerce Sendcloud Shipping module lets the admin use Sendcloud to ship products. It pulls live rates from the Sendcloud API. This makes it a trusted way to ship items at good prices.

This module works with Bagisto 2.4.x. It uses the Sendcloud v3 API to get shipping rates. The admin can set up the module in minutes. After that, customers see real-time shipping options at checkout.

Module also creates parcels, downloads labels, and tracks shipments. All of this happens from the admin panel. No third-party tools are needed.

Key Features

• Live shipping rates from the Sendcloud API based on weight and destination.
• Sandbox mode for testing without buying real labels.
• Auto-create parcels when a customer places an order.
• Address validation for the store origin and customer addresses.
• Brand ID support to set your logo on tracking pages and emails.
• Automatic label download and storage on the server.
• Tracking number stored with each order for easy reference.
• Works with multiple carriers available on your Sendcloud account.
• Virtual, downloadable, and booking products are excluded from shipping.

Installation

Follow these steps to install the module. The process is simple and fast.

Step 1: Unzip the module zip file. Copy the packages folder into your project root directory. This adds the SendcloudShipping package to your Bagisto setup.

Step 2: Open the composer.json file in your project root. Find the “psr-4” section under “autoload”. Add the following line inside it:

"Webkul\\SendcloudShipping\\": "packages/Webkul/SendcloudShipping/src"

Step 3: Open the bootstrap/providers.php file in your project root. Add the following line inside the return array:

Webkul\SendcloudShipping\Providers\SendcloudShippingServiceProvider::class

Step 4: Open a terminal in your project root. Run the following commands in order:

composer dump-autoload
php artisan sendcloud:install

The first command updates the autoload map. The second command runs the database migration and clears the cache.

Step 5: Log in to the admin panel. Go to Configure >> Sales >> Carriers. You will see the Sendcloud section there.

Configuration

After installation, the admin must set up the module. Go to Configure >> Sales >> Carriers in the admin panel. Find the Sendcloud section and fill in the fields as described below.

Status: Turn this on to enable Sendcloud shipping. Turn it off to disable the method.

Title: Enter a name for the shipping method. This name shows up at checkout for the customer.

Description: Add a short text about the shipping method. This also shows up at checkout.

Brand ID: Enter your Sendcloud brand ID if you have one. This sets your logo on tracking pages and email notices.

You can find this under Settings >> Branding in your Sendcloud account. This field is optional.

Public Key: Enter the public API key from your Sendcloud account. You get this key after you create a Sendcloud account.

Secret Key: Enter the secret API key from your Sendcloud account. Keep this key safe. Do not share it.

Sandbox Mode: Turn this on to test the module without buying real shipping labels. In sandbox mode, the module uses a test shipping option. Turn this off when you are ready to ship real products.

Auto-Create Parcels on Order: Turn this on to create a Sendcloud parcel as soon as a customer places an order.

The label is downloaded and stored on the server. Turn this off if you want to create parcels manually later.

Validate Addresses with Sendcloud: Turn this on to check addresses before they are saved. The module checks the store shipping origin, customer addresses, and checkout shipping addresses.

If an address is wrong, the admin or customer sees an error message.

After you fill in all the fields, click the Save button. The Sendcloud shipping method is now live for customers.

Store Shipping Origin

Module needs a store shipping origin to work. Go to Configure >> Sales >> Shipping >> Origin. Fill in the country, state, city, street address, and postal code.

These fields are required. Without them, the module cannot calculate shipping rates.

How It Works for the Customer

Once the module is set up, the customer sees Sendcloud shipping options at checkout. The module fetches live rates from the Sendcloud API.

Rates depend on the weight of the products and the shipping destination.

The customer picks a shipping option from the list. Each option shows its name and price. The customer then clicks Place Order to finish the purchase.

How It Works for the Admin

The admin can see the shipping details in the order view. Go to Sales >> Orders and open an order. The shipping method used by the customer is shown there.

If auto-parcel creation is on, the parcel ID and tracking number are also shown.

The admin can also see shipping details in the invoice and shipment sections. The label PDF is stored on the server and can be downloaded from the order page.

Sandbox Mode

Use sandbox mode to test the module before going live. In sandbox mode, the module sends a test shipping option to Sendcloud. No real label is bought. This is useful during development and setup.

When you are ready to ship real products, turn off sandbox mode. Make sure your Sendcloud account is verified and has active carriers before you switch to live mode.

Address Validation

When address validation is turned on, the module checks three types of addresses:

• Store Origin: Checked when the admin saves the shipping origin in the configuration.
• Customer Addresses: Checked when a customer creates or updates an address in their account.
• Checkout Addresses: Checked when the customer enters a shipping address during checkout.

If the address is wrong, the module shows an error. It may also suggest a corrected address. This helps avoid failed deliveries and extra shipping costs.

Troubleshooting

• No shipping rates show at checkout: Check that the store shipping origin has a country and postal code. Also check that the API keys are correct.
• Parcel creation fails: Make sure your Sendcloud account is verified. Check that you have active carriers. Look at the order page for error details.
• Address validation error: Check the street, postal code, city, and country. Use the suggested address if one is provided.
• Sandbox mode is still on: Go to the Sendcloud configuration and turn off Sandbox Mode. Save the settings.

Requirements

• Bagisto 2.4.x or higher.
• A Sendcloud account with API keys.
• At least one active carrier on your Sendcloud account.
• PHP 8.3 or higher.
• A valid store shipping origin with country and postal code.