Open API v2 will be deprecated on April 3, 2023. Please begin transitioning to Open API v3 as soon as possible. As of September 29, 2022 all new apps will only be permitted to use Open API v3.

API Documentation

CartListing

Overview

Represents the purchase quantity and state for a cart listing.

Fields

Field Visibility Level Permission Scope Type Description
listing_id private cart_rw int The numeric ID of the listing
purchase_quantity private cart_rw int The quantity of the listing being purchased
purchase_state private cart_rw string The purchase state of the listing, possible values: valid, invalid_quantity, invalid_shipping, not_active, edited, invalid_currency, invalid_shipping_currency
is_digital private cart_rw boolean True if this listing is for a digital download.
file_data private cart_rw string Written description of the files attached to this digital listing.
listing_customization_id private cart_rw int When Variations are present on a listing, this can be used to differentiate multiple instances of the same listing.
variations_available private cart_rw boolean Whether Variations are available for this listing.
has_variations private cart_rw boolean Whether the buyer selected Variations for this listing.
selected_variations private cart_rw array(Variations_SelectedProperty) An array of selected Variations for this listing.

Associations

This resource has no associations.

Methods

This resource has no methods.

Open API v3New

Your developer account