Skip to content

Update shipping-providers.md #6793

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

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Update shipping-providers.md #6793

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
280c858
Update shipping-providers.md
busrasengul Jan 14, 2025
a14fbde
Update shipping-providers.md
busrasengul Jan 14, 2025
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
6 changes: 3 additions & 3 deletions 13/umbraco-commerce/key-concepts/shipping-providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,16 @@ public class MyShippingProvider : ShippingProviderBase<MyShippingProviderSettin
public class MyShippingProviderSettings
{
[ShippingProviderSetting(Name = "API Key",
Description = "The API key to the shipping opperators API",
Description = "The API key to the shipping operators API",
SortOrder = 100)]
public string ApieKey { get; set; }
public string ApiKey { get; set; }

...
}

```

All Shipping Providers inherit from a base class `ShippingProviderBase<TSettings>`. `TSettings` is the type of a Plain Old Class Object (POCO) model class representing the Shipping Providers settings. The class must be decorated with `ShippingProviderAttribute` which defines the Shipping Providers `alias`, `name` and `description`, and can also specify an `icon` to be displayed in the Umbraco Commerce backoffice.
All Shipping Providers inherit from a base class `ShippingProviderBase<TSettings>`. `TSettings` is the type of a Plain Old Class Object (POCO) model class representing the Shipping Provider's settings. The class must be decorated with `ShippingProviderAttribute` which defines the Shipping Providers `alias`, `name` and `description`, and can also specify an `icon` to be displayed in the Umbraco Commerce backoffice.

The settings class consists of a series of properties, each decorated with a `ShippingProviderSettingAttribute` defining a name, description, and possible angular editor view file. These will all be used to dynamically build an editor interface for the given settings in the backoffice.

Expand Down
Loading