Back to top

SocialEngine REST API

What is REST API? Simply, REST API is the set of functions to which the developers can perform requests and receive responses. The interaction is performed via the HTTP/HTTPS protocol. An advantage of such an approach is the wide usage of HTTP/HTTPS that’s why REST API can be used practically for any programming language.

Below are the characteristics of the SocialEngineAddOns REST API:

  • When a request is sent to the REST API server, the server will return a response that contains either the data you requested, or the status code, or both.

  • oauth_consumer_key / oauth_consumer_secret? The Consumer Key and Consumer Secret Key are used to make a connection between API client and server. These keys are also used for creating OAuth Tokens for site members to access server resources without sharing their credentials.

Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
  • oauth_token / oauth_secret? The OAuth Token and OAuth Secret are used for identifying site members.
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478

Base URL

All requests to this REST API should have the base URL: [https://example.com/api/rest/]

HTTP Verbs

In REST API, there are four verbs that are used to manage resources: GET, POST, PUT, and DELETE. You can get the contents of a data using GET, delete the data using DELETE, and create or update the data using POST/PUT.

Supported Features

Official SocialEngine Plugins

  • Blogs Plugin

  • Photo Albums Plugin

  • Classifieds Plugin

  • Groups Plugin

  • Events Plugin

  • Forums Plugin

  • Polls Plugin

  • Video Sharing Plugin

  • Music Sharing Plugin

Core SocialEngine Features

  • Search

  • Member Links

  • Member Log-in

  • Member Sign-up With Profile Fields

  • Edit Member Profile Fields

  • Activity Feeds

  • Notifications

  • Friend Requests

  • Messages

  • Member Settings

  • Likes and Comments

  • Easy Implementation of Photo Lightbox.

  • Footer Menus

SocialEngineAddOns Plugins:

  • Advanced Activity Feeds / Wall Plugin

  • Geo-Location, Geo-Tagging, Check-Ins & Proximity Search Plugin [only for Advanced Activity Feed’s location features]

Stores / Marketplace - Ecommerce

These are the APIs for the SocialEngineAddOns Plugin: Stores / Marketplace - Ecommerce.

Browse Stores

Browse Stores
GET/sitestore{?search}

Get the stores listing. Stores can also be browsed and searched based on keywords, categories, etc.

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of events in response and use page for the page number. [i.e: If you have 100 events and the first request has limit=20 and page=1, then in that case the recent 20 events will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent events will be returned.]

Parameters
HideShow
search
string (optional) Example: search=teacher

get stores that contain this keyword in title or description.

category_id
integer (optional) Example: category_id=13

get all stores of a particular category ID.

orderby
string (optional) Example: orderby=view_count

get most recent stores (orderby=creation_date) or get most viewed stores (orderby=view_count) or get most liked stores (orderby=like_count) or alphabetical (orderby=title) or most reviewed (orderby=review_count) and highest rated (orderby=rating).

show
integer (optional) Example: show=1

get everyone stores (show=1) or get only my friends stores (show=2) or get stores I like (show=4) or featured stores (show=5)

user_id
integer (optional) Example: user_id=125

user id of profile owner. Default value is logged-in user’s ID.

page
integer (optional) Example: page=2

return the ‘limit’ number of stores of that page of store listings.

limit
integer (optional) Example: limit=20

number of stores. Default limit is 20.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalItemCount": 39,
  "canCreate": 1,
  "response": [
    {
      "store_id": 6,
      "title": "Electronic Store",
      "store_url": "electronics",
      "body": "Phones and Laptops",
      "overview": null,
      "owner_id": 35,
      "package_id": 1,
      "category_id": 3,
      "profile_type": 0,
      "photo_id": 79121,
      "price": 0,
      "location": "",
      "creation_date": "2016-07-22 10:56:58",
      "modified_date": "2016-07-22 10:56:59",
      "approved": 1,
      "featured": 0,
      "sponsored": 0,
      "view_count": 6,
      "comment_count": 0,
      "like_count": 2,
      "review_count": 0,
      "foursquare_text": 0,
      "search": 1,
      "closed": 0,
      "declined": 0,
      "pending": 0,
      "aprrove_date": "2016-07-22 10:56:58",
      "draft": 1,
      "subcategory_id": 0,
      "userclaim": 1,
      "offer": 0,
      "email": "",
      "website": "",
      "phone": "",
      "status": "initial",
      "all_post": 1,
      "payment_date": null,
      "expiration_date": "2250-01-01 00:00:00",
      "notes": null,
      "gateway_id": null,
      "gateway_profile_id": null,
      "networks_privacy": null,
      "subsubcategory_id": 0,
      "parent_id": 0,
      "member_title": "",
      "store_cover": 0,
      "follow_count": 0,
      "fbpage_url": null,
      "rating": 0,
      "store_gateway": null,
      "min_shipping_cost": 0,
      "category_title": "Electronics & Appliances",
      "package": "Free Store Package",
      "content_url": "http://example.com/profile/andre",
      "image": "http://example.com/public/sitestore_store/47/37/01/13511_34f0.jpg?c=77d8",
      "image_normal": "http://example.com/public/sitestore_store/49/37/01/13513_a522.jpg?c=f01e",
      "image_profile": "http://example.com/public/sitestore_store/48/37/01/13512_099d.jpg?c=df68",
      "image_icon": "http://example.com/public/sitestore_store/4a/37/01/13514_bc25.jpg?c=d47f",
      "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
      "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
      "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
      "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
      "owner_title": "Andre Holmes",
      "allow_to_view": 1,
      "edit": 0,
      "delete": 0
    },
    {
      "store_id": 5,
      "title": "RayBan Sunglasses",
      "store_url": "ray",
      "body": "RayBan Sunglasses",
      "overview": null,
      "owner_id": 35,
      "package_id": 1,
      "category_id": 2,
      "profile_type": 0,
      "photo_id": 79107,
      "price": 0,
      "location": "",
      "creation_date": "2016-07-22 10:43:12",
      "modified_date": "2016-07-22 10:43:12",
      "approved": 1,
      "featured": 0,
      "sponsored": 0,
      "view_count": 5,
      "comment_count": 0,
      "like_count": 1,
      "review_count": 0,
      "foursquare_text": 0,
      "search": 1,
      "closed": 0,
      "declined": 0,
      "pending": 0,
      "aprrove_date": "2016-07-22 10:43:12",
      "draft": 1,
      "subcategory_id": 0,
      "userclaim": 1,
      "offer": 0,
      "email": "",
      "website": "",
      "phone": "",
      "status": "initial",
      "all_post": 1,
      "payment_date": null,
      "expiration_date": "2250-01-01 00:00:00",
      "notes": null,
      "gateway_id": null,
      "gateway_profile_id": null,
      "networks_privacy": null,
      "subsubcategory_id": 0,
      "parent_id": 0,
      "member_title": "",
      "store_cover": 0,
      "follow_count": 0,
      "fbpage_url": null,
      "rating": 0,
      "store_gateway": null,
      "min_shipping_cost": 0,
      "category_title": "Beauty & Personal Care",
      "package": "Free Store Package",
      "content_url": "http://example.com/profile/admin",
      "image": "http://example.com/public/sitestore_store/39/37/01/13503_0c51.png?c=65db",
      "image_normal": "http://example.com/public/sitestore_store/3b/37/01/13505_9d80.png?c=22d7",
      "image_profile": "http://example.com/public/sitestore_store/3a/37/01/13504_71eb.png?c=40ba",
      "image_icon": "http://example.com/public/sitestore_store/3c/37/01/13506_8c18.png?c=c3c3",
      "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
      "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
      "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
      "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
      "owner_title": "Andre Holmes",
      "allow_to_view": 1,
      "edit": 0,
      "delete": 0
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

My Stores

My Stores
GET/sitestore/manage{?search}

Get the stores of a member. Stores can also be browsed and searched based on keywords, categories, etc.

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of events in response and use page for the page number. [i.e: If you have 100 events and the first request has limit=20 and page=1, then in that case the recent 20 events will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent events will be returned.]

Parameters
HideShow
search
string (optional) Example: search=teacher

get stores that contain this keyword in title or description.

category_id
integer (optional) Example: category_id=13

get all stores of a particular category ID.

orderby
string (optional) Example: orderby=view_count

get most recent stores (orderby=creation_date) or get most viewed stores (orderby=view_count) or get most liked stores (orderby=like_count) or alphabetical (orderby=title) or most reviewed (orderby=review_count) and highest rated (orderby=rating).

show
integer (optional) Example: show=1

get everyone stores (show=1) or get only my friends stores (show=2) or get stores I like (show=4) or featured stores (show=5)

user_id
integer (optional) Example: user_id=125

user id of profile owner. Default value is logged-in user’s ID.

page
integer (optional) Example: page=2

return the ‘limit’ number of stores of that page of store listings.

limit
integer (optional) Example: limit=20

number of stores. Default limit is 20.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalItemCount": 1,
  "canCreate": 1,
  "response": [
    {
      "store_id": 6,
      "title": "Electronic Store",
      "store_url": "electronics",
      "body": "Phones and Laptops",
      "overview": null,
      "owner_id": 35,
      "package_id": 1,
      "category_id": 3,
      "profile_type": 0,
      "photo_id": 79121,
      "price": 0,
      "location": "",
      "creation_date": "2016-07-22 10:56:58",
      "modified_date": "2016-07-22 10:56:59",
      "approved": 1,
      "featured": 0,
      "sponsored": 0,
      "view_count": 6,
      "comment_count": 0,
      "like_count": 2,
      "review_count": 0,
      "foursquare_text": 0,
      "search": 1,
      "closed": 0,
      "declined": 0,
      "pending": 0,
      "aprrove_date": "2016-07-22 10:56:58",
      "draft": 1,
      "subcategory_id": 0,
      "userclaim": 1,
      "offer": 0,
      "email": "",
      "website": "",
      "phone": "",
      "status": "initial",
      "all_post": 1,
      "payment_date": null,
      "expiration_date": "2250-01-01 00:00:00",
      "notes": null,
      "gateway_id": null,
      "gateway_profile_id": null,
      "networks_privacy": null,
      "subsubcategory_id": 0,
      "parent_id": 0,
      "member_title": "",
      "store_cover": 0,
      "follow_count": 0,
      "fbpage_url": null,
      "rating": 0,
      "store_gateway": null,
      "min_shipping_cost": 0,
      "menu": [
        {
          "label": "Close Store",
          "name": "close",
          "url": "sitestore/close/7"
        },
        {
          "label": "Delete Store",
          "name": "delete",
          "url": "sitestore/delete/7"
        }
      ],
      "category_title": "Electronics & Appliances",
      "package": "Free Store Package",
      "content_url": "http://example.com/profile/andre",
      "image": "http://example.com/public/sitestore_store/47/37/01/13511_34f0.jpg?c=77d8",
      "image_normal": "http://example.com/public/sitestore_store/49/37/01/13513_a522.jpg?c=f01e",
      "image_profile": "http://example.com/public/sitestore_store/48/37/01/13512_099d.jpg?c=df68",
      "image_icon": "http://example.com/public/sitestore_store/4a/37/01/13514_bc25.jpg?c=d47f",
      "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
      "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
      "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
      "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
      "owner_title": "Andre Holmes",
      "allow_to_view": 1,
      "edit": 1,
      "delete": 1
    },
    {
      "store_id": 5,
      "title": "RayBan Sunglasses",
      "store_url": "ray",
      "body": "RayBan Sunglasses",
      "overview": null,
      "owner_id": 35,
      "package_id": 1,
      "category_id": 2,
      "profile_type": 0,
      "photo_id": 79107,
      "price": 0,
      "location": "",
      "creation_date": "2016-07-22 10:43:12",
      "modified_date": "2016-07-22 10:43:12",
      "approved": 1,
      "featured": 0,
      "sponsored": 0,
      "view_count": 5,
      "comment_count": 0,
      "like_count": 1,
      "review_count": 0,
      "foursquare_text": 0,
      "search": 1,
      "closed": 0,
      "declined": 0,
      "pending": 0,
      "aprrove_date": "2016-07-22 10:43:12",
      "draft": 1,
      "subcategory_id": 0,
      "userclaim": 1,
      "offer": 0,
      "email": "",
      "website": "",
      "phone": "",
      "status": "initial",
      "all_post": 1,
      "payment_date": null,
      "expiration_date": "2250-01-01 00:00:00",
      "notes": null,
      "gateway_id": null,
      "gateway_profile_id": null,
      "networks_privacy": null,
      "subsubcategory_id": 0,
      "parent_id": 0,
      "member_title": "",
      "store_cover": 0,
      "follow_count": 0,
      "fbpage_url": null,
      "rating": 0,
      "store_gateway": null,
      "min_shipping_cost": 0,
      "menu": [
        {
          "label": "Close Store",
          "name": "close",
          "url": "sitestore/close/7"
        },
        {
          "label": "Delete Store",
          "name": "delete",
          "url": "sitestore/delete/7"
        }
      ],
      "category_title": "Beauty & Personal Care",
      "package": "Free Store Package",
      "content_url": "http://example.com/profile/admin",
      "image": "http://example.com/public/sitestore_store/39/37/01/13503_0c51.png?c=65db",
      "image_normal": "http://example.com/public/sitestore_store/3b/37/01/13505_9d80.png?c=22d7",
      "image_profile": "http://example.com/public/sitestore_store/3a/37/01/13504_71eb.png?c=40ba",
      "image_icon": "http://example.com/public/sitestore_store/3c/37/01/13506_8c18.png?c=c3c3",
      "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
      "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
      "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
      "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
      "owner_title": "Andre Holmes",
      "allow_to_view": 1,
      "edit": 1,
      "delete": 1
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Store Search Form

Store Search Form
GET/sitestore/search-form

Get the store search form.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "type": "select",
    "name": "show",
    "label": "Show",
    "multiOptions": {
      "1": "Everyone's Stores",
      "2": "Only My Friends' Stores",
      "4": "Stores I Like",
      "5": "Featured Stores"
    },
    "value": 1
  },
  {
    "type": "select",
    "name": "orderby",
    "label": "Browse By",
    "multiOptions": {
      "": "",
      "creation_date": "Most Recent",
      "view_count": "Most Viewed",
      "like_count": "Most Liked",
      "title": "Alphabetical",
      "review_count": "Most Reviewed",
      "rating": "Highest Rated"
    }
  },
  {
    "type": "text",
    "name": "search",
    "label": "Search Stores"
  },
  {
    "type": "select",
    "name": "locationmiles",
    "label": "Within Miles",
    "multiOptions": {
      "0": "",
      "1": "1 Mile",
      "2": "2 Miles",
      "5": "5 Miles",
      "10": "10 Miles",
      "20": "20 Miles",
      "50": "50 Miles",
      "100": "100 Miles",
      "250": "250 Miles",
      "500": "500 Miles",
      "750": "750 Miles",
      "1000": "1000 Miles"
    }
  },
  {
    "type": "text",
    "name": "sitestore_country",
    "label": "Country"
  },
  {
    "type": "select",
    "name": "offer_type",
    "label": "Stores With Offers",
    "multiOptions": {
      "": "",
      "all": "All Offers",
      "hot": "Hot Offers",
      "featured": "Featured Offers"
    }
  },
  {
    "label": "Category",
    "type": "select",
    "name": "category_id",
    "multiOptions": [
      "",
      "Clothing, Footwear & Accessories",
      "Beauty & Personal Care",
      "Electronics & Appliances",
      "Mobiles, Tablets & Accessories",
      "Laptops & Accessories",
      "Cameras",
      "Home & Kitchen",
      "Books & Magazines",
      "Music & Movies",
      "Gaming",
      "Software",
      "Baby Care & Toys",
      "Sports & Fitness",
      "Restaurants",
      "Local Business",
      "Others"
    ]
  },
  {
    "type": "checkbox",
    "name": "has_review",
    "label": "Only Stores With Reviews"
  },
  {
    "type": "checkbox",
    "name": "has_photo",
    "label": "Only Stores With Photos"
  },
  {
    "type": "submit",
    "name": "done",
    "label": "Search"
  }
]
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Store Profile

Store Profile
GET/sitestore/view/{store_id}{?gutter_menu}

Get a store post and its gutter menu’s (edit, invite, share, delete) and profile tab’s (update, members, photos)

Parameters
HideShow
store_id
integer (required) Example: store_id=878

store id

gutter_menu
boolean (optional) Example: gutter_menu=1 OR 0

get gutter menu’s array. Default valus is 1.

profile_tabs
boolean (optional) Example: profile_tabs=1 OR 0

get profile tab’s array. Default valus is 1.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "store_id": 6,
  "title": "Electronic Store",
  "store_url": "electronicsss",
  "body": "Phones and Laptops",
  "overview": null,
  "owner_id": 35,
  "package_id": 1,
  "category_id": 3,
  "profile_type": 0,
  "photo_id": 79121,
  "price": 0,
  "location": "",
  "creation_date": "2016-07-22 10:56:58",
  "modified_date": "2016-07-22 10:56:59",
  "approved": 1,
  "featured": 0,
  "sponsored": 0,
  "view_count": 6,
  "comment_count": 0,
  "like_count": 2,
  "review_count": 0,
  "foursquare_text": 0,
  "search": 1,
  "closed": 0,
  "declined": 0,
  "pending": 0,
  "aprrove_date": "2016-07-22 10:56:58",
  "draft": 1,
  "subcategory_id": 0,
  "userclaim": 1,
  "offer": 0,
  "email": "",
  "website": "",
  "phone": "",
  "status": "initial",
  "all_post": 1,
  "payment_date": null,
  "expiration_date": "2250-01-01 00:00:00",
  "notes": null,
  "gateway_id": null,
  "gateway_profile_id": null,
  "networks_privacy": null,
  "subsubcategory_id": 0,
  "parent_id": 0,
  "member_title": "",
  "store_cover": 0,
  "follow_count": 0,
  "fbpage_url": null,
  "rating": 0,
  "store_gateway": null,
  "min_shipping_cost": 0,
  "content_url": "http://example.com/store/electronicsss",
  "image": "http://example.com/public/sitestore_store/47/37/01/13511_34f0.jpg?c=77d8",
  "image_normal": "http://example.com/public/sitestore_store/49/37/01/13513_a522.jpg?c=f01e",
  "image_profile": "http://example.com/public/sitestore_store/48/37/01/13512_099d.jpg?c=df68",
  "image_icon": "http://example.com/public/sitestore_store/4a/37/01/13514_bc25.jpg?c=d47f",
  "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
  "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
  "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
  "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
  "gutterMenu": [
    {
      "name": "Open",
      "label": "Open Store",
      "url": "sitestore/close/6"
    },
    {
      "name": "share",
      "label": "Share This Page",
      "url": "activity/share",
      "urlParams": {
        "type": "sitestore_store",
        "id": 6
      }
    },
    {
      "name": "report",
      "label": "Report This Page",
      "url": "report/create/subject/sitestore_store_6",
      "urlParams": {
        "type": "sitestore_store",
        "id": 6
      }
    }
  ],
  "profileTabs": [
    {
      "label": "Products",
      "name": "products",
      "count": 0,
      "url": "sitestoreproduct/browse/6"
    },
    {
      "label": "Updates",
      "name": "update",
      "count": 0,
      "url": "sitestore/updates/6"
    },
    {
      "label": "Info",
      "name": "information",
      "url": "sitestore/information/6"
    },
    {
      "label": "Overview",
      "name": "overview",
      "url": "sitestore/overview/6"
    },
    {
      "label": "Photos",
      "name": "photos",
      "url": "sitestore/browse6"
    },
    {
      "label": "Reviews",
      "name": "reviews",
      "url": "sitestore/reviews/browse/6"
    },
    {
      "label": "Forum",
      "name": "form",
      "url": "sitestore/form/6"
    },
    {
      "label": "Coupons",
      "name": "coupons",
      "url": "sitestore/offers/browse/6"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Store Information

Store Information
GET/sitestore/information/{store_id}

Get the store’s information.

Parameters
HideShow
store_id
integer (required) Example: store_id=58

get the store information

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
"Basic Information": {
  "Posted": "Jul 22, 2015",
  "Last Updated": "Jul 22, 2015",
  "Views": 436,
  "Likes": 312,
  "Category": "Electronics & Appliances",
  "Tags": " #electronic",
  "Description": "Phones and Laptops"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Open / Close Event

Open / Close Event
POST/sitestore/close/{store_id}

Open / close a store-post. If store is open then it will be close by default and If store is close then it will be open by default, there are no need for extra params.

Parameters
HideShow
store_id
integer (required) Example: 244

store id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Delete Store

Delete Store
DELETE/sitestore/delete/{store_id}

Delete a store.

Parameters
HideShow
store_id
integer (required) Example: store_id=124

store id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Store Overview

Store Overview
GET/sitestore/overview/{store_id}

Get the store’s overview information.

Parameters
HideShow
store_id
integer (required) Example: store_id=58

get the store id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "My World Enterprise is a support services company based in Farington in Lancashire, England. Its core markets are selling electronics products. Please purchase products from us and support. Thanks you !!"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Store Albums

Store Album
GET/sitestore/album/{store_id}

Get the store’s album information.

Parameters
HideShow
store_id
integer (required) Example: store_id=58

get the store id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalItemCount": 1,
  "response": [
    {
      "album_id": 6,
      "store_id": 6,
      "owner_id": 35,
      "order": 0,
      "title": "Electronic Store",
      "search": 1,
      "photo_id": 79121,
      "view_count": 1,
      "comment_count": 0,
      "default_value": 1,
      "like_count": 0,
      "type": null,
      "modified_date": "2016-07-22 10:56:59",
      "creation_date": "2016-07-22 10:56:59",
      "image": "http://example.com/public/sitestore_store/47/37/01/13511_34f0.jpg?c=77d8",
      "image_normal": "http://example.com/public/sitestore_store/49/37/01/13513_a522.jpg?c=f01e",
      "image_profile": "http://example.com/public/sitestore_store/48/37/01/13512_099d.jpg?c=df68",
      "image_icon": "http://example.com/public/sitestore_store/4a/37/01/13514_bc25.jpg?c=d47f",
      "content_url": "http://example.com/stores/album/view/store_id/6/album_id/6/slug/electronic-store",
      "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
      "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
      "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
      "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
      "photoCount": 1
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Stores / Marketplace - Cart

These are the APIs for the SocialEngineAddOns Plugin: Stores / Marketplace - Ecommerce.

Manage Cart

Manage Cart
GET/sitestore/cart

Get the list of products have in cart.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "3": {
    "name": "Puma",
    "link": "http://example.com/mobiledemotesting/store/puma",
    "cartCount": 2,
    "subTotal": 224,
    "products": [
      {
        "title": "puma shoes sneakers",
        "cartproduct_id": 1,
        "image": "http://example.com/public/sitestoreproduct_product/7b/36/01/13446_cf73.JPG?c=54f9",
        "image_normal": "http://example.com/public/sitestoreproduct_product/7d/36/01/13448_cc65.JPG?c=44fc",
        "image_profile": "http://example.com/public/sitestoreproduct_product/7c/36/01/13447_d27d.JPG?c=4c4b",
        "image_icon": "http://example.com/public/sitestoreproduct_product/7f/36/01/1344a_5c7c.JPG?c=a07a",
        "content_url": "http://example.com/stores/product/1/puma-shoes-sneakers",
        "quantity": 2,
        "product_type": "simple",
        "price": 224,
        "downPaymentPrice": 0
      }
    ]
  },
  "7": {
    "name": "Reebock",
    "link": "http://example.com/mobiledemotesting/store/test-store",
    "cartCount": 2,
    "subTotal": 285,
    "products": [
      {
        "title": "Top Configure Product",
        "cartproduct_id": 3,
        "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
        "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
        "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
        "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d",
        "content_url": "http://example.com/stores/product/8/tops-configured",
        "quantity": 1,
        "product_type": "configurable",
        "price": 150,
        "downPaymentPrice": 0,
        "configuration": {
          "color": "black",
          "shipping": "Level_1_4",
          "country": "level_2_5",
          "level_3": "level_3_5",
          "Level_4": "level_4_1",
          "description": "",
          "Anything": "",
          "multicheckbox": "multi_2"
        }
      },
      {
        "title": "Top Configure Product",
        "cartproduct_id": 212,
        "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
        "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
        "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
        "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d",
        "content_url": "http://example.com/stores/product/8/tops-configured",
        "quantity": 1,
        "product_type": "configurable",
        "price": 135,
        "downPaymentPrice": 0,
        "configuration": {
          "color": "black",
          "shipping": "level_1_1",
          "country": "level_2_1",
          "level_3": "level_3_2",
          "Level_4": "level_4_3"
        }
      }
    ]
  },
  "currency": "USD",
  "canApplyCoupon": 1
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Update Cart Quantity

Update Cart Quantity
POST/sitestore/cart/update-quantity

Update a cart quantity

Parameters
HideShow
cartproduct_id
integer (required) Example: cartproduct_id=872

cart product id

quantity
integer (required) Example: quantity=3

new updated quantity

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Delete Cart Product

Delete Cart Product
DELETE/sitestore/cart/delete-product/{cartproduct_id}

Delete added cart product.

Parameters
HideShow
cartproduct_id
integer (required) Example: cartproduct_id=124

cart product id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Apply Discount Coupon

Apply Discount Coupon
POST/sitestore/cart/apply-coupon

Apply discount coupon for store.

Parameters
HideShow
store_id
integer (required) Example: store_id=244

store id

coupon_code
integer (required) Example: coupon_code=dsd@#dsd232D@

coupon code

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "3": {
    "name": "Puma",
    "link": "http://example.com/mobiledemotesting/store/puma",
    "totalProductsCount": 1,
    "subTotal": 112,
    "totalProductsQuantity": 1,
    "products": [
      {
        "title": "puma shoes sneakers",
        "cartproduct_id": 5,
        "image": "http://example.com/public/sitestoreproduct_product/7b/36/01/13446_cf73.JPG?c=54f9",
        "image_normal": "http://example.com/public/sitestoreproduct_product/7d/36/01/13448_cc65.JPG?c=44fc",
        "image_profile": "http://example.com/public/sitestoreproduct_product/7c/36/01/13447_d27d.JPG?c=4c4b",
        "image_icon": "http://example.com/public/sitestoreproduct_product/7f/36/01/1344a_5c7c.JPG?c=a07a",
        "content_url": "http://example.com/stores/product/1/puma-shoes-sneakers",
        "quantity": 1,
        "product_type": "simple",
        "price": 112,
        "downPaymentPrice": 0
      }
    ],
    "coupon": {
      "name": "Discount",
      "value": 11.2,
      "total": 100.8
    }
  },
  "totalItemCount": 1,
  "currency": "USD",
  "canApplyCoupon": 1
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Stores / Marketplace - Checkout

These are the APIs for the SocialEngineAddOns Plugin: Stores / Marketplace - Ecommerce.

Billing / Shipping Address

Get Billing / Shipping Address Form
GET/sitestore/checkout/address

Get the billing and shipping address.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": {
    "billingForm": [
      {
        "name": "f_name_billing",
        "title": "First Name",
        "type": "text"
      },
      {
        "name": "l_name_billing",
        "title": "Last Name",
        "type": "text"
      },
      {
        "name": "phone_billing",
        "title": "Phone Number",
        "type": "text"
      },
      {
        "name": "country_billing",
        "label": "Country",
        "type": "select",
        "multiOptions": {
          "": "Select Country",
          "US": "United States"
        }
      },
      {
        "name": "state_billing",
        "label": "Region / State",
        "type": "select",
        "multiOptions": []
      },
      {
        "name": "city_billing",
        "type": "text",
        "label": "City"
      },
      {
        "name": "locality_billing",
        "type": "text",
        "label": "Locality"
      },
      {
        "name": "zip_billing",
        "type": "text",
        "label": "Zip/Pin Code"
      },
      {
        "name": "address_billing",
        "type": "Textarea",
        "label": "Address"
      }
    ],
    "shippingForm": [
      {
        "name": "f_name_shipping",
        "title": "First Name",
        "type": "text"
      },
      {
        "name": "l_name_shipping",
        "title": "Last Name",
        "type": "text"
      },
      {
        "name": "phone_shipping",
        "title": "Phone Number",
        "type": "text"
      },
      {
        "name": "country_shipping",
        "label": "Country",
        "type": "select",
        "multiOptions": {
          "": "Select Country",
          "US": "United States"
        }
      },
      {
        "name": "state_shipping",
        "label": "Region / State",
        "type": "select",
        "multiOptions": []
      },
      {
        "name": "city_shipping",
        "type": "text",
        "label": "City"
      },
      {
        "name": "locality_shipping",
        "type": "text",
        "label": "Locality"
      },
      {
        "name": "zip_shipping",
        "type": "text",
        "label": "Zip/Pin Code"
      },
      {
        "name": "address_shipping",
        "type": "Textarea",
        "label": "Address"
      }
    ]
  },
  "formValues": {
    "billingAddress": {
      "f_name_billing": null,
      "l_name_billing": null,
      "email_billing": null,
      "phone_billing": null,
      "country_billing": null,
      "state_billing": null,
      "city_billing": null,
      "locality_billing": null,
      "zip_billing": null
    },
    "shippingAddress": {
      "f_name_shipping": null,
      "l_name_shipping": null,
      "email_shipping": null,
      "phone_shipping": null,
      "country_shipping": null,
      "state_shipping": null,
      "city_shipping": null,
      "locality_shipping": null,
      "zip_shipping": null
    }
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Set Billing / Shipping Address Form
POST/sitestore/checkout/address

Save Billing / Shipping address form value for future use.

Parameters
HideShow
f_name_billing
string (optional) Example: f_name_billing=Alen

first name for billing address

l_name_billing
string (optional) Example: l_name_billing=K

last name for billing address

phone_billing
integer (optional) Example: phone_billing=999999999

phone number for billing address

country_billing
string (required) 

country name for billing address

state_billing
integer (optional) Example: state_billing=3

state for billing address

city_billing
string (optional) Example: city_billing=San Diego

city for billing address

locality_billing
string (optional) Example: locality_billing=San Diego

locality for billing address

zip_billing
string (optional) Example: zip_billing=E1202

zip for billing address

address_billing
string (optional) Example: address_billing=150 Linden Street-San Diego California US

. address for billing address

f_name_shipping
string (optional) Example: f_name_shipping=Alen

first name for shipping address

l_name_shipping
string (optional) Example: l_name_shipping=K

last name for shipping address

phone_shipping
integer (optional) Example: phone_shipping=999999999

phone number for shipping address

country_shipping
string (required) 

country name for shipping address

state_shipping
integer (optional) Example: state_shipping=3

state for shipping address

city_shipping
string (optional) Example: city_shipping=San Diego

city for shipping address

locality_shipping
string (optional) Example: locality_shipping=San Diego

locality for shipping address

zip_shipping
string (optional) Example: zip_shipping=E1202

zip for shipping address

address_shipping
string (optional) Example: address_shipping=150 Linden Street-San Diego California US

. address for shipping address

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Get Region / State

Get Region / State
GET/sitestore/checkout/states

Get the Region / State of the country, which selected by user in checkout process.

Parameters
HideShow
store_id
integer (required) Example: store_id=58

store id

country
string (required) Example: country=US

country

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  "--- select ---",
  "Alabama",
  "Alaska",
  "American Samoa",
  "Arizona",
  "Arkansas",
  "Armed Forces Africa",
  "Armed Forces Americas",
  "Armed Forces Canada",
  "Armed Forces Europe",
  "Armed Forces Middle East",
  "Armed Forces Pacific",
  "California",
  "Colorado",
  "Connecticut",
  "Delaware",
  "District of Columbia",
  "Federated States Of Micronesia",
  "Florida",
  "Georgia",
  "Guam",
  "Hawaii",
  "Idaho",
  "Illinois",
  "Indiana",
  "Iowa",
  "Kansas",
  "Kentucky",
  "Louisiana",
  "Maine",
  "Marshall Islands",
  "Maryland",
  "Massachusetts",
  "Michigan",
  "Minnesota",
  "Mississippi",
  "Missouri",
  "Montana",
  "Nebraska",
  "Nevada",
  "New Hampshire",
  "New Jersey",
  "New Mexico",
  "New York",
  "North Carolina",
  "North Dakota",
  "Northern Mariana Islands",
  "Ohio",
  "Oklahoma",
  "Oregon",
  "Palau",
  "Pennsylvania",
  "Puerto Rico",
  "Rhode Island",
  "South Carolina",
  "South Dakota",
  "Tennessee",
  "Texas",
  "Utah",
  "Vermont",
  "Virgin Islands",
  "Virginia",
  "Washington",
  "West Virginia",
  "Wisconsin",
  "Wyoming"
]
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Shipping Methods

Shipping Methods
GET/sitestore/checkout/shipping

Get the enabled shipping methods of store for logged-in user

Parameters
HideShow
store_id
integer (required) Example: store_id=58

store id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "label": "Shipping method",
      "name": "shippingmethod_id",
      "type": "radio",
      "multiOptions": {
        "3": {
          "label": "Free Shipping",
          "description": "2-6 Business Days"
        }
      }
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Payment Method

Payment Method
GET/sitestore/checkout/payment

Get the enabled payment methods of store for logged-in user

Parameters
HideShow
store_id
integer (required) Example: store_id=58

store id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": {
    "type": "checkbox",
    "label": "Select Payment Gateway",
    "name": "payment_gateway",
    "multiOptions": {
      "3": "By Cheque",
      "4": "Cash on delivery"
    }
  },
  "chequeForm": [
    {
      "type": "text",
      "name": "cheque_number",
      "label": "Cheque No. / Ref. No."
    },
    {
      "type": "text",
      "name": "cheque_name",
      "label": "Account Holder Name"
    },
    {
      "type": "text",
      "name": "cheque_account_number",
      "label": "Account Number"
    },
    {
      "type": "text",
      "name": "cheque_routing_number",
      "label": "Bank Routing Number"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Order Review / Place Order

Order Review
GET/sitestore/checkout/validating-order

Get the order review

Parameters
HideShow
store_id
integer (required) Example: store_id=58

store id

shippingmethod_id
integer (required) Example: shippingmethod_id=3

selected shipping method id

payment_id
integer (required) Example: payment_id=3

selected payment gateway id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalProductQuantity": 1,
  "totalProductCount": 1,
  "currency": "US",
  "products": [
    {
      "product_name": "puma shoes sneakers",
      "cartproduct_id": 5,
      "quantity": 1,
      "product_type": "simple",
      "price": 112,
      "subTotal": 112,
      "tax": 0,
      "tax_detail": []
    }
  ],
  "shipping": {
    "label": "",
    "value": ""
  },
  "tax": "0",
  "coupon": {
    "label": "",
    "value": ""
  },
  "total": "112.00",
  "grandTotal": "112.00",
  "form": [
    {
      "name": "is_private_order",
      "label": "Make my purchase private.",
      "type": "checkbox"
    },
    {
      "name": "order_note",
      "label": "Write a note for your order from this Store.",
      "type": "text"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Place Order
POST/sitestore/checkout/validating-order

Place order

Parameters
HideShow
store_id
integer (required) Example: store_id=58

store id

shippingmethod_id
integer (required) Example: shippingmethod_id=3

selected shipping method id

payment_id
integer (required) Example: payment_id=3

selected payment gateway id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Stores / Marketplace - Manage Orders

These are the APIs for the SocialEngineAddOns Plugin: Stores / Marketplace - Ecommerce.

Manage Orders

Manage Orders
GET/sitestore/orders

Get the manage orders page respect to the user.

Parameters
HideShow
store_id
integer (required) Example: store_id=58

store id

shippingmethod_id
integer (required) Example: shippingmethod_id=87

selected shipping method id

payment_id
string (required) Example: payment_id=7

selected payment id

coupon_code
string (optional) Example: coupon_code=j32%3@3$5

entered coupon code

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalItemCount": 1,
  "currency": "US",
  "orders": [
    {
      "order_id": 1,
      "billing_name": "",
      "shipping_name": "",
      "creation_date": "2016-07-22 10:56:58",
      "qty": 1,
      "order_total": "0.00",
      "order_status": "Payment Pending",
      "payment_status": "No",
      "delivery_time": "-",
      "options": [
        {
          "name": "view",
          "label": "View",
          "url": "sitestore/order/view/1"
        }
      ]
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Order Profile

Order Profile
GET/sitestore/orders/view/

Get the complete information of the order.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "currency": "Us",
  "order": {
    "order_date": "2016-08-04 11:00:26",
    "order_status": "Payment Pending",
    "tax_amount": "0.00",
    "shipping_amount": "0.00",
    "delivery_time": "-",
    "ip_address": "14.141.112.75",
    "label": "Order Information"
  },
  "billing_address": {
    "label": "Name & Billing Address",
    "name": "Alen K",
    "address": "150 Linden Street-San Diego California US",
    "state": "California",
    "city": "San Diego",
    "zip": "E1202",
    "phone": "999999999"
  },
  "shipping_address": {
    "label": "Shipping Information",
    "name": "Alen K",
    "address": "150 Linden Street-San Diego California US",
    "state": "California",
    "city": "San Diego",
    "zip": "E1202",
    "phone": "999999999"
  },
  "shipping_mathod": "Free Shipping",
  "payment": {
    "label": "Payment Information",
    "payment_method": "Cash On Delivery"
  },
  "order_detail": {
    "totalItemCount": 1,
    "products": [
      {
        "product_title": "puma shoes sneakers",
        "product_sku": "puma-shoes-sneakers",
        "quantity": 1,
        "tax_amount": "0.00",
        "sub_total": "112.00"
      }
    ]
  },
  "order_summary": {
    "label": "Order Summary",
    "sub_total": "112.00",
    "shipping_cost": "0.00",
    "taxes": "0.00",
    "grand_total": "112.00"
  },
  "comments": {
    "buyerComments": {
      "totalItemCount": 0
    },
    "sellerComments": {
      "totalItemCount": 0
    },
    "siteAdminComments": {
      "totalItemCount": 0
    }
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Buyer Comments

Get Comment Form
GET/sitestore/orders/comment/

Get buyer comments form

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": {
    "name": "commentText",
    "type": "text",
    "label": "Add a comment"
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Post Comment
POST/sitestore/orders/comment/

Post comment on order

Parameters
HideShow
commentText
string (required) Example: commentText=Please ship my product!

comment entered by buyer

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Shipping Information

Shipping Information
GET/sitestore/orders/order-ship/

Get the shipping information respect to the order.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalItemCount": 1,
  "shipment_tracking": {
    "service": null,
    "title": "E827UEY23JD2MD",
    "tracking_number": "E827UEY23JD2MD",
    "date": "2016-08-05 06:53:39",
    "status": "Active",
    "note": "Please contact us, If get any problem there!!"
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Re-Order

Re-Order
POST/sitestore/orders/reorder/{order_id}

Re-order the order. It will add all the products of the order in to the cart.

Parameters
HideShow
order_id
integer (required) Example: order_id=736

order id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "3": {
    "name": "Puma",
    "link": "http://example.com/mobiledemotesting/store/puma",
    "cartCount": 2,
    "subTotal": 224,
    "products": [
      {
        "title": "puma shoes sneakers",
        "cartproduct_id": 1,
        "image": "http://example.com/public/sitestoreproduct_product/7b/36/01/13446_cf73.JPG?c=54f9",
        "image_normal": "http://example.com/public/sitestoreproduct_product/7d/36/01/13448_cc65.JPG?c=44fc",
        "image_profile": "http://example.com/public/sitestoreproduct_product/7c/36/01/13447_d27d.JPG?c=4c4b",
        "image_icon": "http://example.com/public/sitestoreproduct_product/7f/36/01/1344a_5c7c.JPG?c=a07a",
        "content_url": "http://example.com/stores/product/1/puma-shoes-sneakers",
        "quantity": 2,
        "product_type": "simple",
        "price": 224,
        "downPaymentPrice": 0
      }
    ]
  },
  "7": {
    "name": "Reebock",
    "link": "http://example.com/mobiledemotesting/store/test-store",
    "cartCount": 2,
    "subTotal": 285,
    "products": [
      {
        "title": "Top Configure Product",
        "cartproduct_id": 3,
        "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
        "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
        "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
        "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d",
        "content_url": "http://example.com/stores/product/8/tops-configured",
        "quantity": 1,
        "product_type": "configurable",
        "price": 150,
        "downPaymentPrice": 0,
        "configuration": {
          "color": "black",
          "shipping": "Level_1_4",
          "country": "level_2_5",
          "level_3": "level_3_5",
          "Level_4": "level_4_1",
          "description": "",
          "Anything": "",
          "multicheckbox": "multi_2"
        }
      },
      {
        "title": "Top Configure Product",
        "cartproduct_id": 212,
        "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
        "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
        "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
        "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d",
        "content_url": "http://example.com/stores/product/8/tops-configured",
        "quantity": 1,
        "product_type": "configurable",
        "price": 135,
        "downPaymentPrice": 0,
        "configuration": {
          "color": "black",
          "shipping": "level_1_1",
          "country": "level_2_1",
          "level_3": "level_3_2",
          "Level_4": "level_4_3"
        }
      }
    ]
  },
  "currency": "USD",
  "canApplyCoupon": 1
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Stores / Marketplace - Products

These are the APIs for the SocialEngineAddOns Plugin: Stores / Marketplace - Ecommerce.

Browse Products

Browse Products
GET/sitestore/products{?search}

Get the stores listing. Stores can also be browsed and searched based on keywords, categories, etc.

In case of discount, we have some parameters to show discount on a product. Please check all of them following:

discount: check discount applied or not on the product.

discount_start_date: discount started from.

discount_permanant: discount_permanant=0, discount have end date OR discount_permanant=1 discount will apply on the product forever.

discount_end_date: discount end date in case of discount_permanant=0.

user_type: user_type=0 everyone allow for discount OR user_type=1 public level allow for discount OR user_type=2 all registered members allow for this discount.

handling_type: handling_type=0 discount value calculate as fix amount OR handling_type=1 discount value calculate in percentage.

discount_value: show how much discount entered by product owner on the bases of handling_type.

discount_amount: show discounted amount(calculate from the product price on the bases of above cases)

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of events in response and use page for the page number. [i.e: If you have 100 events and the first request has limit=20 and page=1, then in that case the recent 20 events will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent events will be returned.]

Parameters
HideShow
search
string (optional) Example: search=teacher

get stores that contain this keyword in title or description.

category_id
integer (optional) Example: category_id=13

get all stores of a particular category ID.

orderby
string (optional) Example: orderby=view_count

get product in the order of price low to high (orderby=price_low_to_high) or get product in the order of price high to low (orderby=price_high_to_low) or most discounted products (orderby=discount_amount) or get product alphabetic (orderby=title) or get most recent products (orderby=product_id) or get most viewed products (orderby=view_count) or get most liked products (orderby=like_count) or get most commented products (orderby=comment_count) or get most reviewed products (orderby=review_count) or get most rated products (orderby=rating_avg)

user_id
integer (optional) Example: user_id=125

user id of profile owner. Default value is logged-in user’s ID.

page
integer (optional) Example: page=2

return the ‘limit’ number of stores of that page of store listings.

limit
integer (optional) Example: limit=20

number of stores. Default limit is 20.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "currency": "USD",
    "totalItemCount": 7,
    "response": [
      {
        "product_id": 8,
        "title": "Tops Configured",
        "body": "classic product",
        "owner_id": 18787,
        "store_id": 7,
        "profile_type": 3,
        "photo_id": 79655,
        "section_id": 0,
        "category_id": 55,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "creation_date": "2016-08-02 10:15:37",
        "modified_date": "2016-08-02 10:15:37",
        "start_date": "2016-08-01 18:30:00",
        "end_date": null,
        "end_date_enable": 0,
        "approved": 1,
        "featured": 0,
        "sponsored": 0,
        "newlabel": 0,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "price": 123,
        "review_count": 0,
        "view_count": 8,
        "comment_count": 0,
        "like_count": 0,
        "search": 1,
        "closed": 0,
        "approved_date": "2016-08-02 10:15:37",
        "draft": 0,
        "main_video": "",
        "video_snapshot_id": 0,
        "networks_privacy": null,
        "product_code": "topsconfig",
        "product_type": "configurable",
        "weight": 100,
        "stock_unlimited": 1,
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "user_tax": null,
        "highlighted": 0,
        "allow_purchase": 1,
        "location": null,
        "discount": 1,
        "discount_start_date": "2016-08-24 00:00:00",
        "discount_end_date": "2016-09-05 00:00:00",
        "discount_permanant": 1,
        "user_type": 0,
        "handling_type": 1,
        "discount_value": 10,
        "discount_amount": 12.3,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
        "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
        "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
        "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d",
        "content_url": "http://example.com/stores/product/8/tops-configured",
        "owner_image": "http://example.com/public/album_photo/47/39/01/1370f_59c7.jpg?c=d296",
        "owner_image_normal": "http://example.com/public/album_photo/48/39/01/13710_409e.jpg?c=93a5",
        "owner_image_profile": "http://example.com/public/album_photo/47/39/01/1370f_59c7.jpg?c=d296",
        "owner_image_icon": "http://example.com/public/album_photo/4a/39/01/13712_0d8e.jpg?c=d792",
        "wishlist": [
          {
            "3": "My Wishlist",
            "9": "My Favorite"
          }
        ]
        "menu": [
          {
            "label": "Add to Wishlist",
            "name": "wishlist",
            "url": "sitestore/product/add-to-wishlist/7/8"
          },
          {
            "name": "messageowner",
            "label": "Message Owner",
            "url": "sitestore/product/messageowner/7/8"
          },
          {
            "name": "share",
            "label": "Share This Product",
            "url": "activity/share",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 8
            }
          },
          {
            "name": "report",
            "label": "Report This Product",
            "url": "report/create/subject/sitestoreproduct_product_8",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 8
            }
          },
          {
            "name": "tellafriend",
            "label": "Tell a Friend",
            "url": "sitestore/product/tellafriend/7/8"
          },
          {
            "name": "askopinion",
            "label": "Ask For Opinion",
            "url": "sitestore/product/askopinion/7/8"
          }
        ],
        "owner_title": "Alen J",
        "tags": "madame",
        "allow_to_view": 1,
        "is_liked": 0,
        "is_followed": 0,
        "edit": 1,
        "delete": 1
      },
      {
        "product_id": 7,
        "title": "Enrique ",
        "body": "Music",
        "owner_id": 35,
        "store_id": 5,
        "profile_type": 11,
        "photo_id": 79130,
        "section_id": 0,
        "category_id": 151,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "creation_date": "2016-07-22 11:00:30",
        "modified_date": "2016-07-22 11:00:30",
        "start_date": "2016-07-22 07:00:00",
        "end_date": null,
        "end_date_enable": 0,
        "approved": 1,
        "featured": 0,
        "sponsored": 0,
        "newlabel": 0,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "price": 456,
        "review_count": 4,
        "view_count": 6,
        "comment_count": 0,
        "like_count": 0,
        "search": 1,
        "closed": 0,
        "approved_date": "2016-07-22 11:00:30",
        "draft": 0,
        "main_video": "",
        "video_snapshot_id": 0,
        "networks_privacy": null,
        "product_code": 322,
        "product_type": "downloadable",
        "weight": 0,
        "stock_unlimited": 1,
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "user_tax": null,
        "highlighted": 0,
        "allow_purchase": 1,
        "location": null,
        "discount": 1,
        "discount_start_date": "2016-08-16 00:00:00",
        "discount_end_date": "2016-09-05 00:00:00",
        "discount_permanant": 0,
        "user_type": 1,
        "handling_type": 0,
        "discount_value": 100,
        "discount_amount": 100,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/50/37/01/1351a_3f4c.jpg?c=5903",
        "image_normal": "http://example.com/public/sitestoreproduct_product/52/37/01/1351c_94bf.jpg?c=72bc",
        "image_profile": "http://example.com/public/sitestoreproduct_product/51/37/01/1351b_dfb5.jpg?c=365f",
        "image_icon": "http://example.com/public/sitestoreproduct_product/54/37/01/1351e_d604.jpg?c=722e",
        "content_url": "http://example.com/stores/product/7/enrique",
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
        "menu": [
          {
            "label": "Add to Wishlist",
            "name": "wishlist",
            "url": "sitestore/product/add-to-wishlist/5/7"
          },
          {
            "name": "messageowner",
            "label": "Message Owner",
            "url": "sitestore/product/messageowner/5/7"
          },
          {
            "name": "share",
            "label": "Share This Product",
            "url": "activity/share",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 7
            }
          },
          {
            "name": "report",
            "label": "Report This Product",
            "url": "report/create/subject/sitestoreproduct_product_7",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 7
            }
          },
          {
            "name": "tellafriend",
            "label": "Tell a Friend",
            "url": "sitestore/product/tellafriend/5/7"
          },
          {
            "name": "askopinion",
            "label": "Ask For Opinion",
            "url": "sitestore/product/askopinion/5/7"
          }
        ],
        "owner_title": "Andre Holmes",
        "allow_to_view": 1,
        "is_liked": 0,
        "is_followed": 0,
        "edit": 0,
        "delete": 0
      },
    ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Manage Products

Manage Products
GET/sitestore/product/manage/{store_id}{?search}

Get the stores listing. Stores can also be browsed and searched based on keywords, categories, etc.

In case of discount, we have some parameters to show discount on a product. Please check all of them following:

discount: check discount applied or not on the product.

discount_start_date: discount started from.

discount_permanant: discount_permanant=0, discount have end date OR discount_permanant=1 discount will apply on the product forever.

discount_end_date: discount end date in case of discount_permanant=0.

user_type: user_type=0 everyone allow for discount OR user_type=1 public level allow for discount OR user_type=2 all registered members allow for this discount.

handling_type: handling_type=0 discount value calculate as fix amount OR handling_type=1 discount value calculate in percentage.

discount_value: show how much discount entered by product owner on the bases of handling_type.

discount_amount: show discounted amount(calculate from the product price on the bases of above cases)

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of events in response and use page for the page number. [i.e: If you have 100 events and the first request has limit=20 and page=1, then in that case the recent 20 events will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent events will be returned.]

Parameters
HideShow
store_id
integer (required) Example: store_id=234

store id

search
string (optional) Example: search=teacher

get stores that contain this keyword in title or description.

category_id
integer (optional) Example: category_id=13

get all stores of a particular category ID.

orderby
string (optional) Example: orderby=view_count

get product in the order of price low to high (orderby=price_low_to_high) or get product in the order of price high to low (orderby=price_high_to_low) or most discounted products (orderby=discount_amount) or get product alphabetic (orderby=title) or get most recent products (orderby=product_id) or get most viewed products (orderby=view_count) or get most liked products (orderby=like_count) or get most commented products (orderby=comment_count) or get most reviewed products (orderby=review_count) or get most rated products (orderby=rating_avg)

user_id
integer (optional) Example: user_id=125

user id of profile owner. Default value is logged-in user’s ID.

page
integer (optional) Example: page=2

return the ‘limit’ number of stores of that page of store listings.

limit
integer (optional) Example: limit=20

number of stores. Default limit is 20.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "currency": "USD",
    "totalItemCount": 7,
    "response": [
      {
        "product_id": 8,
        "title": "Tops Configured",
        "body": "classic product",
        "owner_id": 18787,
        "store_id": 7,
        "profile_type": 3,
        "photo_id": 79655,
        "section_id": 0,
        "category_id": 55,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "creation_date": "2016-08-02 10:15:37",
        "modified_date": "2016-08-02 10:15:37",
        "start_date": "2016-08-01 18:30:00",
        "end_date": null,
        "end_date_enable": 0,
        "approved": 1,
        "featured": 0,
        "sponsored": 0,
        "newlabel": 0,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "price": 123,
        "review_count": 0,
        "view_count": 8,
        "comment_count": 0,
        "like_count": 0,
        "search": 1,
        "closed": 0,
        "approved_date": "2016-08-02 10:15:37",
        "draft": 0,
        "main_video": "",
        "video_snapshot_id": 0,
        "networks_privacy": null,
        "product_code": "topsconfig",
        "product_type": "configurable",
        "weight": 100,
        "stock_unlimited": 1,
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "user_tax": null,
        "highlighted": 0,
        "allow_purchase": 1,
        "location": null,
        "discount": 1,
        "discount_start_date": "2016-08-24 00:00:00",
        "discount_end_date": "2016-09-05 00:00:00",
        "discount_permanant": 1,
        "user_type": 0,
        "handling_type": 1,
        "discount_value": 10,
        "discount_amount": 12.3,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
        "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
        "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
        "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d",
        "content_url": "http://example.com/stores/product/8/tops-configured",
        "owner_image": "http://example.com/public/album_photo/47/39/01/1370f_59c7.jpg?c=d296",
        "owner_image_normal": "http://example.com/public/album_photo/48/39/01/13710_409e.jpg?c=93a5",
        "owner_image_profile": "http://example.com/public/album_photo/47/39/01/1370f_59c7.jpg?c=d296",
        "owner_image_icon": "http://example.com/public/album_photo/4a/39/01/13712_0d8e.jpg?c=d792",
        "wishlist": [
          {
            "3": "My Wishlist",
            "9": "My Favorite"
          }
        ]
        "menu": [
          {
            "label": "Add to Wishlist",
            "name": "wishlist",
            "url": "sitestore/product/add-to-wishlist/7/8"
          },
          {
            "name": "messageowner",
            "label": "Message Owner",
            "url": "sitestore/product/messageowner/7/8"
          },
          {
            "name": "share",
            "label": "Share This Product",
            "url": "activity/share",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 8
            }
          },
          {
            "name": "report",
            "label": "Report This Product",
            "url": "report/create/subject/sitestoreproduct_product_8",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 8
            }
          },
          {
            "name": "tellafriend",
            "label": "Tell a Friend",
            "url": "sitestore/product/tellafriend/7/8"
          },
          {
            "name": "askopinion",
            "label": "Ask For Opinion",
            "url": "sitestore/product/askopinion/7/8"
          }
        ],
        "owner_title": "Alen J",
        "tags": "madame",
        "allow_to_view": 1,
        "is_liked": 0,
        "is_followed": 0,
        "edit": 1,
        "delete": 1
      },
      {
        "product_id": 7,
        "title": "Enrique ",
        "body": "Music",
        "owner_id": 35,
        "store_id": 5,
        "profile_type": 11,
        "photo_id": 79130,
        "section_id": 0,
        "category_id": 151,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "creation_date": "2016-07-22 11:00:30",
        "modified_date": "2016-07-22 11:00:30",
        "start_date": "2016-07-22 07:00:00",
        "end_date": null,
        "end_date_enable": 0,
        "approved": 1,
        "featured": 0,
        "sponsored": 0,
        "newlabel": 0,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "price": 456,
        "review_count": 4,
        "view_count": 6,
        "comment_count": 0,
        "like_count": 0,
        "search": 1,
        "closed": 0,
        "approved_date": "2016-07-22 11:00:30",
        "draft": 0,
        "main_video": "",
        "video_snapshot_id": 0,
        "networks_privacy": null,
        "product_code": 322,
        "product_type": "downloadable",
        "weight": 0,
        "stock_unlimited": 1,
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "user_tax": null,
        "highlighted": 0,
        "allow_purchase": 1,
        "location": null,
        "discount": 1,
        "discount_start_date": "2016-08-16 00:00:00",
        "discount_end_date": "2016-09-05 00:00:00",
        "discount_permanant": 0,
        "user_type": 1,
        "handling_type": 0,
        "discount_value": 100,
        "discount_amount": 100,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/50/37/01/1351a_3f4c.jpg?c=5903",
        "image_normal": "http://example.com/public/sitestoreproduct_product/52/37/01/1351c_94bf.jpg?c=72bc",
        "image_profile": "http://example.com/public/sitestoreproduct_product/51/37/01/1351b_dfb5.jpg?c=365f",
        "image_icon": "http://example.com/public/sitestoreproduct_product/54/37/01/1351e_d604.jpg?c=722e",
        "content_url": "http://example.com/stores/product/7/enrique",
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
        "menu": [
          {
            "label": "Add to Wishlist",
            "name": "wishlist",
            "url": "sitestore/product/add-to-wishlist/5/7"
          },
          {
            "name": "messageowner",
            "label": "Message Owner",
            "url": "sitestore/product/messageowner/5/7"
          },
          {
            "name": "share",
            "label": "Share This Product",
            "url": "activity/share",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 7
            }
          },
          {
            "name": "report",
            "label": "Report This Product",
            "url": "report/create/subject/sitestoreproduct_product_7",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 7
            }
          },
          {
            "name": "tellafriend",
            "label": "Tell a Friend",
            "url": "sitestore/product/tellafriend/5/7"
          },
          {
            "name": "askopinion",
            "label": "Ask For Opinion",
            "url": "sitestore/product/askopinion/5/7"
          }
        ],
        "owner_title": "Andre Holmes",
        "allow_to_view": 1,
        "is_liked": 0,
        "is_followed": 0,
        "edit": 0,
        "delete": 0
      },
    ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Store Products

Store Products
GET/sitestore/products/{store_id}{?search}

Get the stores listing. Stores can also be browsed and searched based on keywords, categories, etc.

In case of discount, we have some parameters to show discount on a product. Please check all of them following:

discount: check discount applied or not on the product.

discount_start_date: discount started from.

discount_permanant: discount_permanant=0, discount have end date OR discount_permanant=1 discount will apply on the product forever.

discount_end_date: discount end date in case of discount_permanant=0.

user_type: user_type=0 everyone allow for discount OR user_type=1 public level allow for discount OR user_type=2 all registered members allow for this discount.

handling_type: handling_type=0 discount value calculate as fix amount OR handling_type=1 discount value calculate in percentage.

discount_value: show how much discount entered by product owner on the bases of handling_type.

discount_amount: show discounted amount(calculate from the product price on the bases of above cases)

In case of pagination, we need to use 2 parameters limit and page. Use limit to set the number of events in response and use page for the page number. [i.e: If you have 100 events and the first request has limit=20 and page=1, then in that case the recent 20 events will be returned in response, and if limit=20 and page=2 is sent in request, then the next 20 recent events will be returned.]

Parameters
HideShow
store_id
integer (required) Example: store_id=234

store id

search
string (optional) Example: search=teacher

get stores that contain this keyword in title or description.

category_id
integer (optional) Example: category_id=13

get all stores of a particular category ID.

orderby
string (optional) Example: orderby=view_count

get product in the order of price low to high (orderby=price_low_to_high) or get product in the order of price high to low (orderby=price_high_to_low) or most discounted products (orderby=discount_amount) or get product alphabetic (orderby=title) or get most recent products (orderby=product_id) or get most viewed products (orderby=view_count) or get most liked products (orderby=like_count) or get most commented products (orderby=comment_count) or get most reviewed products (orderby=review_count) or get most rated products (orderby=rating_avg)

user_id
integer (optional) Example: user_id=125

user id of profile owner. Default value is logged-in user’s ID.

page
integer (optional) Example: page=2

return the ‘limit’ number of stores of that page of store listings.

limit
integer (optional) Example: limit=20

number of stores. Default limit is 20.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "currency": "USD",
    "totalItemCount": 7,
    "response": [
      {
        "product_id": 8,
        "title": "Tops Configured",
        "body": "classic product",
        "owner_id": 18787,
        "store_id": 7,
        "profile_type": 3,
        "photo_id": 79655,
        "section_id": 0,
        "category_id": 55,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "creation_date": "2016-08-02 10:15:37",
        "modified_date": "2016-08-02 10:15:37",
        "start_date": "2016-08-01 18:30:00",
        "end_date": null,
        "end_date_enable": 0,
        "approved": 1,
        "featured": 0,
        "sponsored": 0,
        "newlabel": 0,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "price": 123,
        "review_count": 0,
        "view_count": 8,
        "comment_count": 0,
        "like_count": 0,
        "search": 1,
        "closed": 0,
        "approved_date": "2016-08-02 10:15:37",
        "draft": 0,
        "main_video": "",
        "video_snapshot_id": 0,
        "networks_privacy": null,
        "product_code": "topsconfig",
        "product_type": "configurable",
        "weight": 100,
        "stock_unlimited": 1,
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "user_tax": null,
        "highlighted": 0,
        "allow_purchase": 1,
        "location": null,
        "discount": 1,
        "discount_start_date": "2016-08-24 00:00:00",
        "discount_end_date": "2016-09-05 00:00:00",
        "discount_permanant": 1,
        "user_type": 0,
        "handling_type": 1,
        "discount_value": 10,
        "discount_amount": 12.3,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
        "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
        "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
        "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d",
        "content_url": "http://example.com/stores/product/8/tops-configured",
        "owner_image": "http://example.com/public/album_photo/47/39/01/1370f_59c7.jpg?c=d296",
        "owner_image_normal": "http://example.com/public/album_photo/48/39/01/13710_409e.jpg?c=93a5",
        "owner_image_profile": "http://example.com/public/album_photo/47/39/01/1370f_59c7.jpg?c=d296",
        "owner_image_icon": "http://example.com/public/album_photo/4a/39/01/13712_0d8e.jpg?c=d792",
        "wishlist": [
          {
            "3": "My Wishlist",
            "9": "My Favorite"
          }
        ]
        "menu": [
          {
            "label": "Add to Wishlist",
            "name": "wishlist",
            "url": "sitestore/product/add-to-wishlist/7/8"
          },
          {
            "name": "messageowner",
            "label": "Message Owner",
            "url": "sitestore/product/messageowner/7/8"
          },
          {
            "name": "share",
            "label": "Share This Product",
            "url": "activity/share",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 8
            }
          },
          {
            "name": "report",
            "label": "Report This Product",
            "url": "report/create/subject/sitestoreproduct_product_8",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 8
            }
          },
          {
            "name": "tellafriend",
            "label": "Tell a Friend",
            "url": "sitestore/product/tellafriend/7/8"
          },
          {
            "name": "askopinion",
            "label": "Ask For Opinion",
            "url": "sitestore/product/askopinion/7/8"
          }
        ],
        "owner_title": "Alen J",
        "tags": "madame",
        "allow_to_view": 1,
        "is_liked": 0,
        "is_followed": 0,
        "edit": 1,
        "delete": 1
      },
      {
        "product_id": 7,
        "title": "Enrique ",
        "body": "Music",
        "owner_id": 35,
        "store_id": 5,
        "profile_type": 11,
        "photo_id": 79130,
        "section_id": 0,
        "category_id": 151,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "creation_date": "2016-07-22 11:00:30",
        "modified_date": "2016-07-22 11:00:30",
        "start_date": "2016-07-22 07:00:00",
        "end_date": null,
        "end_date_enable": 0,
        "approved": 1,
        "featured": 0,
        "sponsored": 0,
        "newlabel": 0,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "price": 456,
        "review_count": 4,
        "view_count": 6,
        "comment_count": 0,
        "like_count": 0,
        "search": 1,
        "closed": 0,
        "approved_date": "2016-07-22 11:00:30",
        "draft": 0,
        "main_video": "",
        "video_snapshot_id": 0,
        "networks_privacy": null,
        "product_code": 322,
        "product_type": "downloadable",
        "weight": 0,
        "stock_unlimited": 1,
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "user_tax": null,
        "highlighted": 0,
        "allow_purchase": 1,
        "location": null,
        "discount": 1,
        "discount_start_date": "2016-08-16 00:00:00",
        "discount_end_date": "2016-09-05 00:00:00",
        "discount_permanant": 0,
        "user_type": 1,
        "handling_type": 0,
        "discount_value": 100,
        "discount_amount": 100,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/50/37/01/1351a_3f4c.jpg?c=5903",
        "image_normal": "http://example.com/public/sitestoreproduct_product/52/37/01/1351c_94bf.jpg?c=72bc",
        "image_profile": "http://example.com/public/sitestoreproduct_product/51/37/01/1351b_dfb5.jpg?c=365f",
        "image_icon": "http://example.com/public/sitestoreproduct_product/54/37/01/1351e_d604.jpg?c=722e",
        "content_url": "http://example.com/stores/product/7/enrique",
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
        "menu": [
          {
            "label": "Add to Wishlist",
            "name": "wishlist",
            "url": "sitestore/product/add-to-wishlist/5/7"
          },
          {
            "name": "messageowner",
            "label": "Message Owner",
            "url": "sitestore/product/messageowner/5/7"
          },
          {
            "name": "share",
            "label": "Share This Product",
            "url": "activity/share",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 7
            }
          },
          {
            "name": "report",
            "label": "Report This Product",
            "url": "report/create/subject/sitestoreproduct_product_7",
            "urlParams": {
              "type": "sitestoreproduct_product",
              "id": 7
            }
          },
          {
            "name": "tellafriend",
            "label": "Tell a Friend",
            "url": "sitestore/product/tellafriend/5/7"
          },
          {
            "name": "askopinion",
            "label": "Ask For Opinion",
            "url": "sitestore/product/askopinion/5/7"
          }
        ],
        "owner_title": "Andre Holmes",
        "allow_to_view": 1,
        "is_liked": 0,
        "is_followed": 0,
        "edit": 0,
        "delete": 0
      },
    ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Product Search Form

Product Search Form
GET/sitestore/products/search-form

Get the store search form.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "name": "search",
    "type": "text",
    "label": "Search :"
  },
  {
    "name": "orderby",
    "label": "Browse by",
    "type": "select",
    "multiOptions": {
      "": "",
      "price_low_to_high": "Price low to high",
      "price_high_to_low": "Price high to low",
      "discount_amount": "Most Discounted",
      "title": "Alphabetic",
      "product_id": "Most Recent",
      "view_count": "Most Viewed",
      "like_count": "Most Liked",
      "comment_count": "Most Commented",
      "review_count": "Most Reviewed",
      "rating_avg": "Most Rated"
    }
  },
  {
    "name": "sitestoreproduct_street",
    "label": "Street",
    "type": "text"
  },
  {
    "name": "sitestoreproduct_city",
    "label": "City",
    "type": "text"
  },
  {
    "name": "state",
    "label": "State",
    "type": "text"
  },
  {
    "name": "country",
    "label": "Country",
    "type": "text"
  },
  {
    "name": "discount",
    "type": "radio",
    "label": "Discount",
    "multiOptions": {
      "0_10": "Upto 10%",
      "10_20": "10% - 20%",
      "20_30": "20% - 30%",
      "30_40": "30% - 40%",
      "40_50": "40% - 50%",
      "50_100": "More than 50%"
    }
  },
  {
    "name": "in_stock",
    "type": "checkbox",
    "label": "Exclude Out of Stock Products"
  },
  {
    "name": "done",
    "label": "Search",
    "type": "button"
  }
]
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Browse Wishlist

Browse Wishlist
GET/sitestore/product/browse-wishlist/

Get the browse wishlists

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalItemCount": 1,
  "response": [
    {
      "wishlist_id": 1,
      "title": "My Wishlist",
      "body": "My Wishlist",
      "owner_id": 18787,
      "product_id": 1,
      "creation_date": "2016-07-22 07:15:56",
      "modified_date": "2016-07-22 07:15:56",
      "view_count": 0,
      "like_count": 0,
      "follow_count": 0,
      "featured": 0,
      "image": "http://example.com/public/sitestoreproduct_product/7b/36/01/13446_cf73.JPG?c=54f9",
      "image_normal": "http://example.com/public/sitestoreproduct_product/7d/36/01/13448_cc65.JPG?c=44fc",
      "image_profile": "http://example.com/public/sitestoreproduct_product/7c/36/01/13447_d27d.JPG?c=4c4b",
      "image_icon": "http://example.com/public/sitestoreproduct_product/7f/36/01/1344a_5c7c.JPG?c=a07a",
      "content_url": "http://example.com/stores/products/wishlist/1/database"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Product Categories Listing

Product Categories Listings
GET/sitestore/product/category{?category_id}

Get product categories, sub-categories or subsub-categories listings and its products.

Parameters
HideShow
category_id
integer (optional) Example: category_id=878

category_id

subCategory_id
integer (optional) Example: subCategory_id=878

subCategory_id

subsubcategory_id
integer (optional) Example: subsubcategory_id=878

subsubcategory_id

showProducts
boolean (optional) Example: showEvents=0

default 1

showCount
boolean (optional) Example: showCount=0

get category count

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "categories": [
    {
      "category_id": 1,
      "category_name": "Mobiles, Tablets & Accessories",
      "order": 1,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/mobiles-tablets-accessories/1"
      }
    },
    {
      "category_id": 6,
      "category_name": "Desktops, Laptops & Accessories",
      "order": 6,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/desktops-laptops-accessories/6"
      }
    },
    {
      "category_id": 11,
      "category_name": "Digital Cameras & Accessories",
      "order": 11,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/digital-cameras-accessories/11"
      }
    },
    {
      "category_id": 20,
      "category_name": "Appliances",
      "order": 20,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/appliances/20"
      }
    },
    {
      "category_id": 35,
      "category_name": "Home Entertainments",
      "order": 35,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/home-entertainments/35"
      }
    },
    {
      "category_id": 55,
      "category_name": "Clothing",
      "order": 55,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/clothing/55"
      }
    },
    {
      "category_id": 68,
      "category_name": "Footwear",
      "order": 68,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/footwear/68"
      }
    },
    {
      "category_id": 81,
      "category_name": "Watches",
      "order": 81,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/watches/81"
      }
    },
    {
      "category_id": 94,
      "category_name": "Bags & Accessories",
      "order": 94,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/bags-accessories/94"
      }
    },
    {
      "category_id": 105,
      "category_name": "Baby Care Products & Toys",
      "order": 105,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/baby-care-products-toys/105"
      }
    },
    {
      "category_id": 118,
      "category_name": "Home Decor",
      "order": 118,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/home-decor/118"
      }
    },
    {
      "category_id": 131,
      "category_name": "Books, Pens & Diaries",
      "order": 131,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/books-pens-diaries/131"
      }
    },
    {
      "category_id": 138,
      "category_name": "Gaming",
      "order": 138,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/gaming/138"
      }
    },
    {
      "category_id": 151,
      "category_name": "Music & Movies",
      "order": 151,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/music-movies/151"
      }
    },
    {
      "category_id": 160,
      "category_name": "Deals & Specials",
      "order": 160,
      "images": {
        "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
        "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
        "content_url": "http://example.com/stores/products/category/deals-specials/160"
      }
    }
  ],
  "totalItemCount": 15,
  "canCreate": 1
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Product Profile

Product Profile
GET/sitestore/product/view/{store_id}/{product_id}

Get a product profile information

Parameters
HideShow
store_id
integer (required) Example: store_id=878

store id

product_id
integer (required) Example: product_id=123

product id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "product_id": 8,
  "title": "Tops Configured",
  "body": "classic product",
  "owner_id": 18787,
  "store_id": 7,
  "profile_type": 3,
  "photo_id": 79655,
  "section_id": 0,
  "category_id": 55,
  "subcategory_id": 0,
  "subsubcategory_id": 0,
  "creation_date": "2016-08-02 10:15:37",
  "modified_date": "2016-08-05 08:44:53",
  "start_date": "2016-08-01 18:30:00",
  "end_date": null,
  "end_date_enable": 0,
  "approved": 1,
  "featured": 0,
  "sponsored": 0,
  "newlabel": 0,
  "rating_avg": 0,
  "rating_editor": 0,
  "rating_users": 0,
  "price": {
    "original_price": "123.00",
    "discounted_price": "0.00",
    "discount_percent": 0,
    "in_stock": true
  },
  "review_count": 0,
  "view_count": 10,
  "comment_count": 0,
  "like_count": 0,
  "search": 1,
  "closed": 0,
  "approved_date": "2016-08-02 10:15:37",
  "draft": 0,
  "main_video": "",
  "video_snapshot_id": 0,
  "networks_privacy": null,
  "product_code": "topsconfig",
  "product_type": "configurable",
  "weight": 100,
  "stock_unlimited": 1,
  "in_stock": 0,
  "min_order_quantity": 1,
  "max_order_quantity": null,
  "user_tax": null,
  "highlighted": 0,
  "allow_purchase": 1,
  "location": null,
  "owner_title": "Alen J",
  "currency": "USD",
  "tags": "madame",
  "allow_to_view": 1,
  "edit": 1,
  "delete": 1,
  "is_liked": 0,
  "is_followed": 0,
  "owner_image": "http://example.com/public/user/8f/3b/01/13955_698c.png?c=d3b1",
  "owner_image_normal": "http://example.com/public/user/91/3b/01/13957_2aa2.png?c=99d5",
  "owner_image_profile": "http://example.com/public/user/90/3b/01/13956_9755.png?c=7e85",
  "owner_image_icon": "http://example.com/public/user/92/3b/01/13958_b32a.png?c=e0a2",
  "images": [
    {
      "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
      "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
      "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
      "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d"
    },
    {
      "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
      "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
      "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
      "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d"
    }
  ],
  "tabs": [
    {
      "name": "overview",
      "label": "Overview",
      "url": "sitestore/product/overview/7/8"
    },
    {
      "name": "photos",
      "label": "Photos",
      "url": "sitestore/product/photos/7/8"
    }
  ],
  "menu": [
    {
      "label": "Add to Wishlist",
      "name": "wishlist",
      "url": "sitestore/product/add-to-wishlist/7/8"
    },
    {
      "name": "messageowner",
      "label": "Message Owner",
      "url": "sitestore/product/messageowner/7/8"
    },
    {
      "name": "share",
      "label": "Share This Product",
      "url": "activity/share",
      "urlParams": {
        "type": "sitestoreproduct_product",
        "id": 8
      }
    },
    {
      "name": "report",
      "label": "Report This Product",
      "url": "report/create/subject/sitestoreproduct_product_8",
      "urlParams": {
        "type": "sitestoreproduct_product",
        "id": 8
      }
    },
    {
      "name": "tellafriend",
      "label": "Tell a Friend",
      "url": "sitestore/product/tellafriend/7/8"
    },
    {
      "name": "askopinion",
      "label": "Ask For Opinion",
      "url": "sitestore/product/askopinion/7/8"
    }
  ],
  "config": [
    {
      "name": "select_5",
      "type": "select",
      "label": "shipping",
      "multiOptions": {
        "0": "-- select --",
        "21": "level_1_1 (+ 1.00)",
        "22": "level_1_2 (+ 1.00)",
        "23": "level_1_3 (+ 2.00)",
        "24": "Level_1_4 (+ 3.00)"
      }
    },
    {
      "name": "7_8_2",
      "type": "radio",
      "title": "color",
      "description": "this is for color",
      "multiOptions": {
        "9": "black (+ 1.00)",
        "10": "blye (+ 2.00)"
      }
    },
    {
      "name": "7_8_11",
      "type": "multi_checkbox",
      "title": "multicheckbox",
      "description": "multicheckbox",
      "multiOptions": {
        "41": "multi_1 (+ 12.00)",
        "42": "multi_2 (+ 2.00)",
        "43": "multi_3 (+ 12.00)"
      }
    }
  ],
  "profile_information": {
    "Operating System": "Ubuntu",
    "Processor": "intel",
    "RAM": 64,
    "Maximum Display Resolution (dpi)": "298dpi",
    "Screen Size (Inches)": "14inch",
    "Color": "Black"
  },
  "shippingMethods": {
    "totalItemCount": 1,
    "methods": [
      {
        "shippingmethod_id": 6,
        "store_id": 7,
        "title": "free shipping",
        "delivery_time": "2-5 days",
        "allow_weight_from": 0,
        "allow_weight_to": 0,
        "country": "ALL",
        "region": 0,
        "dependency": 0,
        "ship_start_limit": 0,
        "ship_end_limit": 0,
        "ship_type": 0,
        "handling_type": 0,
        "handling_fee": 0,
        "creation_date": "2016-08-02 10:14:08",
        "status": 1,
        "region_name": null
      }
    ]
  },
  "description": "",
  "relatedProducts": {
    "totalItemCount": 6,
    "products": [
      {
        "product_id": 7,
        "title": "Enrique ",
        "price": 456,
        "photo_id": 79130,
        "owner_id": 35,
        "category_id": 151,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "view_count": 7,
        "review_count": 0,
        "like_count": 0,
        "comment_count": 0,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "sponsored": 0,
        "featured": 0,
        "newlabel": 0,
        "creation_date": "2016-07-22 11:00:30",
        "body": "Music",
        "product_type": "downloadable",
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "stock_unlimited": 1,
        "closed": 0,
        "draft": 0,
        "search": 1,
        "approved": 1,
        "start_date": "2016-07-22 07:00:00",
        "end_date": null,
        "end_date_enable": 0,
        "store_id": 5,
        "allow_purchase": 1,
        "discount": 1,
        "discount_value": 100,
        "discount_start_date": "2016-08-16 00:00:00",
        "discount_end_date": "2016-09-05 00:00:00",
        "discount_permanant": 0,
        "handling_type": 0,
        "user_type": 1,
        "discount_amount": 100,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/50/37/01/1351a_3f4c.jpg?c=5903",
        "image_normal": "http://example.com/public/sitestoreproduct_product/52/37/01/1351c_94bf.jpg?c=72bc",
        "image_profile": "http://example.com/public/sitestoreproduct_product/51/37/01/1351b_dfb5.jpg?c=365f",
        "image_icon": "http://example.com/public/sitestoreproduct_product/54/37/01/1351e_d604.jpg?c=722e",
        "content_url": "http://example.com/stores/product/7/enrique",
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
        "owner_title": "Andre Holmes",
        "allow_to_view": 1,
        "is_liked": 0,
        "is_followed": 0,
        "edit": 0,
        "delete": 0
      },
      {
        "product_id": 6,
        "title": "Product Hamper ",
        "price": 0,
        "photo_id": 79125,
        "owner_id": 35,
        "category_id": 20,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "view_count": 11,
        "review_count": 0,
        "like_count": 2,
        "comment_count": 2,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "sponsored": 0,
        "featured": 0,
        "newlabel": 0,
        "creation_date": "2016-07-22 10:58:42",
        "body": "Hamper",
        "product_type": "grouped",
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "stock_unlimited": 1,
        "closed": 0,
        "draft": 0,
        "search": 1,
        "approved": 1,
        "start_date": "2016-07-22 07:00:00",
        "end_date": null,
        "end_date_enable": 0,
        "store_id": 4,
        "allow_purchase": 1,
        "discount": 0,
        "discount_value": 0,
        "discount_start_date": "0000-00-00 00:00:00",
        "discount_end_date": "0000-00-00 00:00:00",
        "discount_permanant": 0,
        "handling_type": 0,
        "user_type": 0,
        "discount_amount": 0,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/4b/37/01/13515_4cd8.jpg?c=d61c",
        "image_normal": "http://example.com/public/sitestoreproduct_product/4d/37/01/13517_1005.jpg?c=f030",
        "image_profile": "http://example.com/public/sitestoreproduct_product/4c/37/01/13516_f1a0.jpg?c=f01d",
        "image_icon": "http://example.com/public/sitestoreproduct_product/4f/37/01/13519_9ae0.jpg?c=aaf1",
        "content_url": "http://example.com/stores/product/6/product-hamper",
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
        "owner_title": "Andre Holmes",
        "allow_to_view": 1,
        "is_liked": 1,
        "is_followed": 0,
        "edit": 0,
        "delete": 0
      },
      {
        "product_id": 5,
        "title": "Laptop (Free Dos)",
        "price": 34000,
        "photo_id": 79116,
        "owner_id": 35,
        "category_id": 6,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "view_count": 7,
        "review_count": 0,
        "like_count": 1,
        "comment_count": 0,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "sponsored": 0,
        "featured": 0,
        "newlabel": 0,
        "creation_date": "2016-07-22 10:52:44",
        "body": "Laptop",
        "product_type": "simple",
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "stock_unlimited": 1,
        "closed": 0,
        "draft": 0,
        "search": 1,
        "approved": 1,
        "start_date": "2016-07-22 07:00:00",
        "end_date": null,
        "end_date_enable": 0,
        "store_id": 4,
        "allow_purchase": 1,
        "discount": 0,
        "discount_value": 0,
        "discount_start_date": "0000-00-00 00:00:00",
        "discount_end_date": "0000-00-00 00:00:00",
        "discount_permanant": 0,
        "handling_type": 0,
        "user_type": 0,
        "discount_amount": 0,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/42/37/01/1350c_7f28.jpg?c=b183",
        "image_normal": "http://example.com/public/sitestoreproduct_product/44/37/01/1350e_7471.jpg?c=bc2e",
        "image_profile": "http://example.com/public/sitestoreproduct_product/43/37/01/1350d_2d63.jpg?c=179b",
        "image_icon": "http://example.com/public/sitestoreproduct_product/46/37/01/13510_39d3.jpg?c=9ebb",
        "content_url": "http://example.com/stores/product/5/laptop-free-dos",
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
        "owner_title": "Andre Holmes",
        "allow_to_view": 1,
        "is_liked": 1,
        "is_followed": 0,
        "edit": 0,
        "delete": 0
      },
      {
        "product_id": 4,
        "title": "Ray Ban Wayfarer Gaugs",
        "price": 7000,
        "photo_id": 79111,
        "owner_id": 35,
        "category_id": 94,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "view_count": 4,
        "review_count": 0,
        "like_count": 1,
        "comment_count": 0,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "sponsored": 0,
        "featured": 0,
        "newlabel": 0,
        "creation_date": "2016-07-22 10:49:32",
        "body": "Ray ban gaugles",
        "product_type": "simple",
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "stock_unlimited": 1,
        "closed": 0,
        "draft": 0,
        "search": 1,
        "approved": 1,
        "start_date": "2016-07-22 07:00:00",
        "end_date": null,
        "end_date_enable": 0,
        "store_id": 5,
        "allow_purchase": 1,
        "discount": 0,
        "discount_value": 0,
        "discount_start_date": "0000-00-00 00:00:00",
        "discount_end_date": "0000-00-00 00:00:00",
        "discount_permanant": 0,
        "handling_type": 0,
        "user_type": 0,
        "discount_amount": 0,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/3d/37/01/13507_f716.jpg?c=412d",
        "image_normal": "http://example.com/public/sitestoreproduct_product/3f/37/01/13509_53d8.jpg?c=45d8",
        "image_profile": "http://example.com/public/sitestoreproduct_product/3e/37/01/13508_cddd.jpg?c=7007",
        "image_icon": "http://example.com/public/sitestoreproduct_product/41/37/01/1350b_33d7.jpg?c=fce7",
        "content_url": "http://example.com/stores/product/4/ray-ban-wayfarer-gaugs",
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
        "owner_title": "Andre Holmes",
        "tags": "Ray Ban",
        "allow_to_view": 1,
        "is_liked": 1,
        "is_followed": 0,
        "edit": 0,
        "delete": 0
      },
      {
        "product_id": 3,
        "title": "Heels",
        "price": 4500,
        "photo_id": 79102,
        "owner_id": 35,
        "category_id": 68,
        "subcategory_id": 0,
        "subsubcategory_id": 0,
        "view_count": 4,
        "review_count": 0,
        "like_count": 0,
        "comment_count": 0,
        "rating_avg": 0,
        "rating_editor": 0,
        "rating_users": 0,
        "sponsored": 0,
        "featured": 0,
        "newlabel": 0,
        "creation_date": "2016-07-22 10:43:05",
        "body": "These are heels",
        "product_type": "simple",
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "stock_unlimited": 1,
        "closed": 0,
        "draft": 0,
        "search": 1,
        "approved": 1,
        "start_date": "2016-07-22 07:00:00",
        "end_date": null,
        "end_date_enable": 0,
        "store_id": 4,
        "allow_purchase": 1,
        "discount": 0,
        "discount_value": 0,
        "discount_start_date": "0000-00-00 00:00:00",
        "discount_end_date": "0000-00-00 00:00:00",
        "discount_permanant": 0,
        "handling_type": 0,
        "user_type": 0,
        "discount_amount": 0,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/34/37/01/134fe_625f.jpg?c=cc0a",
        "image_normal": "http://example.com/public/sitestoreproduct_product/36/37/01/13500_7d5a.jpg?c=f555",
        "image_profile": "http://example.com/public/sitestoreproduct_product/35/37/01/134ff_d9a0.jpg?c=84ec",
        "image_icon": "http://example.com/public/sitestoreproduct_product/38/37/01/13502_fa23.jpg?c=71fb",
        "content_url": "http://example.com/stores/product/3/heels",
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
        "owner_title": "Andre Holmes",
        "tags": "Steletos",
        "allow_to_view": 1,
        "is_liked": 0,
        "is_followed": 0,
        "edit": 0,
        "delete": 0
      },
      {
        "product_id": 1,
        "title": "puma shoes sneakers",
        "price": 112,
        "photo_id": 78918,
        "owner_id": 18787,
        "category_id": 68,
        "subcategory_id": 69,
        "subsubcategory_id": 71,
        "view_count": 238,
        "review_count": 1,
        "like_count": 0,
        "comment_count": 0,
        "rating_avg": 4,
        "rating_editor": 0,
        "rating_users": 4,
        "sponsored": 0,
        "featured": 0,
        "newlabel": 0,
        "creation_date": "2016-07-18 10:19:21",
        "body": "database",
        "product_type": "simple",
        "in_stock": 0,
        "min_order_quantity": 1,
        "max_order_quantity": null,
        "stock_unlimited": 1,
        "closed": 0,
        "draft": 0,
        "search": 1,
        "approved": 1,
        "start_date": "2016-07-18 07:00:00",
        "end_date": null,
        "end_date_enable": 0,
        "store_id": 3,
        "allow_purchase": 1,
        "discount": 0,
        "discount_value": 0,
        "discount_start_date": "0000-00-00 00:00:00",
        "discount_end_date": "0000-00-00 00:00:00",
        "discount_permanant": 0,
        "handling_type": 0,
        "user_type": 0,
        "discount_amount": 0,
        "product_info": "",
        "image": "http://example.com/public/sitestoreproduct_product/7b/36/01/13446_cf73.JPG?c=54f9",
        "image_normal": "http://example.com/public/sitestoreproduct_product/7d/36/01/13448_cc65.JPG?c=44fc",
        "image_profile": "http://example.com/public/sitestoreproduct_product/7c/36/01/13447_d27d.JPG?c=4c4b",
        "image_icon": "http://example.com/public/sitestoreproduct_product/7f/36/01/1344a_5c7c.JPG?c=a07a",
        "content_url": "http://example.com/stores/product/1/puma-shoes-sneakers",
        "owner_image": "http://example.com/public/user/8f/3b/01/13955_698c.png?c=d3b1",
        "owner_image_normal": "http://example.com/public/user/91/3b/01/13957_2aa2.png?c=99d5",
        "owner_image_profile": "http://example.com/public/user/90/3b/01/13956_9755.png?c=7e85",
        "owner_image_icon": "http://example.com/public/user/92/3b/01/13958_b32a.png?c=e0a2",
        "owner_title": "Alen J",
        "tags": "Puma",
        "allow_to_view": 1,
        "is_liked": 0,
        "is_followed": 0,
        "edit": 1,
        "delete": 1
      }
    ]
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Product Variation

Get Product Variation
GET/sitestore/overview/{store_id}

Get product variations for configurable / virtual products.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

get the store id

product_id
integer (required) Example: product_id=736

get the product id

variations
integer (required) Example: select_5=3

parent variation id, child element values and product price will be return on the basis of this

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "field": {
    "name": "select_6",
    "label": "Country",
    "type": "select",
    "multiOptions": {
      "0": "-- select --",
      "30": "United States (+ $7.00)"
    }
  },
  "productPrice": 125
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Message to Store Owners

Get Form
GET/sitestore/product/messageowner/{store_id}/{product_id}

Get the form to send messages to store owners.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "type": "Text",
    "name": "title",
    "label": "Subject",
    "hasValidators": "true"
  },
  {
    "type": "Textarea",
    "name": "body",
    "label": "Message"
  },
  {
    "type": "Submit",
    "name": "submit",
    "label": "Send Message"
  }
]
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Post Form
POST/sitestore/product/messageowner/{store_id}/{product_id}

Send the message to store owners.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

title
string (required) Example: title=Lorem Ipsum!!

message title

body
string (required) Example: body=Lorem ipsum dolor sit amet..

message body

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Tell a Friend

Get Form
GET/sitestore/product/tellafriend/{store_id}/{product_id}

Get the form to send tell a friend for product.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "type": "Text",
      "name": "sender_name",
      "label": "Your Name",
      "hasValidator": "true"
    },
    {
      "type": "Text",
      "name": "sender_email",
      "label": "Your Email",
      "has Validator": "true"
    },
    {
      "type": "Text",
      "name": "receiver_emails",
      "label": "To",
      "description": "Separate multiple addresses with commas",
      "hasValidators": "true"
    },
    {
      "type": "Textarea",
      "name": "message",
      "label": "Message",
      "description": "You can send a personal note in the mail.",
      "hasValidator": "true"
    },
    {
      "type": "Checkbox",
      "name": "send_me",
      "label": "Send a copy to my email address."
    },
    {
      "type": "Submit",
      "name": "send",
      "label": "Tell a Friend"
    }
  ],
  "formValues": {
    "sender_email": "test1@mywebsite.com",
    "sender_name": "Alen J"
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Post Form
POST/sitestore/product/tellafriend/{store_id}/{product_id}

Send the tell a friends form request.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

sender_name
string (required) Example: title=Lorem Ipsum!!

sender name

sender_email
string (required) Example: body=Lorem ipsum dolor sit amet..

sender email address

receiver_emails
string (required) Example: body=Lorem ipsum dolor sit amet..

receiver email address

message
string (required) Example: body=Lorem ipsum dolor sit amet..

message body

send_me
string (optional) Example: body=Lorem ipsum dolor sit amet..

send send=1 in case, If want email on sender email address also.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Ask for an Opinion

Get Form
GET/sitestore/product/askopinion/{store_id}/{product_id}

Get the form to ask for an opinion.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "type": "Text",
      "name": "sender_name",
      "label": "Your Name",
      "hasValidator": "true"
    },
    {
      "type": "Text",
      "name": "sender_email",
      "label": "Your Email",
      "has Validator": "true"
    },
    {
      "type": "Text",
      "name": "receiver_emails",
      "label": "To",
      "description": "Separate multiple addresses with commas",
      "hasValidators": "true"
    },
    {
      "type": "Textarea",
      "name": "message",
      "label": "Message",
      "description": "You can send a personal note in the mail.",
      "hasValidator": "true"
    },
    {
      "type": "Checkbox",
      "name": "send_me",
      "label": "Send a copy to my email address."
    },
    {
      "type": "Submit",
      "name": "send",
      "label": "Tell a Friend"
    }
  ],
  "formValues": {
    "sender_email": "test1@mywebsite.com",
    "sender_name": "Alen J"
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Post Form
POST/sitestore/product/askopinion/{store_id}/{product_id}

Send the tell a friends form request.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

sender_name
string (required) Example: sender_name=Lorem Ipsum!!

sender name

sender_email
string (required) Example: sender_email=test1@mywebsite.com

sender email address

receiver_emails
string (required) Example: receiver_emails=test2@mywebsite.com

receiver email address

message
string (required) Example: message=Lorem ipsum dolor sit amet..

message body

send_me
string (optional) Example: send_me=1

send send=1 in case, If want email on sender email address also.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Product Photos Listing

Product Photos Listing
GET/sitestore/product/photos/{store_id}/{product_id}

Get the product photo listing.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalItemCount": 1,
  "photos": [
    {
      "photo_id": 832,
      "album_id": 82,
      "product_id": 82,
      "user_id": 18787,
      "title": "",
      "description": "",
      "collection_id": 8,
      "file_id": 79655,
      "creation_date": "2016-08-02 10:15:37",
      "modified_date": "2016-08-02 10:15:37",
      "show_slidishow": 0,
      "view_count": 0,
      "comment_count": 0,
      "like_count": 0,
      "order": 7,
      "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
      "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
      "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
      "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d",
      "content_url": "http://example.com/stores/product/photo/view/product_id/8/photo_id/8"
    },
    {
      "photo_id": 438,
      "album_id": 28,
      "product_id": 82,
      "user_id": 18787,
      "title": "",
      "description": "",
      "collection_id": 8,
      "file_id": 79655,
      "creation_date": "2016-08-02 10:15:37",
      "modified_date": "2016-08-02 10:15:37",
      "show_slidishow": 0,
      "view_count": 0,
      "comment_count": 0,
      "like_count": 0,
      "order": 7,
      "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
      "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
      "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
      "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d",
      "content_url": "http://example.com/stores/product/photo/view/product_id/8/photo_id/8"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Create Wishlist

Get Form
GET/sitestore/product/create-wishlist/{store_id}/{product_id}

Get the form to create wishlist.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "type": "text",
    "name": "title",
    "label": "Wishlist Name"
  },
  {
    "type": "text",
    "name": "description",
    "label": "Description"
  },
  {
    "name": "auth_view",
    "type": "select",
    "label": "View Privacy",
    "multiOptions": {
      "everyone": "Everyone",
      "registered": "All Registered Members",
      "owner_network": "Friends and Networks",
      "owner_member_member": "Friends of Friends",
      "owner_member": "Friends Only",
      "owner": "Just Me"
    },
    "value": "everyone"
  },
  {
    "type": "submit",
    "label": "submit"
  }
]
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Post Form
POST/sitestore/product/create-wishlist/{store_id}/{product_id}

Send the tell a friends form request.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

title
string (required) Example: title=Lorem Ipsum!!

wishlist title

description
string (required) Example: description=Lorem Ipsum!!

wishlist description

auth_view
string (required) Example: auth_view=everyone

view privacy

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Add to Cart

Add to Cart
POST/sitestore/product/add-to-cart/{store_id}/{product_id}

Add product into the cart. Also need to send

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

combination_id
integer (required) Example: combination_id=34

only for configurable and virtual products.

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Wishlist Products Listing

Wishlist Products Listing
GET/sitestore/product/wishlist-products/{store_id}/{wishlist_id}

Get wishlist products

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

wishlist_id
integer (required) Example: wishlist_id=77

wishlist id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalItemCount": 2,
  "response": [
    {
      "product_id": 8,
      "title": "Tops Configured",
      "body": "",
      "owner_id": 18787,
      "store_id": 7,
      "profile_type": 2,
      "photo_id": 79655,
      "section_id": 0,
      "category_id": 1,
      "subcategory_id": 2,
      "subsubcategory_id": 0,
      "creation_date": "2016-08-02 10:15:37",
      "modified_date": "2016-08-05 12:39:45",
      "start_date": "2016-08-01 18:30:00",
      "end_date": null,
      "end_date_enable": 0,
      "approved": 1,
      "featured": 0,
      "sponsored": 0,
      "newlabel": 0,
      "rating_avg": 0,
      "rating_editor": 0,
      "rating_users": 0,
      "price": 123,
      "review_count": 0,
      "view_count": 40,
      "comment_count": 0,
      "like_count": 0,
      "search": 1,
      "closed": 0,
      "approved_date": "2016-08-02 10:15:37",
      "draft": 0,
      "main_video": "",
      "video_snapshot_id": 0,
      "networks_privacy": null,
      "product_code": "topsconfig",
      "product_type": "configurable",
      "weight": 100,
      "stock_unlimited": 1,
      "in_stock": 0,
      "min_order_quantity": 1,
      "max_order_quantity": null,
      "user_tax": null,
      "highlighted": 0,
      "allow_purchase": 1,
      "location": null,
      "image": "http://example.com/public/sitestoreproduct_product/5f/39/01/13727_b4e8.jpg?c=b62e",
      "image_normal": "http://example.com/public/sitestoreproduct_product/61/39/01/13729_b259.jpg?c=4786",
      "image_profile": "http://example.com/public/sitestoreproduct_product/60/39/01/13728_b4e8.jpg?c=b62e",
      "image_icon": "http://example.com/public/sitestoreproduct_product/63/39/01/1372b_5cf9.jpg?c=f78d",
      "content_url": "http://example.com/stores/product/8/tops-configured",
      "owner_image": "http://example.com/public/album_photo/fa/36/01/134c5_59c7.jpg?c=d296",
      "owner_image_normal": "http://example.com/public/album_photo/fb/36/01/134c6_409e.jpg?c=93a5",
      "owner_image_profile": "http://example.com/public/album_photo/fa/36/01/134c5_59c7.jpg?c=d296",
      "owner_image_icon": "http://example.com/public/album_photo/fd/36/01/134c8_0d8e.jpg?c=d792"
    },
    {
      "product_id": 1,
      "title": "Puma Shoes Sneakers",
      "body": "",
      "owner_id": 18787,
      "store_id": 3,
      "profile_type": 0,
      "photo_id": 78918,
      "section_id": 1,
      "category_id": 68,
      "subcategory_id": 69,
      "subsubcategory_id": 71,
      "creation_date": "2016-07-18 10:19:21",
      "modified_date": "2016-07-18 10:19:21",
      "start_date": "2016-07-18 07:00:00",
      "end_date": null,
      "end_date_enable": 0,
      "approved": 1,
      "featured": 0,
      "sponsored": 0,
      "newlabel": 0,
      "rating_avg": 4,
      "rating_editor": 0,
      "rating_users": 4,
      "price": 112,
      "review_count": 1,
      "view_count": 258,
      "comment_count": 0,
      "like_count": 0,
      "search": 1,
      "closed": 0,
      "approved_date": "2016-07-18 10:19:21",
      "draft": 0,
      "main_video": "",
      "video_snapshot_id": 0,
      "networks_privacy": null,
      "product_code": "sneakers_puma",
      "product_type": "simple",
      "weight": 113,
      "stock_unlimited": 1,
      "in_stock": 0,
      "min_order_quantity": 1,
      "max_order_quantity": null,
      "user_tax": null,
      "highlighted": 0,
      "allow_purchase": 1,
      "location": null,
      "image": "http://example.com/public/sitestoreproduct_product/7b/36/01/13446_cf73.JPG?c=54f9",
      "image_normal": "http://example.com/public/sitestoreproduct_product/7d/36/01/13448_cc65.JPG?c=44fc",
      "image_profile": "http://example.com/public/sitestoreproduct_product/7c/36/01/13447_d27d.JPG?c=4c4b",
      "image_icon": "http://example.com/public/sitestoreproduct_product/7f/36/01/1344a_5c7c.JPG?c=a07a",
      "content_url": "http://example.com/stores/product/1/puma-shoes-sneakers",
      "owner_image": "http://example.com/public/album_photo/fa/36/01/134c5_59c7.jpg?c=d296",
      "owner_image_normal": "http://example.com/public/album_photo/fb/36/01/134c6_409e.jpg?c=93a5",
      "owner_image_profile": "http://example.com/public/album_photo/fa/36/01/134c5_59c7.jpg?c=d296",
      "owner_image_icon": "http://example.com/public/album_photo/fd/36/01/134c8_0d8e.jpg?c=d792"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Stores / Marketplace - Product Reviews

These are the APIs for the SocialEngineAddOns Plugin: Stores / Marketplace - Ecommerce.

Reviews Listing

Reviews Listing
GET/sitestore/product/review/browse/{store_id}/{product_id}

Get

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=77

product id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "total_reviews": 1,
  "content_title": "Tops Configured",
  "response": [
    {
      "review_id": 2,
      "type": "user",
      "resource_id": 8,
      "resource_type": "sitestoreproduct_product",
      "profile_type_review": 0,
      "owner_id": 35,
      "title": "Overall good product.",
      "body": "Overall good product.",
      "pros": "Overall good product.",
      "cons": "Overall good product.",
      "body_pages": "",
      "update_reason": "",
      "creation_date": "2016-08-09 09:47:55",
      "modified_date": "2016-08-09 09:47:55",
      "view_count": 1,
      "comment_count": 0,
      "like_count": 0,
      "reply_count": 0,
      "helpful_count": 0,
      "recommend": 1,
      "anonymous_name": "",
      "anonymous_email": "",
      "status": 1,
      "featured": 0,
      "owner_title": "Andre Holmes",
      "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
      "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
      "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
      "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
      "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "content_url": "http://example.com/stores/products/review/view/2/8/overall-good-product/14248",
      "gutterMenu": [
        {
          "label": "Edit Review",
          "name": "edit",
          "url": "sitestore/product/review/edit/7/8/2"
        },
        {
          "label": "Delete Review",
          "name": "delete",
          "url": "sitestore/product/review/delete/7/8/2"
        },
        {
          "label": "Like",
          "name": "like",
          "url": "sitestore/product/review/like/7/8/2"
        },
        {
          "label": "comment",
          "name": "comment",
          "url": "sitestore/product/review/comment/7/8/2"
        },
        {
          "label": "List Comments and likes",
          "name": "listcomments",
          "url": "sitestore/product/review/list-comments/7/8/2"
        },
        {
          "name": "share",
          "label": "Share This Page",
          "url": "activity/share",
          "urlParams": {
            "type": "sitestoreproduct_review",
            "id": 2
          }
        },
        {
          "name": "report",
          "label": "Report This Page",
          "url": "report/create/subject/sitestoreproduct_review_2",
          "urlParams": {
            "type": "sitestoreproduct_review",
            "id": 2
          }
        },
        {
          "label": "Was this review helpful",
          "name": "helpful",
          "url": "sitestore/product/review/helpful/7/8/2"
        }
      ],
      "breakdown_ratings_params": [
        {
          "rating": 3,
          "ratingparam_id": 1,
          "ratingparam_name": "Design"
        },
        {
          "rating": 4,
          "ratingparam_id": 2,
          "ratingparam_name": "Size & Weight"
        },
        {
          "rating": 4,
          "ratingparam_id": 3,
          "ratingparam_name": "Value for money"
        },
        {
          "rating": 3,
          "ratingparam_id": 4,
          "ratingparam_name": "Quality"
        },
        {
          "rating": 3,
          "ratingparam_id": 5,
          "ratingparam_name": "Ease of use"
        },
        {
          "rating": 4,
          "ratingparam_id": 6,
          "ratingparam_name": "Features"
        },
        {
          "rating": 5,
          "ratingparam_id": 7,
          "ratingparam_name": "Durability"
        },
        {
          "rating": 4,
          "ratingparam_id": 8,
          "ratingparam_name": "Battery life"
        },
        {
          "rating": 3,
          "ratingparam_id": 9,
          "ratingparam_name": "Performance"
        }
      ]
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Create Review

Get Form
GET/sitestore/product/review/create/{store_id}/{product_id}

Get the form to create a review.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "name": "pros",
      "title": "Pros",
      "type": "text"
    },
    {
      "name": "cons",
      "title": "Cons",
      "type": "text"
    },
    {
      "name": "title",
      "title": "Review Title",
      "type": "text"
    },
    {
      "name": "body",
      "title": "Review",
      "type": "text"
    },
    {
      "name": "recommend",
      "type": "radio",
      "title": "Recommend",
      "multiOptions": {
        "0": "NO",
        "1": "Yes"
      }
    }
  ],
  "ratingParams": [
    {
      "name": "review_rate_0",
      "title": "Overall Rating"
    },
    {
      "name": "review_rate_1",
      "title": "Design"
    },
    {
      "name": "review_rate_2",
      "title": "Size & Weight"
    },
    {
      "name": "review_rate_3",
      "title": "Value for money"
    },
    {
      "name": "review_rate_4",
      "title": "Quality"
    },
    {
      "name": "review_rate_5",
      "title": "Ease of use"
    },
    {
      "name": "review_rate_6",
      "title": "Features"
    },
    {
      "name": "review_rate_7",
      "title": "Durability"
    },
    {
      "name": "review_rate_8",
      "title": "Battery life"
    },
    {
      "name": "review_rate_9",
      "title": "Performance"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Post Review Form
POST/sitestore/product/review/create/{store_id}/{product_id}

Post the review create form

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

pros
string (required) Example: pros=Lorem Ipsum!!

pros body

cons
string (required) Example: cons=Lorem ipsum dolor sit amet..

cons body

title
string (required) Example: title=Lorem ipsum dolor sit amet..

title body

body
string (required) Example: body=Lorem ipsum dolor sit amet..

description

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Review Profile

Review Profile
GET/sitestore/product/review/view/{store_id}/{product_id}/{review_id}

Get the review profile information.

Parameters
HideShow
store_id
integer (required) Example: store_id=58

store id

product_id
integer (required) Example: product_id=58

product id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "review": {
    "review_id": 1,
    "type": "user",
    "resource_id": 1,
    "resource_type": "sitestoreproduct_product",
    "profile_type_review": 0,
    "owner_id": 18859,
    "title": "Nice shoes with nice price.",
    "body": "Nice shoes with nice price.",
    "pros": "Nice shoes with nice price.",
    "cons": "Please provide more colors",
    "body_pages": "",
    "update_reason": "",
    "creation_date": "2016-07-26 11:59:02",
    "modified_date": "2016-07-26 11:59:02",
    "view_count": 1,
    "comment_count": 0,
    "like_count": 0,
    "reply_count": 0,
    "helpful_count": 0,
    "recommend": 1,
    "anonymous_name": "",
    "anonymous_email": "",
    "status": 1,
    "featured": 0,
    "helpful": 0,
    "owner_title": "Alfredo Dukes"
  },
  "gutterMenu": [
    {
      "label": "Edit Review",
      "name": "edit",
      "url": "http://example.com/sitestore/product/review/edit/7/8/1"
    },
    {
      "label": "Delete Review",
      "name": "delete",
      "url": "http://example.com/sitestore/product/review/delete/7/8/1"
    },
    {
      "label": "Like",
      "name": "like",
      "url": "http://example.com/sitestore/product/review/like/7/8/1"
    },
    {
      "label": "comment",
      "name": "comment",
      "url": "http://example.com/sitestore/product/review/comment/7/8/1"
    },
    {
      "label": "List Comments and likes",
      "name": "listcomments",
      "url": "http://example.com/sitestore/product/review/list-comments/7/8/1"
    },
    {
      "name": "share",
      "label": "Share This Page",
      "url": "activity/share",
      "urlParams": {
        "type": "sitestoreproduct_review",
        "id": 1
      }
    },
    {
      "name": "report",
      "label": "Report This Page",
      "url": "http://example.com/report/create/subject/sitestoreproduct_review_1",
      "urlParams": {
        "type": "sitestoreproduct_review",
        "id": 1
      }
    },
    {
      "label": "Was this review helpful",
      "name": "helpful",
      "url": "http://example.com/sitestore/product/review/helpful/7/8/1"
    }
  ],
  "ratingData": [
    {
      "rating": 4,
      "ratingparam_name": null
    },
    {
      "rating": 3,
      "ratingparam_name": "Design"
    },
    {
      "rating": 3,
      "ratingparam_name": "Comfort"
    },
    {
      "rating": 3,
      "ratingparam_name": "Value for money"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Edit Review

Get Form
GET/sitestore/product/review/create/{store_id}/{product_id}/{review_id}

Get the form to edit a review.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "name": "pros",
      "title": "Pros",
      "type": "text"
    },
    {
      "name": "cons",
      "title": "Cons",
      "type": "text"
    },
    {
      "name": "title",
      "title": "Review Title",
      "type": "text"
    },
    {
      "name": "body",
      "title": "Review",
      "type": "text"
    },
    {
      "name": "recommend",
      "type": "radio",
      "title": "Recommend",
      "multiOptions": {
        "0": "NO",
        "1": "Yes"
      }
    }
  ],
  "review": {
    "review_id": 1,
    "type": "user",
    "resource_id": 1,
    "resource_type": "sitestoreproduct_product",
    "profile_type_review": 0,
    "owner_id": 18859,
    "title": "Nice shoes with nice price.",
    "body": "Nice shoes with nice price.",
    "pros": "Nice shoes with nice price.",
    "cons": "Please provide more colors",
    "body_pages": "",
    "update_reason": "",
    "creation_date": "2016-07-26 11:59:02",
    "modified_date": "2016-07-26 11:59:02",
    "view_count": 1,
    "comment_count": 0,
    "like_count": 0,
    "reply_count": 0,
    "helpful_count": 0,
    "recommend": 1,
    "anonymous_name": "",
    "anonymous_email": "",
    "status": 1,
    "featured": 0,
    "ratingParams": []
  },
  "ratingParams": [
    {
      "name": "review_rate_0",
      "title": "Overall Rating"
    },
    {
      "name": "review_rate_1",
      "title": "Design"
    },
    {
      "name": "review_rate_2",
      "title": "Size & Weight"
    },
    {
      "name": "review_rate_3",
      "title": "Value for money"
    },
    {
      "name": "review_rate_4",
      "title": "Quality"
    },
    {
      "name": "review_rate_5",
      "title": "Ease of use"
    },
    {
      "name": "review_rate_6",
      "title": "Features"
    },
    {
      "name": "review_rate_7",
      "title": "Durability"
    },
    {
      "name": "review_rate_8",
      "title": "Battery life"
    },
    {
      "name": "review_rate_9",
      "title": "Performance"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Post Review Form
POST/sitestore/product/review/create/{store_id}/{product_id}/{review_id}

Post the review create form

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

review_id
integer (required) Example: review_id=736

review id

pros
string (required) Example: pros=Lorem Ipsum!!

pros body

cons
string (required) Example: cons=Lorem ipsum dolor sit amet..

cons body

title
string (required) Example: title=Lorem ipsum dolor sit amet..

title body

body
string (required) Example: body=Lorem ipsum dolor sit amet..

description

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Like / Unlike Review

Like / Unlike Review
POST/sitestore/product/review/like/{store_id}/{product_id}/{review_id}

Like / Unlike reviews

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Delete Review

Delete Review
DELETE/sitestore/product/review/delete/{store_id}/{product_id}/{review_id}

Delete a review

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Likes and Comments Listing

Likes and Comments Listing
GET/sitestore/product/review/list-comments/{store_id}/{product_id}/{review_id}

Get the list of likes and comments of review.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "likes": {
    "14476": {
      "like_id": 14476,
      "resource_type": "sitestoreproduct_review",
      "resource_id": 2,
      "poster_type": "user",
      "poster_id": 35,
      "creation_date": "2016-08-09 10:39:25",
      "reaction": "like",
      "owner_images": {
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee"
      },
      "owner_title": "Andre Holmes"
    }
  },
  "comments": {
    "4552": {
      "comment_id": 4552,
      "resource_type": "sitestoreproduct_review",
      "resource_id": 2,
      "poster_type": "user",
      "poster_id": 35,
      "body": "Good Product !!",
      "creation_date": "2016-08-09 10:39:50",
      "like_count": 0,
      "parent_comment_id": 0,
      "fb_comment_id": 0,
      "params": null,
      "attachment_type": null,
      "attachment_id": 0,
      "owner_images": {
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee"
      },
      "owner_title": "Andre Holmes"
    },
    "4553": {
      "comment_id": 4553,
      "resource_type": "sitestoreproduct_review",
      "resource_id": 2,
      "poster_type": "user",
      "poster_id": 35,
      "body": "Usefull Product",
      "creation_date": "2016-08-09 10:40:26",
      "like_count": 0,
      "parent_comment_id": 0,
      "fb_comment_id": 0,
      "params": null,
      "attachment_type": null,
      "attachment_id": 0,
      "owner_images": {
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee"
      },
      "owner_title": "Andre Holmes"
    }
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Is Review HelpFull

Get Form
GET/sitestore/product/review/helpful/{store_id}/{product_id}/{review_id}

Get the form to post help.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "name": "helpful",
    "title": "Was this review Helpfull ?",
    "type": "checkbox",
    "multiOptions": {
      "1": "Helpful",
      "2": "Not Helpful"
    }
  }
]
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Post Form
POST/sitestore/product/review/helpful/{store_id}/{product_id}/{review_id}

Send the help form request.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

product_id
integer (required) Example: product_id=736

product id

review_id
integer (required) Example: review_id=76

review id

helpful
integer (required) Example: helpful=1

is helpful

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Stores / Marketplace - Coupon

These are the APIs for the SocialEngineAddOns Plugin: Stores / Marketplace - Ecommerce.

Coupons Listing

Coupons Listing
GET/sitestore/offers/browse/{store_id}

Get the coupons listing

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalItemCount": 1,
  "response": [
    {
      "offer_id": 1,
      "store_id": 3,
      "owner_id": 35,
      "title": "Discount",
      "description": "Discount",
      "claim_count": -1,
      "claimed": 0,
      "view_count": 0,
      "comment_count": 0,
      "like_count": 0,
      "creation_date": "2016-08-04 06:50:57",
      "sticky": 0,
      "hotoffer": 0,
      "url": "",
      "coupon_code": 123456,
      "end_settings": 0,
      "end_time": "0000-00-00 00:00:00",
      "photo_id": 0,
      "discount_type": 0,
      "discount_amount": 10,
      "minimum_purchase": 0,
      "product_ids": 1,
      "claim_user_count": 0,
      "start_time": "2016-08-04 00:00:00",
      "public": 1,
      "approved": 1,
      "min_product_quantity": 0,
      "status": 1,
      "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
      "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
      "content_url": "http://example.com/store-coupons/35/1/discount",
      "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
      "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
      "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
      "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Coupon Profile

Coupon Profile
GET/sitestore/offer/view/{coupon_id}

Get the coupon profile information.

Parameters
HideShow
coupon_id
integer (required) Example: coupon_id=43

coupon id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "offer_id": 1,
  "store_id": 3,
  "owner_id": 35,
  "title": "Discount",
  "description": "Discount",
  "claim_count": -1,
  "claimed": 0,
  "view_count": 0,
  "comment_count": 0,
  "like_count": 0,
  "creation_date": "2016-08-04 06:50:57",
  "sticky": 0,
  "hotoffer": 0,
  "url": "",
  "coupon_code": 123456,
  "end_settings": 0,
  "end_time": "0000-00-00 00:00:00",
  "photo_id": 0,
  "discount_type": 0,
  "discount_amount": 10,
  "minimum_purchase": 0,
  "product_ids": 1,
  "claim_user_count": 0,
  "start_time": "2016-08-04 00:00:00",
  "public": 1,
  "approved": 1,
  "min_product_quantity": 0,
  "status": 0,
  "image": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "image_normal": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "image_profile": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_profile.png",
  "image_icon": "http://example.com/application/modules/User/externals/images/nophoto_user_thumb_icon.png",
  "content_url": "http://example.com/store-coupons/35/1/discount",
  "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
  "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
  "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
  "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee",
  "owner_title": "Andre Holmes"
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Enable / Disable Coupon

Enable / Disable Coupon
POST/sitestore/offer/enable/{coupon_id}

Enable / Disable coupons

Parameters
HideShow
coupon_id
integer (required) Example: coupon_id=43

coupon id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Delete Coupon

Delete Coupon
DELETE/sitestore/offer/delete/{coupon_id}

Delete a coupon

Parameters
HideShow
coupon_id
integer (required) Example: coupon_id=43

coupon id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Stores / Marketplace - Reviews

These are the APIs for the SocialEngineAddOns Plugin: Stores / Marketplace - Ecommerce.

Reviews Listing

Reviews Listing
GET/sitestore/reviews/browse/{store_id}

Get

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "total_reviews": 1,
  "content_title": "Puma",
  "reviews": [
    {
      "review_id": 1,
      "store_id": 3,
      "owner_id": 18787,
      "title": "Overall Good!!",
      "body": "Overall Good!!",
      "creation_date": "2016-08-09 11:25:19",
      "modified_date": "2016-08-09 11:25:19",
      "view_count": 1,
      "comment_count": 0,
      "like_count": 0,
      "pros": "Overall Good!!",
      "cons": "Overall Good!!",
      "recommend": "Yes",
      "featured": 0,
      "is_liked": false,
      "owner_title": "Alen J",
      "owner_image": "http://example.com/public/album_photo/fa/36/01/134c5_59c7.jpg?c=d296",
      "owner_image_normal": "http://example.com/public/album_photo/fb/36/01/134c6_409e.jpg?c=93a5",
      "owner_image_profile": "http://example.com/public/album_photo/fa/36/01/134c5_59c7.jpg?c=d296",
      "owner_image_icon": "http://example.com/public/album_photo/fd/36/01/134c8_0d8e.jpg?c=d792",
      "store_title": "Puma",
      "overall_rating": 4,
      "category_name": "Clothing, Footwear & Accessories",
      "image": "http://example.com/public/sitestore_store/38/35/01/13304_2cb9.gif?c=3fb2",
      "image_normal": "http://example.com/public/sitestore_store/3a/35/01/13306_5080.gif?c=82af",
      "image_profile": "http://example.com/public/sitestore_store/39/35/01/13305_2e56.gif?c=3dc2",
      "image_icon": "http://example.com/public/sitestore_store/3b/35/01/13307_5bb6.gif?c=20c5",
      "content_url": "http://example.com/store/puma",
      "guttermenu": [
        {
          "label": "Delete Review",
          "name": "delete",
          "url": "sitestore/review/delete/3/1"
        },
        {
          "label": "Edit Review",
          "name": "edit_review",
          "url": "sitestore/review/edit/3/1"
        }
      ],
      "breakdown_ratings_params": []
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Create Review

Get Form
GET/sitestore/reviews/create/{store_id}

Get the form to create a review.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "name": "pros",
      "title": "Pros",
      "type": "text"
    },
    {
      "name": "cons",
      "title": "Cons",
      "type": "text"
    },
    {
      "name": "title",
      "title": "Review Title",
      "type": "text"
    },
    {
      "name": "body",
      "title": "Review",
      "type": "text"
    },
    {
      "name": "recommend",
      "type": "radio",
      "title": "Recommend",
      "multiOptions": {
        "0": "NO",
        "1": "Yes"
      }
    }
  ],
  "ratingParams": [
    {
      "name": "review_rate_0",
      "title": "Overall Rating"
    },
    {
      "name": "review_rate_1",
      "title": "Design"
    },
    {
      "name": "review_rate_2",
      "title": "Size & Weight"
    },
    {
      "name": "review_rate_3",
      "title": "Value for money"
    },
    {
      "name": "review_rate_4",
      "title": "Quality"
    },
    {
      "name": "review_rate_5",
      "title": "Ease of use"
    },
    {
      "name": "review_rate_6",
      "title": "Features"
    },
    {
      "name": "review_rate_7",
      "title": "Durability"
    },
    {
      "name": "review_rate_8",
      "title": "Battery life"
    },
    {
      "name": "review_rate_9",
      "title": "Performance"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Post Review Form
POST/sitestore/reviews/create/{store_id}

Post the review create form

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

pros
string (required) Example: pros=Lorem Ipsum!!

pros body

cons
string (required) Example: cons=Lorem ipsum dolor sit amet..

cons body

title
string (required) Example: title=Lorem ipsum dolor sit amet..

title body

body
string (required) Example: body=Lorem ipsum dolor sit amet..

description

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Review Profile

Review Profile
GET/sitestore/review/view/{store_id}/{review_id}

Get the review profile information.

Parameters
HideShow
store_id
integer (required) Example: store_id=58

store id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "review": {
    "review_id": 1,
    "type": "user",
    "resource_id": 1,
    "resource_type": "sitestore_store",
    "profile_type_review": 0,
    "owner_id": 18859,
    "title": "Nice shoes with nice price.",
    "body": "Nice shoes with nice price.",
    "pros": "Nice shoes with nice price.",
    "cons": "Please provide more colors",
    "body_pages": "",
    "update_reason": "",
    "creation_date": "2016-07-26 11:59:02",
    "modified_date": "2016-07-26 11:59:02",
    "view_count": 1,
    "comment_count": 0,
    "like_count": 0,
    "reply_count": 0,
    "helpful_count": 0,
    "recommend": 1,
    "anonymous_name": "",
    "anonymous_email": "",
    "status": 1,
    "featured": 0,
    "helpful": 0,
    "owner_title": "Alfredo Dukes"
  },
  "gutterMenu": [
    {
      "label": "Edit Review",
      "name": "edit",
      "url": "sitestore/review/edit/7/1"
    },
    {
      "label": "Delete Review",
      "name": "delete",
      "url": "sitestore/review/delete/7/1"
    },
    {
      "label": "Like",
      "name": "like",
      "url": "sitestore/review/like/7/1"
    },
    {
      "label": "comment",
      "name": "comment",
      "url": "sitestore/review/comment/7/1"
    }
  ],
  "ratingData": [
    {
      "rating": 4,
      "ratingparam_name": null
    },
    {
      "rating": 3,
      "ratingparam_name": "Design"
    },
    {
      "rating": 3,
      "ratingparam_name": "Comfort"
    },
    {
      "rating": 3,
      "ratingparam_name": "Value for money"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Edit Review

Get Form
GET/sitestore/review/edit/{store_id}/{review_id}

Get the form to edit a review.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "form": [
    {
      "name": "pros",
      "title": "Pros",
      "type": "text"
    },
    {
      "name": "cons",
      "title": "Cons",
      "type": "text"
    },
    {
      "name": "title",
      "title": "Review Title",
      "type": "text"
    },
    {
      "name": "body",
      "title": "Review",
      "type": "text"
    },
    {
      "name": "recommend",
      "type": "radio",
      "title": "Recommend",
      "multiOptions": {
        "0": "NO",
        "1": "Yes"
      }
    }
  ],
  "review": {
    "review_id": 1,
    "type": "user",
    "resource_id": 1,
    "resource_type": "sitestore_store",
    "profile_type_review": 0,
    "owner_id": 18859,
    "title": "Nice shoes with nice price.",
    "body": "Nice shoes with nice price.",
    "pros": "Nice shoes with nice price.",
    "cons": "Please provide more colors",
    "body_pages": "",
    "update_reason": "",
    "creation_date": "2016-07-26 11:59:02",
    "modified_date": "2016-07-26 11:59:02",
    "view_count": 1,
    "comment_count": 0,
    "like_count": 0,
    "reply_count": 0,
    "helpful_count": 0,
    "recommend": 1,
    "anonymous_name": "",
    "anonymous_email": "",
    "status": 1,
    "featured": 0,
    "ratingParams": []
  },
  "ratingParams": [
    {
      "name": "review_rate_0",
      "title": "Overall Rating"
    },
    {
      "name": "review_rate_1",
      "title": "Design"
    },
    {
      "name": "review_rate_2",
      "title": "Size & Weight"
    },
    {
      "name": "review_rate_3",
      "title": "Value for money"
    },
    {
      "name": "review_rate_4",
      "title": "Quality"
    },
    {
      "name": "review_rate_5",
      "title": "Ease of use"
    },
    {
      "name": "review_rate_6",
      "title": "Features"
    },
    {
      "name": "review_rate_7",
      "title": "Durability"
    },
    {
      "name": "review_rate_8",
      "title": "Battery life"
    },
    {
      "name": "review_rate_9",
      "title": "Performance"
    }
  ]
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Post Review Form
POST/sitestore/review/edit/{store_id}/{review_id}

Post the review create form

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

review_id
integer (required) Example: review_id=736

review id

pros
string (required) Example: pros=Lorem Ipsum!!

pros body

cons
string (required) Example: cons=Lorem ipsum dolor sit amet..

cons body

title
string (required) Example: title=Lorem ipsum dolor sit amet..

title body

body
string (required) Example: body=Lorem ipsum dolor sit amet..

description

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Like / Unlike Review

Like / Unlike Review
POST/sitestore/review/like/{store_id}/{review_id}

Like / Unlike reviews

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Delete Review

Delete Review
DELETE/sitestore/review/delete/{store_id}/{review_id}

Delete a review

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
oauth_token: 276ed9327d0478c2606adea438f4fd15
oauth_secret: ffaff6754b5d4ca5f2fc4cc2a3a75478
Response  204
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}
Response  404
HideShow
Body
{
  "status_code": 404,
  "error": true,
  "error_code": "no_record",
  "message": "No record found"
}

Likes and Comments Listing

Likes and Comments Listing
GET/sitestore/review/listcomments/{store_id}/{review_id}

Get the list of likes and comments of review.

Parameters
HideShow
store_id
integer (required) Example: store_id=82

store id

review_id
integer (required) Example: review_id=736

review id

Request
HideShow
Headers
Accept: application/json
oauth_consumer_key: e6a5845684bf49df63d9eef489acfee1
oauth_consumer_secret: 42b9eef48e96c65f9ca29d07712d39fb
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "likes": {
    "14476": {
      "like_id": 14476,
      "resource_type": "sitestore_store",
      "resource_id": 2,
      "poster_type": "user",
      "poster_id": 35,
      "creation_date": "2016-08-09 10:39:25",
      "reaction": "like",
      "owner_images": {
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee"
      },
      "owner_title": "Andre Holmes"
    }
  },
  "comments": {
    "4552": {
      "comment_id": 4552,
      "resource_type": "sitestore_store",
      "resource_id": 2,
      "poster_type": "user",
      "poster_id": 35,
      "body": "Good Product !!",
      "creation_date": "2016-08-09 10:39:50",
      "like_count": 0,
      "parent_comment_id": 0,
      "fb_comment_id": 0,
      "params": null,
      "attachment_type": null,
      "attachment_id": 0,
      "owner_images": {
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee"
      },
      "owner_title": "Andre Holmes"
    },
    "4553": {
      "comment_id": 4553,
      "resource_type": "sitestore_store",
      "resource_id": 2,
      "poster_type": "user",
      "poster_id": 35,
      "body": "Usefull Product",
      "creation_date": "2016-08-09 10:40:26",
      "like_count": 0,
      "parent_comment_id": 0,
      "fb_comment_id": 0,
      "params": null,
      "attachment_type": null,
      "attachment_id": 0,
      "owner_images": {
        "owner_image": "http://example.com/public/user/68/28/01/12641_aead.jpg?c=1540",
        "owner_image_normal": "http://example.com/public/user/6a/28/01/12643_d52c.jpg?c=35f2",
        "owner_image_profile": "http://example.com/public/user/69/28/01/12642_96f3.jpg?c=3ae8",
        "owner_image_icon": "http://example.com/public/user/6b/28/01/12644_04fa.jpg?c=caee"
      },
      "owner_title": "Andre Holmes"
    }
  }
}
Response  401
HideShow
Body
{
  "status_code": 401,
  "error": true,
  "error_code": "unauthorized",
  "message": "User does not have access to this resource."
}

Generated by aglio on 09 Aug 2016