Magento Extensions Rating 2024
EXTENSIONS BY CATEGORY
B2B (Business-To-Business)
Blog
Customer
ERP (Enterprise Resource Planning)
Mega Menu
One Step Checkout
Order
POS (Point Of Sale)
Search
Shopping Cart
Sitemap
SEO
Social
Stock & Inventory Management
EXTENSIONS BY DEVELOPER
aheadWorks
Amasty
Boost My Shop
BSS Commerce
Magestore
MageWorx
Mirasvit
Templates Master
Wyomind
XTENTO
Magento 2 Documentation
Magento 2 Documentation
2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
vendor
magento
module-sales
Api
Data
ShipmentInterface.php
Go to the documentation of this file.
1
<?php
6
namespace
Magento\Sales\Api\Data
;
7
16
interface
ShipmentInterface
extends
\Magento\Framework\Api\ExtensibleDataInterface
17
{
21
/*
22
* Entity ID.
23
*/
24
const
ENTITY_ID
=
'entity_id'
;
25
/*
26
* Store ID.
27
*/
28
const
STORE_ID
=
'store_id'
;
29
/*
30
* Total weight.
31
*/
32
const
TOTAL_WEIGHT
=
'total_weight'
;
33
/*
34
* Total quantity.
35
*/
36
const
TOTAL_QTY
=
'total_qty'
;
37
/*
38
* Email sent flag.
39
*/
40
const
EMAIL_SENT
=
'email_sent'
;
41
/*
42
* Order ID.
43
*/
44
const
ORDER_ID
=
'order_id'
;
45
/*
46
* Customer ID.
47
*/
48
const
CUSTOMER_ID
=
'customer_id'
;
49
/*
50
* Shipping address ID.
51
*/
52
const
SHIPPING_ADDRESS_ID
=
'shipping_address_id'
;
53
/*
54
* Billing address ID.
55
*/
56
const
BILLING_ADDRESS_ID
=
'billing_address_id'
;
57
/*
58
* Shipment status.
59
*/
60
const
SHIPMENT_STATUS
=
'shipment_status'
;
61
/*
62
* Increment ID.
63
*/
64
const
INCREMENT_ID
=
'increment_id'
;
65
/*
66
* Created-at timestamp.
67
*/
68
const
CREATED_AT
=
'created_at'
;
69
/*
70
* Updated-at timestamp.
71
*/
72
const
UPDATED_AT
=
'updated_at'
;
73
/*
74
* Packages.
75
*/
76
const
PACKAGES
=
'packages'
;
77
/*
78
* Shipping label.
79
*/
80
const
SHIPPING_LABEL
=
'shipping_label'
;
81
/*
82
* Items.
83
*/
84
const
ITEMS
=
'items'
;
85
/*
86
* Tracks.
87
*/
88
const
TRACKS
=
'tracks'
;
89
/*
90
* Comments.
91
*/
92
const
COMMENTS
=
'comments'
;
93
99
public
function
getBillingAddressId
();
100
106
public
function
getCreatedAt
();
107
114
public
function
setCreatedAt
($createdAt);
115
121
public
function
getCustomerId
();
122
128
public
function
getEmailSent
();
129
135
public
function
getEntityId
();
136
143
public
function
setEntityId
($entityId);
144
150
public
function
getIncrementId
();
151
157
public
function
getOrderId
();
158
164
public
function
getPackages
();
165
172
public
function
setPackages
(array $packages =
null
);
173
179
public
function
getShipmentStatus
();
180
186
public
function
getShippingAddressId
();
187
193
public
function
getShippingLabel
();
194
200
public
function
getStoreId
();
201
207
public
function
getTotalQty
();
208
214
public
function
getTotalWeight
();
215
221
public
function
getUpdatedAt
();
222
228
public
function
getItems
();
229
236
public
function
setItems
(
$items
);
237
243
public
function
getTracks
();
244
251
public
function
setTracks
(
$tracks
);
252
258
public
function
getComments
();
259
266
public
function
setComments
(
$comments
=
null
);
267
274
public
function
setStoreId
(
$id
);
275
282
public
function
setTotalWeight
($totalWeight);
283
290
public
function
setTotalQty
($qty);
291
298
public
function
setEmailSent
($emailSent);
299
306
public
function
setOrderId
(
$id
);
307
314
public
function
setCustomerId
(
$id
);
315
322
public
function
setShippingAddressId
(
$id
);
323
330
public
function
setBillingAddressId
(
$id
);
331
338
public
function
setShipmentStatus
($shipmentStatus);
339
346
public
function
setIncrementId
(
$id
);
347
354
public
function
setShippingLabel
($shippingLabel);
355
362
public
function
setUpdatedAt
($timestamp);
363
369
public
function
getExtensionAttributes
();
370
377
public
function
setExtensionAttributes
(\
Magento
\Sales\Api\Data\ShipmentExtensionInterface
$extensionAttributes
);
378
}
Magento\Sales\Api\Data\ShipmentInterface\EMAIL_SENT
const EMAIL_SENT
Definition:
ShipmentInterface.php:40
Magento\Sales\Api\Data\ShipmentInterface\getItems
getItems()
Magento\Sales\Api\Data\ShipmentInterface\getCustomerId
getCustomerId()
Magento\Sales\Api\Data\ShipmentInterface\SHIPPING_LABEL
const SHIPPING_LABEL
Definition:
ShipmentInterface.php:80
Magento\Sales\Api\Data\ShipmentInterface\ENTITY_ID
const ENTITY_ID
Definition:
ShipmentInterface.php:24
$id
$id
Definition:
fieldset.phtml:14
Magento\Sales\Api\Data\ShipmentInterface\setTotalQty
setTotalQty($qty)
Magento\Sales\Api\Data\ShipmentInterface\setTracks
setTracks($tracks)
Magento\Sales\Api\Data\ShipmentInterface\getTracks
getTracks()
Magento\Sales\Api\Data\ShipmentInterface\UPDATED_AT
const UPDATED_AT
Definition:
ShipmentInterface.php:72
Magento\Sales\Api\Data\ShipmentInterface\setShippingAddressId
setShippingAddressId($id)
Magento\Sales\Api\Data\ShipmentInterface\setPackages
setPackages(array $packages=null)
Magento\Sales\Api\Data\ShipmentInterface\setBillingAddressId
setBillingAddressId($id)
Magento\Sales\Api\Data\ShipmentInterface\CREATED_AT
const CREATED_AT
Definition:
ShipmentInterface.php:68
Magento\Sales\Api\Data\ShipmentInterface\TRACKS
const TRACKS
Definition:
ShipmentInterface.php:88
Magento\Sales\Api\Data\ShipmentInterface\CUSTOMER_ID
const CUSTOMER_ID
Definition:
ShipmentInterface.php:48
Magento\Sales\Api\Data\ShipmentInterface\setItems
setItems($items)
Magento\Sales\Api\Data\ShipmentInterface\TOTAL_QTY
const TOTAL_QTY
Definition:
ShipmentInterface.php:36
Magento\Sales\Api\Data\ShipmentInterface\setTotalWeight
setTotalWeight($totalWeight)
Magento\Sales\Api\Data\ShipmentInterface\getEntityId
getEntityId()
Magento\Sales\Api\Data\ShipmentInterface\SHIPPING_ADDRESS_ID
const SHIPPING_ADDRESS_ID
Definition:
ShipmentInterface.php:52
Magento\Sales\Api\Data\ShipmentInterface\setOrderId
setOrderId($id)
Magento\Sales\Api\Data\ShipmentInterface\getTotalQty
getTotalQty()
Magento\Sales\Api\Data\ShipmentInterface\setShippingLabel
setShippingLabel($shippingLabel)
Magento\Sales\Api\Data\ShipmentInterface\getEmailSent
getEmailSent()
Magento\Sales\Api\Data\ShipmentInterface\getShippingLabel
getShippingLabel()
Magento\Sales\Api\Data\ShipmentInterface\ORDER_ID
const ORDER_ID
Definition:
ShipmentInterface.php:44
Magento\Sales\Api\Data\ShipmentInterface\getPackages
getPackages()
Magento\Sales\Api\Data\ShipmentInterface\getTotalWeight
getTotalWeight()
Magento\Sales\Api\Data\ShipmentInterface\getUpdatedAt
getUpdatedAt()
Magento\Sales\Api\Data\ShipmentInterface\setUpdatedAt
setUpdatedAt($timestamp)
Magento\Sales\Api\Data\ShipmentInterface\BILLING_ADDRESS_ID
const BILLING_ADDRESS_ID
Definition:
ShipmentInterface.php:56
Magento\Sales\Api\Data\ShipmentInterface\getComments
getComments()
Magento\Sales\Api\Data\ShipmentInterface\setCustomerId
setCustomerId($id)
Magento\Sales\Api\Data\ShipmentInterface\SHIPMENT_STATUS
const SHIPMENT_STATUS
Definition:
ShipmentInterface.php:60
$extensionAttributes
$extensionAttributes
Definition:
payment.php:22
Magento\Sales\Api\Data\ShipmentInterface\setEntityId
setEntityId($entityId)
Magento
Magento\Sales\Api\Data
Definition:
CommentInterface.php:6
Magento\Sales\Api\Data\ShipmentInterface\getShipmentStatus
getShipmentStatus()
Magento\Sales\Api\Data\ShipmentInterface\setIncrementId
setIncrementId($id)
Magento\Sales\Api\Data\ShipmentInterface\setComments
setComments($comments=null)
Magento\Sales\Api\Data\ShipmentInterface\getExtensionAttributes
getExtensionAttributes()
Magento\Sales\Api\Data\ShipmentInterface\getStoreId
getStoreId()
$tracks
$tracks
Definition:
shipment_tracks_for_search.php:32
Magento\Framework\Api\ExtensibleDataInterface
Definition:
ExtensibleDataInterface.php:15
Magento\Sales\Api\Data\ShipmentInterface\getShippingAddressId
getShippingAddressId()
Magento\Sales\Api\Data\ShipmentInterface\getOrderId
getOrderId()
Magento\Sales\Api\Data\ShipmentInterface\INCREMENT_ID
const INCREMENT_ID
Definition:
ShipmentInterface.php:64
Magento\Sales\Api\Data\ShipmentInterface\ITEMS
const ITEMS
Definition:
ShipmentInterface.php:84
Magento\Sales\Api\Data\ShipmentInterface\setExtensionAttributes
setExtensionAttributes(\Magento\Sales\Api\Data\ShipmentExtensionInterface $extensionAttributes)
Magento\Sales\Api\Data\ShipmentInterface\STORE_ID
const STORE_ID
Definition:
ShipmentInterface.php:28
$comments
$comments
Definition:
creditmemo_comments_for_search.php:30
Magento\Sales\Api\Data\ShipmentInterface\TOTAL_WEIGHT
const TOTAL_WEIGHT
Definition:
ShipmentInterface.php:32
Magento\Sales\Api\Data\ShipmentInterface\COMMENTS
const COMMENTS
Definition:
ShipmentInterface.php:92
Magento\Sales\Api\Data\ShipmentInterface\getIncrementId
getIncrementId()
Magento\Sales\Api\Data\ShipmentInterface\setCreatedAt
setCreatedAt($createdAt)
Magento\Sales\Api\Data\ShipmentInterface\setEmailSent
setEmailSent($emailSent)
Magento\Sales\Api\Data\ShipmentInterface
Definition:
ShipmentInterface.php:16
Magento\Sales\Api\Data\ShipmentInterface\getCreatedAt
getCreatedAt()
Magento\Sales\Api\Data\ShipmentInterface\setShipmentStatus
setShipmentStatus($shipmentStatus)
Magento\Sales\Api\Data\ShipmentInterface\setStoreId
setStoreId($id)
Magento\Sales\Api\Data\ShipmentInterface\getBillingAddressId
getBillingAddressId()
Magento\Sales\Api\Data\ShipmentInterface\PACKAGES
const PACKAGES
Definition:
ShipmentInterface.php:76
$items
$items
Definition:
order_rollback.php:21