sparkfly_client.MerchantsItemSetsApi

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

Method	HTTP request	Description
create_merchant_item_set	POST /v1.0/merchants/{merchant_id}/item_sets	Create an item set for merchant
delete_merchant_item_set	DELETE /v1.0/merchants/{merchant_id}/item_sets/{item_set_id}	Delete item set by ID for merchant
get_merchant_item_set	GET /v1.0/merchants/{merchant_id}/item_sets/{item_set_id}	Get item set by ID for merchant
get_merchant_item_sets	GET /v1.0/merchants/{merchant_id}/item_sets	Get all item sets for merchant
update_merchant_item_set	PUT /v1.0/merchants/{merchant_id}/item_sets/{item_set_id}	Update item set by ID for merchant

create_merchant_item_set

ItemSetResponse create_merchant_item_set(merchant_id, item_set_input_request=item_set_input_request)

Create an item set for merchant

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.item_set_input_request import ItemSetInputRequest
from sparkfly_client.models.item_set_response import ItemSetResponse
from sparkfly_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sparkfly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sparkfly_client.Configuration(
    host = "https://api.sparkfly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.MerchantsItemSetsApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    item_set_input_request = sparkfly_client.ItemSetInputRequest() # ItemSetInputRequest | Item set to add (optional)

    try:
        # Create an item set for merchant
        api_response = api_instance.create_merchant_item_set(merchant_id, item_set_input_request=item_set_input_request)
        print("The response of MerchantsItemSetsApi->create_merchant_item_set:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsItemSetsApi->create_merchant_item_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
item_set_input_request	ItemSetInputRequest	Item set to add	[optional]

Return type

ItemSetResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Item set successfully created	* Cache-Control - * Content-Length - * Content-Type - * Date - * Etag - * Location - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
400	Error parsing request	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
401	Unauthorized	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -

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

delete_merchant_item_set

delete_merchant_item_set(merchant_id, item_set_id)

Delete item set by ID for merchant

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sparkfly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sparkfly_client.Configuration(
    host = "https://api.sparkfly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.MerchantsItemSetsApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    item_set_id = 56 # int | The id of the item set

    try:
        # Delete item set by ID for merchant
        api_instance.delete_merchant_item_set(merchant_id, item_set_id)
    except Exception as e:
        print("Exception when calling MerchantsItemSetsApi->delete_merchant_item_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
item_set_id	int	The id of the item set

Return type

void (empty response body)

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Successful deletion	* Cache-Control - * Content-Length - * Content-Type - * Date - * Etag - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
401	Unauthorized	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
404	Item set was not found by id	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -

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

get_merchant_item_set

ItemSetResponse get_merchant_item_set(merchant_id, item_set_id)

Get item set by ID for merchant

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.item_set_response import ItemSetResponse
from sparkfly_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sparkfly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sparkfly_client.Configuration(
    host = "https://api.sparkfly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.MerchantsItemSetsApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    item_set_id = 56 # int | The id of the item set

    try:
        # Get item set by ID for merchant
        api_response = api_instance.get_merchant_item_set(merchant_id, item_set_id)
        print("The response of MerchantsItemSetsApi->get_merchant_item_set:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsItemSetsApi->get_merchant_item_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
item_set_id	int	The id of the item set

Return type

ItemSetResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Item set to be returned	* Cache-Control - * Content-Length - * Date - * Etag - * Server - * Set-Cookie - * X-Auth-Token - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
401	Unauthorized	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
404	Item set was not found by id	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -

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

get_merchant_item_sets

MerchantItemSetList get_merchant_item_sets(merchant_id)

Get all item sets for merchant

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.merchant_item_set_list import MerchantItemSetList
from sparkfly_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sparkfly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sparkfly_client.Configuration(
    host = "https://api.sparkfly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.MerchantsItemSetsApi(api_client)
    merchant_id = 56 # int | The id of the merchant

    try:
        # Get all item sets for merchant
        api_response = api_instance.get_merchant_item_sets(merchant_id)
        print("The response of MerchantsItemSetsApi->get_merchant_item_sets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsItemSetsApi->get_merchant_item_sets: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant

Return type

MerchantItemSetList

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful retrieval of item sets for merchant	* Cache-Control - * Content-Length - * Date - * Etag - * Server - * Set-Cookie - * X-Auth-Token - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
401	Unauthorized	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -

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

update_merchant_item_set

ItemSetResponse update_merchant_item_set(merchant_id, item_set_id, item_set_input_request=item_set_input_request)

Update item set by ID for merchant

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.item_set_input_request import ItemSetInputRequest
from sparkfly_client.models.item_set_response import ItemSetResponse
from sparkfly_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sparkfly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sparkfly_client.Configuration(
    host = "https://api.sparkfly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-Auth-Token
configuration.api_key['X-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with sparkfly_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sparkfly_client.MerchantsItemSetsApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    item_set_id = 56 # int | The id of the item set
    item_set_input_request = sparkfly_client.ItemSetInputRequest() # ItemSetInputRequest | Fields of item set to update in system (optional)

    try:
        # Update item set by ID for merchant
        api_response = api_instance.update_merchant_item_set(merchant_id, item_set_id, item_set_input_request=item_set_input_request)
        print("The response of MerchantsItemSetsApi->update_merchant_item_set:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsItemSetsApi->update_merchant_item_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
item_set_id	int	The id of the item set
item_set_input_request	ItemSetInputRequest	Fields of item set to update in system	[optional]

Return type

ItemSetResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully updated item set	* Cache-Control - * Content-Length - * Date - * Etag - * Server - * Set-Cookie - * X-Auth-Token - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
400	Error parsing request	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
401	Unauthorized	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -
404	Item set was not found by id	* Cache-Control - * Content-Length - * Content-Type - * Date - * Server - * Set-Cookie - * X-Request-Id - * X-Runtime - * X-Ua-Compatible -

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

Files

MerchantsItemSetsApi.md

Latest commit

History

MerchantsItemSetsApi.md

File metadata and controls

sparkfly_client.MerchantsItemSetsApi

create_merchant_item_set

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_merchant_item_set

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_merchant_item_set

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_merchant_item_sets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_merchant_item_set

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details