Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

"Add custom shipping carrier": added meta description/keywords, removed community note #87

Merged
merged 1 commit into from
Oct 10, 2024
Merged

"Add custom shipping carrier": added meta description/keywords, removed community note #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions add-custom-shipping-carrier.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
---
description: Find out how to integrate custom shipping carriers into Mage-OS. Configure new shipping options tailored to your business needs, enhancing your eCommerce platform’s flexibility and functionality.
keywords: Mage-OS, Mage-OS custom shipping, add shipping carrier, custom shipping method, shipping integration, Mage-OS shipping configuration, Magento carrier setup, Magento shipping module
communityNote: false
---
# Add custom shipping carrier

[TOC]

Mage-OS allows the creation of custom shipping carriers to handle various shipping methods for

Check failure on line 10 in add-custom-shipping-carrier.md

View workflow job for this annotation

GitHub Actions / lint

Line length 

add-custom-shipping-carrier.md:10:81 MD013/line-length Line length [Expected: 80; Actual: 94] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
different carriers or logistics providers. A custom shipping carrier can be added by creating a

Check failure on line 11 in add-custom-shipping-carrier.md

View workflow job for this annotation

GitHub Actions / lint

Line length 

add-custom-shipping-carrier.md:11:81 MD013/line-length Line length [Expected: 80; Actual: 95] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
Mage-OS module and configuring the required fields to handle shipping calculations,
carrier configurations, and frontend integration.

## Module Setup

The first step in adding a custom shipping carrier is creating the necessary directory structure

Check failure on line 17 in add-custom-shipping-carrier.md

View workflow job for this annotation

GitHub Actions / lint

Line length 

add-custom-shipping-carrier.md:17:81 MD013/line-length Line length [Expected: 80; Actual: 96] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
for the Mage-OS module:

```bash
Expand Down Expand Up @@ -50,7 +55,7 @@

## Shipping Carrier Configuration

In the `config.xml` file, define the shipping carrier's core settings, such as its active state,

Check failure on line 58 in add-custom-shipping-carrier.md

View workflow job for this annotation

GitHub Actions / lint

Line length 

add-custom-shipping-carrier.md:58:81 MD013/line-length Line length [Expected: 80; Actual: 96] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
title, and allowed countries. Create `app/code/MageOS/ShippingCarrier/etc/config.xml`:

```xml
Expand Down Expand Up @@ -82,7 +87,7 @@

## Admin Configuration for Carrier

To allow store administrators to configure the shipping method, we define settings in

Check failure on line 90 in add-custom-shipping-carrier.md

View workflow job for this annotation

GitHub Actions / lint

Line length 

add-custom-shipping-carrier.md:90:81 MD013/line-length Line length [Expected: 80; Actual: 85] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
`app/code/MageOS/ShippingCarrier/etc/adminhtml/system.xml`:

```xml
Expand All @@ -91,19 +96,19 @@
xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
<system>
<section id="carriers">
<group id="customcarrier" translate="label" type="text" sortOrder="0" showInDefault="1" showInWebsite="1" showInStore="1">

Check failure on line 99 in add-custom-shipping-carrier.md

View workflow job for this annotation

GitHub Actions / lint

Line length 

add-custom-shipping-carrier.md:99:81 MD013/line-length Line length [Expected: 80; Actual: 134] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
<label>Custom Shipping Module</label>
<field id="active" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">

Check failure on line 101 in add-custom-shipping-carrier.md

View workflow job for this annotation

GitHub Actions / lint

Line length 

add-custom-shipping-carrier.md:101:81 MD013/line-length Line length [Expected: 80; Actual: 149] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
<label>Enabled</label>
<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
</field>
<field id="title" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">

Check failure on line 105 in add-custom-shipping-carrier.md

View workflow job for this annotation

GitHub Actions / lint

Line length 

add-custom-shipping-carrier.md:105:81 MD013/line-length Line length [Expected: 80; Actual: 146] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
<label>Title</label>
</field>
<field id="name" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">

Check failure on line 108 in add-custom-shipping-carrier.md

View workflow job for this annotation

GitHub Actions / lint

Line length 

add-custom-shipping-carrier.md:108:81 MD013/line-length Line length [Expected: 80; Actual: 145] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
<label>Method Name</label>
</field>
<field id="shipping_cost" translate="label" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">

Check failure on line 111 in add-custom-shipping-carrier.md

View workflow job for this annotation

GitHub Actions / lint

Line length 

add-custom-shipping-carrier.md:111:81 MD013/line-length Line length [Expected: 80; Actual: 154] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
<label>Shipping Cost</label>
<validate>validate-number validate-zero-or-greater</validate>
</field>
Expand Down
Loading