sparkfly_client.MerchantsStoresApi

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

Method	HTTP request	Description
create_merchant_store	POST /v1.0/merchants/{merchant_id}/stores	Create an Store for merchant
delete_merchant_store	DELETE /v1.0/merchants/{merchant_id}/stores/{store_id}	Delete Store by ID for merchant
get_filtered_merchant_stores	GET /v1.0/merchants/stores/index	Get and Filter Stores WITH Active Offers (stores/index)
get_merchant_store	GET /v1.0/merchants/{merchant_id}/stores/{store_id}	Get Store by ID for merchant
get_merchant_store_offer_ids	GET /v1.0/merchants/{merchant_id}/stores/{store_id}/offers	List Offer IDs for Merchant and Store
get_merchant_store_without_merchant	GET /v1.0/merchants/stores/{store_id}	Get Store by ID (without merchant)
get_merchant_stores	GET /v1.0/merchants/{merchant_id}/stores	Get all Stores for merchant
get_nearby_filtered_merchant_stores	GET /v1.0/merchants/stores/nearby/index	Get and Filter Stores WITH Active Offers (stores/nearby/index)
get_nearby_merchant_stores	GET /v1.0/merchants/stores/nearby/{lat}/{lng}/index	Get and Filter Stores WITH Active Offers (stores/nearby/{lat}/{lng}/index)
update_merchant_store	PUT /v1.0/merchants/{merchant_id}/stores/{store_id}	Update Store by ID for merchant

create_merchant_store

StoreResponse create_merchant_store(merchant_id, store_input_request=store_input_request)

Create an Store for merchant

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.store_input_request import StoreInputRequest
from sparkfly_client.models.store_response import StoreResponse
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.MerchantsStoresApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    store_input_request = sparkfly_client.StoreInputRequest() # StoreInputRequest | Store to add (optional)

    try:
        # Create an Store for merchant
        api_response = api_instance.create_merchant_store(merchant_id, store_input_request=store_input_request)
        print("The response of MerchantsStoresApi->create_merchant_store:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsStoresApi->create_merchant_store: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
store_input_request	StoreInputRequest	Store to add	[optional]

Return type

StoreResponse

Authorization

X-Auth-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Store 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_store

delete_merchant_store(merchant_id, store_id)

Delete Store 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.MerchantsStoresApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    store_id = 56 # int | The id of the store

    try:
        # Delete Store by ID for merchant
        api_instance.delete_merchant_store(merchant_id, store_id)
    except Exception as e:
        print("Exception when calling MerchantsStoresApi->delete_merchant_store: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
store_id	int	The id of the store

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	Store 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_filtered_merchant_stores

StoreListResponse get_filtered_merchant_stores(lat, lng, by_tag_ids=by_tag_ids, sort_by=sort_by)

Get and Filter Stores WITH Active Offers (stores/index)

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.store_list_response import StoreListResponse
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.MerchantsStoresApi(api_client)
    lat = 'lat_example' # str | The latitude for the location to check
    lng = 'lng_example' # str | The longitude for the location to check
    by_tag_ids = 'by_tag_ids_example' # str | Store Tag IDs to filter by (optional)
    sort_by = 'sort_by_example' # str | Sort offers by 1 of their attributes ( name, start_running_at, status ) (optional)

    try:
        # Get and Filter Stores WITH Active Offers (stores/index)
        api_response = api_instance.get_filtered_merchant_stores(lat, lng, by_tag_ids=by_tag_ids, sort_by=sort_by)
        print("The response of MerchantsStoresApi->get_filtered_merchant_stores:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsStoresApi->get_filtered_merchant_stores: %s\n" % e)

Parameters

Name	Type	Description	Notes
lat	str	The latitude for the location to check
lng	str	The longitude for the location to check
by_tag_ids	str	Store Tag IDs to filter by	[optional]
sort_by	str	Sort offers by 1 of their attributes ( name, start_running_at, status )	[optional]

Return type

StoreListResponse

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 Stores	* 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]

get_merchant_store

StoreResponse get_merchant_store(merchant_id, store_id)

Get Store by ID for merchant

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.store_response import StoreResponse
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.MerchantsStoresApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    store_id = 56 # int | The id of the store

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

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
store_id	int	The id of the store

Return type

StoreResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

MerchantStoreOfferIdList get_merchant_store_offer_ids(merchant_id, store_id)

List Offer IDs for Merchant and Store

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.merchant_store_offer_id_list import MerchantStoreOfferIdList
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.MerchantsStoresApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    store_id = 56 # int | The id of the store

    try:
        # List Offer IDs for Merchant and Store
        api_response = api_instance.get_merchant_store_offer_ids(merchant_id, store_id)
        print("The response of MerchantsStoresApi->get_merchant_store_offer_ids:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsStoresApi->get_merchant_store_offer_ids: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
store_id	int	The id of the store

Return type

MerchantStoreOfferIdList

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 Offers for merchant store	* 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]

get_merchant_store_without_merchant

StoreResponse get_merchant_store_without_merchant(store_id)

Get Store by ID (without merchant)

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.store_response import StoreResponse
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.MerchantsStoresApi(api_client)
    store_id = 56 # int | The id of the store

    try:
        # Get Store by ID (without merchant)
        api_response = api_instance.get_merchant_store_without_merchant(store_id)
        print("The response of MerchantsStoresApi->get_merchant_store_without_merchant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsStoresApi->get_merchant_store_without_merchant: %s\n" % e)

Parameters

Name	Type	Description	Notes
store_id	int	The id of the store

Return type

StoreResponse

Authorization

X-Auth-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

StoreListResponse get_merchant_stores(merchant_id, name=name)

Get all Stores for merchant

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.store_list_response import StoreListResponse
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.MerchantsStoresApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    name = 'name_example' # str | The store name to search by (optional)

    try:
        # Get all Stores for merchant
        api_response = api_instance.get_merchant_stores(merchant_id, name=name)
        print("The response of MerchantsStoresApi->get_merchant_stores:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsStoresApi->get_merchant_stores: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
name	str	The store name to search by	[optional]

Return type

StoreListResponse

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 Stores 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]

get_nearby_filtered_merchant_stores

StoreListResponse get_nearby_filtered_merchant_stores(lat, lng, by_tag_ids=by_tag_ids, sort_by=sort_by)

Get and Filter Stores WITH Active Offers (stores/nearby/index)

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.store_list_response import StoreListResponse
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.MerchantsStoresApi(api_client)
    lat = 'lat_example' # str | The latitude for the location to check
    lng = 'lng_example' # str | The longitude for the location to check
    by_tag_ids = 'by_tag_ids_example' # str | Store Tag IDs to filter by (optional)
    sort_by = 'sort_by_example' # str | Sort offers by 1 of their attributes ( name, start_running_at, status ) (optional)

    try:
        # Get and Filter Stores WITH Active Offers (stores/nearby/index)
        api_response = api_instance.get_nearby_filtered_merchant_stores(lat, lng, by_tag_ids=by_tag_ids, sort_by=sort_by)
        print("The response of MerchantsStoresApi->get_nearby_filtered_merchant_stores:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsStoresApi->get_nearby_filtered_merchant_stores: %s\n" % e)

Parameters

Name	Type	Description	Notes
lat	str	The latitude for the location to check
lng	str	The longitude for the location to check
by_tag_ids	str	Store Tag IDs to filter by	[optional]
sort_by	str	Sort offers by 1 of their attributes ( name, start_running_at, status )	[optional]

Return type

StoreListResponse

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 Stores	* 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]

get_nearby_merchant_stores

StoreListResponse get_nearby_merchant_stores(lat, lng, by_tag_ids=by_tag_ids, sort_by=sort_by)

Get and Filter Stores WITH Active Offers (stores/nearby/{lat}/{lng}/index)

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.store_list_response import StoreListResponse
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.MerchantsStoresApi(api_client)
    lat = 'lat_example' # str | The latitude for the location to check
    lng = 'lng_example' # str | The longitude for the location to check
    by_tag_ids = 'by_tag_ids_example' # str | Store Tag IDs to filter by (optional)
    sort_by = 'sort_by_example' # str | Sort offers by 1 of their attributes ( name, start_running_at, status ) (optional)

    try:
        # Get and Filter Stores WITH Active Offers (stores/nearby/{lat}/{lng}/index)
        api_response = api_instance.get_nearby_merchant_stores(lat, lng, by_tag_ids=by_tag_ids, sort_by=sort_by)
        print("The response of MerchantsStoresApi->get_nearby_merchant_stores:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsStoresApi->get_nearby_merchant_stores: %s\n" % e)

Parameters

Name	Type	Description	Notes
lat	str	The latitude for the location to check
lng	str	The longitude for the location to check
by_tag_ids	str	Store Tag IDs to filter by	[optional]
sort_by	str	Sort offers by 1 of their attributes ( name, start_running_at, status )	[optional]

Return type

StoreListResponse

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 Stores	* 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_store

StoreResponse update_merchant_store(merchant_id, store_id, store_input_request=store_input_request)

Update Store by ID for merchant

Example

Api Key Authentication (X-Auth-Token):

import time
import os
import sparkfly_client
from sparkfly_client.models.store_input_request import StoreInputRequest
from sparkfly_client.models.store_response import StoreResponse
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.MerchantsStoresApi(api_client)
    merchant_id = 56 # int | The id of the merchant
    store_id = 56 # int | The id of the store
    store_input_request = sparkfly_client.StoreInputRequest() # StoreInputRequest | Fields of Store to update in system (optional)

    try:
        # Update Store by ID for merchant
        api_response = api_instance.update_merchant_store(merchant_id, store_id, store_input_request=store_input_request)
        print("The response of MerchantsStoresApi->update_merchant_store:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantsStoresApi->update_merchant_store: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id	int	The id of the merchant
store_id	int	The id of the store
store_input_request	StoreInputRequest	Fields of Store to update in system	[optional]

Return type

StoreResponse

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 store	* 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	Store 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

MerchantsStoresApi.md

Latest commit

History

MerchantsStoresApi.md

File metadata and controls

sparkfly_client.MerchantsStoresApi

create_merchant_store

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_merchant_store

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_filtered_merchant_stores

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_merchant_store

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_merchant_store_offer_ids

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_merchant_store_without_merchant

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_merchant_stores

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_nearby_filtered_merchant_stores

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_nearby_merchant_stores

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_merchant_store

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details