Skip to main content

A type that defines the fields for the shipping options.

Type that uses ShippingOption

LineItem

Calls that use ShippingOption

POST
/guest_checkout_session/{checkoutSessionId}/apply_coupon
GET
/guest_checkout_session/{checkoutSessionId}
POST
/guest_checkout_session/initiate
POST
/guest_checkout_session/{checkoutSessionId}/remove_coupon
POST
/guest_checkout_session/{checkoutSessionId}/update_quantity
POST
/guest_checkout_session/{checkoutSessionId}/update_shipping_address
POST
/guest_checkout_session/{checkoutSessionId}/update_shipping_option

Fields

Field
Type
Description
baseDeliveryCost
Amount
The delivery cost using this shipping option, for this line item, before any delivery discounts are applied.

Note: The cost includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.
deliveryDiscount
Amount
The monetary value of any delivery discounts.
importCharges
Amount
The Global Shipping Program import charges for this line item.
maxEstimatedDeliveryDate
string
The end of the date range in which the purchase order is expected to be delivered to the shipping address.
minEstimatedDeliveryDate
string
The beginning of the date range in which the purchase order is expected to be delivered to the shipping address.
selected
boolean
A field that indicates whether the shipping method is selected.
shippingCarrierCode
string
The shipping provider for the line item, such as FedEx or USPS.
shippingOptionId
string
A unique ID for the selected shipping option/method.
shippingServiceCode
string
The name of the shipping service code. For example, Priority Mail Express (provided by USPS) or FedEx International Priority (Provided by FedEx).