sparkfly_client.MerchantsApi

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

Method	HTTP request	Description
create_merchant	POST /v1.0/merchants	Create a merchant
delete_merchant	DELETE /v1.0/merchants/{merchant_id}	Delete merchant by ID
get_merchant	GET /v1.0/merchants/{merchant_id}	Get merchant by ID
get_merchants	GET /v1.0/merchants	Get all merchants
update_merchant	PUT /v1.0/merchants/{merchant_id}	Update merchant by ID

create_merchant

MerchantResponse create_merchant(merchant_input_request=merchant_input_request)

Create a merchant

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.merchant_input_request import MerchantInputRequest
from sparkfly_client.models.merchant_response import MerchantResponse
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.MerchantsApi(api_client)
    merchant_input_request = sparkfly_client.MerchantInputRequest() # MerchantInputRequest | Merchant to add to system (optional)

    try:
        # Create a merchant
        api_response = api_instance.create_merchant(merchant_input_request=merchant_input_request)
        print("The response of MerchantsApi->create_merchant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsApi->create_merchant: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_input_request	MerchantInputRequest	Merchant to add to system	[optional]

Return type

MerchantResponse

Authorization

X-Auth-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful creation	* 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

delete_merchant(merchant_id)

Delete merchant by ID

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.MerchantsApi(api_client)
    merchant_id = 56 # int | The id of the merchant

    try:
        # Delete merchant by ID
        api_instance.delete_merchant(merchant_id)
    except Exception as e:
        print("Exception when calling MerchantsApi->delete_merchant: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant

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	Merchant 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

MerchantResponse get_merchant(merchant_id)

Get merchant by ID

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.merchant_response import MerchantResponse
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.MerchantsApi(api_client)
    merchant_id = 56 # int | The id of the merchant

    try:
        # Get merchant by ID
        api_response = api_instance.get_merchant(merchant_id)
        print("The response of MerchantsApi->get_merchant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsApi->get_merchant: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant

Return type

MerchantResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	merchant 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	Event 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_merchants

MerchantList get_merchants()

Get all merchants

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.merchant_list import MerchantList
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.MerchantsApi(api_client)

    try:
        # Get all merchants
        api_response = api_instance.get_merchants()
        print("The response of MerchantsApi->get_merchants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsApi->get_merchants: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantList

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	merchants 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 -

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

update_merchant

MerchantResponse update_merchant(merchant_id, merchant_input_request=merchant_input_request)

Update merchant by ID

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.merchant_input_request import MerchantInputRequest
from sparkfly_client.models.merchant_response import MerchantResponse
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.MerchantsApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    merchant_input_request = sparkfly_client.MerchantInputRequest() # MerchantInputRequest | Merchant to update in system (optional)

    try:
        # Update merchant by ID
        api_response = api_instance.update_merchant(merchant_id, merchant_input_request=merchant_input_request)
        print("The response of MerchantsApi->update_merchant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsApi->update_merchant: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
merchant_input_request	MerchantInputRequest	Merchant to update in system	[optional]

Return type

MerchantResponse

Authorization

X-Auth-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	updated merchant	* 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	Event 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

MerchantsApi.md

Latest commit

History

MerchantsApi.md

File metadata and controls

sparkfly_client.MerchantsApi

create_merchant

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_merchant

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_merchant

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_merchants

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_merchant

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details