1
0
Files
PayPal-PHP-Server-SDK/doc/models/order-update-callback-shipping-option.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

1.4 KiB

Order Update Callback Shipping Option

The options that the payee or merchant offers to the payer to ship or pick up their items.

Structure

OrderUpdateCallbackShippingOption

Fields

Name Type Tags Description Getter Setter
id string Required A unique ID that identifies a payer-selected shipping option.
Constraints: Maximum Length: 127
getId(): string setId(string id): void
label string Required A description that the payer sees, which helps them choose an appropriate shipping option. For example, Free Shipping, USPS Priority Shipping, Expédition prioritaire USPS, or USPS yōuxiān fā huò. Localize this description to the payer's locale.
Constraints: Maximum Length: 127
getLabel(): string setLabel(string label): void
type ?string(ShippingType) Optional A classification for the method of purchase fulfillment. getType(): ?string setType(?string type): void
amount ?Money Optional The currency and amount for a financial transaction, such as a balance or payment due. getAmount(): ?Money setAmount(?Money amount): void

Example (as JSON)

{
  "id": "id8",
  "label": "label8",
  "type": "SHIPPING",
  "amount": {
    "currency_code": "currency_code6",
    "value": "value0"
  }
}