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 ShippingAddress

Class ShippingAddress

Extended Address object used as shipping address in a payment.

PayPal\Common\PayPalModel
Extended by PayPal\Api\BaseAddress
Extended by PayPal\Api\Address
Extended by PayPal\Api\ShippingAddress
Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/ShippingAddress.php

Methods summary

public
# setId( string $id )

Address ID assigned in PayPal system.

Address ID assigned in PayPal system.

Deprecated

Not publicly available

Parameters

$id

Returns


$this
public string
# getId( )

Address ID assigned in PayPal system.

Address ID assigned in PayPal system.

Deprecated

Not publicly available

Returns

string
public
# setRecipientName( string $recipient_name )

Name of the recipient at this address.

Name of the recipient at this address.

Parameters

$recipient_name

Returns


$this
public string
# getRecipientName( )

Name of the recipient at this address.

Name of the recipient at this address.

Returns

string
public
# setDefaultAddress( boolean $default_address )

Default shipping address of the Payer.

Default shipping address of the Payer.

Deprecated

Not publicly available

Parameters

$default_address

Returns


$this
public boolean
# getDefaultAddress( )

Default shipping address of the Payer.

Default shipping address of the Payer.

Deprecated

Not publicly available

Returns

boolean
public
# setPreferredAddress( boolean $preferred_address )

Shipping Address marked as preferred by Payer.

Shipping Address marked as preferred by Payer.

Deprecated

Not publicly available

Parameters

$preferred_address

Returns


$this
public boolean
# getPreferredAddress( )

Shipping Address marked as preferred by Payer.

Shipping Address marked as preferred by Payer.

Deprecated

Not publicly available

Returns

boolean

Methods inherited from PayPal\Api\Address

getPhone(), getType(), setPhone(), setType()

Methods inherited from PayPal\Api\BaseAddress

getCity(), getCountryCode(), getLine1(), getLine2(), getNormalizationStatus(), getPostalCode(), getState(), getStatus(), setCity(), setCountryCode(), setLine1(), setLine2(), setNormalizationStatus(), setPostalCode(), setState(), setStatus()

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