forked from LiveCarta/PayPal-PHP-Server-SDK
cf6ca18307
* Automated commit message * Automated commit message --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
2.9 KiB
2.9 KiB
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 |
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"
},
"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
}
],
"address": {
"address_line_1": "address_line_16",
"address_line_2": "address_line_26",
"admin_area_2": "admin_area_20",
"admin_area_1": "admin_area_12",
"postal_code": "postal_code8",
"country_code": "country_code6"
}
}