PHP Class PayPal\Api\ItemList

Inheritance: extends Resource
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
addItem ( Item $item ) Append Items to the list.
getItems ( ) : Item[] List of items.
getShippingAddress ( ) : ShippingAddress Shipping address.
getShippingMethod ( ) : string Shipping method used for this payment like USPSParcel etc.
getShippingPhoneNumber ( ) : string Allows merchant's to share payer’s contact number with PayPal for the current payment. Final contact number of payer associated with the transaction might be same as shipping_phone_number or different based on Payer’s action on PayPal. The phone number must be represented in its canonical international format, as defined by the E.164 numbering plan
removeItem ( Item $item ) Remove Items from the list.
setItems ( Item[] $items ) List of items.
setShippingAddress ( ShippingAddress $shipping_address ) Shipping address.
setShippingMethod ( string $shipping_method ) Shipping method used for this payment like USPSParcel etc.
setShippingPhoneNumber ( string $shipping_phone_number ) Allows merchant's to share payer’s contact number with PayPal for the current payment. Final contact number of payer associated with the transaction might be same as shipping_phone_number or different based on Payer’s action on PayPal. The phone number must be represented in its canonical international format, as defined by the E.164 numbering plan

Method Details

addItem() public method

Append Items to the list.
public addItem ( Item $item )
$item Item

getItems() public method

List of items.
public getItems ( ) : Item[]
return Item[]

getShippingAddress() public method

Shipping address.
public getShippingAddress ( ) : ShippingAddress
return ShippingAddress

getShippingMethod() public method

Shipping method used for this payment like USPSParcel etc.
public getShippingMethod ( ) : string
return string

getShippingPhoneNumber() public method

Allows merchant's to share payer’s contact number with PayPal for the current payment. Final contact number of payer associated with the transaction might be same as shipping_phone_number or different based on Payer’s action on PayPal. The phone number must be represented in its canonical international format, as defined by the E.164 numbering plan
public getShippingPhoneNumber ( ) : string
return string

removeItem() public method

Remove Items from the list.
public removeItem ( Item $item )
$item Item

setItems() public method

List of items.
public setItems ( Item[] $items )
$items Item[]

setShippingAddress() public method

Shipping address.
public setShippingAddress ( ShippingAddress $shipping_address )
$shipping_address ShippingAddress

setShippingMethod() public method

Shipping method used for this payment like USPSParcel etc.
public setShippingMethod ( string $shipping_method )
$shipping_method string

setShippingPhoneNumber() public method

Allows merchant's to share payer’s contact number with PayPal for the current payment. Final contact number of payer associated with the transaction might be same as shipping_phone_number or different based on Payer’s action on PayPal. The phone number must be represented in its canonical international format, as defined by the E.164 numbering plan
public setShippingPhoneNumber ( string $shipping_phone_number )
$shipping_phone_number string