Inheritance diagram for ShipmentInterface:

Public Member Functions
	getBillingAddressId ()

	getCreatedAt ()

	setCreatedAt ($createdAt)

	getCustomerId ()

	getEmailSent ()

	getEntityId ()

	setEntityId ($entityId)

	getIncrementId ()

	getOrderId ()

	getPackages ()

	setPackages (array $packages=null)

	getShipmentStatus ()

	getShippingAddressId ()

	getShippingLabel ()

	getStoreId ()

	getTotalQty ()

	getTotalWeight ()

	getUpdatedAt ()

	getItems ()

	setItems ($items)

	getTracks ()

	setTracks ($tracks)

	getComments ()

	setComments ($comments=null)

	setStoreId ($id)

	setTotalWeight ($totalWeight)

	setTotalQty ($qty)

	setEmailSent ($emailSent)

	setOrderId ($id)

	setCustomerId ($id)

	setShippingAddressId ($id)

	setBillingAddressId ($id)

	setShipmentStatus ($shipmentStatus)

	setIncrementId ($id)

	setShippingLabel ($shippingLabel)

	setUpdatedAt ($timestamp)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Sales\Api\Data\ShipmentExtensionInterface $extensionAttributes)

Data Fields
const	ENTITY_ID = 'entity_id'

const	STORE_ID = 'store_id'

const	TOTAL_WEIGHT = 'total_weight'

const	TOTAL_QTY = 'total_qty'

const	EMAIL_SENT = 'email_sent'

const	ORDER_ID = 'order_id'

const	CUSTOMER_ID = 'customer_id'

const	SHIPPING_ADDRESS_ID = 'shipping_address_id'

const	BILLING_ADDRESS_ID = 'billing_address_id'

const	SHIPMENT_STATUS = 'shipment_status'

const	INCREMENT_ID = 'increment_id'

const	CREATED_AT = 'created_at'

const	UPDATED_AT = 'updated_at'

const	PACKAGES = 'packages'

const	SHIPPING_LABEL = 'shipping_label'

const	ITEMS = 'items'

const	TRACKS = 'tracks'

const	COMMENTS = 'comments'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Detailed Description

Shipment interface.

A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. @api

Since: 100.0.2

Definition at line 16 of file ShipmentInterface.php.

Member Function Documentation

◆ getBillingAddressId()

getBillingAddressId ( )

Gets the billing address ID for the shipment.

Returns: int|null Billing address ID.

Implemented in Shipment.

◆ getComments()

getComments ( )

Gets the comments for the shipment.

Returns: \Magento\Sales\Api\Data\ShipmentCommentInterface[] Array of comments.

Implemented in Shipment.

◆ getCreatedAt()

getCreatedAt ( )

Gets the created-at timestamp for the shipment.

Returns: string|null Created-at timestamp.

Implemented in Shipment.

◆ getCustomerId()

getCustomerId ( )

Gets the customer ID for the shipment.

Returns: int|null Customer ID.

Implemented in Shipment.

◆ getEmailSent()

getEmailSent ( )

Gets the email-sent flag value for the shipment.

Returns: int|null Email-sent flag value.

Implemented in Shipment.

◆ getEntityId()

getEntityId ( )

Gets the ID for the shipment.

Returns: int|null Shipment ID.

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Sales\Api\Data\ShipmentExtensionInterface|null

Implemented in Shipment.

◆ getIncrementId()

getIncrementId ( )

Gets the increment ID for the shipment.

Returns: string|null Increment ID.

Implemented in Shipment.

◆ getItems()

getItems ( )

Gets the items for the shipment.

Returns: \Magento\Sales\Api\Data\ShipmentItemInterface[] Array of items.

Implemented in Shipment.

◆ getOrderId()

getOrderId ( )

Gets the order ID for the shipment.

Returns: int Order ID.

Implemented in Shipment.

◆ getPackages()

getPackages ( )

Gets any packages for the shipment.

Returns: \Magento\Sales\Api\Data\ShipmentPackageInterface[]|null Array of packages, if any. Otherwise, null.

Implemented in Shipment.

◆ getShipmentStatus()

getShipmentStatus ( )

Gets the shipment status.

Returns: int|null Shipment status.

Implemented in Shipment.

◆ getShippingAddressId()

getShippingAddressId ( )

Gets the shipping address ID for the shipment.

Returns: int|null Shipping address ID.

Implemented in Shipment.

◆ getShippingLabel()

getShippingLabel ( )

Gets the shipping label for the shipment.

Returns: string|null Shipping label.

Implemented in Shipment.

◆ getStoreId()

getStoreId ( )

Gets the store ID for the shipment.

Returns: int|null Store ID.

Implemented in Shipment.

◆ getTotalQty()

getTotalQty ( )

Gets the total quantity for the shipment.

Returns: float|null Total quantity.

Implemented in Shipment.

◆ getTotalWeight()

getTotalWeight ( )

Gets the total weight for the shipment.

Returns: float|null Total weight.

Implemented in Shipment.

◆ getTracks()

getTracks ( )

Gets the tracks for the shipment.

Returns: \Magento\Sales\Api\Data\ShipmentTrackInterface[] Array of tracks.

Implemented in Shipment.

◆ getUpdatedAt()

getUpdatedAt ( )

Gets the updated-at timestamp for the shipment.

Returns: string|null Updated-at timestamp.

Implemented in Shipment.

◆ setBillingAddressId()

setBillingAddressId ( $id )

Sets the billing address ID for the shipment.

Parameters

int $id

Returns: $this

Implemented in Shipment.

◆ setComments()

setComments ( $comments = null )

Sets the comments for the shipment.

Parameters

Implemented in Shipment.

◆ setCreatedAt()

setCreatedAt ( $createdAt )

Sets the created-at timestamp for the shipment.

Parameters

string $createdAt timestamp

Returns: $this

Implemented in Shipment.

◆ setCustomerId()

setCustomerId ( $id )

Sets the customer ID for the shipment.

Parameters

int $id

Returns: $this

Implemented in Shipment.

◆ setEmailSent()

setEmailSent ( $emailSent )

Sets the email-sent flag value for the shipment.

Parameters

int $emailSent

Returns: $this

Implemented in Shipment.

◆ setEntityId()

setEntityId ( $entityId )

Sets entity ID.

Parameters

int $entityId

Returns: $this

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Sales\Api\Data\ShipmentExtensionInterface $extensionAttributes )

Set an extension attributes object.

Parameters

\Magento\Sales\Api\Data\ShipmentExtensionInterface $extensionAttributes

Returns: $this

◆ setIncrementId()

setIncrementId ( $id )

Sets the increment ID for the shipment.

Parameters

string $id

Returns: $this

Implemented in Shipment.

◆ setItems()

setItems ( $items )

Sets the items for the shipment.

Parameters

Implemented in Shipment.

◆ setOrderId()

setOrderId ( $id )

Sets the order ID for the shipment.

Parameters

int $id

Returns: $this

Implemented in Shipment.

◆ setPackages()

setPackages ( array $packages = null )

Sets any packages for the shipment.

Parameters

Implemented in Shipment.

◆ setShipmentStatus()

setShipmentStatus ( $shipmentStatus )

Sets the shipment status.

Parameters

int $shipmentStatus

Returns: $this

Implemented in Shipment.

◆ setShippingAddressId()

setShippingAddressId ( $id )

Sets the shipping address ID for the shipment.

Parameters

int $id

Returns: $this

Implemented in Shipment.

◆ setShippingLabel()

setShippingLabel ( $shippingLabel )

Sets the shipping label for the shipment.

Parameters

string $shippingLabel

Returns: $this

Implemented in Shipment.

◆ setStoreId()

setStoreId ( $id )

Sets the store ID for the shipment.

Parameters

int $id

Returns: $this

Implemented in Shipment.

◆ setTotalQty()

setTotalQty ( $qty )

Sets the total quantity for the shipment.

Parameters

float $qty

Returns: $this

Implemented in Shipment.

◆ setTotalWeight()

setTotalWeight ( $totalWeight )

Sets the total weight for the shipment.

Parameters

float $totalWeight

Returns: $this

Implemented in Shipment.

◆ setTracks()

setTracks ( $tracks )

Sets the tracks for the shipment.

Parameters

Implemented in Shipment.

◆ setUpdatedAt()

setUpdatedAt ( $timestamp )

Sets the updated-at timestamp for the shipment.

Parameters

string $timestamp

Returns: $this

Implemented in Shipment.

Field Documentation

◆ BILLING_ADDRESS_ID

const BILLING_ADDRESS_ID = 'billing_address_id'

Definition at line 56 of file ShipmentInterface.php.

◆ COMMENTS

const COMMENTS = 'comments'

Definition at line 92 of file ShipmentInterface.php.

◆ CREATED_AT

const CREATED_AT = 'created_at'

Definition at line 68 of file ShipmentInterface.php.

◆ CUSTOMER_ID

const CUSTOMER_ID = 'customer_id'

Definition at line 48 of file ShipmentInterface.php.

◆ EMAIL_SENT

const EMAIL_SENT = 'email_sent'

Definition at line 40 of file ShipmentInterface.php.

◆ ENTITY_ID

const ENTITY_ID = 'entity_id'

#+ Constants for keys of data array. Identical to the name of the getter in snake case

Definition at line 24 of file ShipmentInterface.php.

◆ INCREMENT_ID

const INCREMENT_ID = 'increment_id'

Definition at line 64 of file ShipmentInterface.php.

◆ ITEMS

const ITEMS = 'items'

Definition at line 84 of file ShipmentInterface.php.

◆ ORDER_ID

const ORDER_ID = 'order_id'

Definition at line 44 of file ShipmentInterface.php.

◆ PACKAGES

const PACKAGES = 'packages'

Definition at line 76 of file ShipmentInterface.php.

◆ SHIPMENT_STATUS

const SHIPMENT_STATUS = 'shipment_status'

Definition at line 60 of file ShipmentInterface.php.

◆ SHIPPING_ADDRESS_ID

const SHIPPING_ADDRESS_ID = 'shipping_address_id'

Definition at line 52 of file ShipmentInterface.php.

◆ SHIPPING_LABEL

const SHIPPING_LABEL = 'shipping_label'

Definition at line 80 of file ShipmentInterface.php.

◆ STORE_ID

const STORE_ID = 'store_id'

Definition at line 28 of file ShipmentInterface.php.

◆ TOTAL_QTY

const TOTAL_QTY = 'total_qty'

Definition at line 36 of file ShipmentInterface.php.

◆ TOTAL_WEIGHT

const TOTAL_WEIGHT = 'total_weight'

Definition at line 32 of file ShipmentInterface.php.

◆ TRACKS

const TRACKS = 'tracks'

Definition at line 88 of file ShipmentInterface.php.

◆ UPDATED_AT

const UPDATED_AT = 'updated_at'

Definition at line 72 of file ShipmentInterface.php.

The documentation for this interface was generated from the following file:

vendor/magento/module-sales/Api/Data/ShipmentInterface.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ getBillingAddressId()

◆ getComments()

◆ getCreatedAt()

◆ getCustomerId()

◆ getEmailSent()

◆ getEntityId()

◆ getExtensionAttributes()

◆ getIncrementId()

◆ getItems()

◆ getOrderId()

◆ getPackages()

◆ getShipmentStatus()

◆ getShippingAddressId()

◆ getShippingLabel()

◆ getStoreId()

◆ getTotalQty()

◆ getTotalWeight()

◆ getTracks()

◆ getUpdatedAt()

◆ setBillingAddressId()

◆ setComments()

◆ setCreatedAt()

◆ setCustomerId()

◆ setEmailSent()

◆ setEntityId()

◆ setExtensionAttributes()

◆ setIncrementId()

◆ setItems()

◆ setOrderId()

◆ setPackages()

◆ setShipmentStatus()

◆ setShippingAddressId()

◆ setShippingLabel()

◆ setStoreId()

◆ setTotalQty()

◆ setTotalWeight()

◆ setTracks()

◆ setUpdatedAt()

Field Documentation

◆ BILLING_ADDRESS_ID

◆ COMMENTS

◆ CREATED_AT

◆ CUSTOMER_ID

◆ EMAIL_SENT

◆ ENTITY_ID

◆ INCREMENT_ID

◆ ITEMS

◆ ORDER_ID

◆ PACKAGES

◆ SHIPMENT_STATUS

◆ SHIPPING_ADDRESS_ID

◆ SHIPPING_LABEL

◆ STORE_ID

◆ TOTAL_QTY

◆ TOTAL_WEIGHT

◆ TRACKS

◆ UPDATED_AT