1
0
Files
PayPal-PHP-Server-SDK/doc/models/order-update-callback-shipping-address.md
Patrick Powers 504c367386 Release 0.7.0
Beta Release 0.7.0 including:

- Bug fixes
- Updated model/function names
- Updated models to reflect changes in APIs
2025-03-20 13:18:55 -05:00

2.2 KiB

Order Update Callback Shipping Address

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

Structure

OrderUpdateCallbackShippingAddress

Fields

Name Type Tags Description Getter Setter
adminArea2 ?string Optional A city, town, or village. Smaller than admin_area_level_1.
Constraints: Maximum Length: 120
getAdminArea2(): ?string setAdminArea2(?string adminArea2): void
adminArea1 ?string Optional The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is: UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton.
Constraints: Maximum Length: 300
getAdminArea1(): ?string setAdminArea1(?string adminArea1): void
postalCode ?string Optional The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
Constraints: Maximum Length: 60
getPostalCode(): ?string setPostalCode(?string postalCode): void
countryCode string Required The 2-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Constraints: Minimum Length: 2, Maximum Length: 2, Pattern: ^([A-Z]{2}|C2)$
getCountryCode(): string setCountryCode(string countryCode): void

Example (as JSON)

{
  "admin_area_2": "admin_area_26",
  "admin_area_1": "admin_area_16",
  "postal_code": "postal_code2",
  "country_code": "country_code0"
}