my test docs
If you are already our client you can get your credentials (API key and API secret) in our Admin Panel -> Account -> API ( https://www.socialshopwave.com/admin/settings/api)
Request body
API key
API Secret
Grant type
The scope of the access request
Responses
Body
The access token issued by the authorization server
The lifetime in seconds of the access token
The type of the token
The scope of the access token
Examples
{
"access_token" : "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"expires_in" : 2764800,
"token_type" : "Bearer",
"scope" : "read_user write_user"
}Receive a list of Users.
Request parameters
Pagination index. Items per request depends on limit parameter
Amount of results per request
Responses
Body
Model Body (User)
Identifier of a user in SocialShopWave
(Read-only) Shopify customer id
(Read-only) Shopify customer’s email address
Shopify customer’s first name
Shopify customer’s last name
(Read-only) Link to user’s profile photo
User information. Example: Rare cars collector
User’s birthdate. Example: 1992-05-22
(Read-only) Profile link of a customer
Alpha numeric username of a user. Example: billgates55
Defines who can see user’s profile and activity. Example: public
Examples
{
"status" : 200,
"message" : "OK",
"data" : [
{
"user_id" : 5,
"customer_id" : "2761504389",
"email" : "george.lucas@example.com",
"first_name" : "George",
"last_name" : "Lukas",
"photo_url" : "https://img8.socialshopwave.com/client5/profileimages/user259/56e64b9c256e2service_profile_m.jpg?c=1457955199",
"about" : "American filmmaker and entrepreneur",
"birthdate" : "1944-05-14",
"profile_address" : "https://star-wars.myshopify.com/pages/profile/glukas",
"username" : "glukas",
"privacy" : "public"
}
]
}Search for a user (by email only)
Request parameters
The field name to search by
The email address of user searching for
Responses
Body
HTTP status code. Example: 200
API response message. Example: OK
Model Body (User)
Identifier of a user in SocialShopWave
(Read-only) Shopify customer id
(Read-only) Shopify customer’s email address
Shopify customer’s first name
Shopify customer’s last name
(Read-only) Link to user’s profile photo
User information. Example: Rare cars collector
User’s birthdate. Example: 1992-05-22
(Read-only) Profile link of a customer
Alpha numeric username of a user. Example: billgates55
Defines who can see user’s profile and activity. Example: public
Examples
{
"status" : 200,
"message" : "OK",
"data" : {
"user_id" : 1,
"customer_id" : "2391076613",
"email" : "elon.musk@mail.com",
"first_name" : "Elon",
"last_name" : "Musk",
"photo_url" : "https://img7.socialshopwave.com/client1/profileimages/user1/56ca9c016e653service_profile_m.jpg?c=1457947907",
"about" : "Entrepreneur, engineer, inventor, investor",
"birthdate" : "1971-06-28",
"profile_address" : "https://tesla-motors.myshopify.com/pages/profile/elon-musk",
"username" : "elon-musk",
"privacy" : "public"
}
}Body
HTTP status code
API response message
Examples
{
"status" : 404,
"message" : "User with email:'email@example.com' not found"
}Receive a list of Wishlist
Request parameters
Identifier of a user in SocialShopWave
Identifier of a board
Shopify product_id
Shopify product variant_id
Pagination index. Items per request depends on limit parameter
Amount of results per request
Responses
Body
Examples
{
"status" : 200,
"message" : "OK",
"data" : [
{
"user_id" : 1,
"product_id" : "1632310531",
"variant_id" : "4835103811",
"board_id" : 8,
"date" : "2015-12-30 14:28:46"
},
{
"user_id" : 1,
"product_id" : "1632311491",
"variant_id" : "0",
"board_id" : 8,
"date" : "2016-02-16 15:49:03"
},
{
"user_id" : 5,
"product_id" : "1632314179",
"variant_id" : "6835103411",
"board_id" : 4,
"date" : "2016-02-16 15:49:00"
}
]
}Add to wishlist
Request body
{
"user_id" : 5,
"product_id" : "1632314179",
"board_id" : 8
}Identifier of a user in SocialShopWave
Shopify product_id
Shopify product variant_id
Identifier of a wishlist board
Responses
Body
Examples
{
"status" : 200,
"message" : "OK",
"data" : [ ]
}Body
Examples
{
"status" : 404,
"message" : "User or product not found"
}Body
Examples
{
"status" : 406,
"message" : "user_id and product_id are required"
}Remove product from user’s wishlist
Request parameters
Identifier of a user in SocialShopWave
Shopify product_id
Responses
Body
Examples
{
"status" : 200,
"message" : "OK",
"data" : [ ]
}Body
Examples
{
"status" : 404,
"message" : "Resource does not exists"
}Body
Examples
{
"status" : 406,
"message" : "user_id and product_id are required"
}Receive added count to wishlists of products
Request parameters
Shopify Product identifiers
Responses
Body
Examples
{
"status" : 200,
"message" : "OK",
"data" : [
{
"product_id" : "1632309955",
"count" : "7"
},
{
"product_id" : "1632310019",
"count" : "6"
},
{
"product_id" : "1632310147",
"count" : "7"
},
{
"product_id" : "1632310275",
"count" : "5"
},
{
"product_id" : "1632310403",
"count" : "7"
},
{
"product_id" : "1632310531",
"count" : "8"
},
{
"product_id" : "1632310851",
"count" : "9"
},
{
"product_id" : "1632310979",
"count" : "9"
},
{
"product_id" : "1632311107",
"count" : "6"
},
{
"product_id" : "1632311299",
"count" : "9"
},
{
"product_id" : "1632311491",
"count" : "19"
},
{
"product_id" : "1632311811",
"count" : "12"
},
{
"product_id" : "1632311875",
"count" : "7"
},
{
"product_id" : "1632311939",
"count" : "8"
},
{
"product_id" : "1632312067",
"count" : "8"
},
{
"product_id" : "1632312195",
"count" : "16"
},
{
"product_id" : "1632312323",
"count" : "7"
},
{
"product_id" : "1632312387",
"count" : "6"
},
{
"product_id" : "1632312451",
"count" : "7"
},
{
"product_id" : "1632312515",
"count" : "12"
},
{
"product_id" : "1632312707",
"count" : "10"
},
{
"product_id" : "1632312771",
"count" : "8"
},
{
"product_id" : "1632312835",
"count" : "9"
},
{
"product_id" : "1632312899",
"count" : "9"
},
{
"product_id" : "1632312963",
"count" : "15"
},
{
"product_id" : "1632313027",
"count" : "10"
},
{
"product_id" : "1632313091",
"count" : "11"
},
{
"product_id" : "1632313219",
"count" : "10"
},
{
"product_id" : "1632313475",
"count" : "8"
},
{
"product_id" : "1632313795",
"count" : "9"
},
{
"product_id" : "1632313923",
"count" : "4"
},
{
"product_id" : "1632314115",
"count" : "5"
},
{
"product_id" : "1632314179",
"count" : "10"
},
{
"product_id" : "1632314371",
"count" : "7"
},
{
"product_id" : "1632314435",
"count" : "6"
},
{
"product_id" : "1632314755",
"count" : "10"
},
{
"product_id" : "1632314819",
"count" : "6"
},
{
"product_id" : "1632315139",
"count" : "10"
},
{
"product_id" : "1632315395",
"count" : "10"
},
{
"product_id" : "1632315459",
"count" : "10"
},
{
"product_id" : "1632315587",
"count" : "6"
},
{
"product_id" : "1632315715",
"count" : "8"
},
{
"product_id" : "1632316291",
"count" : "8"
},
{
"product_id" : "1632316547",
"count" : "5"
},
{
"product_id" : "1632316803",
"count" : "6"
},
{
"product_id" : "1632316995",
"count" : "11"
},
{
"product_id" : "1632317187",
"count" : "8"
},
{
"product_id" : "1632317379",
"count" : "14"
},
{
"product_id" : "1632317443",
"count" : "6"
}
]
}Receive a list of all Customers who added the product to wishlist
Request parameters
Shopify product_id
Responses
Body
Examples
{
"status" : 200,
"message" : "OK",
"data" : [
{
"user_id" : 5,
"customer_id" : "2761504389",
"email" : "george.lucas@example.com",
"first_name" : "George",
"last_name" : "Lukas",
"photo_url" : "https://img8.socialshopwave.com/client5/profileimages/user259/56e64b9c256e2service_profile_m.jpg?c=1457955199",
"about" : "American filmmaker and entrepreneur",
"birthdate" : "1944-05-14",
"profile_address" : "https://star-wars.myshopify.com/pages/profile/glukas",
"username" : "glukas",
"gender" : "male",
"privacy" : "public"
}
]
}Body
Examples
{
"status" : 406,
"message" : "product_id is required"
}Receive a list of all Boards of user
Request parameters
Identifier of a user in SocialShopWave
Responses
Body
Examples
{
"status" : 200,
"message" : "OK",
"data" : [
{
"board_id" : "4",
"title" : "Favorites"
}
]
}Body
Examples
{
"status" : 406,
"message" : "user_id is required"
}Create a new Board
Request body
{
"user_id" : 23348,
"title" : "Birthday"
}Identifier of a user in SocialShopWave
Title of a board
Responses
Body
Examples
{
"status" : 200,
"message" : "OK",
"data" : {
"user_id" : "8",
"title" : "Birthday",
"board_id" : "13"
}
}Body
Examples
{
"status" : 406,
"message" : "user_id and title are required"
}Receive a list of reviews by user_id or product_id.
Request parameters
Filter by Shopify product_id (set 0 to get site reviews)
Filter by user_id (Identifier of a user in SocialShopWave)
Pagination index. Items per request depends on limit parameter
Amount of results per request
Responses
Body
Idenitfier of a review in SocialShopWave
Shopify product_id
Identifier of a user in SocialShopWave
Content of a review
Posted date of a review
Published status of a review
Review rate
Examples
{
"status" : 200,
"message" : "OK",
"data" : [
{
"review_id" : "107",
"product_id" : "0",
"user_id" : "1",
"body" : "Awesome",
"creation_date" : "2016-02-16 13:46:11",
"status" : "published",
"rate" : "4"
},
{
"review_id" : "115",
"product_id" : "0",
"user_id" : "5",
"body" : "Consulted he eagerness unfeeling deficient existence of. Calling nothing end fertile for venture way boy. Esteem spirit temper too say adieus who direct esteem. It esteems luckily mr or picture placing drawing no. Apartments frequently or motionless on reasonable projecting expression. Way mrs end gave tall walk fact bed. ",
"creation_date" : "2016-02-17 13:16:06",
"status" : "published",
"rate" : "5"
},
{
"review_id" : "110",
"product_id" : "0",
"user_id" : "4656",
"body" : "Delightful unreserved impossible few estimating men favourable see entreaties. She propriety immediate was improving. He or entrance humoured likewise moderate. Much nor game son say feel. Fat make met can must form into gate. Me we offending prevailed discovery. ",
"creation_date" : "2016-02-16 16:58:09",
"status" : "unpublished",
"rate" : "5"
}
]
}Post a single review
Request body
{
"email" : "john.doe@example.com",
"name" : "John Doe",
"product_id" : 0,
"body" : "it looks amazing!!!",
"rate" : 5
}Reviewer email
Reviewer name
Reviewed product id (0 - for site review)
Review message
Review score
Responses
Body
Examples
{
"status" : 200,
"message" : "OK",
"data" : {
"review_id" : "1",
"user_id" : "2",
"rate" : 5,
"body" : "it looks amazing!!!",
"creation_date" : "2016-03-24 11:33:11"
}
}Body
Body
Get review score for single product or a group of products
Request parameters
Shopify Product identifiers
Responses
Body
Identifier of selected product (0 for site review)
Examples
{
"status" : 200,
"message" : "OK",
"data" : [
{
"product_id" : "0",
"reviews_count" : "2",
"average_rate" : "4.5000"
}
]
}Identifier of a user in SocialShopWave
(Read-only) Shopify customer id
(Read-only) Shopify customer’s email address
Shopify customer’s first name
Shopify customer’s last name
(Read-only) Link to user’s profile photo
User information. Example: Rare cars collector
User’s birthdate. Example: 1992-05-22
(Read-only) Profile link of a customer
Alpha numeric username of a user. Example: billgates55
Defines who can see user’s profile and activity. Example: public
{
"user_id" : 2,
"customer_id" : "3619153093",
"email" : "sergey.brin@example.com",
"first_name" : "Sergey",
"last_name" : "Brin",
"photo_url" : "https://img7.socialshopwave.com/client1/profileimages/user2/56ca9c026e653service_profile_m.jpg?c=1437947905",
"about" : "Russian-born American computer scientist, internet entrepreneur, and philanthropist",
"birthdate" : "1973-08-21",
"profile_address" : "https://google-glass.myshopify.com/pages/profile/sergey-brin",
"username" : "sergey-brin",
"privacy" : "public"
}Identifier of a user in SocialShopWave
Shopify product_id
Shopify product variant_id
Identifier of a wishlist board
Creation date of item
{
"user_id" : 5,
"product_id" : "1632312451",
"variant_id" : "4835103811",
"board_id" : 4
}Identifier of a user in SocialShopWave
Title of board
{
"board_id" : 4,
"user_id" : 5,
"title" : "Favorites"
}