Store Harmony E-Commerce API

StoreHarmonyAccess

createMerchantStore

register a store on storeharmony

With an upgraded referral code, a store can be created on storeharmony from any external entity


/access/register

Usage and SDK Samples

curl -X POST "https://storeharmony.net/webapi/access/register"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyAccessApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyAccessApi apiInstance = new StoreHarmonyAccessApi();
        Registration body = ; // Registration | Registration details of user
        try {
            WebStore result = apiInstance.createMerchantStore(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyAccessApi#createMerchantStore");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyAccessApi;

public class StoreHarmonyAccessApiExample {

    public static void main(String[] args) {
        StoreHarmonyAccessApi apiInstance = new StoreHarmonyAccessApi();
        Registration body = ; // Registration | Registration details of user
        try {
            WebStore result = apiInstance.createMerchantStore(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyAccessApi#createMerchantStore");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Registration *body = ; // Registration details of user

StoreHarmonyAccessApi *apiInstance = [[StoreHarmonyAccessApi alloc] init];

// register a store on storeharmony
[apiInstance createMerchantStoreWith:body
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyAccessApi()
var body = ; // {{Registration}} Registration details of user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMerchantStore(body, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class createMerchantStoreExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyAccessApi();
            var body = new Registration(); // Registration | Registration details of user

            try
            {
                // register a store on storeharmony
                WebStore result = apiInstance.createMerchantStore(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyAccessApi.createMerchantStore: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyAccessApi();
$body = ; // Registration | Registration details of user

try {
    $result = $api_instance->createMerchantStore($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyAccessApi->createMerchantStore: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyAccessApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyAccessApi->new();
my $body = WWW::StoreHarmonyClient::Object::Registration->new(); # Registration | Registration details of user

eval { 
    my $result = $api_instance->createMerchantStore(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyAccessApi->createMerchantStore: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyAccessApi()
body =  # Registration | Registration details of user

try: 
    # register a store on storeharmony
    api_response = api_instance.create_merchant_store(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyAccessApi->createMerchantStore: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Returns a merchant store object. Retrieve access token and use to authorize subsequent calls

Status: 403 - Error unable to retrieve a store with the provided ID

Status: 404 - Bad request


disableMerchantStore

requests a deactivation of the account of a store

Enables a user request a cancellation of their storeharmony account


/access/register/{storeid}

Usage and SDK Samples

curl -X DELETE "https://storeharmony.net/webapi/access/register/{storeid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyAccessApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyAccessApi apiInstance = new StoreHarmonyAccessApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.disableMerchantStore(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyAccessApi#disableMerchantStore");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyAccessApi;

public class StoreHarmonyAccessApiExample {

    public static void main(String[] args) {
        StoreHarmonyAccessApi apiInstance = new StoreHarmonyAccessApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.disableMerchantStore(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyAccessApi#disableMerchantStore");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyAccessApi *apiInstance = [[StoreHarmonyAccessApi alloc] init];

// requests a deactivation of the account of a store
[apiInstance disableMerchantStoreWith:storeid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyAccessApi()
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disableMerchantStore(storeid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class disableMerchantStoreExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyAccessApi();
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // requests a deactivation of the account of a store
                WebStore result = apiInstance.disableMerchantStore(storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyAccessApi.disableMerchantStore: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyAccessApi();
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->disableMerchantStore($storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyAccessApi->disableMerchantStore: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyAccessApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyAccessApi->new();
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->disableMerchantStore(storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyAccessApi->disableMerchantStore: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyAccessApi()
storeid = storeid_example # String | The store id of the specific store

try: 
    # requests a deactivation of the account of a store
    api_response = api_instance.disable_merchant_store(storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyAccessApi->disableMerchantStore: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required

Responses

Status: 200 - Returns a merchant store object. Retrieve access token and use to authorize subsequent calls

Status: 403 - Error unable to retrieve a store with the provided ID

Status: 404 - Bad request


loadStoreInfo

Retrieves a merchant store info from Storeharmony

To access details about the merchant being integrated with, call this method passing the merchant store id as generated by storeharmony and provided per merchant store


/{storeid}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyAccessApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyAccessApi apiInstance = new StoreHarmonyAccessApi();
        String storeid = storeid_example; // String | The id of the merchant store to be retrieved
        try {
            WebStore result = apiInstance.loadStoreInfo(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyAccessApi#loadStoreInfo");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyAccessApi;

public class StoreHarmonyAccessApiExample {

    public static void main(String[] args) {
        StoreHarmonyAccessApi apiInstance = new StoreHarmonyAccessApi();
        String storeid = storeid_example; // String | The id of the merchant store to be retrieved
        try {
            WebStore result = apiInstance.loadStoreInfo(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyAccessApi#loadStoreInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The id of the merchant store to be retrieved

StoreHarmonyAccessApi *apiInstance = [[StoreHarmonyAccessApi alloc] init];

// Retrieves a merchant store info from Storeharmony
[apiInstance loadStoreInfoWith:storeid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyAccessApi()
var storeid = storeid_example; // {{String}} The id of the merchant store to be retrieved

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loadStoreInfo(storeid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class loadStoreInfoExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyAccessApi();
            var storeid = storeid_example;  // String | The id of the merchant store to be retrieved

            try
            {
                // Retrieves a merchant store info from Storeharmony
                WebStore result = apiInstance.loadStoreInfo(storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyAccessApi.loadStoreInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyAccessApi();
$storeid = storeid_example; // String | The id of the merchant store to be retrieved

try {
    $result = $api_instance->loadStoreInfo($storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyAccessApi->loadStoreInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyAccessApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyAccessApi->new();
my $storeid = storeid_example; # String | The id of the merchant store to be retrieved

eval { 
    my $result = $api_instance->loadStoreInfo(storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyAccessApi->loadStoreInfo: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyAccessApi()
storeid = storeid_example # String | The id of the merchant store to be retrieved

try: 
    # Retrieves a merchant store info from Storeharmony
    api_response = api_instance.load_store_info(storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyAccessApi->loadStoreInfo: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The id of the merchant store to be retrieved
Required

Responses

Status: 200 - The merchant store object containing the merchant details

Status: 414 - Error unable to retrieve a store with the provided ID


loginToMerchantStore

creates a login request to retrieve the authorization token to make calls on behalf of the store

Enables a user create a login request to retrieve the authorization token to make calls on behalf of the store


/access

Usage and SDK Samples

curl -X POST "https://storeharmony.net/webapi/access"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyAccessApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyAccessApi apiInstance = new StoreHarmonyAccessApi();
        Credentials body = ; // Credentials | login details of user
        try {
            WebStore result = apiInstance.loginToMerchantStore(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyAccessApi#loginToMerchantStore");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyAccessApi;

public class StoreHarmonyAccessApiExample {

    public static void main(String[] args) {
        StoreHarmonyAccessApi apiInstance = new StoreHarmonyAccessApi();
        Credentials body = ; // Credentials | login details of user
        try {
            WebStore result = apiInstance.loginToMerchantStore(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyAccessApi#loginToMerchantStore");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Credentials *body = ; // login details of user

StoreHarmonyAccessApi *apiInstance = [[StoreHarmonyAccessApi alloc] init];

// creates a login request to retrieve the authorization token to make calls on behalf of the store
[apiInstance loginToMerchantStoreWith:body
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyAccessApi()
var body = ; // {{Credentials}} login details of user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loginToMerchantStore(body, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class loginToMerchantStoreExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyAccessApi();
            var body = new Credentials(); // Credentials | login details of user

            try
            {
                // creates a login request to retrieve the authorization token to make calls on behalf of the store
                WebStore result = apiInstance.loginToMerchantStore(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyAccessApi.loginToMerchantStore: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyAccessApi();
$body = ; // Credentials | login details of user

try {
    $result = $api_instance->loginToMerchantStore($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyAccessApi->loginToMerchantStore: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyAccessApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyAccessApi->new();
my $body = WWW::StoreHarmonyClient::Object::Credentials->new(); # Credentials | login details of user

eval { 
    my $result = $api_instance->loginToMerchantStore(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyAccessApi->loginToMerchantStore: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyAccessApi()
body =  # Credentials | login details of user

try: 
    # creates a login request to retrieve the authorization token to make calls on behalf of the store
    api_response = api_instance.login_to_merchant_store(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyAccessApi->loginToMerchantStore: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Returns a merchant store object. Retrieve access token and use to authorize subsequent calls

Status: 403 - Error unable to retrieve a store with the provided ID

Status: 404 - Bad request


updateMerchantStore

updates a merchant info

Enable update of a merchant info


/access/register/{storeid}

Usage and SDK Samples

curl -X PUT "https://storeharmony.net/webapi/access/register/{storeid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyAccessApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyAccessApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyAccessApi apiInstance = new StoreHarmonyAccessApi();
        Registration body = ; // Registration | Registration details of user
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.updateMerchantStore(body, storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyAccessApi#updateMerchantStore");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyAccessApi;

public class StoreHarmonyAccessApiExample {

    public static void main(String[] args) {
        StoreHarmonyAccessApi apiInstance = new StoreHarmonyAccessApi();
        Registration body = ; // Registration | Registration details of user
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.updateMerchantStore(body, storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyAccessApi#updateMerchantStore");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Registration *body = ; // Registration details of user
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyAccessApi *apiInstance = [[StoreHarmonyAccessApi alloc] init];

// updates a merchant info
[apiInstance updateMerchantStoreWith:body
    storeid:storeid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyAccessApi()
var body = ; // {{Registration}} Registration details of user
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateMerchantStore(bodystoreid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class updateMerchantStoreExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyAccessApi();
            var body = new Registration(); // Registration | Registration details of user
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // updates a merchant info
                WebStore result = apiInstance.updateMerchantStore(body, storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyAccessApi.updateMerchantStore: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyAccessApi();
$body = ; // Registration | Registration details of user
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->updateMerchantStore($body, $storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyAccessApi->updateMerchantStore: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyAccessApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyAccessApi->new();
my $body = WWW::StoreHarmonyClient::Object::Registration->new(); # Registration | Registration details of user
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->updateMerchantStore(body => $body, storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyAccessApi->updateMerchantStore: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyAccessApi()
body =  # Registration | Registration details of user
storeid = storeid_example # String | The store id of the specific store

try: 
    # updates a merchant info
    api_response = api_instance.update_merchant_store(body, storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyAccessApi->updateMerchantStore: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Returns a merchant store object. Retrieve access token and use to authorize subsequent calls

Status: 403 - Error unable to retrieve a store with the provided ID

Status: 404 - Bad request


StoreHarmonyContacts

createCustomer

Create customer contacts for a store merchant

Create a customer information for the merchant


/contact/{storeid}

Usage and SDK Samples

curl -X POST "https://storeharmony.net/webapi/contact/{storeid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        Customer body = ; // Customer | Customer contact details
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            CustomerData result = apiInstance.createCustomer(body, storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#createCustomer");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        Customer body = ; // Customer | Customer contact details
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            CustomerData result = apiInstance.createCustomer(body, storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#createCustomer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Customer *body = ; // Customer contact details
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyContactsApi *apiInstance = [[StoreHarmonyContactsApi alloc] init];

// Create customer contacts for a store merchant
[apiInstance createCustomerWith:body
    storeid:storeid
              completionHandler: ^(CustomerData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyContactsApi()
var body = ; // {{Customer}} Customer contact details
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCustomer(bodystoreid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class createCustomerExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyContactsApi();
            var body = new Customer(); // Customer | Customer contact details
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // Create customer contacts for a store merchant
                CustomerData result = apiInstance.createCustomer(body, storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyContactsApi.createCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyContactsApi();
$body = ; // Customer | Customer contact details
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->createCustomer($body, $storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyContactsApi->createCustomer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyContactsApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyContactsApi->new();
my $body = WWW::StoreHarmonyClient::Object::Customer->new(); # Customer | Customer contact details
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->createCustomer(body => $body, storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyContactsApi->createCustomer: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyContactsApi()
body =  # Customer | Customer contact details
storeid = storeid_example # String | The store id of the specific store

try: 
    # Create customer contacts for a store merchant
    api_response = api_instance.create_customer(body, storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyContactsApi->createCustomer: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The merchant customer list. Retrieve list by calling 'object.customerList'

Status: 404 - Error unable to retrieve a store with the provided ID


customerReport

Reports on the customer records giving best customer etc

Returns a basic report on customer


/contact/report/{storeid}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/contact/report/{storeid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            CustomerData result = apiInstance.customerReport(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#customerReport");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            CustomerData result = apiInstance.customerReport(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#customerReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyContactsApi *apiInstance = [[StoreHarmonyContactsApi alloc] init];

// Reports on the customer records giving best customer etc
[apiInstance customerReportWith:storeid
              completionHandler: ^(CustomerData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyContactsApi()
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customerReport(storeid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class customerReportExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyContactsApi();
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // Reports on the customer records giving best customer etc
                CustomerData result = apiInstance.customerReport(storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyContactsApi.customerReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyContactsApi();
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->customerReport($storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyContactsApi->customerReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyContactsApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyContactsApi->new();
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->customerReport(storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyContactsApi->customerReport: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyContactsApi()
storeid = storeid_example # String | The store id of the specific store

try: 
    # Reports on the customer records giving best customer etc
    api_response = api_instance.customer_report(storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyContactsApi->customerReport: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required

Responses

Status: 200 - The merchant customer list.

Status: 404 - Error unable to retrieve a store with the provided ID


deleteCustomer

Deletes a customer contacts details for a store merchant

Deletes a customer of the merchant accouunt with provided ID


/contact/{storeid}/{customerid}

Usage and SDK Samples

curl -X DELETE "https://storeharmony.net/webapi/contact/{storeid}/{customerid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String customerid = customerid_example; // String | The customerid id of the contact
        try {
            Customer result = apiInstance.deleteCustomer(storeid, customerid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#deleteCustomer");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String customerid = customerid_example; // String | The customerid id of the contact
        try {
            Customer result = apiInstance.deleteCustomer(storeid, customerid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#deleteCustomer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *customerid = customerid_example; // The customerid id of the contact

StoreHarmonyContactsApi *apiInstance = [[StoreHarmonyContactsApi alloc] init];

// Deletes a customer contacts details for a store merchant
[apiInstance deleteCustomerWith:storeid
    customerid:customerid
              completionHandler: ^(Customer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyContactsApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var customerid = customerid_example; // {{String}} The customerid id of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCustomer(storeid, customerid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class deleteCustomerExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyContactsApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var customerid = customerid_example;  // String | The customerid id of the contact

            try
            {
                // Deletes a customer contacts details for a store merchant
                Customer result = apiInstance.deleteCustomer(storeid, customerid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyContactsApi.deleteCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyContactsApi();
$storeid = storeid_example; // String | The store id of the specific store
$customerid = customerid_example; // String | The customerid id of the contact

try {
    $result = $api_instance->deleteCustomer($storeid, $customerid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyContactsApi->deleteCustomer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyContactsApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyContactsApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $customerid = customerid_example; # String | The customerid id of the contact

eval { 
    my $result = $api_instance->deleteCustomer(storeid => $storeid, customerid => $customerid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyContactsApi->deleteCustomer: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyContactsApi()
storeid = storeid_example # String | The store id of the specific store
customerid = customerid_example # String | The customerid id of the contact

try: 
    # Deletes a customer contacts details for a store merchant
    api_response = api_instance.delete_customer(storeid, customerid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyContactsApi->deleteCustomer: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
customerid*
String (string)
The customerid id of the contact
Required

Responses

Status: 200 - The merchant deleted customer information.

Status: 404 - Error unable to retrieve a store with the provided ID


getCustomer

Retrieves a customer contacts details for a store merchant

Retrieves a customer of the merchant accouunt with provided ID


/contact/{storeid}/{customerid}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/contact/{storeid}/{customerid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String customerid = customerid_example; // String | The customerid id of the contact
        try {
            Customer result = apiInstance.getCustomer(storeid, customerid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#getCustomer");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String customerid = customerid_example; // String | The customerid id of the contact
        try {
            Customer result = apiInstance.getCustomer(storeid, customerid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#getCustomer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *customerid = customerid_example; // The customerid id of the contact

StoreHarmonyContactsApi *apiInstance = [[StoreHarmonyContactsApi alloc] init];

// Retrieves a customer contacts details for a store merchant
[apiInstance getCustomerWith:storeid
    customerid:customerid
              completionHandler: ^(Customer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyContactsApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var customerid = customerid_example; // {{String}} The customerid id of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCustomer(storeid, customerid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class getCustomerExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyContactsApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var customerid = customerid_example;  // String | The customerid id of the contact

            try
            {
                // Retrieves a customer contacts details for a store merchant
                Customer result = apiInstance.getCustomer(storeid, customerid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyContactsApi.getCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyContactsApi();
$storeid = storeid_example; // String | The store id of the specific store
$customerid = customerid_example; // String | The customerid id of the contact

try {
    $result = $api_instance->getCustomer($storeid, $customerid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyContactsApi->getCustomer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyContactsApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyContactsApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $customerid = customerid_example; # String | The customerid id of the contact

eval { 
    my $result = $api_instance->getCustomer(storeid => $storeid, customerid => $customerid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyContactsApi->getCustomer: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyContactsApi()
storeid = storeid_example # String | The store id of the specific store
customerid = customerid_example # String | The customerid id of the contact

try: 
    # Retrieves a customer contacts details for a store merchant
    api_response = api_instance.get_customer(storeid, customerid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyContactsApi->getCustomer: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
customerid*
String (string)
The customerid id of the contact
Required

Responses

Status: 200 - The merchant customer information.

Status: 404 - Error unable to retrieve a store with the provided ID


listCustomer

List customer contacts for a store merchant

Returns the list of contacts for a merchant accouunt


/contact/{storeid}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/contact/{storeid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            CustomerData result = apiInstance.listCustomer(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#listCustomer");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            CustomerData result = apiInstance.listCustomer(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#listCustomer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyContactsApi *apiInstance = [[StoreHarmonyContactsApi alloc] init];

// List customer contacts for a store merchant
[apiInstance listCustomerWith:storeid
              completionHandler: ^(CustomerData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyContactsApi()
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCustomer(storeid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class listCustomerExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyContactsApi();
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // List customer contacts for a store merchant
                CustomerData result = apiInstance.listCustomer(storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyContactsApi.listCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyContactsApi();
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->listCustomer($storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyContactsApi->listCustomer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyContactsApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyContactsApi->new();
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->listCustomer(storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyContactsApi->listCustomer: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyContactsApi()
storeid = storeid_example # String | The store id of the specific store

try: 
    # List customer contacts for a store merchant
    api_response = api_instance.list_customer(storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyContactsApi->listCustomer: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required

Responses

Status: 200 - The merchant customer list. Retrieve list by calling 'object.customerList'

Status: 404 - Error unable to retrieve a store with the provided ID


listCustomerByPage

List customer contacts for a store merchant

Returns the list of contacts for a merchant accouunt


/contact/{storeid}/{page}/{size}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/contact/{storeid}/{page}/{size}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String page = page_example; // String | page number to start listing
        String size = size_example; // String | size of records to list
        try {
            CustomerData result = apiInstance.listCustomerByPage(storeid, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#listCustomerByPage");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String page = page_example; // String | page number to start listing
        String size = size_example; // String | size of records to list
        try {
            CustomerData result = apiInstance.listCustomerByPage(storeid, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#listCustomerByPage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *page = page_example; // page number to start listing
String *size = size_example; // size of records to list

StoreHarmonyContactsApi *apiInstance = [[StoreHarmonyContactsApi alloc] init];

// List customer contacts for a store merchant
[apiInstance listCustomerByPageWith:storeid
    page:page
    size:size
              completionHandler: ^(CustomerData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyContactsApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var page = page_example; // {{String}} page number to start listing
var size = size_example; // {{String}} size of records to list

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCustomerByPage(storeid, page, size, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class listCustomerByPageExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyContactsApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var page = page_example;  // String | page number to start listing
            var size = size_example;  // String | size of records to list

            try
            {
                // List customer contacts for a store merchant
                CustomerData result = apiInstance.listCustomerByPage(storeid, page, size);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyContactsApi.listCustomerByPage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyContactsApi();
$storeid = storeid_example; // String | The store id of the specific store
$page = page_example; // String | page number to start listing
$size = size_example; // String | size of records to list

try {
    $result = $api_instance->listCustomerByPage($storeid, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyContactsApi->listCustomerByPage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyContactsApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyContactsApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $page = page_example; # String | page number to start listing
my $size = size_example; # String | size of records to list

eval { 
    my $result = $api_instance->listCustomerByPage(storeid => $storeid, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyContactsApi->listCustomerByPage: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyContactsApi()
storeid = storeid_example # String | The store id of the specific store
page = page_example # String | page number to start listing
size = size_example # String | size of records to list

try: 
    # List customer contacts for a store merchant
    api_response = api_instance.list_customer_by_page(storeid, page, size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyContactsApi->listCustomerByPage: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
page*
String (string)
page number to start listing
Required
size*
String (string)
size of records to list
Required

Responses

Status: 200 - The merchant customer list.

Status: 404 - Error unable to retrieve a store with the provided ID


searchCustomer

List customer contacts for a store merchant

Returns the list of contacts for a merchant accouunt


/contact/{storeid}/{search}/{page}/{size}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/contact/{storeid}/{search}/{page}/{size}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String search = search_example; // String | The search query
        String page = page_example; // String | page number to start listing
        String size = size_example; // String | size of records to list
        try {
            CustomerData result = apiInstance.searchCustomer(storeid, search, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#searchCustomer");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String search = search_example; // String | The search query
        String page = page_example; // String | page number to start listing
        String size = size_example; // String | size of records to list
        try {
            CustomerData result = apiInstance.searchCustomer(storeid, search, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#searchCustomer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *search = search_example; // The search query
String *page = page_example; // page number to start listing
String *size = size_example; // size of records to list

StoreHarmonyContactsApi *apiInstance = [[StoreHarmonyContactsApi alloc] init];

// List customer contacts for a store merchant
[apiInstance searchCustomerWith:storeid
    search:search
    page:page
    size:size
              completionHandler: ^(CustomerData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyContactsApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var search = search_example; // {{String}} The search query
var page = page_example; // {{String}} page number to start listing
var size = size_example; // {{String}} size of records to list

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchCustomer(storeid, search, page, size, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class searchCustomerExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyContactsApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var search = search_example;  // String | The search query
            var page = page_example;  // String | page number to start listing
            var size = size_example;  // String | size of records to list

            try
            {
                // List customer contacts for a store merchant
                CustomerData result = apiInstance.searchCustomer(storeid, search, page, size);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyContactsApi.searchCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyContactsApi();
$storeid = storeid_example; // String | The store id of the specific store
$search = search_example; // String | The search query
$page = page_example; // String | page number to start listing
$size = size_example; // String | size of records to list

try {
    $result = $api_instance->searchCustomer($storeid, $search, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyContactsApi->searchCustomer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyContactsApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyContactsApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $search = search_example; # String | The search query
my $page = page_example; # String | page number to start listing
my $size = size_example; # String | size of records to list

eval { 
    my $result = $api_instance->searchCustomer(storeid => $storeid, search => $search, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyContactsApi->searchCustomer: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyContactsApi()
storeid = storeid_example # String | The store id of the specific store
search = search_example # String | The search query
page = page_example # String | page number to start listing
size = size_example # String | size of records to list

try: 
    # List customer contacts for a store merchant
    api_response = api_instance.search_customer(storeid, search, page, size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyContactsApi->searchCustomer: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
search*
page*
String (string)
page number to start listing
Required
size*
String (string)
size of records to list
Required

Responses

Status: 200 - The merchant customer list.

Status: 404 - Error unable to retrieve a store with the provided ID


updateCustomer

Updates a customer contacts details for a store merchant

Updates a customer of the merchant accouunt with provided ID


/contact/{storeid}/{customerid}

Usage and SDK Samples

curl -X PUT "https://storeharmony.net/webapi/contact/{storeid}/{customerid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        Customer body = ; // Customer | Customer contact details
        String storeid = storeid_example; // String | The store id of the specific store
        String customerid = customerid_example; // String | The customerid id of the contact
        try {
            Customer result = apiInstance.updateCustomer(body, storeid, customerid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#updateCustomer");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyContactsApi;

public class StoreHarmonyContactsApiExample {

    public static void main(String[] args) {
        StoreHarmonyContactsApi apiInstance = new StoreHarmonyContactsApi();
        Customer body = ; // Customer | Customer contact details
        String storeid = storeid_example; // String | The store id of the specific store
        String customerid = customerid_example; // String | The customerid id of the contact
        try {
            Customer result = apiInstance.updateCustomer(body, storeid, customerid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyContactsApi#updateCustomer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Customer *body = ; // Customer contact details
String *storeid = storeid_example; // The store id of the specific store
String *customerid = customerid_example; // The customerid id of the contact

StoreHarmonyContactsApi *apiInstance = [[StoreHarmonyContactsApi alloc] init];

// Updates a customer contacts details for a store merchant
[apiInstance updateCustomerWith:body
    storeid:storeid
    customerid:customerid
              completionHandler: ^(Customer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyContactsApi()
var body = ; // {{Customer}} Customer contact details
var storeid = storeid_example; // {{String}} The store id of the specific store
var customerid = customerid_example; // {{String}} The customerid id of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCustomer(bodystoreidcustomerid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class updateCustomerExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyContactsApi();
            var body = new Customer(); // Customer | Customer contact details
            var storeid = storeid_example;  // String | The store id of the specific store
            var customerid = customerid_example;  // String | The customerid id of the contact

            try
            {
                // Updates a customer contacts details for a store merchant
                Customer result = apiInstance.updateCustomer(body, storeid, customerid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyContactsApi.updateCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyContactsApi();
$body = ; // Customer | Customer contact details
$storeid = storeid_example; // String | The store id of the specific store
$customerid = customerid_example; // String | The customerid id of the contact

try {
    $result = $api_instance->updateCustomer($body, $storeid, $customerid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyContactsApi->updateCustomer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyContactsApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyContactsApi->new();
my $body = WWW::StoreHarmonyClient::Object::Customer->new(); # Customer | Customer contact details
my $storeid = storeid_example; # String | The store id of the specific store
my $customerid = customerid_example; # String | The customerid id of the contact

eval { 
    my $result = $api_instance->updateCustomer(body => $body, storeid => $storeid, customerid => $customerid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyContactsApi->updateCustomer: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyContactsApi()
body =  # Customer | Customer contact details
storeid = storeid_example # String | The store id of the specific store
customerid = customerid_example # String | The customerid id of the contact

try: 
    # Updates a customer contacts details for a store merchant
    api_response = api_instance.update_customer(body, storeid, customerid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyContactsApi->updateCustomer: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
customerid*
String (string)
The customerid id of the contact
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The merchant deleted customer information.

Status: 404 - Error unable to retrieve a store with the provided ID


StoreHarmonyInventory

listStoreInventory

retrieve list of products from the merchant store

Returns a list of available items from a merchant store which can be displayed for a client app to use to info their users on prices or availablity


/{storeid}/inventory

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/inventory"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.listStoreInventory(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#listStoreInventory");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.listStoreInventory(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#listStoreInventory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyInventoryApi *apiInstance = [[StoreHarmonyInventoryApi alloc] init];

// retrieve list of products from the merchant store
[apiInstance listStoreInventoryWith:storeid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyInventoryApi()
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStoreInventory(storeid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class listStoreInventoryExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyInventoryApi();
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // retrieve list of products from the merchant store
                WebStore result = apiInstance.listStoreInventory(storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyInventoryApi.listStoreInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyInventoryApi();
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->listStoreInventory($storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyInventoryApi->listStoreInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyInventoryApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyInventoryApi->new();
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->listStoreInventory(storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyInventoryApi->listStoreInventory: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyInventoryApi()
storeid = storeid_example # String | The store id of the specific store

try: 
    # retrieve list of products from the merchant store
    api_response = api_instance.list_store_inventory(storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyInventoryApi->listStoreInventory: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required

Responses

Status: 200 - The merchant store inventory which can be accessed as 'object.products'

Status: 404 - Error unable to retrieve a store with the provided ID


listStoreInventoryPaged

retrieve list of products from the merchant store

Returns a list of available items from a merchant store which can be displayed for a client app to use to info their users on prices or availablity


/{storeid}/{start}/{size}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/{start}/{size}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String start = start_example; // String | The start of page of listed products
        String size = size_example; // String | The size of page of listed products
        try {
            WebStore result = apiInstance.listStoreInventoryPaged(storeid, start, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#listStoreInventoryPaged");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String start = start_example; // String | The start of page of listed products
        String size = size_example; // String | The size of page of listed products
        try {
            WebStore result = apiInstance.listStoreInventoryPaged(storeid, start, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#listStoreInventoryPaged");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *start = start_example; // The start of page of listed products
String *size = size_example; // The size of page of listed products

StoreHarmonyInventoryApi *apiInstance = [[StoreHarmonyInventoryApi alloc] init];

// retrieve list of products from the merchant store
[apiInstance listStoreInventoryPagedWith:storeid
    start:start
    size:size
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyInventoryApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var start = start_example; // {{String}} The start of page of listed products
var size = size_example; // {{String}} The size of page of listed products

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStoreInventoryPaged(storeid, start, size, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class listStoreInventoryPagedExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyInventoryApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var start = start_example;  // String | The start of page of listed products
            var size = size_example;  // String | The size of page of listed products

            try
            {
                // retrieve list of products from the merchant store
                WebStore result = apiInstance.listStoreInventoryPaged(storeid, start, size);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyInventoryApi.listStoreInventoryPaged: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyInventoryApi();
$storeid = storeid_example; // String | The store id of the specific store
$start = start_example; // String | The start of page of listed products
$size = size_example; // String | The size of page of listed products

try {
    $result = $api_instance->listStoreInventoryPaged($storeid, $start, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyInventoryApi->listStoreInventoryPaged: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyInventoryApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyInventoryApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $start = start_example; # String | The start of page of listed products
my $size = size_example; # String | The size of page of listed products

eval { 
    my $result = $api_instance->listStoreInventoryPaged(storeid => $storeid, start => $start, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyInventoryApi->listStoreInventoryPaged: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyInventoryApi()
storeid = storeid_example # String | The store id of the specific store
start = start_example # String | The start of page of listed products
size = size_example # String | The size of page of listed products

try: 
    # retrieve list of products from the merchant store
    api_response = api_instance.list_store_inventory_paged(storeid, start, size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyInventoryApi->listStoreInventoryPaged: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
start*
String (string)
The start of page of listed products
Required
size*
String (string)
The size of page of listed products
Required

Responses

Status: 200 - The merchant store inventory which can be accessed as 'object.products'

Status: 404 - Error unable to retrieve a store with the provided ID


loadStoreCategories

retrieve list of products categories from the merchant store

Returns a list of available items from a merchant store which can be displayed for a client app to use to info their users on prices or availablity


/{storeid}/categories

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/categories"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.loadStoreCategories(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreCategories");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.loadStoreCategories(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreCategories");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyInventoryApi *apiInstance = [[StoreHarmonyInventoryApi alloc] init];

// retrieve list of products categories from the merchant store
[apiInstance loadStoreCategoriesWith:storeid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyInventoryApi()
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loadStoreCategories(storeid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class loadStoreCategoriesExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyInventoryApi();
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // retrieve list of products categories from the merchant store
                WebStore result = apiInstance.loadStoreCategories(storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyInventoryApi.loadStoreCategories: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyInventoryApi();
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->loadStoreCategories($storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyInventoryApi->loadStoreCategories: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyInventoryApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyInventoryApi->new();
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->loadStoreCategories(storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyInventoryApi->loadStoreCategories: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyInventoryApi()
storeid = storeid_example # String | The store id of the specific store

try: 
    # retrieve list of products categories from the merchant store
    api_response = api_instance.load_store_categories(storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyInventoryApi->loadStoreCategories: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required

Responses

Status: 200 - The merchant store inventory which can be accessed as 'object.products'

Status: 404 - Error unable to retrieve a store with the provided ID


loadStoreItem

retrieve a product from the store getting its price, details and availability

Returns the details about a store product which can be connected to a payment process or checkout process


/{storeid}/{itemid}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/{itemid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String itemid = itemid_example; // String | The itemid carrying the ID or slug of the product being loaded
        try {
            WebStore result = apiInstance.loadStoreItem(storeid, itemid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreItem");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String itemid = itemid_example; // String | The itemid carrying the ID or slug of the product being loaded
        try {
            WebStore result = apiInstance.loadStoreItem(storeid, itemid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *itemid = itemid_example; // The itemid carrying the ID or slug of the product being loaded

StoreHarmonyInventoryApi *apiInstance = [[StoreHarmonyInventoryApi alloc] init];

// retrieve a product from the store getting its price, details and availability
[apiInstance loadStoreItemWith:storeid
    itemid:itemid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyInventoryApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var itemid = itemid_example; // {{String}} The itemid carrying the ID or slug of the product being loaded

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loadStoreItem(storeid, itemid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class loadStoreItemExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyInventoryApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var itemid = itemid_example;  // String | The itemid carrying the ID or slug of the product being loaded

            try
            {
                // retrieve a product from the store getting its price, details and availability
                WebStore result = apiInstance.loadStoreItem(storeid, itemid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyInventoryApi.loadStoreItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyInventoryApi();
$storeid = storeid_example; // String | The store id of the specific store
$itemid = itemid_example; // String | The itemid carrying the ID or slug of the product being loaded

try {
    $result = $api_instance->loadStoreItem($storeid, $itemid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyInventoryApi->loadStoreItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyInventoryApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyInventoryApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $itemid = itemid_example; # String | The itemid carrying the ID or slug of the product being loaded

eval { 
    my $result = $api_instance->loadStoreItem(storeid => $storeid, itemid => $itemid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyInventoryApi->loadStoreItem: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyInventoryApi()
storeid = storeid_example # String | The store id of the specific store
itemid = itemid_example # String | The itemid carrying the ID or slug of the product being loaded

try: 
    # retrieve a product from the store getting its price, details and availability
    api_response = api_instance.load_store_item(storeid, itemid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyInventoryApi->loadStoreItem: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
itemid*
String (string)
The itemid carrying the ID or slug of the product being loaded
Required

Responses

Status: 200 - The merchant store object containing the merchant details

Status: 414 - Error unable to retrieve a store with the provided ID


loadStoreItemBySlug

retrieve a product from the store getting its price, details and availability via a slug

Returns the details about a store product usnig its slug


/{storeid}/slug/{slug}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/slug/{slug}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String slug = slug_example; // String | The slug carrying the ID or slug of the product being loaded
        try {
            WebStore result = apiInstance.loadStoreItemBySlug(storeid, slug);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreItemBySlug");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String slug = slug_example; // String | The slug carrying the ID or slug of the product being loaded
        try {
            WebStore result = apiInstance.loadStoreItemBySlug(storeid, slug);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreItemBySlug");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *slug = slug_example; // The slug carrying the ID or slug of the product being loaded

StoreHarmonyInventoryApi *apiInstance = [[StoreHarmonyInventoryApi alloc] init];

// retrieve a product from the store getting its price, details and availability via a slug
[apiInstance loadStoreItemBySlugWith:storeid
    slug:slug
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyInventoryApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var slug = slug_example; // {{String}} The slug carrying the ID or slug of the product being loaded

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loadStoreItemBySlug(storeid, slug, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class loadStoreItemBySlugExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyInventoryApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var slug = slug_example;  // String | The slug carrying the ID or slug of the product being loaded

            try
            {
                // retrieve a product from the store getting its price, details and availability via a slug
                WebStore result = apiInstance.loadStoreItemBySlug(storeid, slug);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyInventoryApi.loadStoreItemBySlug: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyInventoryApi();
$storeid = storeid_example; // String | The store id of the specific store
$slug = slug_example; // String | The slug carrying the ID or slug of the product being loaded

try {
    $result = $api_instance->loadStoreItemBySlug($storeid, $slug);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyInventoryApi->loadStoreItemBySlug: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyInventoryApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyInventoryApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $slug = slug_example; # String | The slug carrying the ID or slug of the product being loaded

eval { 
    my $result = $api_instance->loadStoreItemBySlug(storeid => $storeid, slug => $slug);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyInventoryApi->loadStoreItemBySlug: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyInventoryApi()
storeid = storeid_example # String | The store id of the specific store
slug = slug_example # String | The slug carrying the ID or slug of the product being loaded

try: 
    # retrieve a product from the store getting its price, details and availability via a slug
    api_response = api_instance.load_store_item_by_slug(storeid, slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyInventoryApi->loadStoreItemBySlug: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
slug*
String (string)
The slug carrying the ID or slug of the product being loaded
Required

Responses

Status: 200 - The merchant store object containing the merchant details

Status: 414 - Error unable to retrieve a store with the provided ID or item


loadStoreItemByUniqueId

retrieve a product from the store getting its price, details and availability

Returns the details about a store product usnig its universal ID


/{storeid}/id/{itemid}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/id/{itemid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String itemid = itemid_example; // String | The itemid carrying the ID or slug of the product being loaded
        try {
            WebStore result = apiInstance.loadStoreItemByUniqueId(storeid, itemid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreItemByUniqueId");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String itemid = itemid_example; // String | The itemid carrying the ID or slug of the product being loaded
        try {
            WebStore result = apiInstance.loadStoreItemByUniqueId(storeid, itemid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreItemByUniqueId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *itemid = itemid_example; // The itemid carrying the ID or slug of the product being loaded

StoreHarmonyInventoryApi *apiInstance = [[StoreHarmonyInventoryApi alloc] init];

// retrieve a product from the store getting its price, details and availability
[apiInstance loadStoreItemByUniqueIdWith:storeid
    itemid:itemid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyInventoryApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var itemid = itemid_example; // {{String}} The itemid carrying the ID or slug of the product being loaded

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loadStoreItemByUniqueId(storeid, itemid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class loadStoreItemByUniqueIdExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyInventoryApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var itemid = itemid_example;  // String | The itemid carrying the ID or slug of the product being loaded

            try
            {
                // retrieve a product from the store getting its price, details and availability
                WebStore result = apiInstance.loadStoreItemByUniqueId(storeid, itemid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyInventoryApi.loadStoreItemByUniqueId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyInventoryApi();
$storeid = storeid_example; // String | The store id of the specific store
$itemid = itemid_example; // String | The itemid carrying the ID or slug of the product being loaded

try {
    $result = $api_instance->loadStoreItemByUniqueId($storeid, $itemid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyInventoryApi->loadStoreItemByUniqueId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyInventoryApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyInventoryApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $itemid = itemid_example; # String | The itemid carrying the ID or slug of the product being loaded

eval { 
    my $result = $api_instance->loadStoreItemByUniqueId(storeid => $storeid, itemid => $itemid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyInventoryApi->loadStoreItemByUniqueId: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyInventoryApi()
storeid = storeid_example # String | The store id of the specific store
itemid = itemid_example # String | The itemid carrying the ID or slug of the product being loaded

try: 
    # retrieve a product from the store getting its price, details and availability
    api_response = api_instance.load_store_item_by_unique_id(storeid, itemid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyInventoryApi->loadStoreItemByUniqueId: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
itemid*
String (string)
The itemid carrying the ID or slug of the product being loaded
Required

Responses

Status: 200 - The merchant store object containing the merchant details

Status: 414 - Error unable to retrieve a store with the provided ID or item or security exception


loadStoreItemsForCategory

searches and retrieves a list of products from the merchant store for category

Returns a query of available items from a merchant store which can be displayed for a client app to use to info their users on prices or availablity under a category


/{storeid}/category/{categoryid}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/category/{categoryid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String categoryid = categoryid_example; // String | The category id returned from categories call. See /storeid/categories
        try {
            WebStore result = apiInstance.loadStoreItemsForCategory(storeid, categoryid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreItemsForCategory");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String categoryid = categoryid_example; // String | The category id returned from categories call. See /storeid/categories
        try {
            WebStore result = apiInstance.loadStoreItemsForCategory(storeid, categoryid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreItemsForCategory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *categoryid = categoryid_example; // The category id returned from categories call. See /storeid/categories

StoreHarmonyInventoryApi *apiInstance = [[StoreHarmonyInventoryApi alloc] init];

// searches and retrieves a list of products from the merchant store for category
[apiInstance loadStoreItemsForCategoryWith:storeid
    categoryid:categoryid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyInventoryApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var categoryid = categoryid_example; // {{String}} The category id returned from categories call. See /storeid/categories

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loadStoreItemsForCategory(storeid, categoryid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class loadStoreItemsForCategoryExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyInventoryApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var categoryid = categoryid_example;  // String | The category id returned from categories call. See /storeid/categories

            try
            {
                // searches and retrieves a list of products from the merchant store for category
                WebStore result = apiInstance.loadStoreItemsForCategory(storeid, categoryid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyInventoryApi.loadStoreItemsForCategory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyInventoryApi();
$storeid = storeid_example; // String | The store id of the specific store
$categoryid = categoryid_example; // String | The category id returned from categories call. See /storeid/categories

try {
    $result = $api_instance->loadStoreItemsForCategory($storeid, $categoryid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyInventoryApi->loadStoreItemsForCategory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyInventoryApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyInventoryApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $categoryid = categoryid_example; # String | The category id returned from categories call. See /storeid/categories

eval { 
    my $result = $api_instance->loadStoreItemsForCategory(storeid => $storeid, categoryid => $categoryid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyInventoryApi->loadStoreItemsForCategory: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyInventoryApi()
storeid = storeid_example # String | The store id of the specific store
categoryid = categoryid_example # String | The category id returned from categories call. See /storeid/categories

try: 
    # searches and retrieves a list of products from the merchant store for category
    api_response = api_instance.load_store_items_for_category(storeid, categoryid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyInventoryApi->loadStoreItemsForCategory: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
categoryid*
String (string)
The category id returned from categories call. See /storeid/categories
Required

Responses

Status: 200 - The merchant store inventory which can be accessed as 'object.products'

Status: 404 - Error unable to retrieve a store with the provided ID


loadStoreItemsForCategoryByPages

searches and retrieves a list of products from the merchant store

Returns a query of available items from a merchant store which can be displayed for a client app to use to info their users on prices or availablity


/{storeid}/category/{categoryid}/{start}/{size}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/category/{categoryid}/{start}/{size}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String categoryid = categoryid_example; // String | The categoryid of the category
        String start = start_example; // String | The start of page of listed products
        String size = size_example; // String | The size of page of listed products
        try {
            WebStore result = apiInstance.loadStoreItemsForCategoryByPages(storeid, categoryid, start, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreItemsForCategoryByPages");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String categoryid = categoryid_example; // String | The categoryid of the category
        String start = start_example; // String | The start of page of listed products
        String size = size_example; // String | The size of page of listed products
        try {
            WebStore result = apiInstance.loadStoreItemsForCategoryByPages(storeid, categoryid, start, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#loadStoreItemsForCategoryByPages");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *categoryid = categoryid_example; // The categoryid of the category
String *start = start_example; // The start of page of listed products
String *size = size_example; // The size of page of listed products

StoreHarmonyInventoryApi *apiInstance = [[StoreHarmonyInventoryApi alloc] init];

// searches and retrieves a list of products from the merchant store
[apiInstance loadStoreItemsForCategoryByPagesWith:storeid
    categoryid:categoryid
    start:start
    size:size
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyInventoryApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var categoryid = categoryid_example; // {{String}} The categoryid of the category
var start = start_example; // {{String}} The start of page of listed products
var size = size_example; // {{String}} The size of page of listed products

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loadStoreItemsForCategoryByPages(storeid, categoryid, start, size, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class loadStoreItemsForCategoryByPagesExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyInventoryApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var categoryid = categoryid_example;  // String | The categoryid of the category
            var start = start_example;  // String | The start of page of listed products
            var size = size_example;  // String | The size of page of listed products

            try
            {
                // searches and retrieves a list of products from the merchant store
                WebStore result = apiInstance.loadStoreItemsForCategoryByPages(storeid, categoryid, start, size);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyInventoryApi.loadStoreItemsForCategoryByPages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyInventoryApi();
$storeid = storeid_example; // String | The store id of the specific store
$categoryid = categoryid_example; // String | The categoryid of the category
$start = start_example; // String | The start of page of listed products
$size = size_example; // String | The size of page of listed products

try {
    $result = $api_instance->loadStoreItemsForCategoryByPages($storeid, $categoryid, $start, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyInventoryApi->loadStoreItemsForCategoryByPages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyInventoryApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyInventoryApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $categoryid = categoryid_example; # String | The categoryid of the category
my $start = start_example; # String | The start of page of listed products
my $size = size_example; # String | The size of page of listed products

eval { 
    my $result = $api_instance->loadStoreItemsForCategoryByPages(storeid => $storeid, categoryid => $categoryid, start => $start, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyInventoryApi->loadStoreItemsForCategoryByPages: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyInventoryApi()
storeid = storeid_example # String | The store id of the specific store
categoryid = categoryid_example # String | The categoryid of the category
start = start_example # String | The start of page of listed products
size = size_example # String | The size of page of listed products

try: 
    # searches and retrieves a list of products from the merchant store
    api_response = api_instance.load_store_items_for_category_by_pages(storeid, categoryid, start, size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyInventoryApi->loadStoreItemsForCategoryByPages: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
categoryid*
String (string)
The categoryid of the category
Required
start*
String (string)
The start of page of listed products
Required
size*
String (string)
The size of page of listed products
Required

Responses

Status: 200 - The merchant store inventory which can be accessed as 'object.products'

Status: 404 - Error unable to retrieve a store with the provided ID


searchStoreRecords

searches and retrieves a list of products from the merchant store

Returns a query of available items from a merchant store which can be displayed for a client app to use to info their users on prices or availablity


/{storeid}/{query}/{start}/{size}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/{query}/{start}/{size}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String query = query_example; // String | The query string
        String start = start_example; // String | The start of page of listed products
        String size = size_example; // String | The size of page of listed products
        try {
            WebStore result = apiInstance.searchStoreRecords(storeid, query, start, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#searchStoreRecords");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String query = query_example; // String | The query string
        String start = start_example; // String | The start of page of listed products
        String size = size_example; // String | The size of page of listed products
        try {
            WebStore result = apiInstance.searchStoreRecords(storeid, query, start, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#searchStoreRecords");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *query = query_example; // The query string
String *start = start_example; // The start of page of listed products
String *size = size_example; // The size of page of listed products

StoreHarmonyInventoryApi *apiInstance = [[StoreHarmonyInventoryApi alloc] init];

// searches and retrieves a list of products from the merchant store
[apiInstance searchStoreRecordsWith:storeid
    query:query
    start:start
    size:size
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyInventoryApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var query = query_example; // {{String}} The query string
var start = start_example; // {{String}} The start of page of listed products
var size = size_example; // {{String}} The size of page of listed products

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchStoreRecords(storeid, query, start, size, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class searchStoreRecordsExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyInventoryApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var query = query_example;  // String | The query string
            var start = start_example;  // String | The start of page of listed products
            var size = size_example;  // String | The size of page of listed products

            try
            {
                // searches and retrieves a list of products from the merchant store
                WebStore result = apiInstance.searchStoreRecords(storeid, query, start, size);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyInventoryApi.searchStoreRecords: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyInventoryApi();
$storeid = storeid_example; // String | The store id of the specific store
$query = query_example; // String | The query string
$start = start_example; // String | The start of page of listed products
$size = size_example; // String | The size of page of listed products

try {
    $result = $api_instance->searchStoreRecords($storeid, $query, $start, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyInventoryApi->searchStoreRecords: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyInventoryApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyInventoryApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $query = query_example; # String | The query string
my $start = start_example; # String | The start of page of listed products
my $size = size_example; # String | The size of page of listed products

eval { 
    my $result = $api_instance->searchStoreRecords(storeid => $storeid, query => $query, start => $start, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyInventoryApi->searchStoreRecords: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyInventoryApi()
storeid = storeid_example # String | The store id of the specific store
query = query_example # String | The query string
start = start_example # String | The start of page of listed products
size = size_example # String | The size of page of listed products

try: 
    # searches and retrieves a list of products from the merchant store
    api_response = api_instance.search_store_records(storeid, query, start, size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyInventoryApi->searchStoreRecords: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
query*
String (string)
The query string
Required
start*
String (string)
The start of page of listed products
Required
size*
String (string)
The size of page of listed products
Required

Responses

Status: 200 - The merchant store inventory which can be accessed as 'object.products'

Status: 404 - Error unable to retrieve a store with the provided ID


searchStoreRecordsMore

retrieve list of products from the merchant store

Returns a list of available items from a merchant store which can be displayed for a client app to use to info their users on prices or availablity


/{storeid}/search

Usage and SDK Samples

curl -X POST "https://storeharmony.net/webapi/{storeid}/search"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        AdvancedQuery body = ; // AdvancedQuery | unique identifier of inventory item
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.searchStoreRecordsMore(body, storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#searchStoreRecordsMore");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyInventoryApi;

public class StoreHarmonyInventoryApiExample {

    public static void main(String[] args) {
        StoreHarmonyInventoryApi apiInstance = new StoreHarmonyInventoryApi();
        AdvancedQuery body = ; // AdvancedQuery | unique identifier of inventory item
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.searchStoreRecordsMore(body, storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyInventoryApi#searchStoreRecordsMore");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
AdvancedQuery *body = ; // unique identifier of inventory item
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyInventoryApi *apiInstance = [[StoreHarmonyInventoryApi alloc] init];

// retrieve list of products from the merchant store
[apiInstance searchStoreRecordsMoreWith:body
    storeid:storeid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyInventoryApi()
var body = ; // {{AdvancedQuery}} unique identifier of inventory item
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchStoreRecordsMore(bodystoreid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class searchStoreRecordsMoreExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyInventoryApi();
            var body = new AdvancedQuery(); // AdvancedQuery | unique identifier of inventory item
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // retrieve list of products from the merchant store
                WebStore result = apiInstance.searchStoreRecordsMore(body, storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyInventoryApi.searchStoreRecordsMore: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyInventoryApi();
$body = ; // AdvancedQuery | unique identifier of inventory item
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->searchStoreRecordsMore($body, $storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyInventoryApi->searchStoreRecordsMore: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyInventoryApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyInventoryApi->new();
my $body = WWW::StoreHarmonyClient::Object::AdvancedQuery->new(); # AdvancedQuery | unique identifier of inventory item
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->searchStoreRecordsMore(body => $body, storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyInventoryApi->searchStoreRecordsMore: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyInventoryApi()
body =  # AdvancedQuery | unique identifier of inventory item
storeid = storeid_example # String | The store id of the specific store

try: 
    # retrieve list of products from the merchant store
    api_response = api_instance.search_store_records_more(body, storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyInventoryApi->searchStoreRecordsMore: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The merchant store inventory which can be accessed as 'object.products'

Status: 404 - Error unable to retrieve a store with the provided ID


StoreHarmonyOrdering

loadDeliveryServices

retrieves the list of delivery services according to the zones supported by the store

A store owner can map out the price of making deliveries to each part of their coverage. A zone could be titled 'lagos mainland delivery' or 'central area delivery'. Prices are listed per KG


/{storeid}/delivery_services

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/delivery_services"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.loadDeliveryServices(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#loadDeliveryServices");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.loadDeliveryServices(storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#loadDeliveryServices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyOrderingApi *apiInstance = [[StoreHarmonyOrderingApi alloc] init];

// retrieves the list of delivery services according to the zones supported by the store
[apiInstance loadDeliveryServicesWith:storeid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyOrderingApi()
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loadDeliveryServices(storeid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class loadDeliveryServicesExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyOrderingApi();
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // retrieves the list of delivery services according to the zones supported by the store
                WebStore result = apiInstance.loadDeliveryServices(storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyOrderingApi.loadDeliveryServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyOrderingApi();
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->loadDeliveryServices($storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyOrderingApi->loadDeliveryServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyOrderingApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyOrderingApi->new();
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->loadDeliveryServices(storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyOrderingApi->loadDeliveryServices: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyOrderingApi()
storeid = storeid_example # String | The store id of the specific store

try: 
    # retrieves the list of delivery services according to the zones supported by the store
    api_response = api_instance.load_delivery_services(storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyOrderingApi->loadDeliveryServices: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required

Responses

Status: 200 - The merchant store object containing the merchant details

Status: 414 - Error unable to retrieve a store with the provided ID or item or security exception


payForOrderViaCustomGateway

After an order has been placed and created with Storeharmony, the client can retrieve the order ID and use it to generate payment reference on their custom gateway implementation. They can use this call to pass the reference back to the storeharmony to use to verify the payment has been made. Popular gateways supported includes 'pastack', 'flutterwave', 'global accelerex', 'sterling'

Send payment for an already placed order. This call is made to notify storeharmony that an order has been paid for using a custom payment gateway implementation


/{storeid}/order/pay

Usage and SDK Samples

curl -X POST "https://storeharmony.net/webapi/{storeid}/order/pay"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        WebOrderPayment body = ; // WebOrderPayment | Details of payment for an order
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.payForOrderViaCustomGateway(body, storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#payForOrderViaCustomGateway");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        WebOrderPayment body = ; // WebOrderPayment | Details of payment for an order
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.payForOrderViaCustomGateway(body, storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#payForOrderViaCustomGateway");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
WebOrderPayment *body = ; // Details of payment for an order
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyOrderingApi *apiInstance = [[StoreHarmonyOrderingApi alloc] init];

// After an order has been placed and created with Storeharmony, the client can retrieve the order ID and use it to generate payment reference on their custom gateway implementation. They can use this call to pass the reference back to the storeharmony to use to verify the payment has been made. Popular gateways supported includes 'pastack', 'flutterwave', 'global accelerex', 'sterling'
[apiInstance payForOrderViaCustomGatewayWith:body
    storeid:storeid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyOrderingApi()
var body = ; // {{WebOrderPayment}} Details of payment for an order
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.payForOrderViaCustomGateway(bodystoreid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class payForOrderViaCustomGatewayExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyOrderingApi();
            var body = new WebOrderPayment(); // WebOrderPayment | Details of payment for an order
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // After an order has been placed and created with Storeharmony, the client can retrieve the order ID and use it to generate payment reference on their custom gateway implementation. They can use this call to pass the reference back to the storeharmony to use to verify the payment has been made. Popular gateways supported includes 'pastack', 'flutterwave', 'global accelerex', 'sterling'
                WebStore result = apiInstance.payForOrderViaCustomGateway(body, storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyOrderingApi.payForOrderViaCustomGateway: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyOrderingApi();
$body = ; // WebOrderPayment | Details of payment for an order
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->payForOrderViaCustomGateway($body, $storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyOrderingApi->payForOrderViaCustomGateway: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyOrderingApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyOrderingApi->new();
my $body = WWW::StoreHarmonyClient::Object::WebOrderPayment->new(); # WebOrderPayment | Details of payment for an order
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->payForOrderViaCustomGateway(body => $body, storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyOrderingApi->payForOrderViaCustomGateway: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyOrderingApi()
body =  # WebOrderPayment | Details of payment for an order
storeid = storeid_example # String | The store id of the specific store

try: 
    # After an order has been placed and created with Storeharmony, the client can retrieve the order ID and use it to generate payment reference on their custom gateway implementation. They can use this call to pass the reference back to the storeharmony to use to verify the payment has been made. Popular gateways supported includes 'pastack', 'flutterwave', 'global accelerex', 'sterling'
    api_response = api_instance.pay_for_order_via_custom_gateway(body, storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyOrderingApi->payForOrderViaCustomGateway: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The order response can be which can be accessed via object path 'object.order'.

Status: 404 - Error unable to succeed with this operation


payForOrderViaInternalGateway

After an order is made, you place this call to request storeharmony to give you a payment link to redirect customer to for payment. Gateway settngs are made via customer settings

To allow merchants use the embedded wallet function on their storeharmony or stocker, this call is important for payment processing. After an order is made, you place this call to request storeharmony to give you a payment link to redirect customer to for payment


/{storeid}/order/pay/{orderid}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/order/pay/{orderid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String orderid = orderid_example; // String | The orderid of the Order to be traced from the store whi
        try {
            WebStore result = apiInstance.payForOrderViaInternalGateway(storeid, orderid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#payForOrderViaInternalGateway");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String orderid = orderid_example; // String | The orderid of the Order to be traced from the store whi
        try {
            WebStore result = apiInstance.payForOrderViaInternalGateway(storeid, orderid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#payForOrderViaInternalGateway");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *orderid = orderid_example; // The orderid of the Order to be traced from the store whi

StoreHarmonyOrderingApi *apiInstance = [[StoreHarmonyOrderingApi alloc] init];

// After an order is made, you place this call to request storeharmony to give you a payment link to redirect customer to for payment. Gateway settngs are made via customer settings
[apiInstance payForOrderViaInternalGatewayWith:storeid
    orderid:orderid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyOrderingApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var orderid = orderid_example; // {{String}} The orderid of the Order to be traced from the store whi

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.payForOrderViaInternalGateway(storeid, orderid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class payForOrderViaInternalGatewayExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyOrderingApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var orderid = orderid_example;  // String | The orderid of the Order to be traced from the store whi

            try
            {
                // After an order is made, you place this call to request storeharmony to give you a payment link to redirect customer to for payment. Gateway settngs are made via customer settings
                WebStore result = apiInstance.payForOrderViaInternalGateway(storeid, orderid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyOrderingApi.payForOrderViaInternalGateway: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyOrderingApi();
$storeid = storeid_example; // String | The store id of the specific store
$orderid = orderid_example; // String | The orderid of the Order to be traced from the store whi

try {
    $result = $api_instance->payForOrderViaInternalGateway($storeid, $orderid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyOrderingApi->payForOrderViaInternalGateway: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyOrderingApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyOrderingApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $orderid = orderid_example; # String | The orderid of the Order to be traced from the store whi

eval { 
    my $result = $api_instance->payForOrderViaInternalGateway(storeid => $storeid, orderid => $orderid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyOrderingApi->payForOrderViaInternalGateway: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyOrderingApi()
storeid = storeid_example # String | The store id of the specific store
orderid = orderid_example # String | The orderid of the Order to be traced from the store whi

try: 
    # After an order is made, you place this call to request storeharmony to give you a payment link to redirect customer to for payment. Gateway settngs are made via customer settings
    api_response = api_instance.pay_for_order_via_internal_gateway(storeid, orderid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyOrderingApi->payForOrderViaInternalGateway: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
orderid*
String (string)
The orderid of the Order to be traced from the store whi
Required

Responses

Status: 200 - The merchant store object containing the merchant details

Status: 404 - Error unable to retrieve a store or order ID and fails to connect to a payment gateway


payViaMerchantPOSTerminal

For orders paid using a physical terminal or payment device, this call lets a PTSP notify storeharmony of a successful payment so that it can log it to the merchant dashboard or help fulfil a ecommerce order

For orders paid using a physical terminal or payment device, the PTSP should create a callback that calls Storeharmony using this API to notify that a merchant on its network has been paid. A simple plugin can be developed to trigger this call


/terminal/order/pay/{terminalId}

Usage and SDK Samples

curl -X POST "https://storeharmony.net/webapi/terminal/order/pay/{terminalId}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        TerminalPayment body = ; // TerminalPayment | Details of a terminal payment from a physical payment gateway
        String terminalId = terminalId_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.payViaMerchantPOSTerminal(body, terminalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#payViaMerchantPOSTerminal");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        TerminalPayment body = ; // TerminalPayment | Details of a terminal payment from a physical payment gateway
        String terminalId = terminalId_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.payViaMerchantPOSTerminal(body, terminalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#payViaMerchantPOSTerminal");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
TerminalPayment *body = ; // Details of a terminal payment from a physical payment gateway
String *terminalId = terminalId_example; // The store id of the specific store

StoreHarmonyOrderingApi *apiInstance = [[StoreHarmonyOrderingApi alloc] init];

// For orders paid using a physical terminal or payment device, this call lets a PTSP notify storeharmony of a successful payment so that it can log it to the merchant dashboard or help fulfil a ecommerce order
[apiInstance payViaMerchantPOSTerminalWith:body
    terminalId:terminalId
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyOrderingApi()
var body = ; // {{TerminalPayment}} Details of a terminal payment from a physical payment gateway
var terminalId = terminalId_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.payViaMerchantPOSTerminal(bodyterminalId, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class payViaMerchantPOSTerminalExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyOrderingApi();
            var body = new TerminalPayment(); // TerminalPayment | Details of a terminal payment from a physical payment gateway
            var terminalId = terminalId_example;  // String | The store id of the specific store

            try
            {
                // For orders paid using a physical terminal or payment device, this call lets a PTSP notify storeharmony of a successful payment so that it can log it to the merchant dashboard or help fulfil a ecommerce order
                WebStore result = apiInstance.payViaMerchantPOSTerminal(body, terminalId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyOrderingApi.payViaMerchantPOSTerminal: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyOrderingApi();
$body = ; // TerminalPayment | Details of a terminal payment from a physical payment gateway
$terminalId = terminalId_example; // String | The store id of the specific store

try {
    $result = $api_instance->payViaMerchantPOSTerminal($body, $terminalId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyOrderingApi->payViaMerchantPOSTerminal: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyOrderingApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyOrderingApi->new();
my $body = WWW::StoreHarmonyClient::Object::TerminalPayment->new(); # TerminalPayment | Details of a terminal payment from a physical payment gateway
my $terminalId = terminalId_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->payViaMerchantPOSTerminal(body => $body, terminalId => $terminalId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyOrderingApi->payViaMerchantPOSTerminal: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyOrderingApi()
body =  # TerminalPayment | Details of a terminal payment from a physical payment gateway
terminalId = terminalId_example # String | The store id of the specific store

try: 
    # For orders paid using a physical terminal or payment device, this call lets a PTSP notify storeharmony of a successful payment so that it can log it to the merchant dashboard or help fulfil a ecommerce order
    api_response = api_instance.pay_via_merchant_pos_terminal(body, terminalId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyOrderingApi->payViaMerchantPOSTerminal: %s\n" % e)

Parameters

Path parameters
Name Description
terminalId*
String (string)
The store id of the specific store
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The object representing the merchant payment report log response.

Status: 404 - Error unable to succeed with this operation


placeOrderToStore

places order of listed products to the merchant store. Note that a payment redirect link is also returned which allows the current buyer to make payment into this store if required. An implementation will redirect the customer to this link and later use /storeid/orderid to track the status of payment on this particular order

Creates an order which is placed to the store dashboard for the merchant to immediately attend from their point of sales


/{storeid}/order

Usage and SDK Samples

curl -X POST "https://storeharmony.net/webapi/{storeid}/order"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        WebOrder body = ; // WebOrder | unique identifier of inventory item
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.placeOrderToStore(body, storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#placeOrderToStore");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        WebOrder body = ; // WebOrder | unique identifier of inventory item
        String storeid = storeid_example; // String | The store id of the specific store
        try {
            WebStore result = apiInstance.placeOrderToStore(body, storeid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#placeOrderToStore");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
WebOrder *body = ; // unique identifier of inventory item
String *storeid = storeid_example; // The store id of the specific store

StoreHarmonyOrderingApi *apiInstance = [[StoreHarmonyOrderingApi alloc] init];

// places order of listed products to the merchant store. Note that a payment redirect link is also returned which allows the current buyer to make payment into this store if required. An implementation will redirect the customer to this link and later use /storeid/orderid to track the status of payment on this particular order
[apiInstance placeOrderToStoreWith:body
    storeid:storeid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyOrderingApi()
var body = ; // {{WebOrder}} unique identifier of inventory item
var storeid = storeid_example; // {{String}} The store id of the specific store

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.placeOrderToStore(bodystoreid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class placeOrderToStoreExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyOrderingApi();
            var body = new WebOrder(); // WebOrder | unique identifier of inventory item
            var storeid = storeid_example;  // String | The store id of the specific store

            try
            {
                // places order of listed products to the merchant store. Note that a payment redirect link is also returned which allows the current buyer to make payment into this store if required. An implementation will redirect the customer to this link and later use /storeid/orderid to track the status of payment on this particular order
                WebStore result = apiInstance.placeOrderToStore(body, storeid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyOrderingApi.placeOrderToStore: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyOrderingApi();
$body = ; // WebOrder | unique identifier of inventory item
$storeid = storeid_example; // String | The store id of the specific store

try {
    $result = $api_instance->placeOrderToStore($body, $storeid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyOrderingApi->placeOrderToStore: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyOrderingApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyOrderingApi->new();
my $body = WWW::StoreHarmonyClient::Object::WebOrder->new(); # WebOrder | unique identifier of inventory item
my $storeid = storeid_example; # String | The store id of the specific store

eval { 
    my $result = $api_instance->placeOrderToStore(body => $body, storeid => $storeid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyOrderingApi->placeOrderToStore: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyOrderingApi()
body =  # WebOrder | unique identifier of inventory item
storeid = storeid_example # String | The store id of the specific store

try: 
    # places order of listed products to the merchant store. Note that a payment redirect link is also returned which allows the current buyer to make payment into this store if required. An implementation will redirect the customer to this link and later use /storeid/orderid to track the status of payment on this particular order
    api_response = api_instance.place_order_to_store(body, storeid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyOrderingApi->placeOrderToStore: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The merchant store inventory which can be accessed via object path 'object.order'

Status: 404 - Error unable to retrieve a store with the provided ID


verifyOrderPlaced

retrieve an Order from the store to check the status

Returns the details about the provided Order ID which also indicates if there is any successful payments and payment references on it


/{storeid}/order/{orderid}

Usage and SDK Samples

curl -X GET "https://storeharmony.net/webapi/{storeid}/order/{orderid}"
import com.harmony.web.restapi.*;
import com.harmony.web.restapi.auth.*;
import com.harmony.web.restapi.model.*;
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

import java.io.File;
import java.util.*;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String orderid = orderid_example; // String | The orderid of the Order to be traced from the store whi
        try {
            WebStore result = apiInstance.verifyOrderPlaced(storeid, orderid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#verifyOrderPlaced");
            e.printStackTrace();
        }
    }
}
import com.harmony.web.restapi.api.StoreHarmonyOrderingApi;

public class StoreHarmonyOrderingApiExample {

    public static void main(String[] args) {
        StoreHarmonyOrderingApi apiInstance = new StoreHarmonyOrderingApi();
        String storeid = storeid_example; // String | The store id of the specific store
        String orderid = orderid_example; // String | The orderid of the Order to be traced from the store whi
        try {
            WebStore result = apiInstance.verifyOrderPlaced(storeid, orderid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreHarmonyOrderingApi#verifyOrderPlaced");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *storeid = storeid_example; // The store id of the specific store
String *orderid = orderid_example; // The orderid of the Order to be traced from the store whi

StoreHarmonyOrderingApi *apiInstance = [[StoreHarmonyOrderingApi alloc] init];

// retrieve an Order from the store to check the status
[apiInstance verifyOrderPlacedWith:storeid
    orderid:orderid
              completionHandler: ^(WebStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StoreHarmonyV3MerchantApi = require('store_harmony_v3_merchant_api');
var defaultClient = StoreHarmonyV3MerchantApi.ApiClient.instance;


var api = new StoreHarmonyV3MerchantApi.StoreHarmonyOrderingApi()
var storeid = storeid_example; // {{String}} The store id of the specific store
var orderid = orderid_example; // {{String}} The orderid of the Order to be traced from the store whi

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.verifyOrderPlaced(storeid, orderid, callback);
using System;
using System.Diagnostics;
using IO.StoreHarmony.Api;
using IO.StoreHarmony.Client;
using IO.StoreHarmony.Model;

namespace Example
{
    public class verifyOrderPlacedExample
    {
        public void main()
        {


            var apiInstance = new StoreHarmonyOrderingApi();
            var storeid = storeid_example;  // String | The store id of the specific store
            var orderid = orderid_example;  // String | The orderid of the Order to be traced from the store whi

            try
            {
                // retrieve an Order from the store to check the status
                WebStore result = apiInstance.verifyOrderPlaced(storeid, orderid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreHarmonyOrderingApi.verifyOrderPlaced: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new storeharmony\Client\ApiStoreHarmonyOrderingApi();
$storeid = storeid_example; // String | The store id of the specific store
$orderid = orderid_example; // String | The orderid of the Order to be traced from the store whi

try {
    $result = $api_instance->verifyOrderPlaced($storeid, $orderid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreHarmonyOrderingApi->verifyOrderPlaced: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::StoreHarmonyClient::Configuration;
use WWW::StoreHarmonyClient::StoreHarmonyOrderingApi;


my $api_instance = WWW::StoreHarmonyClient::StoreHarmonyOrderingApi->new();
my $storeid = storeid_example; # String | The store id of the specific store
my $orderid = orderid_example; # String | The orderid of the Order to be traced from the store whi

eval { 
    my $result = $api_instance->verifyOrderPlaced(storeid => $storeid, orderid => $orderid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoreHarmonyOrderingApi->verifyOrderPlaced: $@\n";
}
from __future__ import print_statement
import time
import storeharmony_client
from storeharmony_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = storeharmony_client.StoreHarmonyOrderingApi()
storeid = storeid_example # String | The store id of the specific store
orderid = orderid_example # String | The orderid of the Order to be traced from the store whi

try: 
    # retrieve an Order from the store to check the status
    api_response = api_instance.verify_order_placed(storeid, orderid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoreHarmonyOrderingApi->verifyOrderPlaced: %s\n" % e)

Parameters

Path parameters
Name Description
storeid*
String (string)
The store id of the specific store
Required
orderid*
String (string)
The orderid of the Order to be traced from the store whi
Required

Responses

Status: 200 - The merchant store object containing the merchant details

Status: 404 - Error unable to retrieve a store with the provided ID