Skip to content

Latest commit

 

History

History
177 lines (128 loc) · 5.78 KB

BookmarksApi.md

File metadata and controls

177 lines (128 loc) · 5.78 KB
Raw

BookmarksApi

All URIs are relative to https://api.kinow.com/api

Method HTTP request Description
attach_bookmark_to_customer POST /customers/{customer_id}/bookmarks
detach_bookmark_from_customer DELETE /customers/{customer_id}/bookmarks/{product_id}
get_customer_bookmarks GET /customers/{customer_id}/bookmarks

attach_bookmark_to_customer

attach_bookmark_to_customer(customer_id, product_id)

Attach bookmark to customer

Example

from __future__ import print_statement
import time
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiClientId
kinow_client.configuration.api_key['X-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Id'] = 'Bearer'
# Configure API key authorization: ApiClientSecret
kinow_client.configuration.api_key['X-Client-Secret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'

# create an instance of the API class
api_instance = kinow_client.BookmarksApi()
customer_id = 789 # int | Customer ID to fetch
product_id = 789 # int | 

try: 
    api_instance.attach_bookmark_to_customer(customer_id, product_id)
except ApiException as e:
    print("Exception when calling BookmarksApi->attach_bookmark_to_customer: %s\n" % e)

Parameters

Name Type Description Notes
customer_id int Customer ID to fetch
product_id int

Return type

void (empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list]

detach_bookmark_from_customer

detach_bookmark_from_customer(customer_id, product_id)

Detach bookmark from customer

Example

from __future__ import print_statement
import time
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiClientId
kinow_client.configuration.api_key['X-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Id'] = 'Bearer'
# Configure API key authorization: ApiClientSecret
kinow_client.configuration.api_key['X-Client-Secret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'

# create an instance of the API class
api_instance = kinow_client.BookmarksApi()
customer_id = 789 # int | Customer ID to fetch
product_id = 789 # int | 

try: 
    api_instance.detach_bookmark_from_customer(customer_id, product_id)
except ApiException as e:
    print("Exception when calling BookmarksApi->detach_bookmark_from_customer: %s\n" % e)

Parameters

Name Type Description Notes
customer_id int Customer ID to fetch
product_id int

Return type

void (empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list]

get_customer_bookmarks

ProductListResponse get_customer_bookmarks(customer_id, page=page, per_page=per_page, sort_by=sort_by, sort_direction=sort_direction)

Get customer bookmarks

Example

from __future__ import print_statement
import time
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiClientId
kinow_client.configuration.api_key['X-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Id'] = 'Bearer'
# Configure API key authorization: ApiClientSecret
kinow_client.configuration.api_key['X-Client-Secret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'

# create an instance of the API class
api_instance = kinow_client.BookmarksApi()
customer_id = 789 # int | 
page = 789 # int |  (optional)
per_page = 789 # int |  (optional)
sort_by = 'sort_by_example' # str | Sort by this attribute (id by default) (optional)
sort_direction = 'sort_direction_example' # str | Sorting direction (asc by default) (optional)

try: 
    api_response = api_instance.get_customer_bookmarks(customer_id, page=page, per_page=per_page, sort_by=sort_by, sort_direction=sort_direction)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookmarksApi->get_customer_bookmarks: %s\n" % e)

Parameters

Name Type Description Notes
customer_id int
page int [optional]
per_page int [optional]
sort_by str Sort by this attribute (id by default) [optional]
sort_direction str Sorting direction (asc by default) [optional]

Return type

ProductListResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list]