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
- FeaturedTreasury
- Feedback
- FeedbackInfo
- ForumPost
- Guest
- GuestCart
- ImageType
- Ledger
- LedgerEntry
- Listing
- ListingFile
- ListingImage
- ListingInventory
- ListingOffering
- ListingProduct
- ListingTranslation
- ListingVariationImage
- Money
- ParamList
- Payment
- PaymentAccountLedgerEntry
- PaymentAdjustment
- PaymentAdjustmentItem
ListingFile
Overview
A file attached to a digital listing.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
listing_file_id |
public |
none | int |
The numeric ID of the listing file. |
listing_id |
public |
none | int |
The numeric ID of the listing the file belongs to. |
rank |
public |
none | int |
Display order. |
filename |
public |
none | string |
The file's displayable name. |
filesize |
public |
none | string |
The file's size in a displayable format. |
size_bytes |
public |
none | int |
The file's size in raw bytes. |
filetype |
public |
none | string |
The file's mimetype. |
create_date |
public |
none | int |
The time when this file was uploaded, in Epoch seconds. |
Associations
This resource has no associations.
Methods
findAllListingFiles
Method Name | findAllListingFiles |
||||||||
---|---|---|---|---|---|---|---|---|---|
Synopsis | Finds all ListingFiles on a Listing | ||||||||
HTTP Method | GET |
||||||||
URI | /listings/:listing_id/files |
||||||||
Parameters |
|
||||||||
Requires OAuth | Y |
||||||||
Permission Scope |
|
uploadListingFile
Method Name | uploadListingFile |
||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Upload a new listing file, or attach an existing file to this listing. You must either provide the listing_file_id of an existing listing file, or the name and file data of a new file that you are uploading. If you are attaching a file to a listing that is currently not digital, the listing will be converted to a digital listing. This will cause the listing to have free shipping and will remove any variations. | ||||||||||||||||||||||||
HTTP Method | POST |
||||||||||||||||||||||||
URI | /listings/:listing_id/files |
||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||
Permission Scope |
|
findListingFile
Method Name | findListingFile |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Finds a ListingFile by ID | ||||||||||||
HTTP Method | GET |
||||||||||||
URI | /listings/:listing_id/files/:listing_file_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|
deleteListingFile
Method Name | deleteListingFile |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Removes the listing file from this listing. If this is the last file on a listing, the listing will no longer be considered a digital listing. | ||||||||||||
HTTP Method | DELETE |
||||||||||||
URI | /listings/:listing_id/files/:listing_file_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|