ShippingRefund object

Version 2020-01 (Release candidate)

Represents the shipping costs refunded on the Refund.

Required access

read_orders access scope

Fields

amountSet (MoneyBag!)

The monetary value of the shipping fees to be returned in shop and presentment currencies.

maximumRefundableSet (MoneyBag!)

The maximum amount of shipping fees currently refundable in shop and presentment currencies.

taxSet (MoneyBag!)

The monetary value of the tax allocated to shipping fees to be returned in shop and presentment currencies.

Types that return ShippingRefund

Deprecated fields

Show/Hide
amount (Money!) deprecated

The monetary value of the shipping fees to be returned.

Deprecation warning

Use amountSet instead

maximumRefundable (Money!) deprecated

The maximum amount of shipping fees currently refundable.

Deprecation warning

Use maximumRefundableSet instead

tax (Money!) deprecated

The monetary value of the tax allocated to shipping fees to be returned.

Deprecation warning

Use taxSet instead

Version 2019-10 (Latest)

Represents the shipping costs refunded on the Refund.

Required access

read_orders access scope

Fields

amountSet (MoneyBag!)

The monetary value of the shipping fees to be returned in shop and presentment currencies.

maximumRefundableSet (MoneyBag!)

The maximum amount of shipping fees currently refundable in shop and presentment currencies.

taxSet (MoneyBag!)

The monetary value of the tax allocated to shipping fees to be returned in shop and presentment currencies.

Types that return ShippingRefund

Deprecated fields

Show/Hide
amount (Money!) deprecated

The monetary value of the shipping fees to be returned.

Deprecation warning

Use amountSet instead

maximumRefundable (Money!) deprecated

The maximum amount of shipping fees currently refundable.

Deprecation warning

Use maximumRefundableSet instead

tax (Money!) deprecated

The monetary value of the tax allocated to shipping fees to be returned.

Deprecation warning

Use taxSet instead

Version 2019-07

Represents the shipping costs refunded on the Refund.

Required access

read_orders access scope

Fields

amountSet (MoneyBag!)

The monetary value of the shipping fees to be returned in shop and presentment currencies.

maximumRefundableSet (MoneyBag!)

The maximum amount of shipping fees currently refundable in shop and presentment currencies.

taxSet (MoneyBag!)

The monetary value of the tax allocated to shipping fees to be returned in shop and presentment currencies.

Types that return ShippingRefund

Deprecated fields

Show/Hide
amount (Money!) deprecated

The monetary value of the shipping fees to be returned.

Deprecation warning

Use amountSet instead

maximumRefundable (Money!) deprecated

The maximum amount of shipping fees currently refundable.

Deprecation warning

Use maximumRefundableSet instead

tax (Money!) deprecated

The monetary value of the tax allocated to shipping fees to be returned.

Deprecation warning

Use taxSet instead

Version 2019-04

Represents the shipping costs refunded on the Refund.

Required access

read_orders access scope

Fields

amountSet (MoneyBag!)

The monetary value of the shipping fees to be returned in shop and presentment currencies.

maximumRefundableSet (MoneyBag!)

The maximum amount of shipping fees currently refundable in shop and presentment currencies.

taxSet (MoneyBag!)

The monetary value of the tax allocated to shipping fees to be returned in shop and presentment currencies.

Types that return ShippingRefund

Deprecated fields

Show/Hide
amount (Money!) deprecated

The monetary value of the shipping fees to be returned.

Deprecation warning

Use amountSet instead

maximumRefundable (Money!) deprecated

The maximum amount of shipping fees currently refundable.

Deprecation warning

Use maximumRefundableSet instead

tax (Money!) deprecated

The monetary value of the tax allocated to shipping fees to be returned.

Deprecation warning

Use taxSet instead

Sign up for a Partner account to get started.

Sign up