9
9
* Shipment interface.
10
10
*
11
11
* 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.
13
15
* @api
14
16
* @since 100.0.2
15
17
*/
@@ -21,75 +23,75 @@ interface ShipmentInterface extends \Magento\Framework\Api\ExtensibleDataInterfa
21
23
/*
22
24
* Entity ID.
23
25
*/
24
- const ENTITY_ID = 'entity_id ' ;
26
+ public const ENTITY_ID = 'entity_id ' ;
25
27
/*
26
28
* Store ID.
27
29
*/
28
- const STORE_ID = 'store_id ' ;
30
+ public const STORE_ID = 'store_id ' ;
29
31
/*
30
32
* Total weight.
31
33
*/
32
- const TOTAL_WEIGHT = 'total_weight ' ;
34
+ public const TOTAL_WEIGHT = 'total_weight ' ;
33
35
/*
34
- * Total quantity.
36
+ * Total quantity. Can be greater than ordered quantity (not validated).
35
37
*/
36
- const TOTAL_QTY = 'total_qty ' ;
38
+ public const TOTAL_QTY = 'total_qty ' ;
37
39
/*
38
40
* Email sent flag.
39
41
*/
40
- const EMAIL_SENT = 'email_sent ' ;
42
+ public const EMAIL_SENT = 'email_sent ' ;
41
43
/*
42
44
* Order ID.
43
45
*/
44
- const ORDER_ID = 'order_id ' ;
46
+ public const ORDER_ID = 'order_id ' ;
45
47
/*
46
48
* Customer ID.
47
49
*/
48
- const CUSTOMER_ID = 'customer_id ' ;
50
+ public const CUSTOMER_ID = 'customer_id ' ;
49
51
/*
50
52
* Shipping address ID.
51
53
*/
52
- const SHIPPING_ADDRESS_ID = 'shipping_address_id ' ;
54
+ public const SHIPPING_ADDRESS_ID = 'shipping_address_id ' ;
53
55
/*
54
56
* Billing address ID.
55
57
*/
56
- const BILLING_ADDRESS_ID = 'billing_address_id ' ;
58
+ public const BILLING_ADDRESS_ID = 'billing_address_id ' ;
57
59
/*
58
60
* Shipment status.
59
61
*/
60
- const SHIPMENT_STATUS = 'shipment_status ' ;
62
+ public const SHIPMENT_STATUS = 'shipment_status ' ;
61
63
/*
62
64
* Increment ID.
63
65
*/
64
- const INCREMENT_ID = 'increment_id ' ;
66
+ public const INCREMENT_ID = 'increment_id ' ;
65
67
/*
66
68
* Created-at timestamp.
67
69
*/
68
- const CREATED_AT = 'created_at ' ;
70
+ public const CREATED_AT = 'created_at ' ;
69
71
/*
70
72
* Updated-at timestamp.
71
73
*/
72
- const UPDATED_AT = 'updated_at ' ;
74
+ public const UPDATED_AT = 'updated_at ' ;
73
75
/*
74
76
* Packages.
75
77
*/
76
- const PACKAGES = 'packages ' ;
78
+ public const PACKAGES = 'packages ' ;
77
79
/*
78
80
* Shipping label.
79
81
*/
80
- const SHIPPING_LABEL = 'shipping_label ' ;
82
+ public const SHIPPING_LABEL = 'shipping_label ' ;
81
83
/*
82
84
* Items.
83
85
*/
84
- const ITEMS = 'items ' ;
86
+ public const ITEMS = 'items ' ;
85
87
/*
86
88
* Tracks.
87
89
*/
88
- const TRACKS = 'tracks ' ;
90
+ public const TRACKS = 'tracks ' ;
89
91
/*
90
92
* Comments.
91
93
*/
92
- const COMMENTS = 'comments ' ;
94
+ public const COMMENTS = 'comments ' ;
93
95
94
96
/**
95
97
* Gets the billing address ID for the shipment.
0 commit comments