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
ListingOffering
Overview
A representation of an offering for a listing.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
offering_id |
public |
none | int |
The numeric ID of this offering. |
price |
public |
none | Money |
The price of the product |
quantity |
public |
none | int |
How many of this product are available? |
is_enabled |
private |
|
boolean |
Is the offering shown to buyers? |
is_deleted |
private |
|
boolean |
Has the offering been deleted? |
Associations
This resource has no associations.
Methods
getOffering
Method Name | getOffering |
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Get a specific offering for a listing | ||||||||||||||||
HTTP Method | GET |
||||||||||||||||
URI | /listings/:listing_id/products/:product_id/offerings/:offering_id |
||||||||||||||||
Parameters |
|
||||||||||||||||
Requires OAuth | N |
||||||||||||||||
Permission Scope | none |