Skip to content

Commit 649d2fd

Browse files
committed
ACP2E-3032: [Documentation] Please mention that POST "ship" REST API call does not validate total shipped items quantity.
1 parent 4745100 commit 649d2fd

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

app/code/Magento/Sales/Api/Data/ShipmentInterface.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
* Shipment interface.
1010
*
1111
* A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This
12-
* document lists the products and their quantities in the delivery package.
12+
* document lists the products and their quantities in the delivery package. This interface creates shipment
13+
* record without items quantity (total_qty) validation. To validate total shipped quantity for each item
14+
* in the order you must use newer `POST /V1/order/:orderId/ship` endpoint.
1315
* @api
1416
* @since 100.0.2
1517
*/
@@ -31,7 +33,7 @@ interface ShipmentInterface extends \Magento\Framework\Api\ExtensibleDataInterfa
3133
*/
3234
const TOTAL_WEIGHT = 'total_weight';
3335
/*
34-
* Total quantity.
36+
* Total quantity. Can be greater than ordered (not validated).
3537
*/
3638
const TOTAL_QTY = 'total_qty';
3739
/*

0 commit comments

Comments
 (0)