Skip to content

chore: add public stock cap use-case #1269

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

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

chore: add public stock cap use-case #1269

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af6372b
add public/private distinction
peelar Aug 2, 2024
3a264ce
style
peelar Aug 2, 2024
bca866a
Update docs/developer/stock-allocation.mdx
peelar Aug 6, 2024
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: 5 additions & 1 deletion docs/developer/stock-allocation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,11 @@ the [`updateWarehouse`](api-reference/products/mutations/update-warehouse.mdx) m
There is an option to change the following warehouse fields: `name`, `slug`, `email`, `address` and
also define privacy and `click and collect` options.

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?


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).


### Click-and-collect warehouses

Expand Down