...
Expand | ||
---|---|---|
| ||
|
...
Types of unavailability: There are different types of unavailability declared in store, depending on the reason given by the vendor. You must indicate the types you wish to deduct from the available stock. We advise you to select the
not_in_stock
type.Stock locations reservations: You need to Indicate the sales channels on which store reservations are to be taken into account.
Global buffers: You need to indicate the global buffers to be deducted. If several buffers are selected, the one with the highest value will be applied. The value to be input is the buffer group.
Stock locations buffers: You need to indicate the stock locations buffers to be deducted. If several buffers are selected, the one with the highest value will be applied. The value to be input is the buffer group.
...
Settings
Once the sum of the stock aggregates has been achieved, we can adjust 4 different parameters to obtain an appropriate stock response.
...
In particular cases, you can choose to take into account global reservations only on a list of sales channels, but in general you should leave the "All sales channels" parameter checked.
...
...
The unification adds up all stock lines and returns a single global value. This setting is very important as it will completely change the format of the stock response.
...
Info |
---|
Note : if this parameter is activated, all children will inherit it and it will be impossible to delete it. In general, this parameter should be enabled on unified queries but not on detailed queries. Inheritance must therefore always be in the sense of detailed > unified |
Unification
The unification adds up all stock lines and returns a single global value. This setting is very important as it will completely change the format of the stock response.
The most common form of unification is by stock locations, but you can also unify by stock type if you have more than one configured on your project.
...
Info |
---|
Example : StoreA, StoreB and StoreC each have 5 quantities of stock for a given item. The detailed query will return 3 results, each with 5 available quantities. Whereas the unified query will return a single result of 15 available quantities. |
...
Inheritance must always be in the sense of detailed > unified |
If the query is unified by stock locations, then the "unified" badge will be visible in the main page tree. Otherwise, the badge will be "detailed".
...
Diff/Full: If the "Full" parameter is checked, all stocks returned by the query will be sent. If "Diff" is checked, exported stocks are those that have changed since the last export on the same scope. As the full export is very large, it is usually set to be sent once in the morning. Then, several diff exports are sent at regular intervals during the day.
Scope key: This key, mandatory to perform diff exports, is a freely definable id which identifies a stock perimeter on which the export will be done. This can be a sales channel, a country, etc... When a diff stock is exported, only movements that have taken place since the last export on the same key are counted. Once exported, the counters are reset to 0 for this key, but not for the others.
Note |
---|
To configure a scope key in a diff query, you first need to create it in the full one. |
Info |
---|
Example : The stock of my item changes at 10:05 am on a warehouse that can deliver from both UK and FR sales channels. A diff export to the UK website is carried out at 10:15, and another to the FR website at 10:30. If both exports have the same key, only the 10:15 export will return the movement, as the 10:30 export will not detect any movement since 10:15. On the other hand, if the two exports have a different key, they will both return the movement. |
...
detailed
- this basic query is supposed to return all available stocks from all stock locations on all items. A single aggregateall
can be created, which can refer toendpoints
anditems
queries, and with all deductions set. Only the setting of global reservations can be added.unified
- the query inherits fromdetailed
. Only the setting of unification (by stock type and by stock location) has to be enabled.
Info |
---|
Note : inheritance must always be in the sense of detailed > unified |
Note |
---|
The |
...
Ship From Store:
orchestration_detailed_sfs
- This query can be created at the root to target the stocks available for SFS orchestration. It can be used in rulesets that do not make differences between countries or sales channels. It should contain two aggregates "stores" and "warehouses" which are the two order fulfillment paths.
- The “stores” aggregate should contains contain theitems_sfs
items query, which lists items eligible for order-taking, and thestores_sfs
stock locations query, which lists stores with the Ship From Store module enabled. The parameter “Force usage of stock location filter requested” must be disabled for the stock locations query.
- The “warehouses” aggregate should also use theitems_sfs
items query, and thewarehouses_sfs
stock locations query, which lists warehouses with the Ship From Store module enabled. The parameter “Force usage of stock location filter requested” must be disabled for the stock locations query.All aggregate deductions can be activated (buffers, reservations and unavailabilities) as well as the global reservations parameter.Then, the unified query Aggregates deductions: stock locations reservations and unavailability should be enabled, buffers should be disabled.
orchestration_unified_sfs
- The unified query can be created by inheriting from the detailed one.Settings : global reservations should be enabled, and the unification parameter should be changed (unification by sock locations and stock types enabled).
orchestration_detailed_sfs_{country}
- This query can be created by inheriting from the detailed previous one to target a particular country or sales channel. If we consider that the warehouse can deliver to any country, then the "warehouses" aggregate can remain unchanged. However, we need to modify the "stores" aggregate so that it uses thestores_sfs_{country}
stock locations query to target only stores in the chosen country.- Then, the unified query
Only the “Unification”orchestration_unified_sfs_{country}
- The unified query can be created by inheriting from the detailed one.Settings : global reservations should be enabled, and the unification parameter should be changed (unification by sock locations and stock types enabled).
...
Click and Collect express:
orchestration_detailed_ckc_exp
- This query can be created at the root to target only the pick-up store. As there will be no shipping, it should contain only one aggregate “destination_store” regardless of the country or the sales channel.
- The “destination_store” aggregate should use theitems_ckc
items query, and thestores_cfs
stock locations query which lists stores enabled in Collect From Store (in-store pick-up). Since we want to target ONLY the destination store, we'll need to enable the parameter “Force usage of stock location filter requested” for the stock locations query.Then, the unified query Aggregates deductions: stock locations reservations and unavailability should be enabled, buffers should be disabled.
Only the “Unification”orchestration_unified_ckc_exp
- The unified can be created by inheriting from the detailed one.Settings : global reservations should be enabled, and the unification parameter should be changed (unification by sock locations and stock types enabled).
➡️ The result is a single pair of stock queries for Click & Collect express, regardless of country or sales channel.(image)
...
Click and Collect standard:
orchestration_detailed_ckc_std
- This query can be created at the root to target the stocks available for standard Click & Collect orders, whether the stock is directly available in the pick up store or sent from another stock location. It can be used in rulesets that do not make differences between countries or sales channels. It should contain 3 aggregates "stores", "warehouses" and “destination_store” which are the three order fulfillment paths.
- The “stores” aggregate should contains contain theitems_ckc
items query, which lists items eligible for Click & Collect, and thestores_sfs
stock locations query, which lists stores with the Ship From Store module enabled who will be able to ship the order to the pick-up store. The parameter “Force usage of stock location filter requested” must be disabled for the stock locations query.
- The “warehouses” aggregate should also use theitems_ckc
items query, and thewarehouses_sfs
stock locations query, which lists warehouses with the Ship From Store module enabled who will be able to ship the order to the pick-up store. The parameter “Force usage of stock location filter requested” must be disabled for the stock locations query.
- The “destination_store” aggregate should also use theitems_ckc
items query, and thestores_cfs_not_sfs
stock locations query which lists stores enabled in Collect From Store (in-store pick-up) but not enabled in Ship From Store otherwise they will be double-counted with the "stores" aggregate. Since we want to target ONLY the destination store, we'll need to enable the parameter “Force usage of stock location filter requested” for the stock locations query.All aggregate deductions can be activated (buffers, reservations and unavailabilities) as well as the global reservations parameter.Then, the unified query
orchestration_unified_ckc_std
Aggregates deductions: stock locations reservations and unavailability should be enabled, buffers should be disabled.
Only the “Unification”orchestration_unified_ckc_std
- The unified query can be created by inheriting from the detailed one.Settings : global reservations should be enabled, and the unification parameter should be changed (unification by sock locations and stock types enabled).
orchestration_detailed_ckc_std_{country}
- This query can be created by inheriting from the detailed previous one to target a particular country or sales channel. If we consider that the warehouse can deliver to any country, then the "warehouses" and “destination_store” aggregates can remain unchanged. However, we need to modify the "stores" aggregate so that it uses thestores_sfs_{country}
stock locations query to target only stores in the chosen country.- Then, the unified query
Only the “Unification”orchestration_unified_ckc_std_{country}
- The unified query can be created by inheriting from the detailed one.Settings : global reservations should be enabled, and the unification parameter should be changed (unification by sock locations and stock types enabled).
...
For each sales channel, you will need to set up unified/detailed and full/diff queries.
...
In general, the “full unified” query is called once a day in the morning to initialize product availability on the website. Then, the “diff unified” are called up regularly throughout the day to adjust stock levels according to sales. Full and diff detailed queries should generally not be called up without using a filter, as the data is too voluminous.
Finally, the unified queryexport_detailed_{saleschannel}_full
- This query can be created at the root to target the details of all stocks available for delivery. As the Ship From Store orchestration query, it should contain two aggregates "stores" and "warehouses" which are the two scopes of stock availability.
- The “stores” aggregate should contain theitems_sfs
items query, which lists items eligible for order-taking, and thewarehousesstores_sfs_{countrysaleschannel}_export
stock locations query, which lists warehouses stores eligible for export with the Ship From Store module enabled. The parameter “Force usage of stock location filter requested” can be enabled for the stock locations query, this will allow you to filter on specific stock locations if necessary.
All aggregate deductions can be activated (buffers, reservations and unavailabilities) as well as the global reservations parameter.
Then, the export parameter should be enabled with the “Full” option. A scope key must be specified to identify the perimeter of the export and must be identical to the diff export. It could be, for example “detailed_fr”.export_unified_{country}_full
- The “warehouses” aggregate should also use the
items_sfs
items query, and thewarehouses_sfs_{saleschannel}_export
stock locations query, which lists warehouses eligible for export with the Ship From Store module enabled. The parameter “Force usage of stock location filter requested” can be enabled for the stock locations query, this will allow you to filter on specific stock locations if necessary.Aggregates deductions: all deductions should be enabled (stock locations reservations, unavailability, and global and stock locations buffers).
Settings: global reservations should be enabled. Then, the export parameter should be enabled with the “Full” option. A scope key must be specified to identify the perimeter of the export and must be identical to the diff export. It could be, for example “detailed_fr”.
Theexport_unified_{saleschannel}_full
The unified query can be created by inheriting from the detailed one.Aggregates must remain unchanged.
Settings: the unification parameter should be changed (unification by sock locations and stock types enabled), and also the scope key of the export parameter should be changed. . It could be, for example “unified_fr”.
export_detailed_{countrysaleschannel}_diff
- This The Diff query can be created by inheriting from the “Full” detailed full one. Aggregates must remain unchanged.However,Settings: the export parameter must be changed to "Diff". Make sure the scope key remains the same as the full query, in my example “detailed_fr”. Then, the "Export stock difference instead of raw value" parameter can be activated or deactivated as needed for your project.
export_
detailedunified_{
countrysaleschannel}_diff
export_unified_{country}_diff
For the OIS catalog
For e-reservation
For delivery promise
Full stock queries tree
This is what our stock queries tree should look like.
...
detailed
unified
...
orchestration_detailed_sfs
orchestration_unified_sfs
orchestration_detailed_sfs_fr
orchestration_unified_sfs_fr
orchestration_detailed_sfs_uk
orchestration_unified_sfs_uk
...
orchestration_detailed_ckc_exp
orchestration_unified_ckc_exp
orchestration_detailed_ckc_exp_fr
orchestration_unified_ckc_exp_fr
orchestration_detailed_ckc_exp_uk
orchestration_unified_ckc_exp_uk
...
orchestration_detailed_ckc_std
orchestration_unified_ckc_std
orchestration_detailed_ckc_std_fr
orchestration_unified_ckc_std_fr
orchestration_detailed_ckc_std_uk
orchestration_unified_ckc_std_uk
...
export_detailed_fr_full
export_unified_fr_full
export_detailed_fr_diff
export_unified_fr_diff
export_detailed_uk_full
export_unified_uk_full
export_detailed_uk_diff
export_unified_uk_diff
...
ois_detailed_fr
ois_unified_fr
ois_detailed_uk
ois_unified_uk
...
eresa_detailed_fr
eresa_unified_fr
eresa_detailed_uk
eresa_unified_uk
...
dp_detailed_fr_method1
dp_unified_fr_method1
dp_detailed_fr_method2
dp_unified_fr_method2
dp_detailed_uk_method1
dp_unified_uk_method1
dp_detailed_uk_method2
dp_unified_uk_method2
...
in_stock
...
The unified Diff query can be created by inheriting from the Diff detailed one.
Settings: the unification parameter should be changed (unification by sock locations and stock types enabled), and also the scope key of the export parameter. It could be, for example “unified_fr”.
➡️ Here's what the export queries might look like, differentiating between the two sales channels/websites "FR" and "UK".
...
For add-on modules
Stocks queries are also used on add-on modules such as the OIS catalog, the e-reservation funnel or the delivery promise and so need to be set up.
Order in Store catalog: These queries provide the availability of products in the Store App catalog. The “immediate pickup” availability is based on the detailed query, and the “ordering” availability is based on the unified query
ois_detailed
- This query is only used to provide the immediate pickup availability, and so can be created at the root to target the current OIS store. It should only contain one aggregate "pickup_store"
- The “pickup_store” aggregate should use theitems_ois
items query, and thestores_ois
stock locations query which lists stores havingois
module enabled. Since we want to target ONLY the current store, we'll need to enable the parameter “Force usage of stock location filter requested” for the stock locations query because the store app will add the filter to the query.Aggregates deductions: all deductions should be enabled (stock locations reservations, unavailability, global and stock locations buffers).
ois_unified_{saleschannel}
- Then, the unified query is used to provide the “ordering” availability on a given sales channel. This query should looks like theexport_unified_{saleschannel}_full
one, because we will set up the same aggregates (“stores” and “warehouses” enabled for export). The parameter “Force usage of items filter requested” must be enabled for both aggregates.Aggregates deductions: all deductions should be enabled (stock locations reservations, unavailability, global and stock locations buffers).
Settings : global reservations should be enabled. The export parameter must not be enabled (if a scope key is set, this may affect diff exports). The unification parameter must be enabled (unification by stock types and stock locations).
➡️ Here's what the OIS queries might look like, with a single detailed query at the root, and two unified queries for the two sales channels/websites FR and UK. The UK inherits from the FR, and only the “stores” aggregate is changed.
...
Note |
---|
Once the stock requests have been created, they need to be set up in the Store App configuration in “order_in_store_options”. Please get in touch with your Onestock contact. |
E-reservation: These queries provide the availability of products in the Onestock’s e-reservation funnel in the website. The unified query is used to display or not the product as available for e-reservation, and the detailed one displays the list of available stores.
eresa_detailed_{saleschannel}
- This query is used to target all available stores, so it should only contain one aggregate "stores".
- The “stores” aggregate should contain theitems_eresa
items query, which lists items eligible for Reserve & Collect, and thestores_eresa
stock locations query, which lists stores with the e-reservation module enabled.Aggregates deductions: all deductions should be enabled (stock locations reservations, unavailability, global and stock locations buffers).
eresa_unified_{saleschannel}
- The unified query can be created by inheriting from the detailed one.Settings : only the unification parameter should be changed (unification by sock locations and stock types enabled).
➡️ Here's what the e-reservation queries might look like, with two sales channels/websites FR and UK.
...
Note |
---|
Once the stock requests have been created, they need to be set up in the e-reservation funnel configuration. Please get in touch with your Onestock contact. |
Delivery promise: These queries provide stock availability for different delivery methods.
...