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.

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

chore: add public stock cap use-case #1269

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

peelar
Copy link
Member

@peelar peelar commented Aug 2, 2024

I know Warehouses could be probably use their separate page in the docs, but I wanted to at least capture that information for now

@peelar peelar requested a review from IKarbowiak August 2, 2024 08:08
@peelar peelar self-assigned this Aug 2, 2024
Copy link

vercel bot commented Aug 2, 2024

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 Aug 6, 2024 9:08am

Co-authored-by: Iga Karbowiak <40886528+IKarbowiak@users.noreply.github.com>
We can define warehouse as public or private. Public warehouse allows you to query the stock information publicly in the API. Private warehouse requires permission.
#### Public vs. private warehouses

We can define warehouse as public or private. Public warehouse allows you to query the stock information publicly in the API. Private warehouse requires permission. The [`quantityAvailable`](api-reference/products/objects/product-variant.mdx#productvariantquantityavailableint--) field on `ProductVariant` type is the sum of the available quantity in all public and private warehouses.
Copy link
Member

Choose a reason for hiding this comment

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

Permissions part is a bit unclear for me:

  • when my client has permissions, does it impact variant.quantityAvailable?
  • or did you mean variant.stocks field?


We can define warehouse as public or private. Public warehouse allows you to query the stock information publicly in the API. Private warehouse requires permission. The [`quantityAvailable`](api-reference/products/objects/product-variant.mdx#productvariantquantityavailableint--) field on `ProductVariant` type is the sum of the available quantity in all public and private warehouses.

Storefronts can display product availability at specific locations with public stock. To protect business-sensitive details, you can cap public stock at the maximum orderable quantity per checkout: [`quantityLimitPerCustomer`](api-reference/products/inputs/product-variant-input.mdx#productvariantinputquantitylimitpercustomerint--). Therefore, if a warehouse holds 999 pieces and the max orderable quantity is 50, the API will return 50 as the available stock.
Copy link
Member

Choose a reason for hiding this comment

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

Theres the link for product input, but this setting can be changed globally in SiteSettings (and adjusted in linked variant input).

@timuric
Copy link
Contributor

timuric commented Aug 7, 2024

@peelar I just added link guide to readme https://github.com/saleor/saleor-docs/pull/1276/files
Adding / at the beginning of url path would make them clickable in vscode

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.

4 participants