On this page
No Headings
The options that the payee or merchant offers to the payer to ship or pick up their items.
objectidrequiredstring^[\S\s]*$A unique ID that identifies a payer-selected shipping option.
labelrequiredstring^[\S\s]*$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.
typeobject"SHIPPING", "PICKUP", "PICKUP_IN_STORE", "PICKUP_FROM_PERSON""SHIPPING"A classification for the method of purchase fulfillment.
A classification for the method of purchase fulfillment.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The shipping cost for the selected option.
currency_coderequiredstring^[\S\s]*$The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.selectedrequiredbooleanIf the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. As part of the response if a shipping.option contains selected=true, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one shipping.option can be set to selected=true.