Skip to content

Introduce recipes #1538

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Introduce recipes #1538

wants to merge 1 commit into from

Conversation

krzysztofwolski
Copy link
Member

No description provided.

@krzysztofwolski krzysztofwolski self-assigned this Apr 16, 2025
Copy link

vercel bot commented Apr 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
saleor-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 17, 2025 1:02pm

Copy link
Member

@peelar peelar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is still in progress but you asked for feedback, so I decided to share everything that caught my eye.

/>
</div>

# Setting up collection points
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚨 Markdown Police 🚨

suggestion: There should only be one # heading per document, so this one and the subsequent ones should be ##.

Comment on lines +27 to +33
<div style={{display: 'flex', gap: '1rem', flexWrap: 'wrap', paddingBottom: '4rem'}}>
<CompactCard
name="Warehouses docs"
description="Read more about warehouses configuration."
link="/developer/stock/stock-allocation"
/>
</div>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought: I know this is the closest we have to warehouse docs but it could be a bit misleading to be redirected to "Stock allocation" document when expecting to see warehouses. Maybe we should mark "Warehouse Docs" as worth revisiting and split into its own document to which we could link here in the future.


Each physical location where customers can collect orders must be represented as a **Warehouse** in Saleor, even if you don't track inventory at that specific location. The Warehouse entity represents the physical address for pickup.

By choosing allocation strategy, you can choose if different warehouses will able to deliver to this location, or customers will be able to order only the products available on site.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: I think we should more explicitly say something like:

You should select "all warehouses" In the "Pickup" section of the Warehouse screen.


# Storefront changes

List of available collection points for given checkout can be found in `availableCollectionPoints` field.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion:

Suggested change
List of available collection points for given checkout can be found in `availableCollectionPoints` field.
List of available collection points for given checkout can be found in `checkout.availableCollectionPoints` field.

Ideally, we could also add an example query.


List of available collection points for given checkout can be found in `availableCollectionPoints` field.

To select it use `checkoutDeliveryMethodUpdate` mutation. Shipping address of the checkout will be updated to chosen collection point.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To select it use `checkoutDeliveryMethodUpdate` mutation. Shipping address of the checkout will be updated to chosen collection point.
To select it, use `checkoutDeliveryMethodUpdate` mutation. Shipping address of the checkout will be updated to chosen collection point.


When order is picked up, staff users can use Saleor Dashboard to update fulfillments status as delivered.

For integration with existing order management software create app which will automatically synchronize status with Saleor API.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style:

Suggested change
For integration with existing order management software create app which will automatically synchronize status with Saleor API.
To integrate with existing order management software, create an app which will automatically synchronize status with Saleor API.


Create products using new product type. Fill in the product details, such as name, description, category and add variants.

Create stocks for variants. Without them products wont be available for purchase. If your product has unlimited stock, turn off the "track inventory" setting.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style:

Suggested change
Create stocks for variants. Without them products wont be available for purchase. If your product has unlimited stock, turn off the "track inventory" setting.
Create stocks for variants. Without them, products won't be available for purchase. If your product has unlimited stock, turn off the "track inventory" setting.


When order is made and paid, make content accessible to the customer. Use webhooks to integrate with your business backend.

Create webhook in the dashboard. Choose `Order fully paid` event, define subscription query and target URL. When order is paid, Saleor will send data defined by subscription query to provided address. Now recipient application will be able to perform necessary operations like updating subscription details or sending an email with download link.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When order is paid, Saleor will send data defined by subscription query to provided address.

suggestion: link to https://docs.saleor.io/developer/extending/webhooks/subscription-webhook-payloads

Saleor provides a flexible and powerful approach to multi-region commerce through its channels' management capabilities, allowing businesses to operate across various regions, currencies, and markets from a single backend instance. This recipe explores how to effectively set up and manage a multi-region shop using Saleor's channel architecture.


# Setup Channels
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style:

Suggested change
# Setup Channels
# Set Up Channels

or Channels Setup

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants