PayPal-PHP-Server-SDK/doc/models/shipping-details.md

Shipping Details

The shipping details.

Structure

ShippingDetails

Fields

Name	Type	Tags	Description	Getter	Setter
name	?ShippingName	Optional	The name of the party.	getName(): ?ShippingName	setName(?ShippingName name): void
emailAddress	?string	Optional	The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists. Constraints: Minimum Length: 3, Maximum Length: 254, Pattern: ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$	getEmailAddress(): ?string	setEmailAddress(?string emailAddress): void
phoneNumber	?PhoneNumberWithCountryCode	Optional	The phone number in its canonical international E.164 numbering plan format.	getPhoneNumber(): ?PhoneNumberWithCountryCode	setPhoneNumber(?PhoneNumberWithCountryCode phoneNumber): void
type	?string(FulfillmentType)	Optional	A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either type or options may be present, but not both. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$	getType(): ?string	setType(?string type): void
options	?(ShippingOption[])	Optional	An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items. Constraints: Minimum Items: 0, Maximum Items: 10	getOptions(): ?array	setOptions(?array options): void
address	?Address	Optional	The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.	getAddress(): ?Address	setAddress(?Address address): void

Example (as JSON)

{
  "name": {
    "full_name": "full_name6"
  },
  "email_address": "email_address2",
  "phone_number": {
    "country_code": "country_code2",
    "national_number": "national_number6"
  },
  "type": "PICKUP_IN_STORE",
  "options": [
    {
      "id": "id2",
      "label": "label2",
      "type": "SHIPPING",
      "amount": {
        "currency_code": "currency_code6",
        "value": "value0"
      },
      "selected": false
    },
    {
      "id": "id2",
      "label": "label2",
      "type": "SHIPPING",
      "amount": {
        "currency_code": "currency_code6",
        "value": "value0"
      },
      "selected": false
    },
    {
      "id": "id2",
      "label": "label2",
      "type": "SHIPPING",
      "amount": {
        "currency_code": "currency_code6",
        "value": "value0"
      },
      "selected": false
    }
  ]
}