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.
- ApiMethod
- BillCharge
- BillingOverview
- BillPayment
- Cart
- CartListing
- Country
- Coupon
- DataType
- FavoriteListing
- FavoriteUser
- Feedback
- FeedbackInfo
- ForumPost
- Guest
- GuestCart
- ImageType
- Ledger
- LedgerEntry
- Listing
- ListingFile
- ListingImage
- ListingInventory
- ListingOffering
- ListingProduct
- ListingTranslation
- ListingVariationImage
- Money
- ParamList
- Payment
- PaymentAccountLedgerEntry
- PaymentAdjustment
- PaymentAdjustmentItem
- PaymentTemplate
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 |
|
int |
The numeric ID of the cart |
shop_name |
private |
|
string |
The shop name |
message_to_seller |
private |
|
string |
The message to the seller |
destination_country_id |
private |
|
int |
The numeric ID of the destination country |
coupon_code |
private |
|
string |
The alphanumeric coupon code applied to the cart
Deprecated: The Etsy API no longer supports coupons. |
currency_code |
private |
|
string |
The ISO (alphabetic) code for the currency |
total |
private |
|
string |
The total price |
subtotal |
private |
|
string |
The subtotal price |
shipping_cost |
private |
|
string |
The shipping cost |
tax_cost |
private |
|
string |
The tax cost |
discount_amount |
private |
|
string |
The line-item discount amount (does not include tax or shipping) |
shipping_discount_amount |
private |
|
string |
The shipping discount amount |
tax_discount_amount |
private |
|
string |
The tax discount amount |
url |
private |
|
string |
The full URL to the cart page on Etsy |
listings |
private |
|
|
An array of purchase information for the listings |
is_download_only |
private |
|
boolean |
The cart is download only |
has_vat |
private |
|
boolean |
The cart has VAT tax |
shipping_option |
private |
|
|
The selected shipping option identifier for the cart |
Associations
Association | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
Shop |
private |
|
|
The shop |
Listings |
private |
|
|
An array of listings |
ShippingOptions |
private |
|
|
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 |
|
||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||
Permission Scope |
|
addToCart
Method Name | addToCart |
||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Add a listing to a cart | ||||||||||||||||||||||||
HTTP Method | POST |
||||||||||||||||||||||||
URI | /users/:user_id/carts |
||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||
Permission Scope |
|
updateCartListingQuantity
Method Name | updateCartListingQuantity |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Update a cart listing purchase quantity | ||||||||||||||||||||
HTTP Method | PUT |
||||||||||||||||||||
URI | /users/:user_id/carts |
||||||||||||||||||||
Parameters |
|
||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||
Permission Scope |
|
removeCartListing
Method Name | removeCartListing |
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Remove a listing from a cart | ||||||||||||||||
HTTP Method | DELETE |
||||||||||||||||
URI | /users/:user_id/carts |
||||||||||||||||
Parameters |
|
||||||||||||||||
Requires OAuth | Y |
||||||||||||||||
Permission Scope |
|
getUserCart
Method Name | getUserCart |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Get a cart | ||||||||||||
HTTP Method | GET |
||||||||||||
URI | /users/:user_id/carts/:cart_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|
updateCart
Method Name | updateCart |
||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Update a cart | ||||||||||||||||||||||||||||||||
HTTP Method | PUT |
||||||||||||||||||||||||||||||||
URI | /users/:user_id/carts/:cart_id |
||||||||||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||||||||||
Permission Scope |
|
deleteCart
Method Name | deleteCart |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Delete a cart | ||||||||||||
HTTP Method | DELETE |
||||||||||||
URI | /users/:user_id/carts/:cart_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|
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 |
|
||||||||||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||||||||||
Permission Scope |
|
saveListingForLater
Method Name | saveListingForLater |
||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Move a listing to Saved for Later | ||||||||||||||||||||||||
HTTP Method | DELETE |
||||||||||||||||||||||||
URI | /users/:user_id/carts/save |
||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||
Permission Scope |
|
getUserCartForShop
Method Name | getUserCartForShop |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Get a cart from a shop ID | ||||||||||||
HTTP Method | GET |
||||||||||||
URI | /users/:user_id/carts/shop/:shop_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|
createSingleListingCart
Method Name | createSingleListingCart |
||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Create a single-listing cart from a listing | ||||||||||||||||||||||||
HTTP Method | POST |
||||||||||||||||||||||||
URI | /users/:user_id/carts/single_listing |
||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||
Permission Scope |
|