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

Cart

Overview

Represents a shopping cart on Etsy. Users have one cart per shop.

Fields

Field Visibility Level Permission Scope Type Description
cart_id private cart_rw int The numeric ID of the cart
shop_name private cart_rw string The shop name
message_to_seller private cart_rw string The message to the seller
destination_country_id private cart_rw int The numeric ID of the destination country
coupon_code private cart_rw string The alphanumeric coupon code applied to the cart
Deprecated: The Etsy API no longer supports coupons.
currency_code private cart_rw string The ISO (alphabetic) code for the currency
total private cart_rw string The total price
subtotal private cart_rw string The subtotal price
shipping_cost private cart_rw string The shipping cost
tax_cost private cart_rw string The tax cost
discount_amount private cart_rw string The line-item discount amount (does not include tax or shipping)
shipping_discount_amount private cart_rw string The shipping discount amount
tax_discount_amount private cart_rw string The tax discount amount
url private cart_rw string The full URL to the cart page on Etsy
listings private cart_rw array(CartListing) An array of purchase information for the listings
is_download_only private cart_rw boolean The cart is download only
has_vat private cart_rw boolean The cart has VAT tax
shipping_option private cart_rw ShippingOption The selected shipping option identifier for the cart

Associations

Association Visibility Level Permission Scope Type Description
Shop private cart_rw Shop The shop
Listings private cart_rw array(Listing) An array of listings
ShippingOptions private cart_rw array(ShippingOption) Available shipping options for the cart

Methods

getAllUserCarts

Method Name getAllUserCarts
Synopsis Get a user's Carts
HTTP Method GET
URI /users/:user_id/carts
Parameters
Name Required Default Type
user_id Y   user_id_or_name
limit N 100 int
offset N 0 int
page N   int
Requires OAuth Y
Permission Scope cart_rw

addToCart

Method Name addToCart
Synopsis Add a listing to a cart
HTTP Method POST
URI /users/:user_id/carts
Parameters
Name Required Default Type
user_id Y   user_id_or_name
listing_id Y   int
quantity N 1 int
selected_variations N   map(int, int)
personalization N   personalization
Requires OAuth Y
Permission Scope cart_rw

updateCartListingQuantity

Method Name updateCartListingQuantity
Synopsis Update a cart listing purchase quantity
HTTP Method PUT
URI /users/:user_id/carts
Parameters
Name Required Default Type
user_id Y   user_id_or_name
listing_id Y   int
quantity Y   int
listing_customization_id N 0 int
Requires OAuth Y
Permission Scope cart_rw

removeCartListing

Method Name removeCartListing
Synopsis Remove a listing from a cart
HTTP Method DELETE
URI /users/:user_id/carts
Parameters
Name Required Default Type
user_id Y   user_id_or_name
listing_id Y   int
listing_customization_id N 0 int
Requires OAuth Y
Permission Scope cart_rw

getUserCart

Method Name getUserCart
Synopsis Get a cart
HTTP Method GET
URI /users/:user_id/carts/:cart_id
Parameters
Name Required Default Type
user_id Y   user_id_or_name
cart_id Y   cart_id
Requires OAuth Y
Permission Scope cart_rw

updateCart

Method Name updateCart
Synopsis Update a cart
HTTP Method PUT
URI /users/:user_id/carts/:cart_id
Parameters
Name Required Default Type
user_id Y   user_id_or_name
cart_id Y   cart_id
destination_country_id N   int
message_to_seller N   text
coupon_code N   string
shipping_option_id N   string
destination_zip N   string
Requires OAuth Y
Permission Scope cart_rw

deleteCart

Method Name deleteCart
Synopsis Delete a cart
HTTP Method DELETE
URI /users/:user_id/carts/:cart_id
Parameters
Name Required Default Type
user_id Y   user_id_or_name
cart_id Y   cart_id
Requires OAuth Y
Permission Scope cart_rw

addAndSelectShippingForApplePay

Method Name addAndSelectShippingForApplePay
Synopsis Saves and selects a shipping address for apple pay
HTTP Method POST
URI /users/:user_id/carts/:cart_id/add_and_select_shipping_for_apple
Parameters
Name Required Default Type
user_id Y   user_id_or_name
cart_id Y   cart_id
second_line N   string
city Y   string
state N   string
zip Y   string
country_id Y   int
Requires OAuth Y
Permission Scope cart_rw

saveListingForLater

Method Name saveListingForLater
Synopsis Move a listing to Saved for Later
HTTP Method DELETE
URI /users/:user_id/carts/save
Parameters
Name Required Default Type
user_id Y   user_id_or_name
cart_id Y   int
listing_id Y   int
listing_inventory_id N 0 int
listing_customization_id N 0 int
Requires OAuth Y
Permission Scope cart_rw

getUserCartForShop

Method Name getUserCartForShop
Synopsis Get a cart from a shop ID
HTTP Method GET
URI /users/:user_id/carts/shop/:shop_id
Parameters
Name Required Default Type
user_id Y   user_id_or_name
shop_id Y   shop_id_or_name
Requires OAuth Y
Permission Scope cart_rw

createSingleListingCart

Method Name createSingleListingCart
Synopsis Create a single-listing cart from a listing
HTTP Method POST
URI /users/:user_id/carts/single_listing
Parameters
Name Required Default Type
user_id Y   user_id_or_name
listing_id Y   int
quantity N 1 int
selected_variations N   map(int, int)
personalization N   personalization
Requires OAuth Y
Permission Scope cart_rw

Open API v3New

Your developer account