PHP Class PayPal\Api\Item

An item being paid for.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
addPostbackData ( PayPal\Api\NameValuePair $nameValuePair ) Append PostbackData to the list.
addSupplementaryData ( PayPal\Api\NameValuePair $nameValuePair ) Append SupplementaryData to the list.
getCategory ( ) : string Category type of the item.
getCurrency ( ) : string 3-letter currency code.
getDescription ( ) : string Description of the item. Only supported when the payment_method is set to paypal.
getHeight ( ) : PayPal\Api\Measurement Height of the item.
getLength ( ) : PayPal\Api\Measurement Length of the item.
getName ( ) : string Item name. 127 characters max.
getPostbackData ( ) : PayPal\Api\NameValuePair[] Set of optional data used for PayPal post-transaction notifications.
getPrice ( ) : string Item cost. 10 characters max.
getQuantity ( ) : string Number of a particular item. 10 characters max.
getSku ( ) : string Stock keeping unit corresponding (SKU) to item.
getSupplementaryData ( ) : PayPal\Api\NameValuePair[] Set of optional data used for PayPal risk determination.
getTax ( ) : string Tax of the item. Only supported when the payment_method is set to paypal.
getUrl ( ) : string URL linking to item information. Available to payer in transaction history.
getWeight ( ) : PayPal\Api\Measurement Weight of the item.
getWidth ( ) : PayPal\Api\Measurement Width of the item.
removePostbackData ( PayPal\Api\NameValuePair $nameValuePair ) Remove PostbackData from the list.
removeSupplementaryData ( PayPal\Api\NameValuePair $nameValuePair ) Remove SupplementaryData from the list.
setCategory ( string $category ) Category type of the item.
setCurrency ( string $currency ) 3-letter currency code.
setDescription ( string $description ) Description of the item. Only supported when the payment_method is set to paypal.
setHeight ( PayPal\Api\Measurement $height ) Height of the item.
setLength ( PayPal\Api\Measurement $length ) Length of the item.
setName ( string $name ) Item name. 127 characters max.
setPostbackData ( PayPal\Api\NameValuePair[] $postback_data ) Set of optional data used for PayPal post-transaction notifications.
setPrice ( string | double $price ) Item cost. 10 characters max.
setQuantity ( string $quantity ) Number of a particular item. 10 characters max.
setSku ( string $sku ) Stock keeping unit corresponding (SKU) to item.
setSupplementaryData ( PayPal\Api\NameValuePair[] $supplementary_data ) Set of optional data used for PayPal risk determination.
setTax ( string | double $tax ) Tax of the item. Only supported when the payment_method is set to paypal.
setUrl ( string $url ) URL linking to item information. Available to payer in transaction history.
setWeight ( PayPal\Api\Measurement $weight ) Weight of the item.
setWidth ( PayPal\Api\Measurement $width ) Width of the item.

Method Details

addPostbackData() public method

Append PostbackData to the list.
Deprecation: Not publicly available
public addPostbackData ( PayPal\Api\NameValuePair $nameValuePair )
$nameValuePair PayPal\Api\NameValuePair

addSupplementaryData() public method

Append SupplementaryData to the list.
Deprecation: Not publicly available
public addSupplementaryData ( PayPal\Api\NameValuePair $nameValuePair )
$nameValuePair PayPal\Api\NameValuePair

getCategory() public method

Category type of the item.
Deprecation: Not publicly available
public getCategory ( ) : string
return string

getCurrency() public method

3-letter currency code.
public getCurrency ( ) : string
return string

getDescription() public method

Description of the item. Only supported when the payment_method is set to paypal.
public getDescription ( ) : string
return string

getHeight() public method

Height of the item.
Deprecation: Not publicly available
public getHeight ( ) : PayPal\Api\Measurement
return PayPal\Api\Measurement

getLength() public method

Length of the item.
Deprecation: Not publicly available
public getLength ( ) : PayPal\Api\Measurement
return PayPal\Api\Measurement

getName() public method

Item name. 127 characters max.
public getName ( ) : string
return string

getPostbackData() public method

Set of optional data used for PayPal post-transaction notifications.
Deprecation: Not publicly available
public getPostbackData ( ) : PayPal\Api\NameValuePair[]
return PayPal\Api\NameValuePair[]

getPrice() public method

Item cost. 10 characters max.
public getPrice ( ) : string
return string

getQuantity() public method

Number of a particular item. 10 characters max.
public getQuantity ( ) : string
return string

getSku() public method

Stock keeping unit corresponding (SKU) to item.
public getSku ( ) : string
return string

getSupplementaryData() public method

Set of optional data used for PayPal risk determination.
Deprecation: Not publicly available
public getSupplementaryData ( ) : PayPal\Api\NameValuePair[]
return PayPal\Api\NameValuePair[]

getTax() public method

Tax of the item. Only supported when the payment_method is set to paypal.
public getTax ( ) : string
return string

getUrl() public method

URL linking to item information. Available to payer in transaction history.
public getUrl ( ) : string
return string

getWeight() public method

Weight of the item.
Deprecation: Not publicly available
public getWeight ( ) : PayPal\Api\Measurement
return PayPal\Api\Measurement

getWidth() public method

Width of the item.
Deprecation: Not publicly available
public getWidth ( ) : PayPal\Api\Measurement
return PayPal\Api\Measurement

removePostbackData() public method

Remove PostbackData from the list.
Deprecation: Not publicly available
public removePostbackData ( PayPal\Api\NameValuePair $nameValuePair )
$nameValuePair PayPal\Api\NameValuePair

removeSupplementaryData() public method

Remove SupplementaryData from the list.
Deprecation: Not publicly available
public removeSupplementaryData ( PayPal\Api\NameValuePair $nameValuePair )
$nameValuePair PayPal\Api\NameValuePair

setCategory() public method

Valid Values: ["DIGITAL", "PHYSICAL"]
Deprecation: Not publicly available
public setCategory ( string $category )
$category string

setCurrency() public method

3-letter currency code.
public setCurrency ( string $currency )
$currency string

setDescription() public method

Description of the item. Only supported when the payment_method is set to paypal.
public setDescription ( string $description )
$description string

setHeight() public method

Height of the item.
Deprecation: Not publicly available
public setHeight ( PayPal\Api\Measurement $height )
$height PayPal\Api\Measurement

setLength() public method

Length of the item.
Deprecation: Not publicly available
public setLength ( PayPal\Api\Measurement $length )
$length PayPal\Api\Measurement

setName() public method

Item name. 127 characters max.
public setName ( string $name )
$name string

setPostbackData() public method

Set of optional data used for PayPal post-transaction notifications.
Deprecation: Not publicly available
public setPostbackData ( PayPal\Api\NameValuePair[] $postback_data )
$postback_data PayPal\Api\NameValuePair[]

setPrice() public method

Item cost. 10 characters max.
public setPrice ( string | double $price )
$price string | double

setQuantity() public method

Number of a particular item. 10 characters max.
public setQuantity ( string $quantity )
$quantity string

setSku() public method

Stock keeping unit corresponding (SKU) to item.
public setSku ( string $sku )
$sku string

setSupplementaryData() public method

Set of optional data used for PayPal risk determination.
Deprecation: Not publicly available
public setSupplementaryData ( PayPal\Api\NameValuePair[] $supplementary_data )
$supplementary_data PayPal\Api\NameValuePair[]

setTax() public method

Tax of the item. Only supported when the payment_method is set to paypal.
public setTax ( string | double $tax )
$tax string | double

setUrl() public method

URL linking to item information. Available to payer in transaction history.
public setUrl ( string $url )
$url string

setWeight() public method

Weight of the item.
Deprecation: Not publicly available
public setWeight ( PayPal\Api\Measurement $weight )
$weight PayPal\Api\Measurement

setWidth() public method

Width of the item.
Deprecation: Not publicly available
public setWidth ( PayPal\Api\Measurement $width )
$width PayPal\Api\Measurement