Overview
  • Namespace
  • Class

Namespaces

  • PayPal
    • Api
    • Auth
    • Cache
    • Common
    • Converter
    • Core
    • Exception
    • Handler
    • Log
    • Rest
    • Security
    • Transport
    • Validation

Classes

  • Address
  • Agreement
  • AgreementDetails
  • AgreementStateDescriptor
  • AgreementTransaction
  • AgreementTransactions
  • AlternatePayment
  • Amount
  • Authorization
  • BankAccount
  • BankAccountsList
  • BankToken
  • BaseAddress
  • Billing
  • BillingAgreementToken
  • BillingInfo
  • CancelNotification
  • Capture
  • CarrierAccount
  • CarrierAccountToken
  • CartBase
  • ChargeModel
  • Cost
  • CountryCode
  • CreateProfileResponse
  • Credit
  • CreditCard
  • CreditCardHistory
  • CreditCardList
  • CreditCardToken
  • CreditFinancingOffered
  • Currency
  • CurrencyConversion
  • CustomAmount
  • DetailedRefund
  • Details
  • Error
  • ErrorDetails
  • ExtendedBankAccount
  • ExternalFunding
  • FileAttachment
  • FlowConfig
  • FmfDetails
  • FundingDetail
  • FundingInstrument
  • FundingOption
  • FundingSource
  • FuturePayment
  • HyperSchema
  • Image
  • Incentive
  • InputFields
  • InstallmentInfo
  • InstallmentOption
  • Invoice
  • InvoiceAddress
  • InvoiceItem
  • InvoiceNumber
  • InvoiceSearchResponse
  • Item
  • ItemList
  • Links
  • Measurement
  • MerchantInfo
  • MerchantPreferences
  • Metadata
  • NameValuePair
  • Notification
  • OpenIdAddress
  • OpenIdError
  • OpenIdSession
  • OpenIdTokeninfo
  • OpenIdUserinfo
  • Order
  • OverrideChargeModel
  • Participant
  • Patch
  • PatchRequest
  • Payee
  • Payer
  • PayerInfo
  • Payment
  • PaymentCard
  • PaymentCardToken
  • PaymentDefinition
  • PaymentDetail
  • PaymentExecution
  • PaymentHistory
  • PaymentInstruction
  • PaymentOptions
  • PaymentSummary
  • PaymentTerm
  • Payout
  • PayoutBatch
  • PayoutBatchHeader
  • PayoutItem
  • PayoutItemDetails
  • PayoutSenderBatchHeader
  • Phone
  • Plan
  • PlanList
  • PotentialPayerInfo
  • Presentation
  • PrivateLabelCard
  • ProcessorResponse
  • RecipientBankingInstruction
  • RedirectUrls
  • Refund
  • RefundDetail
  • RefundRequest
  • RelatedResources
  • Sale
  • Search
  • ShippingAddress
  • ShippingCost
  • ShippingInfo
  • Tax
  • Template
  • TemplateData
  • Templates
  • TemplateSettings
  • TemplateSettingsMetadata
  • Terms
  • Transaction
  • TransactionBase
  • Transactions
  • VerifyWebhookSignature
  • VerifyWebhookSignatureResponse
  • Webhook
  • WebhookEvent
  • WebhookEventList
  • WebhookEventType
  • WebhookEventTypeList
  • WebhookList
  • WebProfile

Class Item

Class Item

Item details.

PayPal\Common\PayPalModel
Extended by PayPal\Api\Item
Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/Item.php

Methods summary

public
# setSku( string $sku )

Stock keeping unit corresponding (SKU) to item.

Stock keeping unit corresponding (SKU) to item.

Parameters

$sku

Returns


$this
public string
# getSku( )

Stock keeping unit corresponding (SKU) to item.

Stock keeping unit corresponding (SKU) to item.

Returns

string
public
# setName( string $name )

Item name. 127 characters max.

Item name. 127 characters max.

Parameters

$name

Returns


$this
public string
# getName( )

Item name. 127 characters max.

Item name. 127 characters max.

Returns

string
public
# setDescription( string $description )

Description of the item. Only supported when the payment_method is set to paypal.

Description of the item. Only supported when the payment_method is set to paypal.

Parameters

$description

Returns


$this
public string
# getDescription( )

Description of the item. Only supported when the payment_method is set to paypal.

Description of the item. Only supported when the payment_method is set to paypal.

Returns

string
public
# setQuantity( string $quantity )

Number of a particular item. 10 characters max.

Number of a particular item. 10 characters max.

Parameters

$quantity

Returns


$this
public string
# getQuantity( )

Number of a particular item. 10 characters max.

Number of a particular item. 10 characters max.

Returns

string
public
# setPrice( string|float $price )

Item cost. 10 characters max.

Item cost. 10 characters max.

Parameters

$price

Returns


$this
public string
# getPrice( )

Item cost. 10 characters max.

Item cost. 10 characters max.

Returns

string
public
# setCurrency( string $currency )

3-letter currency code.

3-letter currency code.

Parameters

$currency

Returns


$this
public string
# getCurrency( )

3-letter currency code.

3-letter currency code.

Returns

string
public
# setTax( string|float $tax )

Tax of the item. Only supported when the payment_method is set to paypal.

Tax of the item. Only supported when the payment_method is set to paypal.

Parameters

$tax

Returns


$this
public string
# getTax( )

Tax of the item. Only supported when the payment_method is set to paypal.

Tax of the item. Only supported when the payment_method is set to paypal.

Returns

string
public
# setUrl( string $url )

URL linking to item information. Available to payer in transaction history.

URL linking to item information. Available to payer in transaction history.

Parameters

$url

Returns


$this

Throws

InvalidArgumentException
public string
# getUrl( )

URL linking to item information. Available to payer in transaction history.

URL linking to item information. Available to payer in transaction history.

Returns

string
public
# setCategory( string $category )

Category type of the item. Valid Values: ["DIGITAL", "PHYSICAL"]

Category type of the item. Valid Values: ["DIGITAL", "PHYSICAL"]

Deprecated

Not publicly available

Parameters

$category

Returns


$this
public string
# getCategory( )

Category type of the item.

Category type of the item.

Deprecated

Not publicly available

Returns

string
public
# setWeight( PayPal\Api\Measurement $weight )

Weight of the item.

Weight of the item.

Deprecated

Not publicly available

Parameters

$weight

Returns


$this
public PayPal\Api\Measurement
# getWeight( )

Weight of the item.

Weight of the item.

Deprecated

Not publicly available

Returns

PayPal\Api\Measurement
public
# setLength( PayPal\Api\Measurement $length )

Length of the item.

Length of the item.

Deprecated

Not publicly available

Parameters

$length

Returns


$this
public PayPal\Api\Measurement
# getLength( )

Length of the item.

Length of the item.

Deprecated

Not publicly available

Returns

PayPal\Api\Measurement
public
# setHeight( PayPal\Api\Measurement $height )

Height of the item.

Height of the item.

Deprecated

Not publicly available

Parameters

$height

Returns


$this
public PayPal\Api\Measurement
# getHeight( )

Height of the item.

Height of the item.

Deprecated

Not publicly available

Returns

PayPal\Api\Measurement
public
# setWidth( PayPal\Api\Measurement $width )

Width of the item.

Width of the item.

Deprecated

Not publicly available

Parameters

$width

Returns


$this
public PayPal\Api\Measurement
# getWidth( )

Width of the item.

Width of the item.

Deprecated

Not publicly available

Returns

PayPal\Api\Measurement
public
# setSupplementaryData( PayPal\Api\NameValuePair[] $supplementary_data )

Set of optional data used for PayPal risk determination.

Set of optional data used for PayPal risk determination.

Deprecated

Not publicly available

Parameters

$supplementary_data

Returns


$this
public PayPal\Api\NameValuePair[]
# getSupplementaryData( )

Set of optional data used for PayPal risk determination.

Set of optional data used for PayPal risk determination.

Deprecated

Not publicly available

Returns

PayPal\Api\NameValuePair[]
public
# addSupplementaryData( PayPal\Api\NameValuePair $nameValuePair )

Append SupplementaryData to the list.

Append SupplementaryData to the list.

Deprecated

Not publicly available

Parameters

$nameValuePair

Returns


$this
public
# removeSupplementaryData( PayPal\Api\NameValuePair $nameValuePair )

Remove SupplementaryData from the list.

Remove SupplementaryData from the list.

Deprecated

Not publicly available

Parameters

$nameValuePair

Returns


$this
public
# setPostbackData( PayPal\Api\NameValuePair[] $postback_data )

Set of optional data used for PayPal post-transaction notifications.

Set of optional data used for PayPal post-transaction notifications.

Deprecated

Not publicly available

Parameters

$postback_data

Returns


$this
public PayPal\Api\NameValuePair[]
# getPostbackData( )

Set of optional data used for PayPal post-transaction notifications.

Set of optional data used for PayPal post-transaction notifications.

Deprecated

Not publicly available

Returns

PayPal\Api\NameValuePair[]
public
# addPostbackData( PayPal\Api\NameValuePair $nameValuePair )

Append PostbackData to the list.

Append PostbackData to the list.

Deprecated

Not publicly available

Parameters

$nameValuePair

Returns


$this
public
# removePostbackData( PayPal\Api\NameValuePair $nameValuePair )

Remove PostbackData from the list.

Remove PostbackData from the list.

Deprecated

Not publicly available

Parameters

$nameValuePair

Returns


$this

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel

$credential

API documentation generated by ApiGen