You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
update inventory-cli-reference.md incorrect info (#8023)
* update inventory-cli-reference.md incorrect info
since the cli command inventory:reservation:create-compensations yet not accepting the -c & -i argument , I rectified few points here for incorrect message string and the arguments.
* Format error message as terminal text
* Remove trailing space
* Remove duplicated content and fix syntax errors
* Added examples and missing option
- Added the `bunchsize` option to the inventory:reservation:list-inconsistencies command.
- Added " Detect inconsistencies and create compensations" section with examples to run piped
commands for incomplete and complete orders.
* Apply suggestions from code review
Co-authored-by: Kevin Harper <keharper@users.noreply.github.com>
* Updates based on review feedback
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Kevin Harper <keharper@users.noreply.github.com>
Copy file name to clipboardExpand all lines: src/guides/v2.3/inventory/inventory-cli-reference.md
+26-8Lines changed: 26 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -53,6 +53,7 @@ Command options:
53
53
54
54
-`-c`, `--complete-orders` - Returns inconsistencies for completed orders. Incorrect reservations may still be on hold for completed orders.
55
55
-`-i`, `--incomplete-orders` - Returns inconsistencies for incomplete orders (partially shipped, unshipped). Incorrect reservations may hold too much or not enough salable quantity for the orders.
56
+
-`-b`, `--bunch-size` - Defines how many orders to load at once.
56
57
-`-r`, `--raw` - Raw output.
57
58
58
59
Responses using `-r` return in `<ORDER_INCREMENT_ID>:<SKU>:<QUANTITY>:<STOCK-ID>` format:
@@ -90,14 +91,15 @@ To create reservations, provide compensations using the format `<ORDER_INCREMENT
-`-c`, `--complete-orders` - Creates reservations for completed order inconsistencies.
96
-
-`-i`, `--incomplete-orders` - Creates reservations for incomplete order inconsistencies.
97
96
-`-r`, `--raw` - Returns raw output.
98
-
-`-d`, `--dry-run` - Simulates reservation creation without applying reservations.
99
97
100
-
If the format of the request is incorrect, the following message displays: A list of compensations needs to be defined as argument or STDIN.
98
+
If the format of the request is incorrect, the following message displays:
99
+
100
+
```terminal
101
+
Error while parsing argument "your_incorrect_format_argument". Given argument does not match pattern "/(?P<increment_id>.*):(?P<sku>.*):(?P<quantity>.*):(?P<stock_id>.*)/".
102
+
```
101
103
102
104
As the command creates reservations, it displays messages indicating the updates by SKU, order, and stock.
103
105
@@ -108,30 +110,46 @@ Following reservations were created:
108
110
- Product bike-123 was compensated by +2.000000 for stock 1
109
111
```
110
112
111
-
You can run both commands by piping `list-inconsistencies` and `create-compensations` to detect inconsistencies and immediately create compensations. Use the `-r` command option to generate and submit the raw data to `create-compensations`.
113
+
### Detect inconsistencies and create compensations
114
+
115
+
You can detect inconsistences and immediately create compensations by using a pipe to run both the `list-inconsistencies` and `create-compensations`. Use the `-r` command option to generate and submit the raw data to `create-compensations`.
{{site.data.var.im}} provides the [Distance Priority](https://docs.magento.com/m2/ce/user_guide/catalog/inventory-configure-distance-priority.html) algorithm, which helps determine the best option for shipping a full or partial order. The algorithm uses GPS information or geocodes to calculate the distance between the source (a warehouse or other physical location) of each item in an order and the shipping address. Based on those results, the algorithm recommends which source should be used to ship out each item in the order.
0 commit comments