-
Notifications
You must be signed in to change notification settings - Fork 813
Umbraco Commerce How to Guide on Creating and Order via Code #7017
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.
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
eshanrnh
merged 4 commits into
umbraco:main
from
mattbrailsford:uc-create-order-via-code
Apr 8, 2025
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
10393ff
Initial commit
mattbrailsford a4ed98b
Added code example for creating an order via code
mattbrailsford 145bc5b
Update 15/umbraco-commerce/how-to-guides/create-order-via-code.md
eshanrnh 9061793
Update 15/umbraco-commerce/how-to-guides/create-order-via-code.md
eshanrnh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
15/umbraco-commerce/how-to-guides/create-order-via-code.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| description: Learn how to create an order via code in Umbraco Commerce. | ||
| --- | ||
|
|
||
| # Create an Order via Code | ||
|
|
||
| It is sometimes necessary, such as when importing orders from another system, to create a fully finalized order via code. | ||
|
|
||
| An example of the code to do this is shown below. Here the `api` variable is an instance of the `IUmbracoCommerceApi` interface, which is an injectable service you access via [dependency injection](../key-concepts/dependency-injection.md). | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```csharp | ||
| await api.Uow.ExecuteAsync(async (uow) => | ||
| { | ||
| // Fetch the store | ||
| var store = await api.GetStoreAsync("blendid"); | ||
|
|
||
| // Create or get the current order | ||
| var order = await api.GetOrCreateCurrentOrderAsync(store.Id).AsWritableAsync(uow); | ||
|
|
||
| // Add product | ||
| var productId = "2fa949e4-2acb-4aef-bb7c-4d3a5f7bbe52"; // The product node Key | ||
| await order.AddProductAsync(productId, null, 1); | ||
|
|
||
| // Set customer details | ||
| var country = await api.GetCountryAsync(store.Id, "GB"); | ||
| await order.SetPropertiesAsync(new Dictionary<string, string> | ||
| { | ||
| { Constants.Properties.Customer.EmailPropertyAlias, $"[email protected]" }, | ||
| { "marketingOptIn", "0" }, | ||
| { Constants.Properties.Customer.FirstNamePropertyAlias, "Example" }, | ||
| { Constants.Properties.Customer.LastNamePropertyAlias, $"Customer" }, | ||
| { "billingAddressLine1", "10 Example Road" }, | ||
| { "billingCity", "Example City" }, | ||
| { "billingZipCode", "EX3 3PL" }, | ||
| { "billingTelephone", "0123456789" }, | ||
| { "shippingSameAsBilling", "1" } | ||
| }) | ||
| .SetPaymentCountryRegionAsync(country, null) | ||
| .SetShippingCountryRegionAsync(country, null); | ||
|
|
||
| // Set shipping method | ||
| var shippingMethod = await api.GetShippingMethodAsync(store.Id, "pickup"); | ||
| await order.SetShippingMethodAsync(shippingMethod); | ||
|
|
||
| // Set payment method | ||
| var paymentMethod = await api.GetPaymentMethodAsync(store.Id, "invoicing"); | ||
| await order.SetPaymentMethodAsync(paymentMethod); | ||
|
|
||
| // Recalculate order | ||
| await order.RecalculateAsync(); | ||
|
|
||
| // Finalize order | ||
| await order.InitializeTransactionAsync(); | ||
| await order.FinalizeAsync(order.TransactionAmount.Value, Guid.NewGuid().ToString("N"), PaymentStatus.Authorized); | ||
|
|
||
| // Save order | ||
| await api.SaveOrderAsync(order); | ||
|
|
||
| // Commit the unit of work | ||
| uow.Complete(); | ||
| }); | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.