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
FavoriteListing
Overview
Represents the association between a user and a listing they've marked as favorite.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
listing_id |
public |
none | int |
The listings numeric ID. |
user_id |
public/private |
|
int |
The user's numeric ID. Note: This field may be absent, depending on the user's privacy settings. |
listing_state |
public |
none | string |
The state of the listing. |
create_date |
public |
none | int |
The date and time that the listing was favorited. |
Associations
Association | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
User |
public/private |
|
|
The user who favorited the listing. Note: This field may be absent, depending on the user's privacy settings. |
Listing |
public |
none |
|
The favorited listing. |
Methods
findAllListingFavoredBy
Method Name | findAllListingFavoredBy |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Retrieves a set of FavoriteListing objects associated to a Listing. | ||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||
URI | /listings/:listing_id/favored-by |
||||||||||||||||||||
Parameters |
|
||||||||||||||||||||
Requires OAuth | N |
||||||||||||||||||||
Permission Scope | none |
findAllUserFavoriteListings
Method Name | findAllUserFavoriteListings |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Finds all favorite listings for a user | ||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||
URI | /users/:user_id/favorites/listings |
||||||||||||||||||||
Parameters |
|
||||||||||||||||||||
Requires OAuth | N |
||||||||||||||||||||
Permission Scope | none |
findUserFavoriteListings
Method Name | findUserFavoriteListings |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Finds a favorite listing for a user | ||||||||||||
HTTP Method | GET |
||||||||||||
URI | /users/:user_id/favorites/listings/:listing_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | N |
||||||||||||
Permission Scope | none |
createUserFavoriteListings
Method Name | createUserFavoriteListings |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Creates a new favorite listing for a user | ||||||||||||
HTTP Method | POST |
||||||||||||
URI | /users/:user_id/favorites/listings/:listing_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|
deleteUserFavoriteListings
Method Name | deleteUserFavoriteListings |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Delete a favorite listing for a user | ||||||||||||
HTTP Method | DELETE |
||||||||||||
URI | /users/:user_id/favorites/listings/:listing_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|