API Documentation

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
url public none string URL to the Shop About page on the site.

Associations

Association Visibility Level Permission Scope Type Description
Shop public none Shop The shop this detail data belongs to
Members public none array(ShopAboutMember) The ShopAboutMembers of this Shop
Images public none array(ShopAboutImages) An array of images to be included with ShopAbout details
Videos public none array(ShopAboutVideo) 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
Name Required Default Type
shop_id Y   shop_id_or_name
Requires OAuth N
Permission Scope none

Your Developer Account