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
ShopAbout
Overview
Data about a user's shop.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
shop_id |
public |
none | int |
Numeric ID of the shop section. |
status |
public |
none | string |
Status of this data: active or draft. Only Shop owners can see drafts. |
story_headline |
public |
none | string |
ShopAbout headline text |
story_leading_paragraph |
public |
none | string |
The first part of the ShopAbout story |
story |
public |
none | string |
The full ShopAbout story text |
related_links |
public |
none | array(string) |
The ShopAbout related links |
url |
public |
none | string |
URL to the Shop About page on the site. |
Associations
Association | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
Shop |
public |
none |
|
The shop this detail data belongs to |
Members |
public |
none |
|
The ShopAboutMembers of this Shop |
Images |
public |
none |
|
An array of images to be included with ShopAbout details |
Videos |
public |
none |
|
The Shop_AboutVideos of this Shop |
Methods
getShopAbout
Method Name | getShopAbout |
||||||||
---|---|---|---|---|---|---|---|---|---|
Synopsis | Retrieves a ShopAbout object associated to a Shop. | ||||||||
HTTP Method | GET |
||||||||
URI | /shops/:shop_id/about |
||||||||
Parameters |
|
||||||||
Requires OAuth | N |
||||||||
Permission Scope | none |