shipping_option

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

idstringRequired

A unique ID that identifies a payer-selected shipping option.

Match^[\S\s]*$Length0 <= length <= 127

labelstringRequired

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.

Match^[\S\s]*$Length0 <= length <= 127

typeenum<shipping_type>Optional

A classification for the method of purchase fulfillment.

Default"SHIPPING"Value in"SHIPPING" | "PICKUP" | "PICKUP_IN_STORE" | "PICKUP_FROM_PERSON"

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

selectedbooleanRequired

If 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`.

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

idstringRequired

A unique ID that identifies a payer-selected shipping option.

Match^[\S\s]*$Length0 <= length <= 127

labelstringRequired

Match^[\S\s]*$Length0 <= length <= 127

typeenum<shipping_type>Optional

A classification for the method of purchase fulfillment.

Default"SHIPPING"Value in"SHIPPING" | "PICKUP" | "PICKUP_IN_STORE" | "PICKUP_FROM_PERSON"

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

selectedbooleanRequired

shipping_option

money properties

Back to top

On this page

On this page

shipping_option

money properties

Back to top

On this page

shipping_option

money properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

shipping_option

money properties

Back to top

On this page