Your IP : 216.73.216.43
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Api\Data;
/**
* 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
*/
interface ShipmentInterface extends \Magento\Framework\Api\ExtensibleDataInterface
{
/**#@+
* Constants for keys of data array. Identical to the name of the getter in snake case
*/
/*
* Entity ID.
*/
const ENTITY_ID = 'entity_id';
/*
* Store ID.
*/
const STORE_ID = 'store_id';
/*
* Total weight.
*/
const TOTAL_WEIGHT = 'total_weight';
/*
* Total quantity.
*/
const TOTAL_QTY = 'total_qty';
/*
* Email sent flag.
*/
const EMAIL_SENT = 'email_sent';
/*
* Order ID.
*/
const ORDER_ID = 'order_id';
/*
* Customer ID.
*/
const CUSTOMER_ID = 'customer_id';
/*
* Shipping address ID.
*/
const SHIPPING_ADDRESS_ID = 'shipping_address_id';
/*
* Billing address ID.
*/
const BILLING_ADDRESS_ID = 'billing_address_id';
/*
* Shipment status.
*/
const SHIPMENT_STATUS = 'shipment_status';
/*
* Increment ID.
*/
const INCREMENT_ID = 'increment_id';
/*
* Created-at timestamp.
*/
const CREATED_AT = 'created_at';
/*
* Updated-at timestamp.
*/
const UPDATED_AT = 'updated_at';
/*
* Packages.
*/
const PACKAGES = 'packages';
/*
* Shipping label.
*/
const SHIPPING_LABEL = 'shipping_label';
/*
* Items.
*/
const ITEMS = 'items';
/*
* Tracks.
*/
const TRACKS = 'tracks';
/*
* Comments.
*/
const COMMENTS = 'comments';
/**
* Gets the billing address ID for the shipment.
*
* @return int|null Billing address ID.
*/
public function getBillingAddressId();
/**
* Gets the created-at timestamp for the shipment.
*
* @return string|null Created-at timestamp.
*/
public function getCreatedAt();
/**
* Sets the created-at timestamp for the shipment.
*
* @param string $createdAt timestamp
* @return $this
*/
public function setCreatedAt($createdAt);
/**
* Gets the customer ID for the shipment.
*
* @return int|null Customer ID.
*/
public function getCustomerId();
/**
* Gets the email-sent flag value for the shipment.
*
* @return int|null Email-sent flag value.
*/
public function getEmailSent();
/**
* Gets the ID for the shipment.
*
* @return int|null Shipment ID.
*/
public function getEntityId();
/**
* Sets entity ID.
*
* @param int $entityId
* @return $this
*/
public function setEntityId($entityId);
/**
* Gets the increment ID for the shipment.
*
* @return string|null Increment ID.
*/
public function getIncrementId();
/**
* Gets the order ID for the shipment.
*
* @return int Order ID.
*/
public function getOrderId();
/**
* Gets any packages for the shipment.
*
* @return \Magento\Sales\Api\Data\ShipmentPackageInterface[]|null Array of packages, if any. Otherwise, null.
*/
public function getPackages();
/**
* Sets any packages for the shipment.
*
* @param \Magento\Sales\Api\Data\ShipmentPackageInterface[] $packages
* @return $this
*/
public function setPackages(array $packages = null);
/**
* Gets the shipment status.
*
* @return int|null Shipment status.
*/
public function getShipmentStatus();
/**
* Gets the shipping address ID for the shipment.
*
* @return int|null Shipping address ID.
*/
public function getShippingAddressId();
/**
* Gets the shipping label for the shipment.
*
* @return string|null Shipping label.
*/
public function getShippingLabel();
/**
* Gets the store ID for the shipment.
*
* @return int|null Store ID.
*/
public function getStoreId();
/**
* Gets the total quantity for the shipment.
*
* @return float|null Total quantity.
*/
public function getTotalQty();
/**
* Gets the total weight for the shipment.
*
* @return float|null Total weight.
*/
public function getTotalWeight();
/**
* Gets the updated-at timestamp for the shipment.
*
* @return string|null Updated-at timestamp.
*/
public function getUpdatedAt();
/**
* Gets the items for the shipment.
*
* @return \Magento\Sales\Api\Data\ShipmentItemInterface[] Array of items.
*/
public function getItems();
/**
* Sets the items for the shipment.
*
* @param \Magento\Sales\Api\Data\ShipmentItemInterface[] $items
* @return $this
*/
public function setItems($items);
/**
* Gets the tracks for the shipment.
*
* @return \Magento\Sales\Api\Data\ShipmentTrackInterface[] Array of tracks.
*/
public function getTracks();
/**
* Sets the tracks for the shipment.
*
* @param \Magento\Sales\Api\Data\ShipmentTrackInterface[] $tracks
* @return $this
*/
public function setTracks($tracks);
/**
* Gets the comments for the shipment.
*
* @return \Magento\Sales\Api\Data\ShipmentCommentInterface[] Array of comments.
*/
public function getComments();
/**
* Sets the comments for the shipment.
*
* @param \Magento\Sales\Api\Data\ShipmentCommentInterface[] $comments
* @return $this
*/
public function setComments($comments = null);
/**
* Sets the store ID for the shipment.
*
* @param int $id
* @return $this
*/
public function setStoreId($id);
/**
* Sets the total weight for the shipment.
*
* @param float $totalWeight
* @return $this
*/
public function setTotalWeight($totalWeight);
/**
* Sets the total quantity for the shipment.
*
* @param float $qty
* @return $this
*/
public function setTotalQty($qty);
/**
* Sets the email-sent flag value for the shipment.
*
* @param int $emailSent
* @return $this
*/
public function setEmailSent($emailSent);
/**
* Sets the order ID for the shipment.
*
* @param int $id
* @return $this
*/
public function setOrderId($id);
/**
* Sets the customer ID for the shipment.
*
* @param int $id
* @return $this
*/
public function setCustomerId($id);
/**
* Sets the shipping address ID for the shipment.
*
* @param int $id
* @return $this
*/
public function setShippingAddressId($id);
/**
* Sets the billing address ID for the shipment.
*
* @param int $id
* @return $this
*/
public function setBillingAddressId($id);
/**
* Sets the shipment status.
*
* @param int $shipmentStatus
* @return $this
*/
public function setShipmentStatus($shipmentStatus);
/**
* Sets the increment ID for the shipment.
*
* @param string $id
* @return $this
*/
public function setIncrementId($id);
/**
* Sets the shipping label for the shipment.
*
* @param string $shippingLabel
* @return $this
*/
public function setShippingLabel($shippingLabel);
/**
* Sets the updated-at timestamp for the shipment.
*
* @param string $timestamp
* @return $this
*/
public function setUpdatedAt($timestamp);
/**
* Retrieve existing extension attributes object or create a new one.
*
* @return \Magento\Sales\Api\Data\ShipmentExtensionInterface|null
*/
public function getExtensionAttributes();
/**
* Set an extension attributes object.
*
* @param \Magento\Sales\Api\Data\ShipmentExtensionInterface $extensionAttributes
* @return $this
*/
public function setExtensionAttributes(\Magento\Sales\Api\Data\ShipmentExtensionInterface $extensionAttributes);
}