NinjaOS API reference docs

CMS

apiCmsPageGet

Get Page Content Details

This is an operation get page content details.


/api/cms/page

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/cms/page?app_id=&page_slug="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMSApi;

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

public class CMSApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        CMSApi apiInstance = new CMSApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String pageSlug = pageSlug_example; // String | Page Slug
        try {
            apiInstance.apiCmsPageGet(appId, pageSlug);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSApi#apiCmsPageGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMSApi;

public class CMSApiExample {

    public static void main(String[] args) {
        CMSApi apiInstance = new CMSApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String pageSlug = pageSlug_example; // String | Page Slug
        try {
            apiInstance.apiCmsPageGet(appId, pageSlug);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSApi#apiCmsPageGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *pageSlug = pageSlug_example; // Page Slug

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

// Get Page Content Details
[apiInstance apiCmsPageGetWith:appId
    pageSlug:pageSlug
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.CMSApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var pageSlug = pageSlug_example; // {{String}} Page Slug

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCmsPageGet(appId, pageSlug, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CMSApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var pageSlug = pageSlug_example;  // String | Page Slug

            try
            {
                // Get Page Content Details
                apiInstance.apiCmsPageGet(appId, pageSlug);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMSApi.apiCmsPageGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCMSApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$pageSlug = pageSlug_example; // String | Page Slug

try {
    $api_instance->apiCmsPageGet($appId, $pageSlug);
} catch (Exception $e) {
    echo 'Exception when calling CMSApi->apiCmsPageGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMSApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CMSApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $pageSlug = pageSlug_example; # String | Page Slug

eval { 
    $api_instance->apiCmsPageGet(appId => $appId, pageSlug => $pageSlug);
};
if ($@) {
    warn "Exception when calling CMSApi->apiCmsPageGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CMSApi()
appId = appId_example # String | App ID Which it refers unique id for every users
pageSlug = pageSlug_example # String | Page Slug

try: 
    # Get Page Content Details
    api_instance.api_cms_page_get(appId, pageSlug)
except ApiException as e:
    print("Exception when calling CMSApi->apiCmsPageGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
page_slug*
String
Page Slug
Required

Responses

Status: 200 - OK


apiCmsStaticblocksGet

Get Static Blocks

This is an operation get staticblocks.


/api/cms/staticblocks

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/cms/staticblocks?app_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMSApi;

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

public class CMSApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        CMSApi apiInstance = new CMSApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        try {
            apiInstance.apiCmsStaticblocksGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSApi#apiCmsStaticblocksGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMSApi;

public class CMSApiExample {

    public static void main(String[] args) {
        CMSApi apiInstance = new CMSApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        try {
            apiInstance.apiCmsStaticblocksGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMSApi#apiCmsStaticblocksGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users

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

// Get Static Blocks
[apiInstance apiCmsStaticblocksGetWith:appId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.CMSApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCmsStaticblocksGet(appId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CMSApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users

            try
            {
                // Get Static Blocks
                apiInstance.apiCmsStaticblocksGet(appId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMSApi.apiCmsStaticblocksGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCMSApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users

try {
    $api_instance->apiCmsStaticblocksGet($appId);
} catch (Exception $e) {
    echo 'Exception when calling CMSApi->apiCmsStaticblocksGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMSApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CMSApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users

eval { 
    $api_instance->apiCmsStaticblocksGet(appId => $appId);
};
if ($@) {
    warn "Exception when calling CMSApi->apiCmsStaticblocksGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CMSApi()
appId = appId_example # String | App ID Which it refers unique id for every users

try: 
    # Get Static Blocks
    api_instance.api_cms_staticblocks_get(appId)
except ApiException as e:
    print("Exception when calling CMSApi->apiCmsStaticblocksGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required

Responses

Status: 200 - OK


Cart

apiCartContentsGet

Get Cart Details

This is an operation get cart details.


/api/cart/contents

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/cart/contents?app_id=&availability=&reference_id=&customer_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartApi;

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

public class CartApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availability = availability_example; // String | 
        String referenceId = referenceId_example; // String | 
        String customerId = customerId_example; // String | 
        try {
            apiInstance.apiCartContentsGet(appId, availability, referenceId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiCartContentsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availability = availability_example; // String | 
        String referenceId = referenceId_example; // String | 
        String customerId = customerId_example; // String | 
        try {
            apiInstance.apiCartContentsGet(appId, availability, referenceId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiCartContentsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *availability = availability_example; // 
String *referenceId = referenceId_example; // 
String *customerId = customerId_example; // 

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

// Get Cart Details
[apiInstance apiCartContentsGetWith:appId
    availability:availability
    referenceId:referenceId
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.CartApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var availability = availability_example; // {{String}} 
var referenceId = referenceId_example; // {{String}} 
var customerId = customerId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCartContentsGet(appId, availability, referenceId, customerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CartApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var availability = availability_example;  // String | 
            var referenceId = referenceId_example;  // String | 
            var customerId = customerId_example;  // String | 

            try
            {
                // Get Cart Details
                apiInstance.apiCartContentsGet(appId, availability, referenceId, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.apiCartContentsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCartApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$availability = availability_example; // String | 
$referenceId = referenceId_example; // String | 
$customerId = customerId_example; // String | 

try {
    $api_instance->apiCartContentsGet($appId, $availability, $referenceId, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling CartApi->apiCartContentsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $availability = availability_example; # String | 
my $referenceId = referenceId_example; # String | 
my $customerId = customerId_example; # String | 

eval { 
    $api_instance->apiCartContentsGet(appId => $appId, availability => $availability, referenceId => $referenceId, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling CartApi->apiCartContentsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CartApi()
appId = appId_example # String | App ID Which it refers unique id for every users
availability = availability_example # String | 
referenceId = referenceId_example # String | 
customerId = customerId_example # String | 

try: 
    # Get Cart Details
    api_instance.api_cart_contents_get(appId, availability, referenceId, customerId)
except ApiException as e:
    print("Exception when calling CartApi->apiCartContentsGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
availability*
String
Required
reference_id*
String
Required
customer_id*
String
Required

Responses

Status: 200 - OK


apiCartDeletePost

Delete Cart

This request allows you to delete cart.


/api/cart/delete

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/cart/delete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartApi;

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

public class CartApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        Integer cartItemId = 56; // Integer | 
        Integer productQty = 56; // Integer | 
        String cartAction = cartAction_example; // String | 
        String referenceId = referenceId_example; // String | 
        String customerId = customerId_example; // String | 
        try {
            apiInstance.apiCartDeletePost(appId, cartItemId, productQty, cartAction, referenceId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiCartDeletePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        Integer cartItemId = 56; // Integer | 
        Integer productQty = 56; // Integer | 
        String cartAction = cartAction_example; // String | 
        String referenceId = referenceId_example; // String | 
        String customerId = customerId_example; // String | 
        try {
            apiInstance.apiCartDeletePost(appId, cartItemId, productQty, cartAction, referenceId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiCartDeletePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
Integer *cartItemId = 56; //  (optional)
Integer *productQty = 56; //  (optional)
String *cartAction = cartAction_example; //  (optional)
String *referenceId = referenceId_example; //  (optional)
String *customerId = customerId_example; //  (optional)

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

// Delete Cart
[apiInstance apiCartDeletePostWith:appId
    cartItemId:cartItemId
    productQty:productQty
    cartAction:cartAction
    referenceId:referenceId
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.CartApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'cartItemId': 56 // {{Integer}} 
  'productQty': 56 // {{Integer}} 
  'cartAction': cartAction_example // {{String}} 
  'referenceId': referenceId_example // {{String}} 
  'customerId': customerId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCartDeletePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CartApi();
            var appId = appId_example;  // String |  (optional) 
            var cartItemId = 56;  // Integer |  (optional) 
            var productQty = 56;  // Integer |  (optional) 
            var cartAction = cartAction_example;  // String |  (optional) 
            var referenceId = referenceId_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 

            try
            {
                // Delete Cart
                apiInstance.apiCartDeletePost(appId, cartItemId, productQty, cartAction, referenceId, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.apiCartDeletePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCartApi();
$appId = appId_example; // String | 
$cartItemId = 56; // Integer | 
$productQty = 56; // Integer | 
$cartAction = cartAction_example; // String | 
$referenceId = referenceId_example; // String | 
$customerId = customerId_example; // String | 

try {
    $api_instance->apiCartDeletePost($appId, $cartItemId, $productQty, $cartAction, $referenceId, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling CartApi->apiCartDeletePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $appId = appId_example; # String | 
my $cartItemId = 56; # Integer | 
my $productQty = 56; # Integer | 
my $cartAction = cartAction_example; # String | 
my $referenceId = referenceId_example; # String | 
my $customerId = customerId_example; # String | 

eval { 
    $api_instance->apiCartDeletePost(appId => $appId, cartItemId => $cartItemId, productQty => $productQty, cartAction => $cartAction, referenceId => $referenceId, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling CartApi->apiCartDeletePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CartApi()
appId = appId_example # String |  (optional)
cartItemId = 56 # Integer |  (optional)
productQty = 56 # Integer |  (optional)
cartAction = cartAction_example # String |  (optional)
referenceId = referenceId_example # String |  (optional)
customerId = customerId_example # String |  (optional)

try: 
    # Delete Cart
    api_instance.api_cart_delete_post(appId=appId, cartItemId=cartItemId, productQty=productQty, cartAction=cartAction, referenceId=referenceId, customerId=customerId)
except ApiException as e:
    print("Exception when calling CartApi->apiCartDeletePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
cart_item_id
Integer
product_qty
Integer
cartAction
String
reference_id
String
customer_id
String

Responses

Status: 200 - OK


apiCartDestroyPost

Destroy Cart

This request allows you to destroy cart.


/api/cart/destroy

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/cart/destroy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartApi;

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

public class CartApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        String referenceId = referenceId_example; // String | 
        String customerId = customerId_example; // String | 
        try {
            apiInstance.apiCartDestroyPost(appId, referenceId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiCartDestroyPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        String referenceId = referenceId_example; // String | 
        String customerId = customerId_example; // String | 
        try {
            apiInstance.apiCartDestroyPost(appId, referenceId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiCartDestroyPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *referenceId = referenceId_example; //  (optional)
String *customerId = customerId_example; //  (optional)

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

// Destroy Cart
[apiInstance apiCartDestroyPostWith:appId
    referenceId:referenceId
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.CartApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'referenceId': referenceId_example // {{String}} 
  'customerId': customerId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCartDestroyPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CartApi();
            var appId = appId_example;  // String |  (optional) 
            var referenceId = referenceId_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 

            try
            {
                // Destroy Cart
                apiInstance.apiCartDestroyPost(appId, referenceId, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.apiCartDestroyPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCartApi();
$appId = appId_example; // String | 
$referenceId = referenceId_example; // String | 
$customerId = customerId_example; // String | 

try {
    $api_instance->apiCartDestroyPost($appId, $referenceId, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling CartApi->apiCartDestroyPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $appId = appId_example; # String | 
my $referenceId = referenceId_example; # String | 
my $customerId = customerId_example; # String | 

eval { 
    $api_instance->apiCartDestroyPost(appId => $appId, referenceId => $referenceId, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling CartApi->apiCartDestroyPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CartApi()
appId = appId_example # String |  (optional)
referenceId = referenceId_example # String |  (optional)
customerId = customerId_example # String |  (optional)

try: 
    # Destroy Cart
    api_instance.api_cart_destroy_post(appId=appId, referenceId=referenceId, customerId=customerId)
except ApiException as e:
    print("Exception when calling CartApi->apiCartDestroyPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
reference_id
String
customer_id
String

Responses

Status: 200 - OK


apiCartInsertPost

Combo Products

This request allows you to Modifier Products cart.


/api/cart/insert

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/cart/insert"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartApi;

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

public class CartApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        String productId = productId_example; // String | 
        Integer productQty = 56; // Integer | 
        String availabilityId = availabilityId_example; // String | 
        String productName = productName_example; // String | 
        String productTotalPrice = productTotalPrice_example; // String | 
        String productUnitPrice = productUnitPrice_example; // String | 
        String productRemarks = productRemarks_example; // String | 
        String productImage = productImage_example; // String | 
        String productSku = productSku_example; // String | 
        String productSlug = productSlug_example; // String | 
        String modifiers = modifiers_example; // String | 
        String menuSetComponent = menuSetComponent_example; // String | 
        String referenceId = referenceId_example; // String | 
        String individual = individual_example; // String | 
        String customerId = customerId_example; // String | 
        String productEditEnable = productEditEnable_example; // String | 
        try {
            apiInstance.apiCartInsertPost(appId, productId, productQty, availabilityId, productName, productTotalPrice, productUnitPrice, productRemarks, productImage, productSku, productSlug, modifiers, menuSetComponent, referenceId, individual, customerId, productEditEnable);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiCartInsertPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        String productId = productId_example; // String | 
        Integer productQty = 56; // Integer | 
        String availabilityId = availabilityId_example; // String | 
        String productName = productName_example; // String | 
        String productTotalPrice = productTotalPrice_example; // String | 
        String productUnitPrice = productUnitPrice_example; // String | 
        String productRemarks = productRemarks_example; // String | 
        String productImage = productImage_example; // String | 
        String productSku = productSku_example; // String | 
        String productSlug = productSlug_example; // String | 
        String modifiers = modifiers_example; // String | 
        String menuSetComponent = menuSetComponent_example; // String | 
        String referenceId = referenceId_example; // String | 
        String individual = individual_example; // String | 
        String customerId = customerId_example; // String | 
        String productEditEnable = productEditEnable_example; // String | 
        try {
            apiInstance.apiCartInsertPost(appId, productId, productQty, availabilityId, productName, productTotalPrice, productUnitPrice, productRemarks, productImage, productSku, productSlug, modifiers, menuSetComponent, referenceId, individual, customerId, productEditEnable);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiCartInsertPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *productId = productId_example; //  (optional)
Integer *productQty = 56; //  (optional)
String *availabilityId = availabilityId_example; //  (optional)
String *productName = productName_example; //  (optional)
String *productTotalPrice = productTotalPrice_example; //  (optional)
String *productUnitPrice = productUnitPrice_example; //  (optional)
String *productRemarks = productRemarks_example; //  (optional)
String *productImage = productImage_example; //  (optional)
String *productSku = productSku_example; //  (optional)
String *productSlug = productSlug_example; //  (optional)
String *modifiers = modifiers_example; //  (optional)
String *menuSetComponent = menuSetComponent_example; //  (optional)
String *referenceId = referenceId_example; //  (optional)
String *individual = individual_example; //  (optional)
String *customerId = customerId_example; //  (optional)
String *productEditEnable = productEditEnable_example; //  (optional)

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

// Combo Products
[apiInstance apiCartInsertPostWith:appId
    productId:productId
    productQty:productQty
    availabilityId:availabilityId
    productName:productName
    productTotalPrice:productTotalPrice
    productUnitPrice:productUnitPrice
    productRemarks:productRemarks
    productImage:productImage
    productSku:productSku
    productSlug:productSlug
    modifiers:modifiers
    menuSetComponent:menuSetComponent
    referenceId:referenceId
    individual:individual
    customerId:customerId
    productEditEnable:productEditEnable
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.CartApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'productId': productId_example // {{String}} 
  'productQty': 56 // {{Integer}} 
  'availabilityId': availabilityId_example // {{String}} 
  'productName': productName_example // {{String}} 
  'productTotalPrice': productTotalPrice_example // {{String}} 
  'productUnitPrice': productUnitPrice_example // {{String}} 
  'productRemarks': productRemarks_example // {{String}} 
  'productImage': productImage_example // {{String}} 
  'productSku': productSku_example // {{String}} 
  'productSlug': productSlug_example // {{String}} 
  'modifiers': modifiers_example // {{String}} 
  'menuSetComponent': menuSetComponent_example // {{String}} 
  'referenceId': referenceId_example // {{String}} 
  'individual': individual_example // {{String}} 
  'customerId': customerId_example // {{String}} 
  'productEditEnable': productEditEnable_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCartInsertPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CartApi();
            var appId = appId_example;  // String |  (optional) 
            var productId = productId_example;  // String |  (optional) 
            var productQty = 56;  // Integer |  (optional) 
            var availabilityId = availabilityId_example;  // String |  (optional) 
            var productName = productName_example;  // String |  (optional) 
            var productTotalPrice = productTotalPrice_example;  // String |  (optional) 
            var productUnitPrice = productUnitPrice_example;  // String |  (optional) 
            var productRemarks = productRemarks_example;  // String |  (optional) 
            var productImage = productImage_example;  // String |  (optional) 
            var productSku = productSku_example;  // String |  (optional) 
            var productSlug = productSlug_example;  // String |  (optional) 
            var modifiers = modifiers_example;  // String |  (optional) 
            var menuSetComponent = menuSetComponent_example;  // String |  (optional) 
            var referenceId = referenceId_example;  // String |  (optional) 
            var individual = individual_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 
            var productEditEnable = productEditEnable_example;  // String |  (optional) 

            try
            {
                // Combo Products
                apiInstance.apiCartInsertPost(appId, productId, productQty, availabilityId, productName, productTotalPrice, productUnitPrice, productRemarks, productImage, productSku, productSlug, modifiers, menuSetComponent, referenceId, individual, customerId, productEditEnable);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.apiCartInsertPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCartApi();
$appId = appId_example; // String | 
$productId = productId_example; // String | 
$productQty = 56; // Integer | 
$availabilityId = availabilityId_example; // String | 
$productName = productName_example; // String | 
$productTotalPrice = productTotalPrice_example; // String | 
$productUnitPrice = productUnitPrice_example; // String | 
$productRemarks = productRemarks_example; // String | 
$productImage = productImage_example; // String | 
$productSku = productSku_example; // String | 
$productSlug = productSlug_example; // String | 
$modifiers = modifiers_example; // String | 
$menuSetComponent = menuSetComponent_example; // String | 
$referenceId = referenceId_example; // String | 
$individual = individual_example; // String | 
$customerId = customerId_example; // String | 
$productEditEnable = productEditEnable_example; // String | 

try {
    $api_instance->apiCartInsertPost($appId, $productId, $productQty, $availabilityId, $productName, $productTotalPrice, $productUnitPrice, $productRemarks, $productImage, $productSku, $productSlug, $modifiers, $menuSetComponent, $referenceId, $individual, $customerId, $productEditEnable);
} catch (Exception $e) {
    echo 'Exception when calling CartApi->apiCartInsertPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $appId = appId_example; # String | 
my $productId = productId_example; # String | 
my $productQty = 56; # Integer | 
my $availabilityId = availabilityId_example; # String | 
my $productName = productName_example; # String | 
my $productTotalPrice = productTotalPrice_example; # String | 
my $productUnitPrice = productUnitPrice_example; # String | 
my $productRemarks = productRemarks_example; # String | 
my $productImage = productImage_example; # String | 
my $productSku = productSku_example; # String | 
my $productSlug = productSlug_example; # String | 
my $modifiers = modifiers_example; # String | 
my $menuSetComponent = menuSetComponent_example; # String | 
my $referenceId = referenceId_example; # String | 
my $individual = individual_example; # String | 
my $customerId = customerId_example; # String | 
my $productEditEnable = productEditEnable_example; # String | 

eval { 
    $api_instance->apiCartInsertPost(appId => $appId, productId => $productId, productQty => $productQty, availabilityId => $availabilityId, productName => $productName, productTotalPrice => $productTotalPrice, productUnitPrice => $productUnitPrice, productRemarks => $productRemarks, productImage => $productImage, productSku => $productSku, productSlug => $productSlug, modifiers => $modifiers, menuSetComponent => $menuSetComponent, referenceId => $referenceId, individual => $individual, customerId => $customerId, productEditEnable => $productEditEnable);
};
if ($@) {
    warn "Exception when calling CartApi->apiCartInsertPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CartApi()
appId = appId_example # String |  (optional)
productId = productId_example # String |  (optional)
productQty = 56 # Integer |  (optional)
availabilityId = availabilityId_example # String |  (optional)
productName = productName_example # String |  (optional)
productTotalPrice = productTotalPrice_example # String |  (optional)
productUnitPrice = productUnitPrice_example # String |  (optional)
productRemarks = productRemarks_example # String |  (optional)
productImage = productImage_example # String |  (optional)
productSku = productSku_example # String |  (optional)
productSlug = productSlug_example # String |  (optional)
modifiers = modifiers_example # String |  (optional)
menuSetComponent = menuSetComponent_example # String |  (optional)
referenceId = referenceId_example # String |  (optional)
individual = individual_example # String |  (optional)
customerId = customerId_example # String |  (optional)
productEditEnable = productEditEnable_example # String |  (optional)

try: 
    # Combo Products
    api_instance.api_cart_insert_post(appId=appId, productId=productId, productQty=productQty, availabilityId=availabilityId, productName=productName, productTotalPrice=productTotalPrice, productUnitPrice=productUnitPrice, productRemarks=productRemarks, productImage=productImage, productSku=productSku, productSlug=productSlug, modifiers=modifiers, menuSetComponent=menuSetComponent, referenceId=referenceId, individual=individual, customerId=customerId, productEditEnable=productEditEnable)
except ApiException as e:
    print("Exception when calling CartApi->apiCartInsertPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
product_id
String
product_qty
Integer
availability_id
String
product_name
String
product_total_price
String
product_unit_price
String
product_remarks
String
product_image
String
product_sku
String
product_slug
String
modifiers
String
menu_set_component
String
reference_id
String
individual
String
customer_id
String
product_edit_enable
String

Responses

Status: 200 - OK


apiCartIsVoucherInsertPost

Voucher Insert

This request allows you to see the permissions that are granted to this account.


/api/cart/is_voucher_insert

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/cart/is_voucher_insert"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartApi;

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

public class CartApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        String productId = productId_example; // String | 
        String productName = productName_example; // String | 
        String productSku = productSku_example; // String | 
        String productImage = productImage_example; // String | 
        String productUnitPrice = productUnitPrice_example; // String | 
        Integer productQty = 56; // Integer | 
        String productTotalPrice = productTotalPrice_example; // String | 
        Integer customerId = 56; // Integer | 
        String orderAvailabilityId = orderAvailabilityId_example; // String | 
        Integer orderItemId = 56; // Integer | 
        Integer orderOutletId = 56; // Integer | 
        try {
            apiInstance.apiCartIsVoucherInsertPost(appId, productId, productName, productSku, productImage, productUnitPrice, productQty, productTotalPrice, customerId, orderAvailabilityId, orderItemId, orderOutletId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiCartIsVoucherInsertPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        String productId = productId_example; // String | 
        String productName = productName_example; // String | 
        String productSku = productSku_example; // String | 
        String productImage = productImage_example; // String | 
        String productUnitPrice = productUnitPrice_example; // String | 
        Integer productQty = 56; // Integer | 
        String productTotalPrice = productTotalPrice_example; // String | 
        Integer customerId = 56; // Integer | 
        String orderAvailabilityId = orderAvailabilityId_example; // String | 
        Integer orderItemId = 56; // Integer | 
        Integer orderOutletId = 56; // Integer | 
        try {
            apiInstance.apiCartIsVoucherInsertPost(appId, productId, productName, productSku, productImage, productUnitPrice, productQty, productTotalPrice, customerId, orderAvailabilityId, orderItemId, orderOutletId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiCartIsVoucherInsertPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *productId = productId_example; //  (optional)
String *productName = productName_example; //  (optional)
String *productSku = productSku_example; //  (optional)
String *productImage = productImage_example; //  (optional)
String *productUnitPrice = productUnitPrice_example; //  (optional)
Integer *productQty = 56; //  (optional)
String *productTotalPrice = productTotalPrice_example; //  (optional)
Integer *customerId = 56; //  (optional)
String *orderAvailabilityId = orderAvailabilityId_example; //  (optional)
Integer *orderItemId = 56; //  (optional)
Integer *orderOutletId = 56; //  (optional)

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

// Voucher Insert
[apiInstance apiCartIsVoucherInsertPostWith:appId
    productId:productId
    productName:productName
    productSku:productSku
    productImage:productImage
    productUnitPrice:productUnitPrice
    productQty:productQty
    productTotalPrice:productTotalPrice
    customerId:customerId
    orderAvailabilityId:orderAvailabilityId
    orderItemId:orderItemId
    orderOutletId:orderOutletId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.CartApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'productId': productId_example // {{String}} 
  'productName': productName_example // {{String}} 
  'productSku': productSku_example // {{String}} 
  'productImage': productImage_example // {{String}} 
  'productUnitPrice': productUnitPrice_example // {{String}} 
  'productQty': 56 // {{Integer}} 
  'productTotalPrice': productTotalPrice_example // {{String}} 
  'customerId': 56 // {{Integer}} 
  'orderAvailabilityId': orderAvailabilityId_example // {{String}} 
  'orderItemId': 56 // {{Integer}} 
  'orderOutletId': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCartIsVoucherInsertPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CartApi();
            var appId = appId_example;  // String |  (optional) 
            var productId = productId_example;  // String |  (optional) 
            var productName = productName_example;  // String |  (optional) 
            var productSku = productSku_example;  // String |  (optional) 
            var productImage = productImage_example;  // String |  (optional) 
            var productUnitPrice = productUnitPrice_example;  // String |  (optional) 
            var productQty = 56;  // Integer |  (optional) 
            var productTotalPrice = productTotalPrice_example;  // String |  (optional) 
            var customerId = 56;  // Integer |  (optional) 
            var orderAvailabilityId = orderAvailabilityId_example;  // String |  (optional) 
            var orderItemId = 56;  // Integer |  (optional) 
            var orderOutletId = 56;  // Integer |  (optional) 

            try
            {
                // Voucher Insert
                apiInstance.apiCartIsVoucherInsertPost(appId, productId, productName, productSku, productImage, productUnitPrice, productQty, productTotalPrice, customerId, orderAvailabilityId, orderItemId, orderOutletId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.apiCartIsVoucherInsertPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCartApi();
$appId = appId_example; // String | 
$productId = productId_example; // String | 
$productName = productName_example; // String | 
$productSku = productSku_example; // String | 
$productImage = productImage_example; // String | 
$productUnitPrice = productUnitPrice_example; // String | 
$productQty = 56; // Integer | 
$productTotalPrice = productTotalPrice_example; // String | 
$customerId = 56; // Integer | 
$orderAvailabilityId = orderAvailabilityId_example; // String | 
$orderItemId = 56; // Integer | 
$orderOutletId = 56; // Integer | 

try {
    $api_instance->apiCartIsVoucherInsertPost($appId, $productId, $productName, $productSku, $productImage, $productUnitPrice, $productQty, $productTotalPrice, $customerId, $orderAvailabilityId, $orderItemId, $orderOutletId);
} catch (Exception $e) {
    echo 'Exception when calling CartApi->apiCartIsVoucherInsertPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $appId = appId_example; # String | 
my $productId = productId_example; # String | 
my $productName = productName_example; # String | 
my $productSku = productSku_example; # String | 
my $productImage = productImage_example; # String | 
my $productUnitPrice = productUnitPrice_example; # String | 
my $productQty = 56; # Integer | 
my $productTotalPrice = productTotalPrice_example; # String | 
my $customerId = 56; # Integer | 
my $orderAvailabilityId = orderAvailabilityId_example; # String | 
my $orderItemId = 56; # Integer | 
my $orderOutletId = 56; # Integer | 

eval { 
    $api_instance->apiCartIsVoucherInsertPost(appId => $appId, productId => $productId, productName => $productName, productSku => $productSku, productImage => $productImage, productUnitPrice => $productUnitPrice, productQty => $productQty, productTotalPrice => $productTotalPrice, customerId => $customerId, orderAvailabilityId => $orderAvailabilityId, orderItemId => $orderItemId, orderOutletId => $orderOutletId);
};
if ($@) {
    warn "Exception when calling CartApi->apiCartIsVoucherInsertPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CartApi()
appId = appId_example # String |  (optional)
productId = productId_example # String |  (optional)
productName = productName_example # String |  (optional)
productSku = productSku_example # String |  (optional)
productImage = productImage_example # String |  (optional)
productUnitPrice = productUnitPrice_example # String |  (optional)
productQty = 56 # Integer |  (optional)
productTotalPrice = productTotalPrice_example # String |  (optional)
customerId = 56 # Integer |  (optional)
orderAvailabilityId = orderAvailabilityId_example # String |  (optional)
orderItemId = 56 # Integer |  (optional)
orderOutletId = 56 # Integer |  (optional)

try: 
    # Voucher Insert
    api_instance.api_cart_is_voucher_insert_post(appId=appId, productId=productId, productName=productName, productSku=productSku, productImage=productImage, productUnitPrice=productUnitPrice, productQty=productQty, productTotalPrice=productTotalPrice, customerId=customerId, orderAvailabilityId=orderAvailabilityId, orderItemId=orderItemId, orderOutletId=orderOutletId)
except ApiException as e:
    print("Exception when calling CartApi->apiCartIsVoucherInsertPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
product_id
String
product_name
String
product_sku
String
product_image
String
product_unit_price
String
product_qty
Integer
product_total_price
String
customer_id
Integer
order_availability_id
String
order_item_id
Integer
order_outlet_id
Integer

Responses

Status: 200 - OK


apiv2CartSimpleCartInsertPost

Simple Cart Insert

This request allows you to add a cart.


/apiv2/cart/simpleCartInsert

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/apiv2/cart/simpleCartInsert"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartApi;

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

public class CartApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        String productId = productId_example; // String | 
        Integer productQty = 56; // Integer | 
        Integer productType = 56; // Integer | 
        String modifiers = modifiers_example; // String | 
        String availabilityId = availabilityId_example; // String | 
        String availabilityName = availabilityName_example; // String | 
        String isAddonProduct = isAddonProduct_example; // String | 
        String referenceId = referenceId_example; // String | 
        String customerId = customerId_example; // String | 
        try {
            apiInstance.apiv2CartSimpleCartInsertPost(appId, productId, productQty, productType, modifiers, availabilityId, availabilityName, isAddonProduct, referenceId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiv2CartSimpleCartInsertPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        String productId = productId_example; // String | 
        Integer productQty = 56; // Integer | 
        Integer productType = 56; // Integer | 
        String modifiers = modifiers_example; // String | 
        String availabilityId = availabilityId_example; // String | 
        String availabilityName = availabilityName_example; // String | 
        String isAddonProduct = isAddonProduct_example; // String | 
        String referenceId = referenceId_example; // String | 
        String customerId = customerId_example; // String | 
        try {
            apiInstance.apiv2CartSimpleCartInsertPost(appId, productId, productQty, productType, modifiers, availabilityId, availabilityName, isAddonProduct, referenceId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiv2CartSimpleCartInsertPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *productId = productId_example; //  (optional)
Integer *productQty = 56; //  (optional)
Integer *productType = 56; //  (optional)
String *modifiers = modifiers_example; //  (optional)
String *availabilityId = availabilityId_example; //  (optional)
String *availabilityName = availabilityName_example; //  (optional)
String *isAddonProduct = isAddonProduct_example; //  (optional)
String *referenceId = referenceId_example; //  (optional)
String *customerId = customerId_example; //  (optional)

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

// Simple Cart Insert
[apiInstance apiv2CartSimpleCartInsertPostWith:appId
    productId:productId
    productQty:productQty
    productType:productType
    modifiers:modifiers
    availabilityId:availabilityId
    availabilityName:availabilityName
    isAddonProduct:isAddonProduct
    referenceId:referenceId
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.CartApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'productId': productId_example // {{String}} 
  'productQty': 56 // {{Integer}} 
  'productType': 56 // {{Integer}} 
  'modifiers': modifiers_example // {{String}} 
  'availabilityId': availabilityId_example // {{String}} 
  'availabilityName': availabilityName_example // {{String}} 
  'isAddonProduct': isAddonProduct_example // {{String}} 
  'referenceId': referenceId_example // {{String}} 
  'customerId': customerId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiv2CartSimpleCartInsertPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CartApi();
            var appId = appId_example;  // String |  (optional) 
            var productId = productId_example;  // String |  (optional) 
            var productQty = 56;  // Integer |  (optional) 
            var productType = 56;  // Integer |  (optional) 
            var modifiers = modifiers_example;  // String |  (optional) 
            var availabilityId = availabilityId_example;  // String |  (optional) 
            var availabilityName = availabilityName_example;  // String |  (optional) 
            var isAddonProduct = isAddonProduct_example;  // String |  (optional) 
            var referenceId = referenceId_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 

            try
            {
                // Simple Cart Insert
                apiInstance.apiv2CartSimpleCartInsertPost(appId, productId, productQty, productType, modifiers, availabilityId, availabilityName, isAddonProduct, referenceId, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.apiv2CartSimpleCartInsertPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCartApi();
$appId = appId_example; // String | 
$productId = productId_example; // String | 
$productQty = 56; // Integer | 
$productType = 56; // Integer | 
$modifiers = modifiers_example; // String | 
$availabilityId = availabilityId_example; // String | 
$availabilityName = availabilityName_example; // String | 
$isAddonProduct = isAddonProduct_example; // String | 
$referenceId = referenceId_example; // String | 
$customerId = customerId_example; // String | 

try {
    $api_instance->apiv2CartSimpleCartInsertPost($appId, $productId, $productQty, $productType, $modifiers, $availabilityId, $availabilityName, $isAddonProduct, $referenceId, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling CartApi->apiv2CartSimpleCartInsertPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $appId = appId_example; # String | 
my $productId = productId_example; # String | 
my $productQty = 56; # Integer | 
my $productType = 56; # Integer | 
my $modifiers = modifiers_example; # String | 
my $availabilityId = availabilityId_example; # String | 
my $availabilityName = availabilityName_example; # String | 
my $isAddonProduct = isAddonProduct_example; # String | 
my $referenceId = referenceId_example; # String | 
my $customerId = customerId_example; # String | 

eval { 
    $api_instance->apiv2CartSimpleCartInsertPost(appId => $appId, productId => $productId, productQty => $productQty, productType => $productType, modifiers => $modifiers, availabilityId => $availabilityId, availabilityName => $availabilityName, isAddonProduct => $isAddonProduct, referenceId => $referenceId, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling CartApi->apiv2CartSimpleCartInsertPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CartApi()
appId = appId_example # String |  (optional)
productId = productId_example # String |  (optional)
productQty = 56 # Integer |  (optional)
productType = 56 # Integer |  (optional)
modifiers = modifiers_example # String |  (optional)
availabilityId = availabilityId_example # String |  (optional)
availabilityName = availabilityName_example # String |  (optional)
isAddonProduct = isAddonProduct_example # String |  (optional)
referenceId = referenceId_example # String |  (optional)
customerId = customerId_example # String |  (optional)

try: 
    # Simple Cart Insert
    api_instance.apiv2_cart_simple_cart_insert_post(appId=appId, productId=productId, productQty=productQty, productType=productType, modifiers=modifiers, availabilityId=availabilityId, availabilityName=availabilityName, isAddonProduct=isAddonProduct, referenceId=referenceId, customerId=customerId)
except ApiException as e:
    print("Exception when calling CartApi->apiv2CartSimpleCartInsertPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
product_id
String
product_qty
Integer
product_type
Integer
modifiers
String
availability_id
String
availability_name
String
isAddonProduct
String
reference_id
String
customer_id
String

Responses

Status: 200 - OK


apiv2CartUpdatePost

Update Cart Quantity

This request allows you to update cart quantity.


/apiv2/cart/update

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/apiv2/cart/update"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartApi;

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

public class CartApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        Integer cartItemId = 56; // Integer | 
        String productId = productId_example; // String | 
        Integer productQty = 56; // Integer | 
        String cartAction = cartAction_example; // String | 
        String referenceId = referenceId_example; // String | 
        String customerId = customerId_example; // String | 
        try {
            apiInstance.apiv2CartUpdatePost(appId, cartItemId, productId, productQty, cartAction, referenceId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiv2CartUpdatePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String appId = appId_example; // String | 
        Integer cartItemId = 56; // Integer | 
        String productId = productId_example; // String | 
        Integer productQty = 56; // Integer | 
        String cartAction = cartAction_example; // String | 
        String referenceId = referenceId_example; // String | 
        String customerId = customerId_example; // String | 
        try {
            apiInstance.apiv2CartUpdatePost(appId, cartItemId, productId, productQty, cartAction, referenceId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#apiv2CartUpdatePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
Integer *cartItemId = 56; //  (optional)
String *productId = productId_example; //  (optional)
Integer *productQty = 56; //  (optional)
String *cartAction = cartAction_example; //  (optional)
String *referenceId = referenceId_example; //  (optional)
String *customerId = customerId_example; //  (optional)

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

// Update Cart Quantity
[apiInstance apiv2CartUpdatePostWith:appId
    cartItemId:cartItemId
    productId:productId
    productQty:productQty
    cartAction:cartAction
    referenceId:referenceId
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.CartApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'cartItemId': 56 // {{Integer}} 
  'productId': productId_example // {{String}} 
  'productQty': 56 // {{Integer}} 
  'cartAction': cartAction_example // {{String}} 
  'referenceId': referenceId_example // {{String}} 
  'customerId': customerId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiv2CartUpdatePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CartApi();
            var appId = appId_example;  // String |  (optional) 
            var cartItemId = 56;  // Integer |  (optional) 
            var productId = productId_example;  // String |  (optional) 
            var productQty = 56;  // Integer |  (optional) 
            var cartAction = cartAction_example;  // String |  (optional) 
            var referenceId = referenceId_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 

            try
            {
                // Update Cart Quantity
                apiInstance.apiv2CartUpdatePost(appId, cartItemId, productId, productQty, cartAction, referenceId, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.apiv2CartUpdatePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCartApi();
$appId = appId_example; // String | 
$cartItemId = 56; // Integer | 
$productId = productId_example; // String | 
$productQty = 56; // Integer | 
$cartAction = cartAction_example; // String | 
$referenceId = referenceId_example; // String | 
$customerId = customerId_example; // String | 

try {
    $api_instance->apiv2CartUpdatePost($appId, $cartItemId, $productId, $productQty, $cartAction, $referenceId, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling CartApi->apiv2CartUpdatePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $appId = appId_example; # String | 
my $cartItemId = 56; # Integer | 
my $productId = productId_example; # String | 
my $productQty = 56; # Integer | 
my $cartAction = cartAction_example; # String | 
my $referenceId = referenceId_example; # String | 
my $customerId = customerId_example; # String | 

eval { 
    $api_instance->apiv2CartUpdatePost(appId => $appId, cartItemId => $cartItemId, productId => $productId, productQty => $productQty, cartAction => $cartAction, referenceId => $referenceId, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling CartApi->apiv2CartUpdatePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CartApi()
appId = appId_example # String |  (optional)
cartItemId = 56 # Integer |  (optional)
productId = productId_example # String |  (optional)
productQty = 56 # Integer |  (optional)
cartAction = cartAction_example # String |  (optional)
referenceId = referenceId_example # String |  (optional)
customerId = customerId_example # String |  (optional)

try: 
    # Update Cart Quantity
    api_instance.apiv2_cart_update_post(appId=appId, cartItemId=cartItemId, productId=productId, productQty=productQty, cartAction=cartAction, referenceId=referenceId, customerId=customerId)
except ApiException as e:
    print("Exception when calling CartApi->apiv2CartUpdatePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
cart_item_id
Integer
product_id
String
product_qty
Integer
cartAction
String
reference_id
String
customer_id
String

Responses

Status: 200 - OK


DeliveryZone

apiv2OutletsFindOutletZoneGet

Get Outlet Zone

This is an operation get outlet zone.


/apiv2/outlets/findOutletZone

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/apiv2/outlets/findOutletZone?app_id=&availability_id=&postal_code=&postalcode_basedoutlet="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeliveryZoneApi;

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

public class DeliveryZoneApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        DeliveryZoneApi apiInstance = new DeliveryZoneApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availabilityId = availabilityId_example; // String | 
        String postalCode = postalCode_example; // String | 
        String postalcodeBasedoutlet = postalcodeBasedoutlet_example; // String | yes
        try {
            apiInstance.apiv2OutletsFindOutletZoneGet(appId, availabilityId, postalCode, postalcodeBasedoutlet);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryZoneApi#apiv2OutletsFindOutletZoneGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeliveryZoneApi;

public class DeliveryZoneApiExample {

    public static void main(String[] args) {
        DeliveryZoneApi apiInstance = new DeliveryZoneApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availabilityId = availabilityId_example; // String | 
        String postalCode = postalCode_example; // String | 
        String postalcodeBasedoutlet = postalcodeBasedoutlet_example; // String | yes
        try {
            apiInstance.apiv2OutletsFindOutletZoneGet(appId, availabilityId, postalCode, postalcodeBasedoutlet);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryZoneApi#apiv2OutletsFindOutletZoneGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *availabilityId = availabilityId_example; // 
String *postalCode = postalCode_example; // 
String *postalcodeBasedoutlet = postalcodeBasedoutlet_example; // yes

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

// Get Outlet Zone
[apiInstance apiv2OutletsFindOutletZoneGetWith:appId
    availabilityId:availabilityId
    postalCode:postalCode
    postalcodeBasedoutlet:postalcodeBasedoutlet
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.DeliveryZoneApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var availabilityId = availabilityId_example; // {{String}} 
var postalCode = postalCode_example; // {{String}} 
var postalcodeBasedoutlet = postalcodeBasedoutlet_example; // {{String}} yes

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiv2OutletsFindOutletZoneGet(appId, availabilityId, postalCode, postalcodeBasedoutlet, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeliveryZoneApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var availabilityId = availabilityId_example;  // String | 
            var postalCode = postalCode_example;  // String | 
            var postalcodeBasedoutlet = postalcodeBasedoutlet_example;  // String | yes

            try
            {
                // Get Outlet Zone
                apiInstance.apiv2OutletsFindOutletZoneGet(appId, availabilityId, postalCode, postalcodeBasedoutlet);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliveryZoneApi.apiv2OutletsFindOutletZoneGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDeliveryZoneApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$availabilityId = availabilityId_example; // String | 
$postalCode = postalCode_example; // String | 
$postalcodeBasedoutlet = postalcodeBasedoutlet_example; // String | yes

try {
    $api_instance->apiv2OutletsFindOutletZoneGet($appId, $availabilityId, $postalCode, $postalcodeBasedoutlet);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryZoneApi->apiv2OutletsFindOutletZoneGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeliveryZoneApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DeliveryZoneApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $availabilityId = availabilityId_example; # String | 
my $postalCode = postalCode_example; # String | 
my $postalcodeBasedoutlet = postalcodeBasedoutlet_example; # String | yes

eval { 
    $api_instance->apiv2OutletsFindOutletZoneGet(appId => $appId, availabilityId => $availabilityId, postalCode => $postalCode, postalcodeBasedoutlet => $postalcodeBasedoutlet);
};
if ($@) {
    warn "Exception when calling DeliveryZoneApi->apiv2OutletsFindOutletZoneGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DeliveryZoneApi()
appId = appId_example # String | App ID Which it refers unique id for every users
availabilityId = availabilityId_example # String | 
postalCode = postalCode_example # String | 
postalcodeBasedoutlet = postalcodeBasedoutlet_example # String | yes

try: 
    # Get Outlet Zone
    api_instance.apiv2_outlets_find_outlet_zone_get(appId, availabilityId, postalCode, postalcodeBasedoutlet)
except ApiException as e:
    print("Exception when calling DeliveryZoneApi->apiv2OutletsFindOutletZoneGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
availability_id*
String
Required
postal_code*
String
Required
postalcode_basedoutlet*
String
yes
Required

Responses

Status: 200 - OK


Home

apiCmsBannerGet

Get Banners

Banner API gets all Banners set in the backend


/api/cms/banner

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/cms/banner?app_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HomeApi;

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

public class HomeApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        HomeApi apiInstance = new HomeApi();
        String appId = appId_example; // String | App ID refers to the unique id of every merchant
        try {
            apiInstance.apiCmsBannerGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#apiCmsBannerGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HomeApi;

public class HomeApiExample {

    public static void main(String[] args) {
        HomeApi apiInstance = new HomeApi();
        String appId = appId_example; // String | App ID refers to the unique id of every merchant
        try {
            apiInstance.apiCmsBannerGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#apiCmsBannerGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID refers to the unique id of every merchant

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

// Get Banners
[apiInstance apiCmsBannerGetWith:appId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.HomeApi()
var appId = appId_example; // {{String}} App ID refers to the unique id of every merchant

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCmsBannerGet(appId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HomeApi();
            var appId = appId_example;  // String | App ID refers to the unique id of every merchant

            try
            {
                // Get Banners
                apiInstance.apiCmsBannerGet(appId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HomeApi.apiCmsBannerGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHomeApi();
$appId = appId_example; // String | App ID refers to the unique id of every merchant

try {
    $api_instance->apiCmsBannerGet($appId);
} catch (Exception $e) {
    echo 'Exception when calling HomeApi->apiCmsBannerGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HomeApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HomeApi->new();
my $appId = appId_example; # String | App ID refers to the unique id of every merchant

eval { 
    $api_instance->apiCmsBannerGet(appId => $appId);
};
if ($@) {
    warn "Exception when calling HomeApi->apiCmsBannerGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HomeApi()
appId = appId_example # String | App ID refers to the unique id of every merchant

try: 
    # Get Banners
    api_instance.api_cms_banner_get(appId)
except ApiException as e:
    print("Exception when calling HomeApi->apiCmsBannerGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID refers to the unique id of every merchant
Required

Responses

Status: 200 - OK


apiCmsTestimonialGet

Get Testimonials

Testimonial API gets all approved customer testimonials set in the backend


/api/cms/testimonial

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/cms/testimonial?app_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HomeApi;

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

public class HomeApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        HomeApi apiInstance = new HomeApi();
        String appId = appId_example; // String | App ID refers to the unique id of every merchant
        try {
            apiInstance.apiCmsTestimonialGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#apiCmsTestimonialGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HomeApi;

public class HomeApiExample {

    public static void main(String[] args) {
        HomeApi apiInstance = new HomeApi();
        String appId = appId_example; // String | App ID refers to the unique id of every merchant
        try {
            apiInstance.apiCmsTestimonialGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#apiCmsTestimonialGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID refers to the unique id of every merchant

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

// Get Testimonials
[apiInstance apiCmsTestimonialGetWith:appId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.HomeApi()
var appId = appId_example; // {{String}} App ID refers to the unique id of every merchant

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCmsTestimonialGet(appId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HomeApi();
            var appId = appId_example;  // String | App ID refers to the unique id of every merchant

            try
            {
                // Get Testimonials
                apiInstance.apiCmsTestimonialGet(appId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HomeApi.apiCmsTestimonialGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHomeApi();
$appId = appId_example; // String | App ID refers to the unique id of every merchant

try {
    $api_instance->apiCmsTestimonialGet($appId);
} catch (Exception $e) {
    echo 'Exception when calling HomeApi->apiCmsTestimonialGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HomeApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HomeApi->new();
my $appId = appId_example; # String | App ID refers to the unique id of every merchant

eval { 
    $api_instance->apiCmsTestimonialGet(appId => $appId);
};
if ($@) {
    warn "Exception when calling HomeApi->apiCmsTestimonialGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HomeApi()
appId = appId_example # String | App ID refers to the unique id of every merchant

try: 
    # Get Testimonials
    api_instance.api_cms_testimonial_get(appId)
except ApiException as e:
    print("Exception when calling HomeApi->apiCmsTestimonialGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID refers to the unique id of every merchant
Required

Responses

Status: 200 - OK


apiMenuMenuv1Get

Get Menu Navigation List

Menu API gets all menu navigation content


/api/menu/menuv1

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/menu/menuv1?app_id=&menu_slug="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HomeApi;

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

public class HomeApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        HomeApi apiInstance = new HomeApi();
        String appId = appId_example; // String | App ID refers to the unique id of every merchant
        String menuSlug = menuSlug_example; // String | Identifier for the Menu under Menu Groups in the backend
        try {
            apiInstance.apiMenuMenuv1Get(appId, menuSlug);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#apiMenuMenuv1Get");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HomeApi;

public class HomeApiExample {

    public static void main(String[] args) {
        HomeApi apiInstance = new HomeApi();
        String appId = appId_example; // String | App ID refers to the unique id of every merchant
        String menuSlug = menuSlug_example; // String | Identifier for the Menu under Menu Groups in the backend
        try {
            apiInstance.apiMenuMenuv1Get(appId, menuSlug);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#apiMenuMenuv1Get");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID refers to the unique id of every merchant
String *menuSlug = menuSlug_example; // Identifier for the Menu under Menu Groups in the backend

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

// Get Menu Navigation List
[apiInstance apiMenuMenuv1GetWith:appId
    menuSlug:menuSlug
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.HomeApi()
var appId = appId_example; // {{String}} App ID refers to the unique id of every merchant
var menuSlug = menuSlug_example; // {{String}} Identifier for the Menu under Menu Groups in the backend

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiMenuMenuv1Get(appId, menuSlug, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HomeApi();
            var appId = appId_example;  // String | App ID refers to the unique id of every merchant
            var menuSlug = menuSlug_example;  // String | Identifier for the Menu under Menu Groups in the backend

            try
            {
                // Get Menu Navigation List
                apiInstance.apiMenuMenuv1Get(appId, menuSlug);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HomeApi.apiMenuMenuv1Get: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHomeApi();
$appId = appId_example; // String | App ID refers to the unique id of every merchant
$menuSlug = menuSlug_example; // String | Identifier for the Menu under Menu Groups in the backend

try {
    $api_instance->apiMenuMenuv1Get($appId, $menuSlug);
} catch (Exception $e) {
    echo 'Exception when calling HomeApi->apiMenuMenuv1Get: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HomeApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HomeApi->new();
my $appId = appId_example; # String | App ID refers to the unique id of every merchant
my $menuSlug = menuSlug_example; # String | Identifier for the Menu under Menu Groups in the backend

eval { 
    $api_instance->apiMenuMenuv1Get(appId => $appId, menuSlug => $menuSlug);
};
if ($@) {
    warn "Exception when calling HomeApi->apiMenuMenuv1Get: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HomeApi()
appId = appId_example # String | App ID refers to the unique id of every merchant
menuSlug = menuSlug_example # String | Identifier for the Menu under Menu Groups in the backend

try: 
    # Get Menu Navigation List
    api_instance.api_menu_menuv1_get(appId, menuSlug)
except ApiException as e:
    print("Exception when calling HomeApi->apiMenuMenuv1Get: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID refers to the unique id of every merchant
Required
menu_slug*
String
Identifier for the Menu under Menu Groups in the backend
Required

Responses

Status: 200 - OK


apiSettingsGetCommonSettingsGet

Get Common settings of the merchant

Common settings API gets all general settings of the merchants ( Store details, tax, payment methods.....)


/api/settings/get_common_settings

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/settings/get_common_settings?app_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HomeApi;

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

public class HomeApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        HomeApi apiInstance = new HomeApi();
        String appId = appId_example; // String | App ID refers to the unique id of every merchant
        try {
            apiInstance.apiSettingsGetCommonSettingsGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#apiSettingsGetCommonSettingsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HomeApi;

public class HomeApiExample {

    public static void main(String[] args) {
        HomeApi apiInstance = new HomeApi();
        String appId = appId_example; // String | App ID refers to the unique id of every merchant
        try {
            apiInstance.apiSettingsGetCommonSettingsGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HomeApi#apiSettingsGetCommonSettingsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID refers to the unique id of every merchant

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

// Get Common settings of the merchant
[apiInstance apiSettingsGetCommonSettingsGetWith:appId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.HomeApi()
var appId = appId_example; // {{String}} App ID refers to the unique id of every merchant

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiSettingsGetCommonSettingsGet(appId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HomeApi();
            var appId = appId_example;  // String | App ID refers to the unique id of every merchant

            try
            {
                // Get Common settings of the merchant
                apiInstance.apiSettingsGetCommonSettingsGet(appId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HomeApi.apiSettingsGetCommonSettingsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiHomeApi();
$appId = appId_example; // String | App ID refers to the unique id of every merchant

try {
    $api_instance->apiSettingsGetCommonSettingsGet($appId);
} catch (Exception $e) {
    echo 'Exception when calling HomeApi->apiSettingsGetCommonSettingsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HomeApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::HomeApi->new();
my $appId = appId_example; # String | App ID refers to the unique id of every merchant

eval { 
    $api_instance->apiSettingsGetCommonSettingsGet(appId => $appId);
};
if ($@) {
    warn "Exception when calling HomeApi->apiSettingsGetCommonSettingsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.HomeApi()
appId = appId_example # String | App ID refers to the unique id of every merchant

try: 
    # Get Common settings of the merchant
    api_instance.api_settings_get_common_settings_get(appId)
except ApiException as e:
    print("Exception when calling HomeApi->apiSettingsGetCommonSettingsGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID refers to the unique id of every merchant
Required

Responses

Status: 200 - OK


Orders

apiOrdersv1SubmitOrderPost

Submit Orders

This request allows you to see the permissions that are granted to this account.


/api/ordersv1/submit_order

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/ordersv1/submit_order"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrdersApi;

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

public class OrdersApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        OrdersApi apiInstance = new OrdersApi();
        String appId = appId_example; // String | 
        String availabilityId = availabilityId_example; // String | 
        String subTotal = subTotal_example; // String | 
        String grandTotal = grandTotal_example; // String | 
        Integer outletId = 56; // Integer | 
        Integer orderOutletCategoryId = 56; // Integer | 
        Integer zoneId = 56; // Integer | 
        String tableNumber = tableNumber_example; // String | 
        String orderStatus = orderStatus_example; // String | 
        String orderSource = orderSource_example; // String | 
        String orderDate = orderDate_example; // String | 
        String orderIsTimeslot = orderIsTimeslot_example; // String | 
        String orderPickupTimeSlotFrom = orderPickupTimeSlotFrom_example; // String | 
        String orderPickupTimeSlotTo = orderPickupTimeSlotTo_example; // String | 
        String products = products_example; // String | 
        String customerId = customerId_example; // String | 
        String customerFname = customerFname_example; // String | 
        String customerLname = customerLname_example; // String | 
        Integer customerMobileNo = 56; // Integer | 
        String customerEmail = customerEmail_example; // String | 
        String customerAddressLine1 = customerAddressLine1_example; // String | 
        String customerAddressLine2 = customerAddressLine2_example; // String | 
        Integer customerPostalCode = 56; // Integer | 
        Integer customerUnitNo1 = 56; // Integer | 
        String customerUnitNo2 = customerUnitNo2_example; // String | 
        String customerBirthdateUpdate = customerBirthdateUpdate_example; // String | 
        String customerBirthdate = customerBirthdate_example; // String | 
        String customerGender = customerGender_example; // String | 
        String billingAddressLine1 = billingAddressLine1_example; // String | 
        Integer billingPostalCode = 56; // Integer | 
        String billingUnitNo1 = billingUnitNo1_example; // String | 
        Integer billingUnitNo2 = 56; // Integer | 
        Integer paymentMode = 56; // Integer | 
        String paymentReference = paymentReference_example; // String | 
        String stripeEnvir = stripeEnvir_example; // String | 
        String paymentType = paymentType_example; // String | 
        String orderCaptureToken = orderCaptureToken_example; // String | 
        String orderPaymentGetwayType = orderPaymentGetwayType_example; // String | 
        String orderPaymentGetwayStatus = orderPaymentGetwayStatus_example; // String | 
        String deliveryCharge = deliveryCharge_example; // String | 
        String additionalDelivery = additionalDelivery_example; // String | 
        Integer orderTatTime = 56; // Integer | 
        Integer taxCharge = 56; // Integer | 
        String orderTaxCalculateAmount = orderTaxCalculateAmount_example; // String | 
        String orderDataEncode = orderDataEncode_example; // String | 
        String orderDiscountApplied = orderDiscountApplied_example; // String | 
        String orderDiscountAmount = orderDiscountAmount_example; // String | 
        String orderDiscountType = orderDiscountType_example; // String | 
        String orderSpecialDiscountAmount = orderSpecialDiscountAmount_example; // String | 
        String orderSpecialDiscountType = orderSpecialDiscountType_example; // String | 
        String validationOnly = validationOnly_example; // String | 
        String discountApplied = discountApplied_example; // String | 
        String discountAmount = discountAmount_example; // String | 
        String redeemApplied = redeemApplied_example; // String | 
        Integer redeemPoint = 56; // Integer | 
        Integer redeemAmount = 56; // Integer | 
        String rewardPointStatus = rewardPointStatus_example; // String | 
        try {
            apiInstance.apiOrdersv1SubmitOrderPost(appId, availabilityId, subTotal, grandTotal, outletId, orderOutletCategoryId, zoneId, tableNumber, orderStatus, orderSource, orderDate, orderIsTimeslot, orderPickupTimeSlotFrom, orderPickupTimeSlotTo, products, customerId, customerFname, customerLname, customerMobileNo, customerEmail, customerAddressLine1, customerAddressLine2, customerPostalCode, customerUnitNo1, customerUnitNo2, customerBirthdateUpdate, customerBirthdate, customerGender, billingAddressLine1, billingPostalCode, billingUnitNo1, billingUnitNo2, paymentMode, paymentReference, stripeEnvir, paymentType, orderCaptureToken, orderPaymentGetwayType, orderPaymentGetwayStatus, deliveryCharge, additionalDelivery, orderTatTime, taxCharge, orderTaxCalculateAmount, orderDataEncode, orderDiscountApplied, orderDiscountAmount, orderDiscountType, orderSpecialDiscountAmount, orderSpecialDiscountType, validationOnly, discountApplied, discountAmount, redeemApplied, redeemPoint, redeemAmount, rewardPointStatus);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#apiOrdersv1SubmitOrderPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrdersApi;

public class OrdersApiExample {

    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        String appId = appId_example; // String | 
        String availabilityId = availabilityId_example; // String | 
        String subTotal = subTotal_example; // String | 
        String grandTotal = grandTotal_example; // String | 
        Integer outletId = 56; // Integer | 
        Integer orderOutletCategoryId = 56; // Integer | 
        Integer zoneId = 56; // Integer | 
        String tableNumber = tableNumber_example; // String | 
        String orderStatus = orderStatus_example; // String | 
        String orderSource = orderSource_example; // String | 
        String orderDate = orderDate_example; // String | 
        String orderIsTimeslot = orderIsTimeslot_example; // String | 
        String orderPickupTimeSlotFrom = orderPickupTimeSlotFrom_example; // String | 
        String orderPickupTimeSlotTo = orderPickupTimeSlotTo_example; // String | 
        String products = products_example; // String | 
        String customerId = customerId_example; // String | 
        String customerFname = customerFname_example; // String | 
        String customerLname = customerLname_example; // String | 
        Integer customerMobileNo = 56; // Integer | 
        String customerEmail = customerEmail_example; // String | 
        String customerAddressLine1 = customerAddressLine1_example; // String | 
        String customerAddressLine2 = customerAddressLine2_example; // String | 
        Integer customerPostalCode = 56; // Integer | 
        Integer customerUnitNo1 = 56; // Integer | 
        String customerUnitNo2 = customerUnitNo2_example; // String | 
        String customerBirthdateUpdate = customerBirthdateUpdate_example; // String | 
        String customerBirthdate = customerBirthdate_example; // String | 
        String customerGender = customerGender_example; // String | 
        String billingAddressLine1 = billingAddressLine1_example; // String | 
        Integer billingPostalCode = 56; // Integer | 
        String billingUnitNo1 = billingUnitNo1_example; // String | 
        Integer billingUnitNo2 = 56; // Integer | 
        Integer paymentMode = 56; // Integer | 
        String paymentReference = paymentReference_example; // String | 
        String stripeEnvir = stripeEnvir_example; // String | 
        String paymentType = paymentType_example; // String | 
        String orderCaptureToken = orderCaptureToken_example; // String | 
        String orderPaymentGetwayType = orderPaymentGetwayType_example; // String | 
        String orderPaymentGetwayStatus = orderPaymentGetwayStatus_example; // String | 
        String deliveryCharge = deliveryCharge_example; // String | 
        String additionalDelivery = additionalDelivery_example; // String | 
        Integer orderTatTime = 56; // Integer | 
        Integer taxCharge = 56; // Integer | 
        String orderTaxCalculateAmount = orderTaxCalculateAmount_example; // String | 
        String orderDataEncode = orderDataEncode_example; // String | 
        String orderDiscountApplied = orderDiscountApplied_example; // String | 
        String orderDiscountAmount = orderDiscountAmount_example; // String | 
        String orderDiscountType = orderDiscountType_example; // String | 
        String orderSpecialDiscountAmount = orderSpecialDiscountAmount_example; // String | 
        String orderSpecialDiscountType = orderSpecialDiscountType_example; // String | 
        String validationOnly = validationOnly_example; // String | 
        String discountApplied = discountApplied_example; // String | 
        String discountAmount = discountAmount_example; // String | 
        String redeemApplied = redeemApplied_example; // String | 
        Integer redeemPoint = 56; // Integer | 
        Integer redeemAmount = 56; // Integer | 
        String rewardPointStatus = rewardPointStatus_example; // String | 
        try {
            apiInstance.apiOrdersv1SubmitOrderPost(appId, availabilityId, subTotal, grandTotal, outletId, orderOutletCategoryId, zoneId, tableNumber, orderStatus, orderSource, orderDate, orderIsTimeslot, orderPickupTimeSlotFrom, orderPickupTimeSlotTo, products, customerId, customerFname, customerLname, customerMobileNo, customerEmail, customerAddressLine1, customerAddressLine2, customerPostalCode, customerUnitNo1, customerUnitNo2, customerBirthdateUpdate, customerBirthdate, customerGender, billingAddressLine1, billingPostalCode, billingUnitNo1, billingUnitNo2, paymentMode, paymentReference, stripeEnvir, paymentType, orderCaptureToken, orderPaymentGetwayType, orderPaymentGetwayStatus, deliveryCharge, additionalDelivery, orderTatTime, taxCharge, orderTaxCalculateAmount, orderDataEncode, orderDiscountApplied, orderDiscountAmount, orderDiscountType, orderSpecialDiscountAmount, orderSpecialDiscountType, validationOnly, discountApplied, discountAmount, redeemApplied, redeemPoint, redeemAmount, rewardPointStatus);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#apiOrdersv1SubmitOrderPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *availabilityId = availabilityId_example; //  (optional)
String *subTotal = subTotal_example; //  (optional)
String *grandTotal = grandTotal_example; //  (optional)
Integer *outletId = 56; //  (optional)
Integer *orderOutletCategoryId = 56; //  (optional)
Integer *zoneId = 56; //  (optional)
String *tableNumber = tableNumber_example; //  (optional)
String *orderStatus = orderStatus_example; //  (optional)
String *orderSource = orderSource_example; //  (optional)
String *orderDate = orderDate_example; //  (optional)
String *orderIsTimeslot = orderIsTimeslot_example; //  (optional)
String *orderPickupTimeSlotFrom = orderPickupTimeSlotFrom_example; //  (optional)
String *orderPickupTimeSlotTo = orderPickupTimeSlotTo_example; //  (optional)
String *products = products_example; //  (optional)
String *customerId = customerId_example; //  (optional)
String *customerFname = customerFname_example; //  (optional)
String *customerLname = customerLname_example; //  (optional)
Integer *customerMobileNo = 56; //  (optional)
String *customerEmail = customerEmail_example; //  (optional)
String *customerAddressLine1 = customerAddressLine1_example; //  (optional)
String *customerAddressLine2 = customerAddressLine2_example; //  (optional)
Integer *customerPostalCode = 56; //  (optional)
Integer *customerUnitNo1 = 56; //  (optional)
String *customerUnitNo2 = customerUnitNo2_example; //  (optional)
String *customerBirthdateUpdate = customerBirthdateUpdate_example; //  (optional)
String *customerBirthdate = customerBirthdate_example; //  (optional)
String *customerGender = customerGender_example; //  (optional)
String *billingAddressLine1 = billingAddressLine1_example; //  (optional)
Integer *billingPostalCode = 56; //  (optional)
String *billingUnitNo1 = billingUnitNo1_example; //  (optional)
Integer *billingUnitNo2 = 56; //  (optional)
Integer *paymentMode = 56; //  (optional)
String *paymentReference = paymentReference_example; //  (optional)
String *stripeEnvir = stripeEnvir_example; //  (optional)
String *paymentType = paymentType_example; //  (optional)
String *orderCaptureToken = orderCaptureToken_example; //  (optional)
String *orderPaymentGetwayType = orderPaymentGetwayType_example; //  (optional)
String *orderPaymentGetwayStatus = orderPaymentGetwayStatus_example; //  (optional)
String *deliveryCharge = deliveryCharge_example; //  (optional)
String *additionalDelivery = additionalDelivery_example; //  (optional)
Integer *orderTatTime = 56; //  (optional)
Integer *taxCharge = 56; //  (optional)
String *orderTaxCalculateAmount = orderTaxCalculateAmount_example; //  (optional)
String *orderDataEncode = orderDataEncode_example; //  (optional)
String *orderDiscountApplied = orderDiscountApplied_example; //  (optional)
String *orderDiscountAmount = orderDiscountAmount_example; //  (optional)
String *orderDiscountType = orderDiscountType_example; //  (optional)
String *orderSpecialDiscountAmount = orderSpecialDiscountAmount_example; //  (optional)
String *orderSpecialDiscountType = orderSpecialDiscountType_example; //  (optional)
String *validationOnly = validationOnly_example; //  (optional)
String *discountApplied = discountApplied_example; //  (optional)
String *discountAmount = discountAmount_example; //  (optional)
String *redeemApplied = redeemApplied_example; //  (optional)
Integer *redeemPoint = 56; //  (optional)
Integer *redeemAmount = 56; //  (optional)
String *rewardPointStatus = rewardPointStatus_example; //  (optional)

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

// Submit Orders
[apiInstance apiOrdersv1SubmitOrderPostWith:appId
    availabilityId:availabilityId
    subTotal:subTotal
    grandTotal:grandTotal
    outletId:outletId
    orderOutletCategoryId:orderOutletCategoryId
    zoneId:zoneId
    tableNumber:tableNumber
    orderStatus:orderStatus
    orderSource:orderSource
    orderDate:orderDate
    orderIsTimeslot:orderIsTimeslot
    orderPickupTimeSlotFrom:orderPickupTimeSlotFrom
    orderPickupTimeSlotTo:orderPickupTimeSlotTo
    products:products
    customerId:customerId
    customerFname:customerFname
    customerLname:customerLname
    customerMobileNo:customerMobileNo
    customerEmail:customerEmail
    customerAddressLine1:customerAddressLine1
    customerAddressLine2:customerAddressLine2
    customerPostalCode:customerPostalCode
    customerUnitNo1:customerUnitNo1
    customerUnitNo2:customerUnitNo2
    customerBirthdateUpdate:customerBirthdateUpdate
    customerBirthdate:customerBirthdate
    customerGender:customerGender
    billingAddressLine1:billingAddressLine1
    billingPostalCode:billingPostalCode
    billingUnitNo1:billingUnitNo1
    billingUnitNo2:billingUnitNo2
    paymentMode:paymentMode
    paymentReference:paymentReference
    stripeEnvir:stripeEnvir
    paymentType:paymentType
    orderCaptureToken:orderCaptureToken
    orderPaymentGetwayType:orderPaymentGetwayType
    orderPaymentGetwayStatus:orderPaymentGetwayStatus
    deliveryCharge:deliveryCharge
    additionalDelivery:additionalDelivery
    orderTatTime:orderTatTime
    taxCharge:taxCharge
    orderTaxCalculateAmount:orderTaxCalculateAmount
    orderDataEncode:orderDataEncode
    orderDiscountApplied:orderDiscountApplied
    orderDiscountAmount:orderDiscountAmount
    orderDiscountType:orderDiscountType
    orderSpecialDiscountAmount:orderSpecialDiscountAmount
    orderSpecialDiscountType:orderSpecialDiscountType
    validationOnly:validationOnly
    discountApplied:discountApplied
    discountAmount:discountAmount
    redeemApplied:redeemApplied
    redeemPoint:redeemPoint
    redeemAmount:redeemAmount
    rewardPointStatus:rewardPointStatus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.OrdersApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'availabilityId': availabilityId_example // {{String}} 
  'subTotal': subTotal_example // {{String}} 
  'grandTotal': grandTotal_example // {{String}} 
  'outletId': 56 // {{Integer}} 
  'orderOutletCategoryId': 56 // {{Integer}} 
  'zoneId': 56 // {{Integer}} 
  'tableNumber': tableNumber_example // {{String}} 
  'orderStatus': orderStatus_example // {{String}} 
  'orderSource': orderSource_example // {{String}} 
  'orderDate': orderDate_example // {{String}} 
  'orderIsTimeslot': orderIsTimeslot_example // {{String}} 
  'orderPickupTimeSlotFrom': orderPickupTimeSlotFrom_example // {{String}} 
  'orderPickupTimeSlotTo': orderPickupTimeSlotTo_example // {{String}} 
  'products': products_example // {{String}} 
  'customerId': customerId_example // {{String}} 
  'customerFname': customerFname_example // {{String}} 
  'customerLname': customerLname_example // {{String}} 
  'customerMobileNo': 56 // {{Integer}} 
  'customerEmail': customerEmail_example // {{String}} 
  'customerAddressLine1': customerAddressLine1_example // {{String}} 
  'customerAddressLine2': customerAddressLine2_example // {{String}} 
  'customerPostalCode': 56 // {{Integer}} 
  'customerUnitNo1': 56 // {{Integer}} 
  'customerUnitNo2': customerUnitNo2_example // {{String}} 
  'customerBirthdateUpdate': customerBirthdateUpdate_example // {{String}} 
  'customerBirthdate': customerBirthdate_example // {{String}} 
  'customerGender': customerGender_example // {{String}} 
  'billingAddressLine1': billingAddressLine1_example // {{String}} 
  'billingPostalCode': 56 // {{Integer}} 
  'billingUnitNo1': billingUnitNo1_example // {{String}} 
  'billingUnitNo2': 56 // {{Integer}} 
  'paymentMode': 56 // {{Integer}} 
  'paymentReference': paymentReference_example // {{String}} 
  'stripeEnvir': stripeEnvir_example // {{String}} 
  'paymentType': paymentType_example // {{String}} 
  'orderCaptureToken': orderCaptureToken_example // {{String}} 
  'orderPaymentGetwayType': orderPaymentGetwayType_example // {{String}} 
  'orderPaymentGetwayStatus': orderPaymentGetwayStatus_example // {{String}} 
  'deliveryCharge': deliveryCharge_example // {{String}} 
  'additionalDelivery': additionalDelivery_example // {{String}} 
  'orderTatTime': 56 // {{Integer}} 
  'taxCharge': 56 // {{Integer}} 
  'orderTaxCalculateAmount': orderTaxCalculateAmount_example // {{String}} 
  'orderDataEncode': orderDataEncode_example // {{String}} 
  'orderDiscountApplied': orderDiscountApplied_example // {{String}} 
  'orderDiscountAmount': orderDiscountAmount_example // {{String}} 
  'orderDiscountType': orderDiscountType_example // {{String}} 
  'orderSpecialDiscountAmount': orderSpecialDiscountAmount_example // {{String}} 
  'orderSpecialDiscountType': orderSpecialDiscountType_example // {{String}} 
  'validationOnly': validationOnly_example // {{String}} 
  'discountApplied': discountApplied_example // {{String}} 
  'discountAmount': discountAmount_example // {{String}} 
  'redeemApplied': redeemApplied_example // {{String}} 
  'redeemPoint': 56 // {{Integer}} 
  'redeemAmount': 56 // {{Integer}} 
  'rewardPointStatus': rewardPointStatus_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiOrdersv1SubmitOrderPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var appId = appId_example;  // String |  (optional) 
            var availabilityId = availabilityId_example;  // String |  (optional) 
            var subTotal = subTotal_example;  // String |  (optional) 
            var grandTotal = grandTotal_example;  // String |  (optional) 
            var outletId = 56;  // Integer |  (optional) 
            var orderOutletCategoryId = 56;  // Integer |  (optional) 
            var zoneId = 56;  // Integer |  (optional) 
            var tableNumber = tableNumber_example;  // String |  (optional) 
            var orderStatus = orderStatus_example;  // String |  (optional) 
            var orderSource = orderSource_example;  // String |  (optional) 
            var orderDate = orderDate_example;  // String |  (optional) 
            var orderIsTimeslot = orderIsTimeslot_example;  // String |  (optional) 
            var orderPickupTimeSlotFrom = orderPickupTimeSlotFrom_example;  // String |  (optional) 
            var orderPickupTimeSlotTo = orderPickupTimeSlotTo_example;  // String |  (optional) 
            var products = products_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 
            var customerFname = customerFname_example;  // String |  (optional) 
            var customerLname = customerLname_example;  // String |  (optional) 
            var customerMobileNo = 56;  // Integer |  (optional) 
            var customerEmail = customerEmail_example;  // String |  (optional) 
            var customerAddressLine1 = customerAddressLine1_example;  // String |  (optional) 
            var customerAddressLine2 = customerAddressLine2_example;  // String |  (optional) 
            var customerPostalCode = 56;  // Integer |  (optional) 
            var customerUnitNo1 = 56;  // Integer |  (optional) 
            var customerUnitNo2 = customerUnitNo2_example;  // String |  (optional) 
            var customerBirthdateUpdate = customerBirthdateUpdate_example;  // String |  (optional) 
            var customerBirthdate = customerBirthdate_example;  // String |  (optional) 
            var customerGender = customerGender_example;  // String |  (optional) 
            var billingAddressLine1 = billingAddressLine1_example;  // String |  (optional) 
            var billingPostalCode = 56;  // Integer |  (optional) 
            var billingUnitNo1 = billingUnitNo1_example;  // String |  (optional) 
            var billingUnitNo2 = 56;  // Integer |  (optional) 
            var paymentMode = 56;  // Integer |  (optional) 
            var paymentReference = paymentReference_example;  // String |  (optional) 
            var stripeEnvir = stripeEnvir_example;  // String |  (optional) 
            var paymentType = paymentType_example;  // String |  (optional) 
            var orderCaptureToken = orderCaptureToken_example;  // String |  (optional) 
            var orderPaymentGetwayType = orderPaymentGetwayType_example;  // String |  (optional) 
            var orderPaymentGetwayStatus = orderPaymentGetwayStatus_example;  // String |  (optional) 
            var deliveryCharge = deliveryCharge_example;  // String |  (optional) 
            var additionalDelivery = additionalDelivery_example;  // String |  (optional) 
            var orderTatTime = 56;  // Integer |  (optional) 
            var taxCharge = 56;  // Integer |  (optional) 
            var orderTaxCalculateAmount = orderTaxCalculateAmount_example;  // String |  (optional) 
            var orderDataEncode = orderDataEncode_example;  // String |  (optional) 
            var orderDiscountApplied = orderDiscountApplied_example;  // String |  (optional) 
            var orderDiscountAmount = orderDiscountAmount_example;  // String |  (optional) 
            var orderDiscountType = orderDiscountType_example;  // String |  (optional) 
            var orderSpecialDiscountAmount = orderSpecialDiscountAmount_example;  // String |  (optional) 
            var orderSpecialDiscountType = orderSpecialDiscountType_example;  // String |  (optional) 
            var validationOnly = validationOnly_example;  // String |  (optional) 
            var discountApplied = discountApplied_example;  // String |  (optional) 
            var discountAmount = discountAmount_example;  // String |  (optional) 
            var redeemApplied = redeemApplied_example;  // String |  (optional) 
            var redeemPoint = 56;  // Integer |  (optional) 
            var redeemAmount = 56;  // Integer |  (optional) 
            var rewardPointStatus = rewardPointStatus_example;  // String |  (optional) 

            try
            {
                // Submit Orders
                apiInstance.apiOrdersv1SubmitOrderPost(appId, availabilityId, subTotal, grandTotal, outletId, orderOutletCategoryId, zoneId, tableNumber, orderStatus, orderSource, orderDate, orderIsTimeslot, orderPickupTimeSlotFrom, orderPickupTimeSlotTo, products, customerId, customerFname, customerLname, customerMobileNo, customerEmail, customerAddressLine1, customerAddressLine2, customerPostalCode, customerUnitNo1, customerUnitNo2, customerBirthdateUpdate, customerBirthdate, customerGender, billingAddressLine1, billingPostalCode, billingUnitNo1, billingUnitNo2, paymentMode, paymentReference, stripeEnvir, paymentType, orderCaptureToken, orderPaymentGetwayType, orderPaymentGetwayStatus, deliveryCharge, additionalDelivery, orderTatTime, taxCharge, orderTaxCalculateAmount, orderDataEncode, orderDiscountApplied, orderDiscountAmount, orderDiscountType, orderSpecialDiscountAmount, orderSpecialDiscountType, validationOnly, discountApplied, discountAmount, redeemApplied, redeemPoint, redeemAmount, rewardPointStatus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.apiOrdersv1SubmitOrderPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiOrdersApi();
$appId = appId_example; // String | 
$availabilityId = availabilityId_example; // String | 
$subTotal = subTotal_example; // String | 
$grandTotal = grandTotal_example; // String | 
$outletId = 56; // Integer | 
$orderOutletCategoryId = 56; // Integer | 
$zoneId = 56; // Integer | 
$tableNumber = tableNumber_example; // String | 
$orderStatus = orderStatus_example; // String | 
$orderSource = orderSource_example; // String | 
$orderDate = orderDate_example; // String | 
$orderIsTimeslot = orderIsTimeslot_example; // String | 
$orderPickupTimeSlotFrom = orderPickupTimeSlotFrom_example; // String | 
$orderPickupTimeSlotTo = orderPickupTimeSlotTo_example; // String | 
$products = products_example; // String | 
$customerId = customerId_example; // String | 
$customerFname = customerFname_example; // String | 
$customerLname = customerLname_example; // String | 
$customerMobileNo = 56; // Integer | 
$customerEmail = customerEmail_example; // String | 
$customerAddressLine1 = customerAddressLine1_example; // String | 
$customerAddressLine2 = customerAddressLine2_example; // String | 
$customerPostalCode = 56; // Integer | 
$customerUnitNo1 = 56; // Integer | 
$customerUnitNo2 = customerUnitNo2_example; // String | 
$customerBirthdateUpdate = customerBirthdateUpdate_example; // String | 
$customerBirthdate = customerBirthdate_example; // String | 
$customerGender = customerGender_example; // String | 
$billingAddressLine1 = billingAddressLine1_example; // String | 
$billingPostalCode = 56; // Integer | 
$billingUnitNo1 = billingUnitNo1_example; // String | 
$billingUnitNo2 = 56; // Integer | 
$paymentMode = 56; // Integer | 
$paymentReference = paymentReference_example; // String | 
$stripeEnvir = stripeEnvir_example; // String | 
$paymentType = paymentType_example; // String | 
$orderCaptureToken = orderCaptureToken_example; // String | 
$orderPaymentGetwayType = orderPaymentGetwayType_example; // String | 
$orderPaymentGetwayStatus = orderPaymentGetwayStatus_example; // String | 
$deliveryCharge = deliveryCharge_example; // String | 
$additionalDelivery = additionalDelivery_example; // String | 
$orderTatTime = 56; // Integer | 
$taxCharge = 56; // Integer | 
$orderTaxCalculateAmount = orderTaxCalculateAmount_example; // String | 
$orderDataEncode = orderDataEncode_example; // String | 
$orderDiscountApplied = orderDiscountApplied_example; // String | 
$orderDiscountAmount = orderDiscountAmount_example; // String | 
$orderDiscountType = orderDiscountType_example; // String | 
$orderSpecialDiscountAmount = orderSpecialDiscountAmount_example; // String | 
$orderSpecialDiscountType = orderSpecialDiscountType_example; // String | 
$validationOnly = validationOnly_example; // String | 
$discountApplied = discountApplied_example; // String | 
$discountAmount = discountAmount_example; // String | 
$redeemApplied = redeemApplied_example; // String | 
$redeemPoint = 56; // Integer | 
$redeemAmount = 56; // Integer | 
$rewardPointStatus = rewardPointStatus_example; // String | 

try {
    $api_instance->apiOrdersv1SubmitOrderPost($appId, $availabilityId, $subTotal, $grandTotal, $outletId, $orderOutletCategoryId, $zoneId, $tableNumber, $orderStatus, $orderSource, $orderDate, $orderIsTimeslot, $orderPickupTimeSlotFrom, $orderPickupTimeSlotTo, $products, $customerId, $customerFname, $customerLname, $customerMobileNo, $customerEmail, $customerAddressLine1, $customerAddressLine2, $customerPostalCode, $customerUnitNo1, $customerUnitNo2, $customerBirthdateUpdate, $customerBirthdate, $customerGender, $billingAddressLine1, $billingPostalCode, $billingUnitNo1, $billingUnitNo2, $paymentMode, $paymentReference, $stripeEnvir, $paymentType, $orderCaptureToken, $orderPaymentGetwayType, $orderPaymentGetwayStatus, $deliveryCharge, $additionalDelivery, $orderTatTime, $taxCharge, $orderTaxCalculateAmount, $orderDataEncode, $orderDiscountApplied, $orderDiscountAmount, $orderDiscountType, $orderSpecialDiscountAmount, $orderSpecialDiscountType, $validationOnly, $discountApplied, $discountAmount, $redeemApplied, $redeemPoint, $redeemAmount, $rewardPointStatus);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->apiOrdersv1SubmitOrderPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrdersApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrdersApi->new();
my $appId = appId_example; # String | 
my $availabilityId = availabilityId_example; # String | 
my $subTotal = subTotal_example; # String | 
my $grandTotal = grandTotal_example; # String | 
my $outletId = 56; # Integer | 
my $orderOutletCategoryId = 56; # Integer | 
my $zoneId = 56; # Integer | 
my $tableNumber = tableNumber_example; # String | 
my $orderStatus = orderStatus_example; # String | 
my $orderSource = orderSource_example; # String | 
my $orderDate = orderDate_example; # String | 
my $orderIsTimeslot = orderIsTimeslot_example; # String | 
my $orderPickupTimeSlotFrom = orderPickupTimeSlotFrom_example; # String | 
my $orderPickupTimeSlotTo = orderPickupTimeSlotTo_example; # String | 
my $products = products_example; # String | 
my $customerId = customerId_example; # String | 
my $customerFname = customerFname_example; # String | 
my $customerLname = customerLname_example; # String | 
my $customerMobileNo = 56; # Integer | 
my $customerEmail = customerEmail_example; # String | 
my $customerAddressLine1 = customerAddressLine1_example; # String | 
my $customerAddressLine2 = customerAddressLine2_example; # String | 
my $customerPostalCode = 56; # Integer | 
my $customerUnitNo1 = 56; # Integer | 
my $customerUnitNo2 = customerUnitNo2_example; # String | 
my $customerBirthdateUpdate = customerBirthdateUpdate_example; # String | 
my $customerBirthdate = customerBirthdate_example; # String | 
my $customerGender = customerGender_example; # String | 
my $billingAddressLine1 = billingAddressLine1_example; # String | 
my $billingPostalCode = 56; # Integer | 
my $billingUnitNo1 = billingUnitNo1_example; # String | 
my $billingUnitNo2 = 56; # Integer | 
my $paymentMode = 56; # Integer | 
my $paymentReference = paymentReference_example; # String | 
my $stripeEnvir = stripeEnvir_example; # String | 
my $paymentType = paymentType_example; # String | 
my $orderCaptureToken = orderCaptureToken_example; # String | 
my $orderPaymentGetwayType = orderPaymentGetwayType_example; # String | 
my $orderPaymentGetwayStatus = orderPaymentGetwayStatus_example; # String | 
my $deliveryCharge = deliveryCharge_example; # String | 
my $additionalDelivery = additionalDelivery_example; # String | 
my $orderTatTime = 56; # Integer | 
my $taxCharge = 56; # Integer | 
my $orderTaxCalculateAmount = orderTaxCalculateAmount_example; # String | 
my $orderDataEncode = orderDataEncode_example; # String | 
my $orderDiscountApplied = orderDiscountApplied_example; # String | 
my $orderDiscountAmount = orderDiscountAmount_example; # String | 
my $orderDiscountType = orderDiscountType_example; # String | 
my $orderSpecialDiscountAmount = orderSpecialDiscountAmount_example; # String | 
my $orderSpecialDiscountType = orderSpecialDiscountType_example; # String | 
my $validationOnly = validationOnly_example; # String | 
my $discountApplied = discountApplied_example; # String | 
my $discountAmount = discountAmount_example; # String | 
my $redeemApplied = redeemApplied_example; # String | 
my $redeemPoint = 56; # Integer | 
my $redeemAmount = 56; # Integer | 
my $rewardPointStatus = rewardPointStatus_example; # String | 

eval { 
    $api_instance->apiOrdersv1SubmitOrderPost(appId => $appId, availabilityId => $availabilityId, subTotal => $subTotal, grandTotal => $grandTotal, outletId => $outletId, orderOutletCategoryId => $orderOutletCategoryId, zoneId => $zoneId, tableNumber => $tableNumber, orderStatus => $orderStatus, orderSource => $orderSource, orderDate => $orderDate, orderIsTimeslot => $orderIsTimeslot, orderPickupTimeSlotFrom => $orderPickupTimeSlotFrom, orderPickupTimeSlotTo => $orderPickupTimeSlotTo, products => $products, customerId => $customerId, customerFname => $customerFname, customerLname => $customerLname, customerMobileNo => $customerMobileNo, customerEmail => $customerEmail, customerAddressLine1 => $customerAddressLine1, customerAddressLine2 => $customerAddressLine2, customerPostalCode => $customerPostalCode, customerUnitNo1 => $customerUnitNo1, customerUnitNo2 => $customerUnitNo2, customerBirthdateUpdate => $customerBirthdateUpdate, customerBirthdate => $customerBirthdate, customerGender => $customerGender, billingAddressLine1 => $billingAddressLine1, billingPostalCode => $billingPostalCode, billingUnitNo1 => $billingUnitNo1, billingUnitNo2 => $billingUnitNo2, paymentMode => $paymentMode, paymentReference => $paymentReference, stripeEnvir => $stripeEnvir, paymentType => $paymentType, orderCaptureToken => $orderCaptureToken, orderPaymentGetwayType => $orderPaymentGetwayType, orderPaymentGetwayStatus => $orderPaymentGetwayStatus, deliveryCharge => $deliveryCharge, additionalDelivery => $additionalDelivery, orderTatTime => $orderTatTime, taxCharge => $taxCharge, orderTaxCalculateAmount => $orderTaxCalculateAmount, orderDataEncode => $orderDataEncode, orderDiscountApplied => $orderDiscountApplied, orderDiscountAmount => $orderDiscountAmount, orderDiscountType => $orderDiscountType, orderSpecialDiscountAmount => $orderSpecialDiscountAmount, orderSpecialDiscountType => $orderSpecialDiscountType, validationOnly => $validationOnly, discountApplied => $discountApplied, discountAmount => $discountAmount, redeemApplied => $redeemApplied, redeemPoint => $redeemPoint, redeemAmount => $redeemAmount, rewardPointStatus => $rewardPointStatus);
};
if ($@) {
    warn "Exception when calling OrdersApi->apiOrdersv1SubmitOrderPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrdersApi()
appId = appId_example # String |  (optional)
availabilityId = availabilityId_example # String |  (optional)
subTotal = subTotal_example # String |  (optional)
grandTotal = grandTotal_example # String |  (optional)
outletId = 56 # Integer |  (optional)
orderOutletCategoryId = 56 # Integer |  (optional)
zoneId = 56 # Integer |  (optional)
tableNumber = tableNumber_example # String |  (optional)
orderStatus = orderStatus_example # String |  (optional)
orderSource = orderSource_example # String |  (optional)
orderDate = orderDate_example # String |  (optional)
orderIsTimeslot = orderIsTimeslot_example # String |  (optional)
orderPickupTimeSlotFrom = orderPickupTimeSlotFrom_example # String |  (optional)
orderPickupTimeSlotTo = orderPickupTimeSlotTo_example # String |  (optional)
products = products_example # String |  (optional)
customerId = customerId_example # String |  (optional)
customerFname = customerFname_example # String |  (optional)
customerLname = customerLname_example # String |  (optional)
customerMobileNo = 56 # Integer |  (optional)
customerEmail = customerEmail_example # String |  (optional)
customerAddressLine1 = customerAddressLine1_example # String |  (optional)
customerAddressLine2 = customerAddressLine2_example # String |  (optional)
customerPostalCode = 56 # Integer |  (optional)
customerUnitNo1 = 56 # Integer |  (optional)
customerUnitNo2 = customerUnitNo2_example # String |  (optional)
customerBirthdateUpdate = customerBirthdateUpdate_example # String |  (optional)
customerBirthdate = customerBirthdate_example # String |  (optional)
customerGender = customerGender_example # String |  (optional)
billingAddressLine1 = billingAddressLine1_example # String |  (optional)
billingPostalCode = 56 # Integer |  (optional)
billingUnitNo1 = billingUnitNo1_example # String |  (optional)
billingUnitNo2 = 56 # Integer |  (optional)
paymentMode = 56 # Integer |  (optional)
paymentReference = paymentReference_example # String |  (optional)
stripeEnvir = stripeEnvir_example # String |  (optional)
paymentType = paymentType_example # String |  (optional)
orderCaptureToken = orderCaptureToken_example # String |  (optional)
orderPaymentGetwayType = orderPaymentGetwayType_example # String |  (optional)
orderPaymentGetwayStatus = orderPaymentGetwayStatus_example # String |  (optional)
deliveryCharge = deliveryCharge_example # String |  (optional)
additionalDelivery = additionalDelivery_example # String |  (optional)
orderTatTime = 56 # Integer |  (optional)
taxCharge = 56 # Integer |  (optional)
orderTaxCalculateAmount = orderTaxCalculateAmount_example # String |  (optional)
orderDataEncode = orderDataEncode_example # String |  (optional)
orderDiscountApplied = orderDiscountApplied_example # String |  (optional)
orderDiscountAmount = orderDiscountAmount_example # String |  (optional)
orderDiscountType = orderDiscountType_example # String |  (optional)
orderSpecialDiscountAmount = orderSpecialDiscountAmount_example # String |  (optional)
orderSpecialDiscountType = orderSpecialDiscountType_example # String |  (optional)
validationOnly = validationOnly_example # String |  (optional)
discountApplied = discountApplied_example # String |  (optional)
discountAmount = discountAmount_example # String |  (optional)
redeemApplied = redeemApplied_example # String |  (optional)
redeemPoint = 56 # Integer |  (optional)
redeemAmount = 56 # Integer |  (optional)
rewardPointStatus = rewardPointStatus_example # String |  (optional)

try: 
    # Submit Orders
    api_instance.api_ordersv1_submit_order_post(appId=appId, availabilityId=availabilityId, subTotal=subTotal, grandTotal=grandTotal, outletId=outletId, orderOutletCategoryId=orderOutletCategoryId, zoneId=zoneId, tableNumber=tableNumber, orderStatus=orderStatus, orderSource=orderSource, orderDate=orderDate, orderIsTimeslot=orderIsTimeslot, orderPickupTimeSlotFrom=orderPickupTimeSlotFrom, orderPickupTimeSlotTo=orderPickupTimeSlotTo, products=products, customerId=customerId, customerFname=customerFname, customerLname=customerLname, customerMobileNo=customerMobileNo, customerEmail=customerEmail, customerAddressLine1=customerAddressLine1, customerAddressLine2=customerAddressLine2, customerPostalCode=customerPostalCode, customerUnitNo1=customerUnitNo1, customerUnitNo2=customerUnitNo2, customerBirthdateUpdate=customerBirthdateUpdate, customerBirthdate=customerBirthdate, customerGender=customerGender, billingAddressLine1=billingAddressLine1, billingPostalCode=billingPostalCode, billingUnitNo1=billingUnitNo1, billingUnitNo2=billingUnitNo2, paymentMode=paymentMode, paymentReference=paymentReference, stripeEnvir=stripeEnvir, paymentType=paymentType, orderCaptureToken=orderCaptureToken, orderPaymentGetwayType=orderPaymentGetwayType, orderPaymentGetwayStatus=orderPaymentGetwayStatus, deliveryCharge=deliveryCharge, additionalDelivery=additionalDelivery, orderTatTime=orderTatTime, taxCharge=taxCharge, orderTaxCalculateAmount=orderTaxCalculateAmount, orderDataEncode=orderDataEncode, orderDiscountApplied=orderDiscountApplied, orderDiscountAmount=orderDiscountAmount, orderDiscountType=orderDiscountType, orderSpecialDiscountAmount=orderSpecialDiscountAmount, orderSpecialDiscountType=orderSpecialDiscountType, validationOnly=validationOnly, discountApplied=discountApplied, discountAmount=discountAmount, redeemApplied=redeemApplied, redeemPoint=redeemPoint, redeemAmount=redeemAmount, rewardPointStatus=rewardPointStatus)
except ApiException as e:
    print("Exception when calling OrdersApi->apiOrdersv1SubmitOrderPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
availability_id
String
sub_total
String
grand_total
String
outlet_id
Integer
order_outlet_category_id
Integer
zone_id
Integer
table_number
String
order_status
String
order_source
String
order_date
String
order_is_timeslot
String
order_pickup_time_slot_from
String
order_pickup_time_slot_to
String
products
String
customer_id
String
customer_fname
String
customer_lname
String
customer_mobile_no
Integer
customer_email
String
customer_address_line1
String
customer_address_line2
String
customer_postal_code
Integer
customer_unit_no1
Integer
customer_unit_no2
String
customer_birthdate_update
String
customer_birthdate
String
customer_gender
String
billing_address_line1
String
billing_postal_code
Integer
billing_unit_no1
String
billing_unit_no2
Integer
payment_mode
Integer
payment_reference
String
stripe_envir
String
payment_type
String
order_capture_token
String
order_payment_getway_type
String
order_payment_getway_status
String
delivery_charge
String
additional_delivery
String
order_tat_time
Integer
tax_charge
Integer
order_tax_calculate_amount
String
order_data_encode
String
order_discount_applied
String
order_discount_amount
String
order_discount_type
String
order_special_discount_amount
String
order_special_discount_type
String
validation_only
String
discount_applied
String
discount_amount
String
redeem_applied
String
redeem_point
Integer
redeem_amount
Integer
reward_point_status
String

Responses

Status: 200 - OK


apiReportsOrderHistoryGet

Get Orders History

This is an operation get orders report


/api/reports/order_history

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/reports/order_history?app_id=&order_status=&customer_id=&limit=&except_availability=&local_order_no="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrdersApi;

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

public class OrdersApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        OrdersApi apiInstance = new OrdersApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String orderStatus = orderStatus_example; // String | Status
        String customerId = customerId_example; // String | Customer ID
        String limit = limit_example; // String | Limit
        String exceptAvailability = exceptAvailability_example; // String | Expect Availablity
        String localOrderNo = localOrderNo_example; // String | Expect Availablity
        try {
            apiInstance.apiReportsOrderHistoryGet(appId, orderStatus, customerId, limit, exceptAvailability, localOrderNo);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#apiReportsOrderHistoryGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrdersApi;

public class OrdersApiExample {

    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String orderStatus = orderStatus_example; // String | Status
        String customerId = customerId_example; // String | Customer ID
        String limit = limit_example; // String | Limit
        String exceptAvailability = exceptAvailability_example; // String | Expect Availablity
        String localOrderNo = localOrderNo_example; // String | Expect Availablity
        try {
            apiInstance.apiReportsOrderHistoryGet(appId, orderStatus, customerId, limit, exceptAvailability, localOrderNo);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#apiReportsOrderHistoryGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *orderStatus = orderStatus_example; // Status
String *customerId = customerId_example; // Customer ID (optional)
String *limit = limit_example; // Limit (optional)
String *exceptAvailability = exceptAvailability_example; // Expect Availablity (optional)
String *localOrderNo = localOrderNo_example; // Expect Availablity (optional)

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

// Get Orders History
[apiInstance apiReportsOrderHistoryGetWith:appId
    orderStatus:orderStatus
    customerId:customerId
    limit:limit
    exceptAvailability:exceptAvailability
    localOrderNo:localOrderNo
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.OrdersApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var orderStatus = orderStatus_example; // {{String}} Status
var opts = { 
  'customerId': customerId_example, // {{String}} Customer ID
  'limit': limit_example, // {{String}} Limit
  'exceptAvailability': exceptAvailability_example, // {{String}} Expect Availablity
  'localOrderNo': localOrderNo_example // {{String}} Expect Availablity
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiReportsOrderHistoryGet(appId, orderStatus, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var orderStatus = orderStatus_example;  // String | Status
            var customerId = customerId_example;  // String | Customer ID (optional) 
            var limit = limit_example;  // String | Limit (optional) 
            var exceptAvailability = exceptAvailability_example;  // String | Expect Availablity (optional) 
            var localOrderNo = localOrderNo_example;  // String | Expect Availablity (optional) 

            try
            {
                // Get Orders History
                apiInstance.apiReportsOrderHistoryGet(appId, orderStatus, customerId, limit, exceptAvailability, localOrderNo);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.apiReportsOrderHistoryGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiOrdersApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$orderStatus = orderStatus_example; // String | Status
$customerId = customerId_example; // String | Customer ID
$limit = limit_example; // String | Limit
$exceptAvailability = exceptAvailability_example; // String | Expect Availablity
$localOrderNo = localOrderNo_example; // String | Expect Availablity

try {
    $api_instance->apiReportsOrderHistoryGet($appId, $orderStatus, $customerId, $limit, $exceptAvailability, $localOrderNo);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->apiReportsOrderHistoryGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrdersApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrdersApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $orderStatus = orderStatus_example; # String | Status
my $customerId = customerId_example; # String | Customer ID
my $limit = limit_example; # String | Limit
my $exceptAvailability = exceptAvailability_example; # String | Expect Availablity
my $localOrderNo = localOrderNo_example; # String | Expect Availablity

eval { 
    $api_instance->apiReportsOrderHistoryGet(appId => $appId, orderStatus => $orderStatus, customerId => $customerId, limit => $limit, exceptAvailability => $exceptAvailability, localOrderNo => $localOrderNo);
};
if ($@) {
    warn "Exception when calling OrdersApi->apiReportsOrderHistoryGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrdersApi()
appId = appId_example # String | App ID Which it refers unique id for every users
orderStatus = orderStatus_example # String | Status
customerId = customerId_example # String | Customer ID (optional)
limit = limit_example # String | Limit (optional)
exceptAvailability = exceptAvailability_example # String | Expect Availablity (optional)
localOrderNo = localOrderNo_example # String | Expect Availablity (optional)

try: 
    # Get Orders History
    api_instance.api_reports_order_history_get(appId, orderStatus, customerId=customerId, limit=limit, exceptAvailability=exceptAvailability, localOrderNo=localOrderNo)
except ApiException as e:
    print("Exception when calling OrdersApi->apiReportsOrderHistoryGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
order_status*
String
Status
Required
customer_id
String
Customer ID
limit
String
Limit
except_availability
String
Expect Availablity
local_order_no
String
Expect Availablity

Responses

Status: 200 - OK


Outlets

apiSettingsGetAvailabilityGet

Get Setting Availablity

This is an operation get all setting availability.


/api/settings/get_availability

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/settings/get_availability?app_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OutletsApi;

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

public class OutletsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        OutletsApi apiInstance = new OutletsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        try {
            apiInstance.apiSettingsGetAvailabilityGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#apiSettingsGetAvailabilityGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OutletsApi;

public class OutletsApiExample {

    public static void main(String[] args) {
        OutletsApi apiInstance = new OutletsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        try {
            apiInstance.apiSettingsGetAvailabilityGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#apiSettingsGetAvailabilityGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users

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

// Get Setting Availablity
[apiInstance apiSettingsGetAvailabilityGetWith:appId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.OutletsApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiSettingsGetAvailabilityGet(appId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OutletsApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users

            try
            {
                // Get Setting Availablity
                apiInstance.apiSettingsGetAvailabilityGet(appId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutletsApi.apiSettingsGetAvailabilityGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiOutletsApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users

try {
    $api_instance->apiSettingsGetAvailabilityGet($appId);
} catch (Exception $e) {
    echo 'Exception when calling OutletsApi->apiSettingsGetAvailabilityGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OutletsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OutletsApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users

eval { 
    $api_instance->apiSettingsGetAvailabilityGet(appId => $appId);
};
if ($@) {
    warn "Exception when calling OutletsApi->apiSettingsGetAvailabilityGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OutletsApi()
appId = appId_example # String | App ID Which it refers unique id for every users

try: 
    # Get Setting Availablity
    api_instance.api_settings_get_availability_get(appId)
except ApiException as e:
    print("Exception when calling OutletsApi->apiSettingsGetAvailabilityGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required

Responses

Status: 200 - OK


apiv2OutletsGetAllOutlesGet

Get Outlets

This is an operation get outlets.


/apiv2/outlets/getAllOutles

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/apiv2/outlets/getAllOutles?app_id=&availability_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OutletsApi;

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

public class OutletsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        OutletsApi apiInstance = new OutletsApi();
        String appId = appId_example; // String | App ID - refers to the unique id for every merchant
        String availabilityId = availabilityId_example; // String | 
        try {
            apiInstance.apiv2OutletsGetAllOutlesGet(appId, availabilityId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#apiv2OutletsGetAllOutlesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OutletsApi;

public class OutletsApiExample {

    public static void main(String[] args) {
        OutletsApi apiInstance = new OutletsApi();
        String appId = appId_example; // String | App ID - refers to the unique id for every merchant
        String availabilityId = availabilityId_example; // String | 
        try {
            apiInstance.apiv2OutletsGetAllOutlesGet(appId, availabilityId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OutletsApi#apiv2OutletsGetAllOutlesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID - refers to the unique id for every merchant
String *availabilityId = availabilityId_example; // 

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

// Get Outlets
[apiInstance apiv2OutletsGetAllOutlesGetWith:appId
    availabilityId:availabilityId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.OutletsApi()
var appId = appId_example; // {{String}} App ID - refers to the unique id for every merchant
var availabilityId = availabilityId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiv2OutletsGetAllOutlesGet(appId, availabilityId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OutletsApi();
            var appId = appId_example;  // String | App ID - refers to the unique id for every merchant
            var availabilityId = availabilityId_example;  // String | 

            try
            {
                // Get Outlets
                apiInstance.apiv2OutletsGetAllOutlesGet(appId, availabilityId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OutletsApi.apiv2OutletsGetAllOutlesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiOutletsApi();
$appId = appId_example; // String | App ID - refers to the unique id for every merchant
$availabilityId = availabilityId_example; // String | 

try {
    $api_instance->apiv2OutletsGetAllOutlesGet($appId, $availabilityId);
} catch (Exception $e) {
    echo 'Exception when calling OutletsApi->apiv2OutletsGetAllOutlesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OutletsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OutletsApi->new();
my $appId = appId_example; # String | App ID - refers to the unique id for every merchant
my $availabilityId = availabilityId_example; # String | 

eval { 
    $api_instance->apiv2OutletsGetAllOutlesGet(appId => $appId, availabilityId => $availabilityId);
};
if ($@) {
    warn "Exception when calling OutletsApi->apiv2OutletsGetAllOutlesGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OutletsApi()
appId = appId_example # String | App ID - refers to the unique id for every merchant
availabilityId = availabilityId_example # String | 

try: 
    # Get Outlets
    api_instance.apiv2_outlets_get_all_outles_get(appId, availabilityId)
except ApiException as e:
    print("Exception when calling OutletsApi->apiv2OutletsGetAllOutlesGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID - refers to the unique id for every merchant
Required
availability_id*
String
Required

Responses

Status: 200 - OK


POSCRM

apiVendornamePosWebservicetaskbarcreditassignPost

Get Order Information

Get Order Information


/api/vendorname_pos/webservice?task=barcreditassign

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/vendorname_pos/webservice?task=barcreditassign"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSCRMApi;

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

public class POSCRMApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        POSCRMApi apiInstance = new POSCRMApi();
        Integer membershipId = 56; // Integer | 
        Integer mobile = 56; // Integer | 
        String authkey = authkey_example; // String | 
        String transactionStatus = transactionStatus_example; // String | 
        String posId = posId_example; // String | 
        String cashierId = cashierId_example; // String | 
        String branchId = branchId_example; // String | 
        String receiptNo = receiptNo_example; // String | 
        String orderNumber = orderNumber_example; // String | 
        String paymentAmount = paymentAmount_example; // String | 
        String lineItems = lineItems_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskbarcreditassignPost(membershipId, mobile, authkey, transactionStatus, posId, cashierId, branchId, receiptNo, orderNumber, paymentAmount, lineItems);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskbarcreditassignPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSCRMApi;

public class POSCRMApiExample {

    public static void main(String[] args) {
        POSCRMApi apiInstance = new POSCRMApi();
        Integer membershipId = 56; // Integer | 
        Integer mobile = 56; // Integer | 
        String authkey = authkey_example; // String | 
        String transactionStatus = transactionStatus_example; // String | 
        String posId = posId_example; // String | 
        String cashierId = cashierId_example; // String | 
        String branchId = branchId_example; // String | 
        String receiptNo = receiptNo_example; // String | 
        String orderNumber = orderNumber_example; // String | 
        String paymentAmount = paymentAmount_example; // String | 
        String lineItems = lineItems_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskbarcreditassignPost(membershipId, mobile, authkey, transactionStatus, posId, cashierId, branchId, receiptNo, orderNumber, paymentAmount, lineItems);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskbarcreditassignPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *membershipId = 56; //  (optional)
Integer *mobile = 56; //  (optional)
String *authkey = authkey_example; //  (optional)
String *transactionStatus = transactionStatus_example; //  (optional)
String *posId = posId_example; //  (optional)
String *cashierId = cashierId_example; //  (optional)
String *branchId = branchId_example; //  (optional)
String *receiptNo = receiptNo_example; //  (optional)
String *orderNumber = orderNumber_example; //  (optional)
String *paymentAmount = paymentAmount_example; //  (optional)
String *lineItems = lineItems_example; //  (optional)

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

// Get Order Information
[apiInstance apiVendornamePosWebservicetaskbarcreditassignPostWith:membershipId
    mobile:mobile
    authkey:authkey
    transactionStatus:transactionStatus
    posId:posId
    cashierId:cashierId
    branchId:branchId
    receiptNo:receiptNo
    orderNumber:orderNumber
    paymentAmount:paymentAmount
    lineItems:lineItems
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.POSCRMApi()
var opts = { 
  'membershipId': 56 // {{Integer}} 
  'mobile': 56 // {{Integer}} 
  'authkey': authkey_example // {{String}} 
  'transactionStatus': transactionStatus_example // {{String}} 
  'posId': posId_example // {{String}} 
  'cashierId': cashierId_example // {{String}} 
  'branchId': branchId_example // {{String}} 
  'receiptNo': receiptNo_example // {{String}} 
  'orderNumber': orderNumber_example // {{String}} 
  'paymentAmount': paymentAmount_example // {{String}} 
  'lineItems': lineItems_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVendornamePosWebservicetaskbarcreditassignPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new POSCRMApi();
            var membershipId = 56;  // Integer |  (optional) 
            var mobile = 56;  // Integer |  (optional) 
            var authkey = authkey_example;  // String |  (optional) 
            var transactionStatus = transactionStatus_example;  // String |  (optional) 
            var posId = posId_example;  // String |  (optional) 
            var cashierId = cashierId_example;  // String |  (optional) 
            var branchId = branchId_example;  // String |  (optional) 
            var receiptNo = receiptNo_example;  // String |  (optional) 
            var orderNumber = orderNumber_example;  // String |  (optional) 
            var paymentAmount = paymentAmount_example;  // String |  (optional) 
            var lineItems = lineItems_example;  // String |  (optional) 

            try
            {
                // Get Order Information
                apiInstance.apiVendornamePosWebservicetaskbarcreditassignPost(membershipId, mobile, authkey, transactionStatus, posId, cashierId, branchId, receiptNo, orderNumber, paymentAmount, lineItems);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSCRMApi.apiVendornamePosWebservicetaskbarcreditassignPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPOSCRMApi();
$membershipId = 56; // Integer | 
$mobile = 56; // Integer | 
$authkey = authkey_example; // String | 
$transactionStatus = transactionStatus_example; // String | 
$posId = posId_example; // String | 
$cashierId = cashierId_example; // String | 
$branchId = branchId_example; // String | 
$receiptNo = receiptNo_example; // String | 
$orderNumber = orderNumber_example; // String | 
$paymentAmount = paymentAmount_example; // String | 
$lineItems = lineItems_example; // String | 

try {
    $api_instance->apiVendornamePosWebservicetaskbarcreditassignPost($membershipId, $mobile, $authkey, $transactionStatus, $posId, $cashierId, $branchId, $receiptNo, $orderNumber, $paymentAmount, $lineItems);
} catch (Exception $e) {
    echo 'Exception when calling POSCRMApi->apiVendornamePosWebservicetaskbarcreditassignPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSCRMApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::POSCRMApi->new();
my $membershipId = 56; # Integer | 
my $mobile = 56; # Integer | 
my $authkey = authkey_example; # String | 
my $transactionStatus = transactionStatus_example; # String | 
my $posId = posId_example; # String | 
my $cashierId = cashierId_example; # String | 
my $branchId = branchId_example; # String | 
my $receiptNo = receiptNo_example; # String | 
my $orderNumber = orderNumber_example; # String | 
my $paymentAmount = paymentAmount_example; # String | 
my $lineItems = lineItems_example; # String | 

eval { 
    $api_instance->apiVendornamePosWebservicetaskbarcreditassignPost(membershipId => $membershipId, mobile => $mobile, authkey => $authkey, transactionStatus => $transactionStatus, posId => $posId, cashierId => $cashierId, branchId => $branchId, receiptNo => $receiptNo, orderNumber => $orderNumber, paymentAmount => $paymentAmount, lineItems => $lineItems);
};
if ($@) {
    warn "Exception when calling POSCRMApi->apiVendornamePosWebservicetaskbarcreditassignPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.POSCRMApi()
membershipId = 56 # Integer |  (optional)
mobile = 56 # Integer |  (optional)
authkey = authkey_example # String |  (optional)
transactionStatus = transactionStatus_example # String |  (optional)
posId = posId_example # String |  (optional)
cashierId = cashierId_example # String |  (optional)
branchId = branchId_example # String |  (optional)
receiptNo = receiptNo_example # String |  (optional)
orderNumber = orderNumber_example # String |  (optional)
paymentAmount = paymentAmount_example # String |  (optional)
lineItems = lineItems_example # String |  (optional)

try: 
    # Get Order Information
    api_instance.api_vendorname_pos_webservicetaskbarcreditassign_post(membershipId=membershipId, mobile=mobile, authkey=authkey, transactionStatus=transactionStatus, posId=posId, cashierId=cashierId, branchId=branchId, receiptNo=receiptNo, orderNumber=orderNumber, paymentAmount=paymentAmount, lineItems=lineItems)
except ApiException as e:
    print("Exception when calling POSCRMApi->apiVendornamePosWebservicetaskbarcreditassignPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
membership_id
Integer
mobile
Integer
authkey
String
transaction_status
String
pos_id
String
cashier_id
String
branch_id
String
receipt_no
String
order_number
String
payment_amount
String
line_items
String

Responses

Status: 201 - Created


apiVendornamePosWebservicetaskconvertBCToDollarPost

Convert points to amount

Convert points to amount


/api/vendorname_pos/webservice?task=convert_BC_To_Dollar

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/vendorname_pos/webservice?task=convert_BC_To_Dollar"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSCRMApi;

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

public class POSCRMApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        POSCRMApi apiInstance = new POSCRMApi();
        String authkey = authkey_example; // String | 
        Float bcPoints = 3.4; // Float | 
        try {
            apiInstance.apiVendornamePosWebservicetaskconvertBCToDollarPost(authkey, bcPoints);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskconvertBCToDollarPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSCRMApi;

public class POSCRMApiExample {

    public static void main(String[] args) {
        POSCRMApi apiInstance = new POSCRMApi();
        String authkey = authkey_example; // String | 
        Float bcPoints = 3.4; // Float | 
        try {
            apiInstance.apiVendornamePosWebservicetaskconvertBCToDollarPost(authkey, bcPoints);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskconvertBCToDollarPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authkey = authkey_example; //  (optional)
Float *bcPoints = 3.4; //  (optional)

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

// Convert points to amount
[apiInstance apiVendornamePosWebservicetaskconvertBCToDollarPostWith:authkey
    bcPoints:bcPoints
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.POSCRMApi()
var opts = { 
  'authkey': authkey_example // {{String}} 
  'bcPoints': 3.4 // {{Float}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVendornamePosWebservicetaskconvertBCToDollarPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new POSCRMApi();
            var authkey = authkey_example;  // String |  (optional) 
            var bcPoints = 3.4;  // Float |  (optional) 

            try
            {
                // Convert points to amount
                apiInstance.apiVendornamePosWebservicetaskconvertBCToDollarPost(authkey, bcPoints);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSCRMApi.apiVendornamePosWebservicetaskconvertBCToDollarPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPOSCRMApi();
$authkey = authkey_example; // String | 
$bcPoints = 3.4; // Float | 

try {
    $api_instance->apiVendornamePosWebservicetaskconvertBCToDollarPost($authkey, $bcPoints);
} catch (Exception $e) {
    echo 'Exception when calling POSCRMApi->apiVendornamePosWebservicetaskconvertBCToDollarPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSCRMApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::POSCRMApi->new();
my $authkey = authkey_example; # String | 
my $bcPoints = 3.4; # Float | 

eval { 
    $api_instance->apiVendornamePosWebservicetaskconvertBCToDollarPost(authkey => $authkey, bcPoints => $bcPoints);
};
if ($@) {
    warn "Exception when calling POSCRMApi->apiVendornamePosWebservicetaskconvertBCToDollarPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.POSCRMApi()
authkey = authkey_example # String |  (optional)
bcPoints = 3.4 # Float |  (optional)

try: 
    # Convert points to amount
    api_instance.api_vendorname_pos_webservicetaskconvert_bc_to_dollar_post(authkey=authkey, bcPoints=bcPoints)
except ApiException as e:
    print("Exception when calling POSCRMApi->apiVendornamePosWebservicetaskconvertBCToDollarPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
authkey
String
bc_points
Float (float)

Responses

Status: 201 - Created


apiVendornamePosWebservicetaskmemberinfoPost

Get member Information

Get member Information


/api/vendorname_pos/webservice?task=memberinfo

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/vendorname_pos/webservice?task=memberinfo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSCRMApi;

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

public class POSCRMApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        POSCRMApi apiInstance = new POSCRMApi();
        Integer membershipId = 56; // Integer | 
        Integer mobile = 56; // Integer | 
        String authkey = authkey_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskmemberinfoPost(membershipId, mobile, authkey);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskmemberinfoPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSCRMApi;

public class POSCRMApiExample {

    public static void main(String[] args) {
        POSCRMApi apiInstance = new POSCRMApi();
        Integer membershipId = 56; // Integer | 
        Integer mobile = 56; // Integer | 
        String authkey = authkey_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskmemberinfoPost(membershipId, mobile, authkey);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskmemberinfoPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *membershipId = 56; //  (optional)
Integer *mobile = 56; //  (optional)
String *authkey = authkey_example; //  (optional)

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

// Get member Information
[apiInstance apiVendornamePosWebservicetaskmemberinfoPostWith:membershipId
    mobile:mobile
    authkey:authkey
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.POSCRMApi()
var opts = { 
  'membershipId': 56 // {{Integer}} 
  'mobile': 56 // {{Integer}} 
  'authkey': authkey_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVendornamePosWebservicetaskmemberinfoPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new POSCRMApi();
            var membershipId = 56;  // Integer |  (optional) 
            var mobile = 56;  // Integer |  (optional) 
            var authkey = authkey_example;  // String |  (optional) 

            try
            {
                // Get member Information
                apiInstance.apiVendornamePosWebservicetaskmemberinfoPost(membershipId, mobile, authkey);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSCRMApi.apiVendornamePosWebservicetaskmemberinfoPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPOSCRMApi();
$membershipId = 56; // Integer | 
$mobile = 56; // Integer | 
$authkey = authkey_example; // String | 

try {
    $api_instance->apiVendornamePosWebservicetaskmemberinfoPost($membershipId, $mobile, $authkey);
} catch (Exception $e) {
    echo 'Exception when calling POSCRMApi->apiVendornamePosWebservicetaskmemberinfoPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSCRMApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::POSCRMApi->new();
my $membershipId = 56; # Integer | 
my $mobile = 56; # Integer | 
my $authkey = authkey_example; # String | 

eval { 
    $api_instance->apiVendornamePosWebservicetaskmemberinfoPost(membershipId => $membershipId, mobile => $mobile, authkey => $authkey);
};
if ($@) {
    warn "Exception when calling POSCRMApi->apiVendornamePosWebservicetaskmemberinfoPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.POSCRMApi()
membershipId = 56 # Integer |  (optional)
mobile = 56 # Integer |  (optional)
authkey = authkey_example # String |  (optional)

try: 
    # Get member Information
    api_instance.api_vendorname_pos_webservicetaskmemberinfo_post(membershipId=membershipId, mobile=mobile, authkey=authkey)
except ApiException as e:
    print("Exception when calling POSCRMApi->apiVendornamePosWebservicetaskmemberinfoPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
membership_id
Integer
mobile
Integer
authkey
String

Responses

Status: 201 - Created


apiVendornamePosWebservicetaskmemberregisterCheckPost

Check Membership

Check Membership


/api/vendorname_pos/webservice?task=memberregister_check

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/vendorname_pos/webservice?task=memberregister_check"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSCRMApi;

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

public class POSCRMApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        POSCRMApi apiInstance = new POSCRMApi();
        Integer membershipId = 56; // Integer | 
        Integer mobile = 56; // Integer | 
        String authkey = authkey_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskmemberregisterCheckPost(membershipId, mobile, authkey);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskmemberregisterCheckPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSCRMApi;

public class POSCRMApiExample {

    public static void main(String[] args) {
        POSCRMApi apiInstance = new POSCRMApi();
        Integer membershipId = 56; // Integer | 
        Integer mobile = 56; // Integer | 
        String authkey = authkey_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskmemberregisterCheckPost(membershipId, mobile, authkey);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskmemberregisterCheckPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *membershipId = 56; //  (optional)
Integer *mobile = 56; //  (optional)
String *authkey = authkey_example; //  (optional)

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

// Check Membership
[apiInstance apiVendornamePosWebservicetaskmemberregisterCheckPostWith:membershipId
    mobile:mobile
    authkey:authkey
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.POSCRMApi()
var opts = { 
  'membershipId': 56 // {{Integer}} 
  'mobile': 56 // {{Integer}} 
  'authkey': authkey_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVendornamePosWebservicetaskmemberregisterCheckPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new POSCRMApi();
            var membershipId = 56;  // Integer |  (optional) 
            var mobile = 56;  // Integer |  (optional) 
            var authkey = authkey_example;  // String |  (optional) 

            try
            {
                // Check Membership
                apiInstance.apiVendornamePosWebservicetaskmemberregisterCheckPost(membershipId, mobile, authkey);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSCRMApi.apiVendornamePosWebservicetaskmemberregisterCheckPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPOSCRMApi();
$membershipId = 56; // Integer | 
$mobile = 56; // Integer | 
$authkey = authkey_example; // String | 

try {
    $api_instance->apiVendornamePosWebservicetaskmemberregisterCheckPost($membershipId, $mobile, $authkey);
} catch (Exception $e) {
    echo 'Exception when calling POSCRMApi->apiVendornamePosWebservicetaskmemberregisterCheckPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSCRMApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::POSCRMApi->new();
my $membershipId = 56; # Integer | 
my $mobile = 56; # Integer | 
my $authkey = authkey_example; # String | 

eval { 
    $api_instance->apiVendornamePosWebservicetaskmemberregisterCheckPost(membershipId => $membershipId, mobile => $mobile, authkey => $authkey);
};
if ($@) {
    warn "Exception when calling POSCRMApi->apiVendornamePosWebservicetaskmemberregisterCheckPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.POSCRMApi()
membershipId = 56 # Integer |  (optional)
mobile = 56 # Integer |  (optional)
authkey = authkey_example # String |  (optional)

try: 
    # Check Membership
    api_instance.api_vendorname_pos_webservicetaskmemberregister_check_post(membershipId=membershipId, mobile=mobile, authkey=authkey)
except ApiException as e:
    print("Exception when calling POSCRMApi->apiVendornamePosWebservicetaskmemberregisterCheckPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
membership_id
Integer
mobile
Integer
authkey
String

Responses

Status: 201 - Created


apiVendornamePosWebservicetaskposRegisterPost

Registor POS

Registor POS


/api/vendorname_pos/webservice?task=pos_register

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/vendorname_pos/webservice?task=pos_register"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSCRMApi;

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

public class POSCRMApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        POSCRMApi apiInstance = new POSCRMApi();
        String locationId = locationId_example; // String | 
        String terminalId = terminalId_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskposRegisterPost(locationId, terminalId);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskposRegisterPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSCRMApi;

public class POSCRMApiExample {

    public static void main(String[] args) {
        POSCRMApi apiInstance = new POSCRMApi();
        String locationId = locationId_example; // String | 
        String terminalId = terminalId_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskposRegisterPost(locationId, terminalId);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskposRegisterPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *locationId = locationId_example; //  (optional)
String *terminalId = terminalId_example; //  (optional)

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

// Registor POS
[apiInstance apiVendornamePosWebservicetaskposRegisterPostWith:locationId
    terminalId:terminalId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.POSCRMApi()
var opts = { 
  'locationId': locationId_example // {{String}} 
  'terminalId': terminalId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVendornamePosWebservicetaskposRegisterPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new POSCRMApi();
            var locationId = locationId_example;  // String |  (optional) 
            var terminalId = terminalId_example;  // String |  (optional) 

            try
            {
                // Registor POS
                apiInstance.apiVendornamePosWebservicetaskposRegisterPost(locationId, terminalId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSCRMApi.apiVendornamePosWebservicetaskposRegisterPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPOSCRMApi();
$locationId = locationId_example; // String | 
$terminalId = terminalId_example; // String | 

try {
    $api_instance->apiVendornamePosWebservicetaskposRegisterPost($locationId, $terminalId);
} catch (Exception $e) {
    echo 'Exception when calling POSCRMApi->apiVendornamePosWebservicetaskposRegisterPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSCRMApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::POSCRMApi->new();
my $locationId = locationId_example; # String | 
my $terminalId = terminalId_example; # String | 

eval { 
    $api_instance->apiVendornamePosWebservicetaskposRegisterPost(locationId => $locationId, terminalId => $terminalId);
};
if ($@) {
    warn "Exception when calling POSCRMApi->apiVendornamePosWebservicetaskposRegisterPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.POSCRMApi()
locationId = locationId_example # String |  (optional)
terminalId = terminalId_example # String |  (optional)

try: 
    # Registor POS
    api_instance.api_vendorname_pos_webservicetaskpos_register_post(locationId=locationId, terminalId=terminalId)
except ApiException as e:
    print("Exception when calling POSCRMApi->apiVendornamePosWebservicetaskposRegisterPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
location_id
String
terminal_id
String

Responses

Status: 201 - Created


apiVendornamePosWebservicetaskredeembarcreditsPost

Redeem points

Redeem points


/api/vendorname_pos/webservice?task=redeembarcredits

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/vendorname_pos/webservice?task=redeembarcredits"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSCRMApi;

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

public class POSCRMApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        POSCRMApi apiInstance = new POSCRMApi();
        Integer membershipId = 56; // Integer | 
        Integer mobile = 56; // Integer | 
        String authkey = authkey_example; // String | 
        String transactionStatus = transactionStatus_example; // String | 
        String posId = posId_example; // String | 
        String cashierId = cashierId_example; // String | 
        String branchId = branchId_example; // String | 
        String receiptNo = receiptNo_example; // String | 
        String orderNumber = orderNumber_example; // String | 
        String paymentPoints = paymentPoints_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskredeembarcreditsPost(membershipId, mobile, authkey, transactionStatus, posId, cashierId, branchId, receiptNo, orderNumber, paymentPoints);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskredeembarcreditsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSCRMApi;

public class POSCRMApiExample {

    public static void main(String[] args) {
        POSCRMApi apiInstance = new POSCRMApi();
        Integer membershipId = 56; // Integer | 
        Integer mobile = 56; // Integer | 
        String authkey = authkey_example; // String | 
        String transactionStatus = transactionStatus_example; // String | 
        String posId = posId_example; // String | 
        String cashierId = cashierId_example; // String | 
        String branchId = branchId_example; // String | 
        String receiptNo = receiptNo_example; // String | 
        String orderNumber = orderNumber_example; // String | 
        String paymentPoints = paymentPoints_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskredeembarcreditsPost(membershipId, mobile, authkey, transactionStatus, posId, cashierId, branchId, receiptNo, orderNumber, paymentPoints);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskredeembarcreditsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *membershipId = 56; //  (optional)
Integer *mobile = 56; //  (optional)
String *authkey = authkey_example; //  (optional)
String *transactionStatus = transactionStatus_example; //  (optional)
String *posId = posId_example; //  (optional)
String *cashierId = cashierId_example; //  (optional)
String *branchId = branchId_example; //  (optional)
String *receiptNo = receiptNo_example; //  (optional)
String *orderNumber = orderNumber_example; //  (optional)
String *paymentPoints = paymentPoints_example; //  (optional)

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

// Redeem points
[apiInstance apiVendornamePosWebservicetaskredeembarcreditsPostWith:membershipId
    mobile:mobile
    authkey:authkey
    transactionStatus:transactionStatus
    posId:posId
    cashierId:cashierId
    branchId:branchId
    receiptNo:receiptNo
    orderNumber:orderNumber
    paymentPoints:paymentPoints
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.POSCRMApi()
var opts = { 
  'membershipId': 56 // {{Integer}} 
  'mobile': 56 // {{Integer}} 
  'authkey': authkey_example // {{String}} 
  'transactionStatus': transactionStatus_example // {{String}} 
  'posId': posId_example // {{String}} 
  'cashierId': cashierId_example // {{String}} 
  'branchId': branchId_example // {{String}} 
  'receiptNo': receiptNo_example // {{String}} 
  'orderNumber': orderNumber_example // {{String}} 
  'paymentPoints': paymentPoints_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVendornamePosWebservicetaskredeembarcreditsPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new POSCRMApi();
            var membershipId = 56;  // Integer |  (optional) 
            var mobile = 56;  // Integer |  (optional) 
            var authkey = authkey_example;  // String |  (optional) 
            var transactionStatus = transactionStatus_example;  // String |  (optional) 
            var posId = posId_example;  // String |  (optional) 
            var cashierId = cashierId_example;  // String |  (optional) 
            var branchId = branchId_example;  // String |  (optional) 
            var receiptNo = receiptNo_example;  // String |  (optional) 
            var orderNumber = orderNumber_example;  // String |  (optional) 
            var paymentPoints = paymentPoints_example;  // String |  (optional) 

            try
            {
                // Redeem points
                apiInstance.apiVendornamePosWebservicetaskredeembarcreditsPost(membershipId, mobile, authkey, transactionStatus, posId, cashierId, branchId, receiptNo, orderNumber, paymentPoints);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSCRMApi.apiVendornamePosWebservicetaskredeembarcreditsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPOSCRMApi();
$membershipId = 56; // Integer | 
$mobile = 56; // Integer | 
$authkey = authkey_example; // String | 
$transactionStatus = transactionStatus_example; // String | 
$posId = posId_example; // String | 
$cashierId = cashierId_example; // String | 
$branchId = branchId_example; // String | 
$receiptNo = receiptNo_example; // String | 
$orderNumber = orderNumber_example; // String | 
$paymentPoints = paymentPoints_example; // String | 

try {
    $api_instance->apiVendornamePosWebservicetaskredeembarcreditsPost($membershipId, $mobile, $authkey, $transactionStatus, $posId, $cashierId, $branchId, $receiptNo, $orderNumber, $paymentPoints);
} catch (Exception $e) {
    echo 'Exception when calling POSCRMApi->apiVendornamePosWebservicetaskredeembarcreditsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSCRMApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::POSCRMApi->new();
my $membershipId = 56; # Integer | 
my $mobile = 56; # Integer | 
my $authkey = authkey_example; # String | 
my $transactionStatus = transactionStatus_example; # String | 
my $posId = posId_example; # String | 
my $cashierId = cashierId_example; # String | 
my $branchId = branchId_example; # String | 
my $receiptNo = receiptNo_example; # String | 
my $orderNumber = orderNumber_example; # String | 
my $paymentPoints = paymentPoints_example; # String | 

eval { 
    $api_instance->apiVendornamePosWebservicetaskredeembarcreditsPost(membershipId => $membershipId, mobile => $mobile, authkey => $authkey, transactionStatus => $transactionStatus, posId => $posId, cashierId => $cashierId, branchId => $branchId, receiptNo => $receiptNo, orderNumber => $orderNumber, paymentPoints => $paymentPoints);
};
if ($@) {
    warn "Exception when calling POSCRMApi->apiVendornamePosWebservicetaskredeembarcreditsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.POSCRMApi()
membershipId = 56 # Integer |  (optional)
mobile = 56 # Integer |  (optional)
authkey = authkey_example # String |  (optional)
transactionStatus = transactionStatus_example # String |  (optional)
posId = posId_example # String |  (optional)
cashierId = cashierId_example # String |  (optional)
branchId = branchId_example # String |  (optional)
receiptNo = receiptNo_example # String |  (optional)
orderNumber = orderNumber_example # String |  (optional)
paymentPoints = paymentPoints_example # String |  (optional)

try: 
    # Redeem points
    api_instance.api_vendorname_pos_webservicetaskredeembarcredits_post(membershipId=membershipId, mobile=mobile, authkey=authkey, transactionStatus=transactionStatus, posId=posId, cashierId=cashierId, branchId=branchId, receiptNo=receiptNo, orderNumber=orderNumber, paymentPoints=paymentPoints)
except ApiException as e:
    print("Exception when calling POSCRMApi->apiVendornamePosWebservicetaskredeembarcreditsPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
membership_id
Integer
mobile
Integer
authkey
String
transaction_status
String
pos_id
String
cashier_id
String
branch_id
String
receipt_no
String
order_number
String
payment_points
String

Responses

Status: 201 - Created


apiVendornamePosWebservicetaskverifyVoucherPost

Verify voucher

Verify voucher


/api/vendorname_pos/webservice?task=verify_voucher

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/vendorname_pos/webservice?task=verify_voucher"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSCRMApi;

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

public class POSCRMApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        POSCRMApi apiInstance = new POSCRMApi();
        String authkey = authkey_example; // String | 
        String voucherNumber = voucherNumber_example; // String | 
        String branchId = branchId_example; // String | 
        Integer redeemed = 56; // Integer | 
        try {
            apiInstance.apiVendornamePosWebservicetaskverifyVoucherPost(authkey, voucherNumber, branchId, redeemed);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskverifyVoucherPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSCRMApi;

public class POSCRMApiExample {

    public static void main(String[] args) {
        POSCRMApi apiInstance = new POSCRMApi();
        String authkey = authkey_example; // String | 
        String voucherNumber = voucherNumber_example; // String | 
        String branchId = branchId_example; // String | 
        Integer redeemed = 56; // Integer | 
        try {
            apiInstance.apiVendornamePosWebservicetaskverifyVoucherPost(authkey, voucherNumber, branchId, redeemed);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskverifyVoucherPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authkey = authkey_example; //  (optional)
String *voucherNumber = voucherNumber_example; //  (optional)
String *branchId = branchId_example; //  (optional)
Integer *redeemed = 56; //  (optional)

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

// Verify voucher
[apiInstance apiVendornamePosWebservicetaskverifyVoucherPostWith:authkey
    voucherNumber:voucherNumber
    branchId:branchId
    redeemed:redeemed
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.POSCRMApi()
var opts = { 
  'authkey': authkey_example // {{String}} 
  'voucherNumber': voucherNumber_example // {{String}} 
  'branchId': branchId_example // {{String}} 
  'redeemed': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVendornamePosWebservicetaskverifyVoucherPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new POSCRMApi();
            var authkey = authkey_example;  // String |  (optional) 
            var voucherNumber = voucherNumber_example;  // String |  (optional) 
            var branchId = branchId_example;  // String |  (optional) 
            var redeemed = 56;  // Integer |  (optional) 

            try
            {
                // Verify voucher
                apiInstance.apiVendornamePosWebservicetaskverifyVoucherPost(authkey, voucherNumber, branchId, redeemed);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSCRMApi.apiVendornamePosWebservicetaskverifyVoucherPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPOSCRMApi();
$authkey = authkey_example; // String | 
$voucherNumber = voucherNumber_example; // String | 
$branchId = branchId_example; // String | 
$redeemed = 56; // Integer | 

try {
    $api_instance->apiVendornamePosWebservicetaskverifyVoucherPost($authkey, $voucherNumber, $branchId, $redeemed);
} catch (Exception $e) {
    echo 'Exception when calling POSCRMApi->apiVendornamePosWebservicetaskverifyVoucherPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSCRMApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::POSCRMApi->new();
my $authkey = authkey_example; # String | 
my $voucherNumber = voucherNumber_example; # String | 
my $branchId = branchId_example; # String | 
my $redeemed = 56; # Integer | 

eval { 
    $api_instance->apiVendornamePosWebservicetaskverifyVoucherPost(authkey => $authkey, voucherNumber => $voucherNumber, branchId => $branchId, redeemed => $redeemed);
};
if ($@) {
    warn "Exception when calling POSCRMApi->apiVendornamePosWebservicetaskverifyVoucherPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.POSCRMApi()
authkey = authkey_example # String |  (optional)
voucherNumber = voucherNumber_example # String |  (optional)
branchId = branchId_example # String |  (optional)
redeemed = 56 # Integer |  (optional)

try: 
    # Verify voucher
    api_instance.api_vendorname_pos_webservicetaskverify_voucher_post(authkey=authkey, voucherNumber=voucherNumber, branchId=branchId, redeemed=redeemed)
except ApiException as e:
    print("Exception when calling POSCRMApi->apiVendornamePosWebservicetaskverifyVoucherPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
authkey
String
voucher_number
String
branch_id
String
redeemed
Integer

Responses

Status: 201 - Created


apiVendornamePosWebservicetaskvoidPaymentPost

Refund

Refund


/api/vendorname_pos/webservice?task=void_payment

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/vendorname_pos/webservice?task=void_payment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSCRMApi;

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

public class POSCRMApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        POSCRMApi apiInstance = new POSCRMApi();
        String authkey = authkey_example; // String | 
        String posId = posId_example; // String | 
        String cashierId = cashierId_example; // String | 
        String orderNumber = orderNumber_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskvoidPaymentPost(authkey, posId, cashierId, orderNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskvoidPaymentPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSCRMApi;

public class POSCRMApiExample {

    public static void main(String[] args) {
        POSCRMApi apiInstance = new POSCRMApi();
        String authkey = authkey_example; // String | 
        String posId = posId_example; // String | 
        String cashierId = cashierId_example; // String | 
        String orderNumber = orderNumber_example; // String | 
        try {
            apiInstance.apiVendornamePosWebservicetaskvoidPaymentPost(authkey, posId, cashierId, orderNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSCRMApi#apiVendornamePosWebservicetaskvoidPaymentPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *authkey = authkey_example; //  (optional)
String *posId = posId_example; //  (optional)
String *cashierId = cashierId_example; //  (optional)
String *orderNumber = orderNumber_example; //  (optional)

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

// Refund
[apiInstance apiVendornamePosWebservicetaskvoidPaymentPostWith:authkey
    posId:posId
    cashierId:cashierId
    orderNumber:orderNumber
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.POSCRMApi()
var opts = { 
  'authkey': authkey_example // {{String}} 
  'posId': posId_example // {{String}} 
  'cashierId': cashierId_example // {{String}} 
  'orderNumber': orderNumber_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVendornamePosWebservicetaskvoidPaymentPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new POSCRMApi();
            var authkey = authkey_example;  // String |  (optional) 
            var posId = posId_example;  // String |  (optional) 
            var cashierId = cashierId_example;  // String |  (optional) 
            var orderNumber = orderNumber_example;  // String |  (optional) 

            try
            {
                // Refund
                apiInstance.apiVendornamePosWebservicetaskvoidPaymentPost(authkey, posId, cashierId, orderNumber);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSCRMApi.apiVendornamePosWebservicetaskvoidPaymentPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPOSCRMApi();
$authkey = authkey_example; // String | 
$posId = posId_example; // String | 
$cashierId = cashierId_example; // String | 
$orderNumber = orderNumber_example; // String | 

try {
    $api_instance->apiVendornamePosWebservicetaskvoidPaymentPost($authkey, $posId, $cashierId, $orderNumber);
} catch (Exception $e) {
    echo 'Exception when calling POSCRMApi->apiVendornamePosWebservicetaskvoidPaymentPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSCRMApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::POSCRMApi->new();
my $authkey = authkey_example; # String | 
my $posId = posId_example; # String | 
my $cashierId = cashierId_example; # String | 
my $orderNumber = orderNumber_example; # String | 

eval { 
    $api_instance->apiVendornamePosWebservicetaskvoidPaymentPost(authkey => $authkey, posId => $posId, cashierId => $cashierId, orderNumber => $orderNumber);
};
if ($@) {
    warn "Exception when calling POSCRMApi->apiVendornamePosWebservicetaskvoidPaymentPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.POSCRMApi()
authkey = authkey_example # String |  (optional)
posId = posId_example # String |  (optional)
cashierId = cashierId_example # String |  (optional)
orderNumber = orderNumber_example # String |  (optional)

try: 
    # Refund
    api_instance.api_vendorname_pos_webservicetaskvoid_payment_post(authkey=authkey, posId=posId, cashierId=cashierId, orderNumber=orderNumber)
except ApiException as e:
    print("Exception when calling POSCRMApi->apiVendornamePosWebservicetaskvoidPaymentPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
authkey
String
pos_id
String
cashier_id
String
order_number
String

Responses

Status: 201 - Created


PaymentGateway

apiPaymentv1GetPaymentReferenceIdGet

Get Orders History

This is an operation get orders report


/api/paymentv1/getPaymentReferenceId

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/paymentv1/getPaymentReferenceId?app_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentGatewayApi;

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

public class PaymentGatewayApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentGatewayApi apiInstance = new PaymentGatewayApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        try {
            apiInstance.apiPaymentv1GetPaymentReferenceIdGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentGatewayApi#apiPaymentv1GetPaymentReferenceIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentGatewayApi;

public class PaymentGatewayApiExample {

    public static void main(String[] args) {
        PaymentGatewayApi apiInstance = new PaymentGatewayApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        try {
            apiInstance.apiPaymentv1GetPaymentReferenceIdGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentGatewayApi#apiPaymentv1GetPaymentReferenceIdGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users

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

// Get Orders History
[apiInstance apiPaymentv1GetPaymentReferenceIdGetWith:appId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.PaymentGatewayApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiPaymentv1GetPaymentReferenceIdGet(appId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentGatewayApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users

            try
            {
                // Get Orders History
                apiInstance.apiPaymentv1GetPaymentReferenceIdGet(appId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentGatewayApi.apiPaymentv1GetPaymentReferenceIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentGatewayApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users

try {
    $api_instance->apiPaymentv1GetPaymentReferenceIdGet($appId);
} catch (Exception $e) {
    echo 'Exception when calling PaymentGatewayApi->apiPaymentv1GetPaymentReferenceIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentGatewayApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentGatewayApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users

eval { 
    $api_instance->apiPaymentv1GetPaymentReferenceIdGet(appId => $appId);
};
if ($@) {
    warn "Exception when calling PaymentGatewayApi->apiPaymentv1GetPaymentReferenceIdGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentGatewayApi()
appId = appId_example # String | App ID Which it refers unique id for every users

try: 
    # Get Orders History
    api_instance.api_paymentv1_get_payment_reference_id_get(appId)
except ApiException as e:
    print("Exception when calling PaymentGatewayApi->apiPaymentv1GetPaymentReferenceIdGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required

Responses

Status: 200 - OK


PaymentGatewayOmise

apiPaymentv1AuthOmisePost

Omise Auth

This request allows you to see the permissions that are granted to this account.


/api/paymentv1/authOmise

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/paymentv1/authOmise"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentGatewayOmiseApi;

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

public class PaymentGatewayOmiseApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentGatewayOmiseApi apiInstance = new PaymentGatewayOmiseApi();
        String appId = appId_example; // String | 
        String token = token_example; // String | 
        String customerId = customerId_example; // String | 
        String outletId = outletId_example; // String | 
        String paidAmount = paidAmount_example; // String | 
        String requestType = requestType_example; // String | 
        String outletName = outletName_example; // String | 
        try {
            apiInstance.apiPaymentv1AuthOmisePost(appId, token, customerId, outletId, paidAmount, requestType, outletName);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentGatewayOmiseApi#apiPaymentv1AuthOmisePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentGatewayOmiseApi;

public class PaymentGatewayOmiseApiExample {

    public static void main(String[] args) {
        PaymentGatewayOmiseApi apiInstance = new PaymentGatewayOmiseApi();
        String appId = appId_example; // String | 
        String token = token_example; // String | 
        String customerId = customerId_example; // String | 
        String outletId = outletId_example; // String | 
        String paidAmount = paidAmount_example; // String | 
        String requestType = requestType_example; // String | 
        String outletName = outletName_example; // String | 
        try {
            apiInstance.apiPaymentv1AuthOmisePost(appId, token, customerId, outletId, paidAmount, requestType, outletName);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentGatewayOmiseApi#apiPaymentv1AuthOmisePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *token = token_example; //  (optional)
String *customerId = customerId_example; //  (optional)
String *outletId = outletId_example; //  (optional)
String *paidAmount = paidAmount_example; //  (optional)
String *requestType = requestType_example; //  (optional)
String *outletName = outletName_example; //  (optional)

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

// Omise Auth
[apiInstance apiPaymentv1AuthOmisePostWith:appId
    token:token
    customerId:customerId
    outletId:outletId
    paidAmount:paidAmount
    requestType:requestType
    outletName:outletName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.PaymentGatewayOmiseApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'token': token_example // {{String}} 
  'customerId': customerId_example // {{String}} 
  'outletId': outletId_example // {{String}} 
  'paidAmount': paidAmount_example // {{String}} 
  'requestType': requestType_example // {{String}} 
  'outletName': outletName_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiPaymentv1AuthOmisePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentGatewayOmiseApi();
            var appId = appId_example;  // String |  (optional) 
            var token = token_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 
            var outletId = outletId_example;  // String |  (optional) 
            var paidAmount = paidAmount_example;  // String |  (optional) 
            var requestType = requestType_example;  // String |  (optional) 
            var outletName = outletName_example;  // String |  (optional) 

            try
            {
                // Omise Auth
                apiInstance.apiPaymentv1AuthOmisePost(appId, token, customerId, outletId, paidAmount, requestType, outletName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentGatewayOmiseApi.apiPaymentv1AuthOmisePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentGatewayOmiseApi();
$appId = appId_example; // String | 
$token = token_example; // String | 
$customerId = customerId_example; // String | 
$outletId = outletId_example; // String | 
$paidAmount = paidAmount_example; // String | 
$requestType = requestType_example; // String | 
$outletName = outletName_example; // String | 

try {
    $api_instance->apiPaymentv1AuthOmisePost($appId, $token, $customerId, $outletId, $paidAmount, $requestType, $outletName);
} catch (Exception $e) {
    echo 'Exception when calling PaymentGatewayOmiseApi->apiPaymentv1AuthOmisePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentGatewayOmiseApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentGatewayOmiseApi->new();
my $appId = appId_example; # String | 
my $token = token_example; # String | 
my $customerId = customerId_example; # String | 
my $outletId = outletId_example; # String | 
my $paidAmount = paidAmount_example; # String | 
my $requestType = requestType_example; # String | 
my $outletName = outletName_example; # String | 

eval { 
    $api_instance->apiPaymentv1AuthOmisePost(appId => $appId, token => $token, customerId => $customerId, outletId => $outletId, paidAmount => $paidAmount, requestType => $requestType, outletName => $outletName);
};
if ($@) {
    warn "Exception when calling PaymentGatewayOmiseApi->apiPaymentv1AuthOmisePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentGatewayOmiseApi()
appId = appId_example # String |  (optional)
token = token_example # String |  (optional)
customerId = customerId_example # String |  (optional)
outletId = outletId_example # String |  (optional)
paidAmount = paidAmount_example # String |  (optional)
requestType = requestType_example # String |  (optional)
outletName = outletName_example # String |  (optional)

try: 
    # Omise Auth
    api_instance.api_paymentv1_auth_omise_post(appId=appId, token=token, customerId=customerId, outletId=outletId, paidAmount=paidAmount, requestType=requestType, outletName=outletName)
except ApiException as e:
    print("Exception when calling PaymentGatewayOmiseApi->apiPaymentv1AuthOmisePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
token
String
customer_id
String
outlet_id
String
paid_amount
String
request_type
String
outlet_name
String

Responses

Status: 200 - OK


apiPaymentv1CaptureAmountOmisePost

Omise Capture

This request allows you to see the permissions that are granted to this account.


/api/paymentv1/captureAmountOmise

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/paymentv1/captureAmountOmise"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentGatewayOmiseApi;

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

public class PaymentGatewayOmiseApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentGatewayOmiseApi apiInstance = new PaymentGatewayOmiseApi();
        String paymentReference = paymentReference_example; // String | 
        String customerId = customerId_example; // String | 
        String appId = appId_example; // String | 
        String token = token_example; // String | 
        String logId = logId_example; // String | 
        String outletId = outletId_example; // String | 
        String orderId = orderId_example; // String | 
        try {
            apiInstance.apiPaymentv1CaptureAmountOmisePost(paymentReference, customerId, appId, token, logId, outletId, orderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentGatewayOmiseApi#apiPaymentv1CaptureAmountOmisePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentGatewayOmiseApi;

public class PaymentGatewayOmiseApiExample {

    public static void main(String[] args) {
        PaymentGatewayOmiseApi apiInstance = new PaymentGatewayOmiseApi();
        String paymentReference = paymentReference_example; // String | 
        String customerId = customerId_example; // String | 
        String appId = appId_example; // String | 
        String token = token_example; // String | 
        String logId = logId_example; // String | 
        String outletId = outletId_example; // String | 
        String orderId = orderId_example; // String | 
        try {
            apiInstance.apiPaymentv1CaptureAmountOmisePost(paymentReference, customerId, appId, token, logId, outletId, orderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentGatewayOmiseApi#apiPaymentv1CaptureAmountOmisePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *paymentReference = paymentReference_example; //  (optional)
String *customerId = customerId_example; //  (optional)
String *appId = appId_example; //  (optional)
String *token = token_example; //  (optional)
String *logId = logId_example; //  (optional)
String *outletId = outletId_example; //  (optional)
String *orderId = orderId_example; //  (optional)

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

// Omise Capture
[apiInstance apiPaymentv1CaptureAmountOmisePostWith:paymentReference
    customerId:customerId
    appId:appId
    token:token
    logId:logId
    outletId:outletId
    orderId:orderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.PaymentGatewayOmiseApi()
var opts = { 
  'paymentReference': paymentReference_example // {{String}} 
  'customerId': customerId_example // {{String}} 
  'appId': appId_example // {{String}} 
  'token': token_example // {{String}} 
  'logId': logId_example // {{String}} 
  'outletId': outletId_example // {{String}} 
  'orderId': orderId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiPaymentv1CaptureAmountOmisePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentGatewayOmiseApi();
            var paymentReference = paymentReference_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 
            var appId = appId_example;  // String |  (optional) 
            var token = token_example;  // String |  (optional) 
            var logId = logId_example;  // String |  (optional) 
            var outletId = outletId_example;  // String |  (optional) 
            var orderId = orderId_example;  // String |  (optional) 

            try
            {
                // Omise Capture
                apiInstance.apiPaymentv1CaptureAmountOmisePost(paymentReference, customerId, appId, token, logId, outletId, orderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentGatewayOmiseApi.apiPaymentv1CaptureAmountOmisePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentGatewayOmiseApi();
$paymentReference = paymentReference_example; // String | 
$customerId = customerId_example; // String | 
$appId = appId_example; // String | 
$token = token_example; // String | 
$logId = logId_example; // String | 
$outletId = outletId_example; // String | 
$orderId = orderId_example; // String | 

try {
    $api_instance->apiPaymentv1CaptureAmountOmisePost($paymentReference, $customerId, $appId, $token, $logId, $outletId, $orderId);
} catch (Exception $e) {
    echo 'Exception when calling PaymentGatewayOmiseApi->apiPaymentv1CaptureAmountOmisePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentGatewayOmiseApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentGatewayOmiseApi->new();
my $paymentReference = paymentReference_example; # String | 
my $customerId = customerId_example; # String | 
my $appId = appId_example; # String | 
my $token = token_example; # String | 
my $logId = logId_example; # String | 
my $outletId = outletId_example; # String | 
my $orderId = orderId_example; # String | 

eval { 
    $api_instance->apiPaymentv1CaptureAmountOmisePost(paymentReference => $paymentReference, customerId => $customerId, appId => $appId, token => $token, logId => $logId, outletId => $outletId, orderId => $orderId);
};
if ($@) {
    warn "Exception when calling PaymentGatewayOmiseApi->apiPaymentv1CaptureAmountOmisePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentGatewayOmiseApi()
paymentReference = paymentReference_example # String |  (optional)
customerId = customerId_example # String |  (optional)
appId = appId_example # String |  (optional)
token = token_example # String |  (optional)
logId = logId_example # String |  (optional)
outletId = outletId_example # String |  (optional)
orderId = orderId_example # String |  (optional)

try: 
    # Omise Capture
    api_instance.api_paymentv1_capture_amount_omise_post(paymentReference=paymentReference, customerId=customerId, appId=appId, token=token, logId=logId, outletId=outletId, orderId=orderId)
except ApiException as e:
    print("Exception when calling PaymentGatewayOmiseApi->apiPaymentv1CaptureAmountOmisePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
payment_reference
String
customer_id
String
app_id
String
token
String
log_id
String
outlet_id
String
order_id
String

Responses

Status: 200 - OK


Products

apiProductsFavouriteProductsAddPost

Add Favourite Product

This request allows you to see the permissions that are Add Favourite Product .


/api/products/favourite_products_add

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/products/favourite_products_add"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

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

public class ProductsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | 
        Integer productId = 56; // Integer | 
        String favFlag = favFlag_example; // String | 
        Integer customerId = 56; // Integer | 
        try {
            apiInstance.apiProductsFavouriteProductsAddPost(appId, productId, favFlag, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiProductsFavouriteProductsAddPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | 
        Integer productId = 56; // Integer | 
        String favFlag = favFlag_example; // String | 
        Integer customerId = 56; // Integer | 
        try {
            apiInstance.apiProductsFavouriteProductsAddPost(appId, productId, favFlag, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiProductsFavouriteProductsAddPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
Integer *productId = 56; //  (optional)
String *favFlag = favFlag_example; //  (optional)
Integer *customerId = 56; //  (optional)

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

// Add Favourite Product
[apiInstance apiProductsFavouriteProductsAddPostWith:appId
    productId:productId
    favFlag:favFlag
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.ProductsApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'productId': 56 // {{Integer}} 
  'favFlag': favFlag_example // {{String}} 
  'customerId': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiProductsFavouriteProductsAddPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var appId = appId_example;  // String |  (optional) 
            var productId = 56;  // Integer |  (optional) 
            var favFlag = favFlag_example;  // String |  (optional) 
            var customerId = 56;  // Integer |  (optional) 

            try
            {
                // Add Favourite Product
                apiInstance.apiProductsFavouriteProductsAddPost(appId, productId, favFlag, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.apiProductsFavouriteProductsAddPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$appId = appId_example; // String | 
$productId = 56; // Integer | 
$favFlag = favFlag_example; // String | 
$customerId = 56; // Integer | 

try {
    $api_instance->apiProductsFavouriteProductsAddPost($appId, $productId, $favFlag, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->apiProductsFavouriteProductsAddPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $appId = appId_example; # String | 
my $productId = 56; # Integer | 
my $favFlag = favFlag_example; # String | 
my $customerId = 56; # Integer | 

eval { 
    $api_instance->apiProductsFavouriteProductsAddPost(appId => $appId, productId => $productId, favFlag => $favFlag, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling ProductsApi->apiProductsFavouriteProductsAddPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
appId = appId_example # String |  (optional)
productId = 56 # Integer |  (optional)
favFlag = favFlag_example # String |  (optional)
customerId = 56 # Integer |  (optional)

try: 
    # Add Favourite Product
    api_instance.api_products_favourite_products_add_post(appId=appId, productId=productId, favFlag=favFlag, customerId=customerId)
except ApiException as e:
    print("Exception when calling ProductsApi->apiProductsFavouriteProductsAddPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
product_id
Integer
fav_flag
String
customer_id
Integer

Responses

Status: 200 - OK


apiProductsFavouriteProductsListGet

Favourite Product List

This is an operation get Highlight Product List.


/api/products/favourite_products_list

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/products/favourite_products_list?app_id=&customer_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

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

public class ProductsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String customerId = customerId_example; // String | Customer ID
        try {
            apiInstance.apiProductsFavouriteProductsListGet(appId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiProductsFavouriteProductsListGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String customerId = customerId_example; // String | Customer ID
        try {
            apiInstance.apiProductsFavouriteProductsListGet(appId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiProductsFavouriteProductsListGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *customerId = customerId_example; // Customer ID

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

// Favourite Product List
[apiInstance apiProductsFavouriteProductsListGetWith:appId
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.ProductsApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var customerId = customerId_example; // {{String}} Customer ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiProductsFavouriteProductsListGet(appId, customerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var customerId = customerId_example;  // String | Customer ID

            try
            {
                // Favourite Product List
                apiInstance.apiProductsFavouriteProductsListGet(appId, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.apiProductsFavouriteProductsListGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$customerId = customerId_example; // String | Customer ID

try {
    $api_instance->apiProductsFavouriteProductsListGet($appId, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->apiProductsFavouriteProductsListGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $customerId = customerId_example; # String | Customer ID

eval { 
    $api_instance->apiProductsFavouriteProductsListGet(appId => $appId, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling ProductsApi->apiProductsFavouriteProductsListGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
appId = appId_example # String | App ID Which it refers unique id for every users
customerId = customerId_example # String | Customer ID

try: 
    # Favourite Product List
    api_instance.api_products_favourite_products_list_get(appId, customerId)
except ApiException as e:
    print("Exception when calling ProductsApi->apiProductsFavouriteProductsListGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
customer_id*
String
Customer ID
Required

Responses

Status: 200 - OK


apiProductsHighlightProductsListGet

Highlight Product List

This is an operation get Highlight Product List.


/api/products/highlight_products_list

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/products/highlight_products_list?app_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

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

public class ProductsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        try {
            apiInstance.apiProductsHighlightProductsListGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiProductsHighlightProductsListGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        try {
            apiInstance.apiProductsHighlightProductsListGet(appId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiProductsHighlightProductsListGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users

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

// Highlight Product List
[apiInstance apiProductsHighlightProductsListGetWith:appId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.ProductsApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiProductsHighlightProductsListGet(appId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users

            try
            {
                // Highlight Product List
                apiInstance.apiProductsHighlightProductsListGet(appId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.apiProductsHighlightProductsListGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users

try {
    $api_instance->apiProductsHighlightProductsListGet($appId);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->apiProductsHighlightProductsListGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users

eval { 
    $api_instance->apiProductsHighlightProductsListGet(appId => $appId);
};
if ($@) {
    warn "Exception when calling ProductsApi->apiProductsHighlightProductsListGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
appId = appId_example # String | App ID Which it refers unique id for every users

try: 
    # Highlight Product List
    api_instance.api_products_highlight_products_list_get(appId)
except ApiException as e:
    print("Exception when calling ProductsApi->apiProductsHighlightProductsListGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required

Responses

Status: 200 - OK


apiProductsNewProductsListGet

New Product List

This is an operation get New Product List.


/api/products/new_products_list

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/products/new_products_list?app_id=&availability="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

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

public class ProductsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availability = availability_example; // String | 
        try {
            apiInstance.apiProductsNewProductsListGet(appId, availability);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiProductsNewProductsListGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availability = availability_example; // String | 
        try {
            apiInstance.apiProductsNewProductsListGet(appId, availability);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiProductsNewProductsListGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *availability = availability_example; //  (optional)

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

// New Product List
[apiInstance apiProductsNewProductsListGetWith:appId
    availability:availability
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.ProductsApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var opts = { 
  'availability': availability_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiProductsNewProductsListGet(appId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var availability = availability_example;  // String |  (optional) 

            try
            {
                // New Product List
                apiInstance.apiProductsNewProductsListGet(appId, availability);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.apiProductsNewProductsListGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$availability = availability_example; // String | 

try {
    $api_instance->apiProductsNewProductsListGet($appId, $availability);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->apiProductsNewProductsListGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $availability = availability_example; # String | 

eval { 
    $api_instance->apiProductsNewProductsListGet(appId => $appId, availability => $availability);
};
if ($@) {
    warn "Exception when calling ProductsApi->apiProductsNewProductsListGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
appId = appId_example # String | App ID Which it refers unique id for every users
availability = availability_example # String |  (optional)

try: 
    # New Product List
    api_instance.api_products_new_products_list_get(appId, availability=availability)
except ApiException as e:
    print("Exception when calling ProductsApi->apiProductsNewProductsListGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
availability
String

Responses

Status: 200 - OK


apiProductsProductsListGet

Get Product Details

This is an operation get product details.


/api/products/products_list

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/products/products_list?app_id=&availability=&product_slug="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

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

public class ProductsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availability = availability_example; // String | 
        String productSlug = productSlug_example; // String | 
        try {
            apiInstance.apiProductsProductsListGet(appId, availability, productSlug);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiProductsProductsListGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availability = availability_example; // String | 
        String productSlug = productSlug_example; // String | 
        try {
            apiInstance.apiProductsProductsListGet(appId, availability, productSlug);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiProductsProductsListGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *availability = availability_example; // 
String *productSlug = productSlug_example; // 

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

// Get Product Details
[apiInstance apiProductsProductsListGetWith:appId
    availability:availability
    productSlug:productSlug
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.ProductsApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var availability = availability_example; // {{String}} 
var productSlug = productSlug_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiProductsProductsListGet(appId, availability, productSlug, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var availability = availability_example;  // String | 
            var productSlug = productSlug_example;  // String | 

            try
            {
                // Get Product Details
                apiInstance.apiProductsProductsListGet(appId, availability, productSlug);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.apiProductsProductsListGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$availability = availability_example; // String | 
$productSlug = productSlug_example; // String | 

try {
    $api_instance->apiProductsProductsListGet($appId, $availability, $productSlug);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->apiProductsProductsListGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $availability = availability_example; # String | 
my $productSlug = productSlug_example; # String | 

eval { 
    $api_instance->apiProductsProductsListGet(appId => $appId, availability => $availability, productSlug => $productSlug);
};
if ($@) {
    warn "Exception when calling ProductsApi->apiProductsProductsListGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
appId = appId_example # String | App ID Which it refers unique id for every users
availability = availability_example # String | 
productSlug = productSlug_example # String | 

try: 
    # Get Product Details
    api_instance.api_products_products_list_get(appId, availability, productSlug)
except ApiException as e:
    print("Exception when calling ProductsApi->apiProductsProductsListGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
availability*
String
Required
product_slug*
String
Required

Responses

Status: 200 - OK


apiv2ProductsGetAllProductsGet

Get All Products

This is an operation get all products.


/apiv2/products/getAllProducts

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/apiv2/products/getAllProducts?app_id=&availability=&category_slug=&subcate_slug=&outletId=&fav_cust_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

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

public class ProductsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availability = availability_example; // String | 
        String categorySlug = categorySlug_example; // String | 
        String outletId = outletId_example; // String | 
        String subcateSlug = subcateSlug_example; // String | 
        String favCustId = favCustId_example; // String | Customer ID
        try {
            apiInstance.apiv2ProductsGetAllProductsGet(appId, availability, categorySlug, outletId, subcateSlug, favCustId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiv2ProductsGetAllProductsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availability = availability_example; // String | 
        String categorySlug = categorySlug_example; // String | 
        String outletId = outletId_example; // String | 
        String subcateSlug = subcateSlug_example; // String | 
        String favCustId = favCustId_example; // String | Customer ID
        try {
            apiInstance.apiv2ProductsGetAllProductsGet(appId, availability, categorySlug, outletId, subcateSlug, favCustId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiv2ProductsGetAllProductsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *availability = availability_example; // 
String *categorySlug = categorySlug_example; // 
String *outletId = outletId_example; // 
String *subcateSlug = subcateSlug_example; //  (optional)
String *favCustId = favCustId_example; // Customer ID (optional)

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

// Get All Products
[apiInstance apiv2ProductsGetAllProductsGetWith:appId
    availability:availability
    categorySlug:categorySlug
    outletId:outletId
    subcateSlug:subcateSlug
    favCustId:favCustId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.ProductsApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var availability = availability_example; // {{String}} 
var categorySlug = categorySlug_example; // {{String}} 
var outletId = outletId_example; // {{String}} 
var opts = { 
  'subcateSlug': subcateSlug_example, // {{String}} 
  'favCustId': favCustId_example // {{String}} Customer ID
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiv2ProductsGetAllProductsGet(appId, availability, categorySlug, outletId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var availability = availability_example;  // String | 
            var categorySlug = categorySlug_example;  // String | 
            var outletId = outletId_example;  // String | 
            var subcateSlug = subcateSlug_example;  // String |  (optional) 
            var favCustId = favCustId_example;  // String | Customer ID (optional) 

            try
            {
                // Get All Products
                apiInstance.apiv2ProductsGetAllProductsGet(appId, availability, categorySlug, outletId, subcateSlug, favCustId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.apiv2ProductsGetAllProductsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$availability = availability_example; // String | 
$categorySlug = categorySlug_example; // String | 
$outletId = outletId_example; // String | 
$subcateSlug = subcateSlug_example; // String | 
$favCustId = favCustId_example; // String | Customer ID

try {
    $api_instance->apiv2ProductsGetAllProductsGet($appId, $availability, $categorySlug, $outletId, $subcateSlug, $favCustId);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->apiv2ProductsGetAllProductsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $availability = availability_example; # String | 
my $categorySlug = categorySlug_example; # String | 
my $outletId = outletId_example; # String | 
my $subcateSlug = subcateSlug_example; # String | 
my $favCustId = favCustId_example; # String | Customer ID

eval { 
    $api_instance->apiv2ProductsGetAllProductsGet(appId => $appId, availability => $availability, categorySlug => $categorySlug, outletId => $outletId, subcateSlug => $subcateSlug, favCustId => $favCustId);
};
if ($@) {
    warn "Exception when calling ProductsApi->apiv2ProductsGetAllProductsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
appId = appId_example # String | App ID Which it refers unique id for every users
availability = availability_example # String | 
categorySlug = categorySlug_example # String | 
outletId = outletId_example # String | 
subcateSlug = subcateSlug_example # String |  (optional)
favCustId = favCustId_example # String | Customer ID (optional)

try: 
    # Get All Products
    api_instance.apiv2_products_get_all_products_get(appId, availability, categorySlug, outletId, subcateSlug=subcateSlug, favCustId=favCustId)
except ApiException as e:
    print("Exception when calling ProductsApi->apiv2ProductsGetAllProductsGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
availability*
String
Required
category_slug*
String
Required
subcate_slug
String
outletId*
String
Required
fav_cust_id
String
Customer ID

Responses

Status: 200 - OK


apiv2ProductsGetMenuNavigationGet

Get Menu Navigation List

This is an operation get Menu Navigation.


/apiv2/products/getMenuNavigation

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/apiv2/products/getMenuNavigation?app_id=&availability=&outletId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

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

public class ProductsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availability = availability_example; // String | 
        String outletId = outletId_example; // String | 
        try {
            apiInstance.apiv2ProductsGetMenuNavigationGet(appId, availability, outletId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiv2ProductsGetMenuNavigationGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availability = availability_example; // String | 
        String outletId = outletId_example; // String | 
        try {
            apiInstance.apiv2ProductsGetMenuNavigationGet(appId, availability, outletId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#apiv2ProductsGetMenuNavigationGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *availability = availability_example; // 
String *outletId = outletId_example; // 

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

// Get Menu Navigation List
[apiInstance apiv2ProductsGetMenuNavigationGetWith:appId
    availability:availability
    outletId:outletId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.ProductsApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var availability = availability_example; // {{String}} 
var outletId = outletId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiv2ProductsGetMenuNavigationGet(appId, availability, outletId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var availability = availability_example;  // String | 
            var outletId = outletId_example;  // String | 

            try
            {
                // Get Menu Navigation List
                apiInstance.apiv2ProductsGetMenuNavigationGet(appId, availability, outletId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.apiv2ProductsGetMenuNavigationGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$availability = availability_example; // String | 
$outletId = outletId_example; // String | 

try {
    $api_instance->apiv2ProductsGetMenuNavigationGet($appId, $availability, $outletId);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->apiv2ProductsGetMenuNavigationGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $availability = availability_example; # String | 
my $outletId = outletId_example; # String | 

eval { 
    $api_instance->apiv2ProductsGetMenuNavigationGet(appId => $appId, availability => $availability, outletId => $outletId);
};
if ($@) {
    warn "Exception when calling ProductsApi->apiv2ProductsGetMenuNavigationGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
appId = appId_example # String | App ID Which it refers unique id for every users
availability = availability_example # String | 
outletId = outletId_example # String | 

try: 
    # Get Menu Navigation List
    api_instance.apiv2_products_get_menu_navigation_get(appId, availability, outletId)
except ApiException as e:
    print("Exception when calling ProductsApi->apiv2ProductsGetMenuNavigationGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
availability*
String
Required
outletId*
String
Required

Responses

Status: 200 - OK


PromotionsRewards

apiLoyaltyCustomerEarnedRewardpointHistroyv1Get

Get Earned Rewards History

This is an operation get promotion code


/api/loyalty/customer_earned_rewardpoint_histroyv1

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/loyalty/customer_earned_rewardpoint_histroyv1?app_id=&status=&customer_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PromotionsRewardsApi;

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

public class PromotionsRewardsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        PromotionsRewardsApi apiInstance = new PromotionsRewardsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String status = status_example; // String | Status
        String customerId = customerId_example; // String | Customer ID
        try {
            apiInstance.apiLoyaltyCustomerEarnedRewardpointHistroyv1Get(appId, status, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromotionsRewardsApi#apiLoyaltyCustomerEarnedRewardpointHistroyv1Get");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PromotionsRewardsApi;

public class PromotionsRewardsApiExample {

    public static void main(String[] args) {
        PromotionsRewardsApi apiInstance = new PromotionsRewardsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String status = status_example; // String | Status
        String customerId = customerId_example; // String | Customer ID
        try {
            apiInstance.apiLoyaltyCustomerEarnedRewardpointHistroyv1Get(appId, status, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromotionsRewardsApi#apiLoyaltyCustomerEarnedRewardpointHistroyv1Get");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *status = status_example; // Status
String *customerId = customerId_example; // Customer ID

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

// Get Earned Rewards History
[apiInstance apiLoyaltyCustomerEarnedRewardpointHistroyv1GetWith:appId
    status:status
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.PromotionsRewardsApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var status = status_example; // {{String}} Status
var customerId = customerId_example; // {{String}} Customer ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiLoyaltyCustomerEarnedRewardpointHistroyv1Get(appId, status, customerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PromotionsRewardsApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var status = status_example;  // String | Status
            var customerId = customerId_example;  // String | Customer ID

            try
            {
                // Get Earned Rewards History
                apiInstance.apiLoyaltyCustomerEarnedRewardpointHistroyv1Get(appId, status, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PromotionsRewardsApi.apiLoyaltyCustomerEarnedRewardpointHistroyv1Get: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPromotionsRewardsApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$status = status_example; // String | Status
$customerId = customerId_example; // String | Customer ID

try {
    $api_instance->apiLoyaltyCustomerEarnedRewardpointHistroyv1Get($appId, $status, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling PromotionsRewardsApi->apiLoyaltyCustomerEarnedRewardpointHistroyv1Get: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PromotionsRewardsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PromotionsRewardsApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $status = status_example; # String | Status
my $customerId = customerId_example; # String | Customer ID

eval { 
    $api_instance->apiLoyaltyCustomerEarnedRewardpointHistroyv1Get(appId => $appId, status => $status, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling PromotionsRewardsApi->apiLoyaltyCustomerEarnedRewardpointHistroyv1Get: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PromotionsRewardsApi()
appId = appId_example # String | App ID Which it refers unique id for every users
status = status_example # String | Status
customerId = customerId_example # String | Customer ID

try: 
    # Get Earned Rewards History
    api_instance.api_loyalty_customer_earned_rewardpoint_histroyv1_get(appId, status, customerId)
except ApiException as e:
    print("Exception when calling PromotionsRewardsApi->apiLoyaltyCustomerEarnedRewardpointHistroyv1Get: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
status*
String
Status
Required
customer_id*
String
Customer ID
Required

Responses

Status: 200 - OK


apiLoyaltyCustomerRedeemedRewardpointHistroyPost

Customer Redeemed History

This request allows you to see the permissions that are granted to this account.


/api/loyalty/customer_redeemed_rewardpoint_histroy

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/loyalty/customer_redeemed_rewardpoint_histroy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PromotionsRewardsApi;

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

public class PromotionsRewardsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        PromotionsRewardsApi apiInstance = new PromotionsRewardsApi();
        String appId = appId_example; // String | 
        String customerId = customerId_example; // String | 
        String status = status_example; // String | 
        try {
            apiInstance.apiLoyaltyCustomerRedeemedRewardpointHistroyPost(appId, customerId, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromotionsRewardsApi#apiLoyaltyCustomerRedeemedRewardpointHistroyPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PromotionsRewardsApi;

public class PromotionsRewardsApiExample {

    public static void main(String[] args) {
        PromotionsRewardsApi apiInstance = new PromotionsRewardsApi();
        String appId = appId_example; // String | 
        String customerId = customerId_example; // String | 
        String status = status_example; // String | 
        try {
            apiInstance.apiLoyaltyCustomerRedeemedRewardpointHistroyPost(appId, customerId, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromotionsRewardsApi#apiLoyaltyCustomerRedeemedRewardpointHistroyPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *customerId = customerId_example; //  (optional)
String *status = status_example; //  (optional)

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

// Customer Redeemed History
[apiInstance apiLoyaltyCustomerRedeemedRewardpointHistroyPostWith:appId
    customerId:customerId
    status:status
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.PromotionsRewardsApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'customerId': customerId_example // {{String}} 
  'status': status_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiLoyaltyCustomerRedeemedRewardpointHistroyPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PromotionsRewardsApi();
            var appId = appId_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 
            var status = status_example;  // String |  (optional) 

            try
            {
                // Customer Redeemed History
                apiInstance.apiLoyaltyCustomerRedeemedRewardpointHistroyPost(appId, customerId, status);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PromotionsRewardsApi.apiLoyaltyCustomerRedeemedRewardpointHistroyPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPromotionsRewardsApi();
$appId = appId_example; // String | 
$customerId = customerId_example; // String | 
$status = status_example; // String | 

try {
    $api_instance->apiLoyaltyCustomerRedeemedRewardpointHistroyPost($appId, $customerId, $status);
} catch (Exception $e) {
    echo 'Exception when calling PromotionsRewardsApi->apiLoyaltyCustomerRedeemedRewardpointHistroyPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PromotionsRewardsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PromotionsRewardsApi->new();
my $appId = appId_example; # String | 
my $customerId = customerId_example; # String | 
my $status = status_example; # String | 

eval { 
    $api_instance->apiLoyaltyCustomerRedeemedRewardpointHistroyPost(appId => $appId, customerId => $customerId, status => $status);
};
if ($@) {
    warn "Exception when calling PromotionsRewardsApi->apiLoyaltyCustomerRedeemedRewardpointHistroyPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PromotionsRewardsApi()
appId = appId_example # String |  (optional)
customerId = customerId_example # String |  (optional)
status = status_example # String |  (optional)

try: 
    # Customer Redeemed History
    api_instance.api_loyalty_customer_redeemed_rewardpoint_histroy_post(appId=appId, customerId=customerId, status=status)
except ApiException as e:
    print("Exception when calling PromotionsRewardsApi->apiLoyaltyCustomerRedeemedRewardpointHistroyPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
customer_id
String
status
String

Responses

Status: 200 - OK


apiPromotionApiV2ApplyPromotionPost

Apply Promotions

This request allows you to see the permissions that are granted to this account.


/api/promotion_api_v2/apply_promotion

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/promotion_api_v2/apply_promotion"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PromotionsRewardsApi;

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

public class PromotionsRewardsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        PromotionsRewardsApi apiInstance = new PromotionsRewardsApi();
        String appId = appId_example; // String | 
        String referenceId = referenceId_example; // String | 
        String promoCode = promoCode_example; // String | 
        String cartAmount = cartAmount_example; // String | 
        String cartQuantity = cartQuantity_example; // String | 
        String categoryId = categoryId_example; // String | 
        String availabilityId = availabilityId_example; // String | 
        try {
            apiInstance.apiPromotionApiV2ApplyPromotionPost(appId, referenceId, promoCode, cartAmount, cartQuantity, categoryId, availabilityId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromotionsRewardsApi#apiPromotionApiV2ApplyPromotionPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PromotionsRewardsApi;

public class PromotionsRewardsApiExample {

    public static void main(String[] args) {
        PromotionsRewardsApi apiInstance = new PromotionsRewardsApi();
        String appId = appId_example; // String | 
        String referenceId = referenceId_example; // String | 
        String promoCode = promoCode_example; // String | 
        String cartAmount = cartAmount_example; // String | 
        String cartQuantity = cartQuantity_example; // String | 
        String categoryId = categoryId_example; // String | 
        String availabilityId = availabilityId_example; // String | 
        try {
            apiInstance.apiPromotionApiV2ApplyPromotionPost(appId, referenceId, promoCode, cartAmount, cartQuantity, categoryId, availabilityId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromotionsRewardsApi#apiPromotionApiV2ApplyPromotionPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *referenceId = referenceId_example; //  (optional)
String *promoCode = promoCode_example; //  (optional)
String *cartAmount = cartAmount_example; //  (optional)
String *cartQuantity = cartQuantity_example; //  (optional)
String *categoryId = categoryId_example; //  (optional)
String *availabilityId = availabilityId_example; //  (optional)

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

// Apply Promotions
[apiInstance apiPromotionApiV2ApplyPromotionPostWith:appId
    referenceId:referenceId
    promoCode:promoCode
    cartAmount:cartAmount
    cartQuantity:cartQuantity
    categoryId:categoryId
    availabilityId:availabilityId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.PromotionsRewardsApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'referenceId': referenceId_example // {{String}} 
  'promoCode': promoCode_example // {{String}} 
  'cartAmount': cartAmount_example // {{String}} 
  'cartQuantity': cartQuantity_example // {{String}} 
  'categoryId': categoryId_example // {{String}} 
  'availabilityId': availabilityId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiPromotionApiV2ApplyPromotionPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PromotionsRewardsApi();
            var appId = appId_example;  // String |  (optional) 
            var referenceId = referenceId_example;  // String |  (optional) 
            var promoCode = promoCode_example;  // String |  (optional) 
            var cartAmount = cartAmount_example;  // String |  (optional) 
            var cartQuantity = cartQuantity_example;  // String |  (optional) 
            var categoryId = categoryId_example;  // String |  (optional) 
            var availabilityId = availabilityId_example;  // String |  (optional) 

            try
            {
                // Apply Promotions
                apiInstance.apiPromotionApiV2ApplyPromotionPost(appId, referenceId, promoCode, cartAmount, cartQuantity, categoryId, availabilityId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PromotionsRewardsApi.apiPromotionApiV2ApplyPromotionPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPromotionsRewardsApi();
$appId = appId_example; // String | 
$referenceId = referenceId_example; // String | 
$promoCode = promoCode_example; // String | 
$cartAmount = cartAmount_example; // String | 
$cartQuantity = cartQuantity_example; // String | 
$categoryId = categoryId_example; // String | 
$availabilityId = availabilityId_example; // String | 

try {
    $api_instance->apiPromotionApiV2ApplyPromotionPost($appId, $referenceId, $promoCode, $cartAmount, $cartQuantity, $categoryId, $availabilityId);
} catch (Exception $e) {
    echo 'Exception when calling PromotionsRewardsApi->apiPromotionApiV2ApplyPromotionPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PromotionsRewardsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PromotionsRewardsApi->new();
my $appId = appId_example; # String | 
my $referenceId = referenceId_example; # String | 
my $promoCode = promoCode_example; # String | 
my $cartAmount = cartAmount_example; # String | 
my $cartQuantity = cartQuantity_example; # String | 
my $categoryId = categoryId_example; # String | 
my $availabilityId = availabilityId_example; # String | 

eval { 
    $api_instance->apiPromotionApiV2ApplyPromotionPost(appId => $appId, referenceId => $referenceId, promoCode => $promoCode, cartAmount => $cartAmount, cartQuantity => $cartQuantity, categoryId => $categoryId, availabilityId => $availabilityId);
};
if ($@) {
    warn "Exception when calling PromotionsRewardsApi->apiPromotionApiV2ApplyPromotionPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PromotionsRewardsApi()
appId = appId_example # String |  (optional)
referenceId = referenceId_example # String |  (optional)
promoCode = promoCode_example # String |  (optional)
cartAmount = cartAmount_example # String |  (optional)
cartQuantity = cartQuantity_example # String |  (optional)
categoryId = categoryId_example # String |  (optional)
availabilityId = availabilityId_example # String |  (optional)

try: 
    # Apply Promotions
    api_instance.api_promotion_api_v2_apply_promotion_post(appId=appId, referenceId=referenceId, promoCode=promoCode, cartAmount=cartAmount, cartQuantity=cartQuantity, categoryId=categoryId, availabilityId=availabilityId)
except ApiException as e:
    print("Exception when calling PromotionsRewardsApi->apiPromotionApiV2ApplyPromotionPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
reference_id
String
promo_code
String
cart_amount
String
cart_quantity
String
category_id
String
availability_id
String

Responses

Status: 200 - OK


apiPromotionApiV2PromotionlistWhitoutuniqcodeGet

Get Promotion Without Unique Code

This is an operation get promotion code


/api/promotion_api_v2/promotionlistWhitoutuniqcode

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/promotion_api_v2/promotionlistWhitoutuniqcode?app_id=&customer_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PromotionsRewardsApi;

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

public class PromotionsRewardsApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        PromotionsRewardsApi apiInstance = new PromotionsRewardsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String customerId = customerId_example; // String | Customer ID
        try {
            apiInstance.apiPromotionApiV2PromotionlistWhitoutuniqcodeGet(appId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromotionsRewardsApi#apiPromotionApiV2PromotionlistWhitoutuniqcodeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PromotionsRewardsApi;

public class PromotionsRewardsApiExample {

    public static void main(String[] args) {
        PromotionsRewardsApi apiInstance = new PromotionsRewardsApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String customerId = customerId_example; // String | Customer ID
        try {
            apiInstance.apiPromotionApiV2PromotionlistWhitoutuniqcodeGet(appId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromotionsRewardsApi#apiPromotionApiV2PromotionlistWhitoutuniqcodeGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *customerId = customerId_example; // Customer ID

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

// Get Promotion Without Unique Code
[apiInstance apiPromotionApiV2PromotionlistWhitoutuniqcodeGetWith:appId
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.PromotionsRewardsApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var customerId = customerId_example; // {{String}} Customer ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiPromotionApiV2PromotionlistWhitoutuniqcodeGet(appId, customerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PromotionsRewardsApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var customerId = customerId_example;  // String | Customer ID

            try
            {
                // Get Promotion Without Unique Code
                apiInstance.apiPromotionApiV2PromotionlistWhitoutuniqcodeGet(appId, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PromotionsRewardsApi.apiPromotionApiV2PromotionlistWhitoutuniqcodeGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPromotionsRewardsApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$customerId = customerId_example; // String | Customer ID

try {
    $api_instance->apiPromotionApiV2PromotionlistWhitoutuniqcodeGet($appId, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling PromotionsRewardsApi->apiPromotionApiV2PromotionlistWhitoutuniqcodeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PromotionsRewardsApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PromotionsRewardsApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $customerId = customerId_example; # String | Customer ID

eval { 
    $api_instance->apiPromotionApiV2PromotionlistWhitoutuniqcodeGet(appId => $appId, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling PromotionsRewardsApi->apiPromotionApiV2PromotionlistWhitoutuniqcodeGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PromotionsRewardsApi()
appId = appId_example # String | App ID Which it refers unique id for every users
customerId = customerId_example # String | Customer ID

try: 
    # Get Promotion Without Unique Code
    api_instance.api_promotion_api_v2_promotionlist_whitoutuniqcode_get(appId, customerId)
except ApiException as e:
    print("Exception when calling PromotionsRewardsApi->apiPromotionApiV2PromotionlistWhitoutuniqcodeGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
customer_id*
String
Customer ID
Required

Responses

Status: 200 - OK


TimeSlot

apiv2SettingsAvailableDatesAdvancedGet

Get Advanced Time Slots

This is an operation get advanced time slots.


/apiv2/settings/availableDatesAdvanced

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/apiv2/settings/availableDatesAdvanced?app_id=&availability_id=&outletId=&tatTime="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeSlotApi;

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

public class TimeSlotApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        TimeSlotApi apiInstance = new TimeSlotApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availabilityId = availabilityId_example; // String | 
        Integer outletId = 56; // Integer | An outletId unique identifier
        Integer tatTime = 56; // Integer | 
        try {
            apiInstance.apiv2SettingsAvailableDatesAdvancedGet(appId, availabilityId, outletId, tatTime);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeSlotApi#apiv2SettingsAvailableDatesAdvancedGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeSlotApi;

public class TimeSlotApiExample {

    public static void main(String[] args) {
        TimeSlotApi apiInstance = new TimeSlotApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String availabilityId = availabilityId_example; // String | 
        Integer outletId = 56; // Integer | An outletId unique identifier
        Integer tatTime = 56; // Integer | 
        try {
            apiInstance.apiv2SettingsAvailableDatesAdvancedGet(appId, availabilityId, outletId, tatTime);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeSlotApi#apiv2SettingsAvailableDatesAdvancedGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *availabilityId = availabilityId_example; // 
Integer *outletId = 56; // An outletId unique identifier
Integer *tatTime = 56; // 

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

// Get Advanced Time Slots
[apiInstance apiv2SettingsAvailableDatesAdvancedGetWith:appId
    availabilityId:availabilityId
    outletId:outletId
    tatTime:tatTime
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.TimeSlotApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var availabilityId = availabilityId_example; // {{String}} 
var outletId = 56; // {{Integer}} An outletId unique identifier
var tatTime = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiv2SettingsAvailableDatesAdvancedGet(appId, availabilityId, outletId, tatTime, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TimeSlotApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var availabilityId = availabilityId_example;  // String | 
            var outletId = 56;  // Integer | An outletId unique identifier
            var tatTime = 56;  // Integer | 

            try
            {
                // Get Advanced Time Slots
                apiInstance.apiv2SettingsAvailableDatesAdvancedGet(appId, availabilityId, outletId, tatTime);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeSlotApi.apiv2SettingsAvailableDatesAdvancedGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTimeSlotApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$availabilityId = availabilityId_example; // String | 
$outletId = 56; // Integer | An outletId unique identifier
$tatTime = 56; // Integer | 

try {
    $api_instance->apiv2SettingsAvailableDatesAdvancedGet($appId, $availabilityId, $outletId, $tatTime);
} catch (Exception $e) {
    echo 'Exception when calling TimeSlotApi->apiv2SettingsAvailableDatesAdvancedGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeSlotApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TimeSlotApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $availabilityId = availabilityId_example; # String | 
my $outletId = 56; # Integer | An outletId unique identifier
my $tatTime = 56; # Integer | 

eval { 
    $api_instance->apiv2SettingsAvailableDatesAdvancedGet(appId => $appId, availabilityId => $availabilityId, outletId => $outletId, tatTime => $tatTime);
};
if ($@) {
    warn "Exception when calling TimeSlotApi->apiv2SettingsAvailableDatesAdvancedGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TimeSlotApi()
appId = appId_example # String | App ID Which it refers unique id for every users
availabilityId = availabilityId_example # String | 
outletId = 56 # Integer | An outletId unique identifier
tatTime = 56 # Integer | 

try: 
    # Get Advanced Time Slots
    api_instance.apiv2_settings_available_dates_advanced_get(appId, availabilityId, outletId, tatTime)
except ApiException as e:
    print("Exception when calling TimeSlotApi->apiv2SettingsAvailableDatesAdvancedGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
availability_id*
String
Required
outletId*
Integer
An outletId unique identifier
Required
tatTime*
Integer
Required

Responses

Status: 200 - OK


UserInfo

apiCustomerActivationPost

Customer Activation

This request allows you to see the permissions that are granted to this account.


/api/customer/activation

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/customer/activation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInfoApi;

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

public class UserInfoApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String key = key_example; // String | 
        try {
            apiInstance.apiCustomerActivationPost(appId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerActivationPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInfoApi;

public class UserInfoApiExample {

    public static void main(String[] args) {
        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String key = key_example; // String | 
        try {
            apiInstance.apiCustomerActivationPost(appId, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerActivationPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *key = key_example; //  (optional)

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

// Customer Activation
[apiInstance apiCustomerActivationPostWith:appId
    key:key
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.UserInfoApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'key': key_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCustomerActivationPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserInfoApi();
            var appId = appId_example;  // String |  (optional) 
            var key = key_example;  // String |  (optional) 

            try
            {
                // Customer Activation
                apiInstance.apiCustomerActivationPost(appId, key);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInfoApi.apiCustomerActivationPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserInfoApi();
$appId = appId_example; // String | 
$key = key_example; // String | 

try {
    $api_instance->apiCustomerActivationPost($appId, $key);
} catch (Exception $e) {
    echo 'Exception when calling UserInfoApi->apiCustomerActivationPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInfoApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserInfoApi->new();
my $appId = appId_example; # String | 
my $key = key_example; # String | 

eval { 
    $api_instance->apiCustomerActivationPost(appId => $appId, key => $key);
};
if ($@) {
    warn "Exception when calling UserInfoApi->apiCustomerActivationPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserInfoApi()
appId = appId_example # String |  (optional)
key = key_example # String |  (optional)

try: 
    # Customer Activation
    api_instance.api_customer_activation_post(appId=appId, key=key)
except ApiException as e:
    print("Exception when calling UserInfoApi->apiCustomerActivationPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
key
String

Responses

Status: 200 - OK


apiCustomerForgotPasswordPost

Forgot Your Password

This request allows you to send mail for your email address.


/api/customer/forgot_password

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/customer/forgot_password"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInfoApi;

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

public class UserInfoApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String type = type_example; // String | 
        String emailAddress = emailAddress_example; // String | 
        Integer siteUrl = 56; // Integer | 
        try {
            apiInstance.apiCustomerForgotPasswordPost(appId, type, emailAddress, siteUrl);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerForgotPasswordPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInfoApi;

public class UserInfoApiExample {

    public static void main(String[] args) {
        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String type = type_example; // String | 
        String emailAddress = emailAddress_example; // String | 
        Integer siteUrl = 56; // Integer | 
        try {
            apiInstance.apiCustomerForgotPasswordPost(appId, type, emailAddress, siteUrl);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerForgotPasswordPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *type = type_example; //  (optional)
String *emailAddress = emailAddress_example; //  (optional)
Integer *siteUrl = 56; //  (optional)

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

// Forgot Your Password
[apiInstance apiCustomerForgotPasswordPostWith:appId
    type:type
    emailAddress:emailAddress
    siteUrl:siteUrl
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.UserInfoApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'type': type_example // {{String}} 
  'emailAddress': emailAddress_example // {{String}} 
  'siteUrl': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCustomerForgotPasswordPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserInfoApi();
            var appId = appId_example;  // String |  (optional) 
            var type = type_example;  // String |  (optional) 
            var emailAddress = emailAddress_example;  // String |  (optional) 
            var siteUrl = 56;  // Integer |  (optional) 

            try
            {
                // Forgot Your Password
                apiInstance.apiCustomerForgotPasswordPost(appId, type, emailAddress, siteUrl);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInfoApi.apiCustomerForgotPasswordPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserInfoApi();
$appId = appId_example; // String | 
$type = type_example; // String | 
$emailAddress = emailAddress_example; // String | 
$siteUrl = 56; // Integer | 

try {
    $api_instance->apiCustomerForgotPasswordPost($appId, $type, $emailAddress, $siteUrl);
} catch (Exception $e) {
    echo 'Exception when calling UserInfoApi->apiCustomerForgotPasswordPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInfoApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserInfoApi->new();
my $appId = appId_example; # String | 
my $type = type_example; # String | 
my $emailAddress = emailAddress_example; # String | 
my $siteUrl = 56; # Integer | 

eval { 
    $api_instance->apiCustomerForgotPasswordPost(appId => $appId, type => $type, emailAddress => $emailAddress, siteUrl => $siteUrl);
};
if ($@) {
    warn "Exception when calling UserInfoApi->apiCustomerForgotPasswordPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserInfoApi()
appId = appId_example # String |  (optional)
type = type_example # String |  (optional)
emailAddress = emailAddress_example # String |  (optional)
siteUrl = 56 # Integer |  (optional)

try: 
    # Forgot Your Password
    api_instance.api_customer_forgot_password_post(appId=appId, type=type, emailAddress=emailAddress, siteUrl=siteUrl)
except ApiException as e:
    print("Exception when calling UserInfoApi->apiCustomerForgotPasswordPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
type
String
email_address
String
site_url
Integer

Responses

Status: 200 - OK


apiCustomerLoginPost

Customer Login

This request allows you to see the permissions that are granted to this account.


/api/customer/login

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/customer/login"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInfoApi;

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

public class UserInfoApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String type = type_example; // String | 
        String logintype = logintype_example; // String | 
        String passwordtype = passwordtype_example; // String | 
        String loginUsername = loginUsername_example; // String | 
        Integer loginPassword = 56; // Integer | 
        try {
            apiInstance.apiCustomerLoginPost(appId, type, logintype, passwordtype, loginUsername, loginPassword);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerLoginPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInfoApi;

public class UserInfoApiExample {

    public static void main(String[] args) {
        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String type = type_example; // String | 
        String logintype = logintype_example; // String | 
        String passwordtype = passwordtype_example; // String | 
        String loginUsername = loginUsername_example; // String | 
        Integer loginPassword = 56; // Integer | 
        try {
            apiInstance.apiCustomerLoginPost(appId, type, logintype, passwordtype, loginUsername, loginPassword);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerLoginPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *type = type_example; //  (optional)
String *logintype = logintype_example; //  (optional)
String *passwordtype = passwordtype_example; //  (optional)
String *loginUsername = loginUsername_example; //  (optional)
Integer *loginPassword = 56; //  (optional)

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

// Customer Login
[apiInstance apiCustomerLoginPostWith:appId
    type:type
    logintype:logintype
    passwordtype:passwordtype
    loginUsername:loginUsername
    loginPassword:loginPassword
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.UserInfoApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'type': type_example // {{String}} 
  'logintype': logintype_example // {{String}} 
  'passwordtype': passwordtype_example // {{String}} 
  'loginUsername': loginUsername_example // {{String}} 
  'loginPassword': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCustomerLoginPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserInfoApi();
            var appId = appId_example;  // String |  (optional) 
            var type = type_example;  // String |  (optional) 
            var logintype = logintype_example;  // String |  (optional) 
            var passwordtype = passwordtype_example;  // String |  (optional) 
            var loginUsername = loginUsername_example;  // String |  (optional) 
            var loginPassword = 56;  // Integer |  (optional) 

            try
            {
                // Customer Login
                apiInstance.apiCustomerLoginPost(appId, type, logintype, passwordtype, loginUsername, loginPassword);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInfoApi.apiCustomerLoginPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserInfoApi();
$appId = appId_example; // String | 
$type = type_example; // String | 
$logintype = logintype_example; // String | 
$passwordtype = passwordtype_example; // String | 
$loginUsername = loginUsername_example; // String | 
$loginPassword = 56; // Integer | 

try {
    $api_instance->apiCustomerLoginPost($appId, $type, $logintype, $passwordtype, $loginUsername, $loginPassword);
} catch (Exception $e) {
    echo 'Exception when calling UserInfoApi->apiCustomerLoginPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInfoApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserInfoApi->new();
my $appId = appId_example; # String | 
my $type = type_example; # String | 
my $logintype = logintype_example; # String | 
my $passwordtype = passwordtype_example; # String | 
my $loginUsername = loginUsername_example; # String | 
my $loginPassword = 56; # Integer | 

eval { 
    $api_instance->apiCustomerLoginPost(appId => $appId, type => $type, logintype => $logintype, passwordtype => $passwordtype, loginUsername => $loginUsername, loginPassword => $loginPassword);
};
if ($@) {
    warn "Exception when calling UserInfoApi->apiCustomerLoginPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserInfoApi()
appId = appId_example # String |  (optional)
type = type_example # String |  (optional)
logintype = logintype_example # String |  (optional)
passwordtype = passwordtype_example # String |  (optional)
loginUsername = loginUsername_example # String |  (optional)
loginPassword = 56 # Integer |  (optional)

try: 
    # Customer Login
    api_instance.api_customer_login_post(appId=appId, type=type, logintype=logintype, passwordtype=passwordtype, loginUsername=loginUsername, loginPassword=loginPassword)
except ApiException as e:
    print("Exception when calling UserInfoApi->apiCustomerLoginPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
type
String
logintype
String
passwordtype
String
login_username
String
login_password
Integer

Responses

Status: 200 - OK


apiCustomerRegistrationPost

Create a New Customer

This request allows you to create new customer.


/api/customer/registration

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/customer/registration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInfoApi;

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

public class UserInfoApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String type = type_example; // String | 
        String registertype = registertype_example; // String | 
        String passwordtype = passwordtype_example; // String | 
        String customerFirstName = customerFirstName_example; // String | 
        String customerEmail = customerEmail_example; // String | 
        Integer customerPin = 56; // Integer | 
        Integer customerPhone = 56; // Integer | 
        Integer customerPdpaConsent = 56; // Integer | 
        Integer siteUrl = 56; // Integer | 
        try {
            apiInstance.apiCustomerRegistrationPost(appId, type, registertype, passwordtype, customerFirstName, customerEmail, customerPin, customerPhone, customerPdpaConsent, siteUrl);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerRegistrationPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInfoApi;

public class UserInfoApiExample {

    public static void main(String[] args) {
        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String type = type_example; // String | 
        String registertype = registertype_example; // String | 
        String passwordtype = passwordtype_example; // String | 
        String customerFirstName = customerFirstName_example; // String | 
        String customerEmail = customerEmail_example; // String | 
        Integer customerPin = 56; // Integer | 
        Integer customerPhone = 56; // Integer | 
        Integer customerPdpaConsent = 56; // Integer | 
        Integer siteUrl = 56; // Integer | 
        try {
            apiInstance.apiCustomerRegistrationPost(appId, type, registertype, passwordtype, customerFirstName, customerEmail, customerPin, customerPhone, customerPdpaConsent, siteUrl);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerRegistrationPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *type = type_example; //  (optional)
String *registertype = registertype_example; //  (optional)
String *passwordtype = passwordtype_example; //  (optional)
String *customerFirstName = customerFirstName_example; //  (optional)
String *customerEmail = customerEmail_example; //  (optional)
Integer *customerPin = 56; //  (optional)
Integer *customerPhone = 56; //  (optional)
Integer *customerPdpaConsent = 56; //  (optional)
Integer *siteUrl = 56; //  (optional)

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

// Create a New Customer
[apiInstance apiCustomerRegistrationPostWith:appId
    type:type
    registertype:registertype
    passwordtype:passwordtype
    customerFirstName:customerFirstName
    customerEmail:customerEmail
    customerPin:customerPin
    customerPhone:customerPhone
    customerPdpaConsent:customerPdpaConsent
    siteUrl:siteUrl
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.UserInfoApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'type': type_example // {{String}} 
  'registertype': registertype_example // {{String}} 
  'passwordtype': passwordtype_example // {{String}} 
  'customerFirstName': customerFirstName_example // {{String}} 
  'customerEmail': customerEmail_example // {{String}} 
  'customerPin': 56 // {{Integer}} 
  'customerPhone': 56 // {{Integer}} 
  'customerPdpaConsent': 56 // {{Integer}} 
  'siteUrl': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCustomerRegistrationPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserInfoApi();
            var appId = appId_example;  // String |  (optional) 
            var type = type_example;  // String |  (optional) 
            var registertype = registertype_example;  // String |  (optional) 
            var passwordtype = passwordtype_example;  // String |  (optional) 
            var customerFirstName = customerFirstName_example;  // String |  (optional) 
            var customerEmail = customerEmail_example;  // String |  (optional) 
            var customerPin = 56;  // Integer |  (optional) 
            var customerPhone = 56;  // Integer |  (optional) 
            var customerPdpaConsent = 56;  // Integer |  (optional) 
            var siteUrl = 56;  // Integer |  (optional) 

            try
            {
                // Create a New Customer
                apiInstance.apiCustomerRegistrationPost(appId, type, registertype, passwordtype, customerFirstName, customerEmail, customerPin, customerPhone, customerPdpaConsent, siteUrl);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInfoApi.apiCustomerRegistrationPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserInfoApi();
$appId = appId_example; // String | 
$type = type_example; // String | 
$registertype = registertype_example; // String | 
$passwordtype = passwordtype_example; // String | 
$customerFirstName = customerFirstName_example; // String | 
$customerEmail = customerEmail_example; // String | 
$customerPin = 56; // Integer | 
$customerPhone = 56; // Integer | 
$customerPdpaConsent = 56; // Integer | 
$siteUrl = 56; // Integer | 

try {
    $api_instance->apiCustomerRegistrationPost($appId, $type, $registertype, $passwordtype, $customerFirstName, $customerEmail, $customerPin, $customerPhone, $customerPdpaConsent, $siteUrl);
} catch (Exception $e) {
    echo 'Exception when calling UserInfoApi->apiCustomerRegistrationPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInfoApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserInfoApi->new();
my $appId = appId_example; # String | 
my $type = type_example; # String | 
my $registertype = registertype_example; # String | 
my $passwordtype = passwordtype_example; # String | 
my $customerFirstName = customerFirstName_example; # String | 
my $customerEmail = customerEmail_example; # String | 
my $customerPin = 56; # Integer | 
my $customerPhone = 56; # Integer | 
my $customerPdpaConsent = 56; # Integer | 
my $siteUrl = 56; # Integer | 

eval { 
    $api_instance->apiCustomerRegistrationPost(appId => $appId, type => $type, registertype => $registertype, passwordtype => $passwordtype, customerFirstName => $customerFirstName, customerEmail => $customerEmail, customerPin => $customerPin, customerPhone => $customerPhone, customerPdpaConsent => $customerPdpaConsent, siteUrl => $siteUrl);
};
if ($@) {
    warn "Exception when calling UserInfoApi->apiCustomerRegistrationPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserInfoApi()
appId = appId_example # String |  (optional)
type = type_example # String |  (optional)
registertype = registertype_example # String |  (optional)
passwordtype = passwordtype_example # String |  (optional)
customerFirstName = customerFirstName_example # String |  (optional)
customerEmail = customerEmail_example # String |  (optional)
customerPin = 56 # Integer |  (optional)
customerPhone = 56 # Integer |  (optional)
customerPdpaConsent = 56 # Integer |  (optional)
siteUrl = 56 # Integer |  (optional)

try: 
    # Create a New Customer
    api_instance.api_customer_registration_post(appId=appId, type=type, registertype=registertype, passwordtype=passwordtype, customerFirstName=customerFirstName, customerEmail=customerEmail, customerPin=customerPin, customerPhone=customerPhone, customerPdpaConsent=customerPdpaConsent, siteUrl=siteUrl)
except ApiException as e:
    print("Exception when calling UserInfoApi->apiCustomerRegistrationPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
type
String
registertype
String
passwordtype
String
customer_first_name
String
customer_email
String
customer_pin
Integer
customer_phone
Integer
customer_pdpa_consent
Integer
site_url
Integer

Responses

Status: 200 - OK


apiCustomerResetpasswordPost

Reset Your Password

This request allows you to change your password.


/api/customer/resetpassword

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/customer/resetpassword"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInfoApi;

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

public class UserInfoApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String key = key_example; // String | 
        Integer password = 56; // Integer | 
        Integer confirmpassword = 56; // Integer | 
        Integer siteUrl = 56; // Integer | 
        try {
            apiInstance.apiCustomerResetpasswordPost(appId, key, password, confirmpassword, siteUrl);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerResetpasswordPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInfoApi;

public class UserInfoApiExample {

    public static void main(String[] args) {
        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String key = key_example; // String | 
        Integer password = 56; // Integer | 
        Integer confirmpassword = 56; // Integer | 
        Integer siteUrl = 56; // Integer | 
        try {
            apiInstance.apiCustomerResetpasswordPost(appId, key, password, confirmpassword, siteUrl);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerResetpasswordPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *key = key_example; //  (optional)
Integer *password = 56; //  (optional)
Integer *confirmpassword = 56; //  (optional)
Integer *siteUrl = 56; //  (optional)

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

// Reset Your Password
[apiInstance apiCustomerResetpasswordPostWith:appId
    key:key
    password:password
    confirmpassword:confirmpassword
    siteUrl:siteUrl
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.UserInfoApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'key': key_example // {{String}} 
  'password': 56 // {{Integer}} 
  'confirmpassword': 56 // {{Integer}} 
  'siteUrl': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCustomerResetpasswordPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserInfoApi();
            var appId = appId_example;  // String |  (optional) 
            var key = key_example;  // String |  (optional) 
            var password = 56;  // Integer |  (optional) 
            var confirmpassword = 56;  // Integer |  (optional) 
            var siteUrl = 56;  // Integer |  (optional) 

            try
            {
                // Reset Your Password
                apiInstance.apiCustomerResetpasswordPost(appId, key, password, confirmpassword, siteUrl);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInfoApi.apiCustomerResetpasswordPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserInfoApi();
$appId = appId_example; // String | 
$key = key_example; // String | 
$password = 56; // Integer | 
$confirmpassword = 56; // Integer | 
$siteUrl = 56; // Integer | 

try {
    $api_instance->apiCustomerResetpasswordPost($appId, $key, $password, $confirmpassword, $siteUrl);
} catch (Exception $e) {
    echo 'Exception when calling UserInfoApi->apiCustomerResetpasswordPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInfoApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserInfoApi->new();
my $appId = appId_example; # String | 
my $key = key_example; # String | 
my $password = 56; # Integer | 
my $confirmpassword = 56; # Integer | 
my $siteUrl = 56; # Integer | 

eval { 
    $api_instance->apiCustomerResetpasswordPost(appId => $appId, key => $key, password => $password, confirmpassword => $confirmpassword, siteUrl => $siteUrl);
};
if ($@) {
    warn "Exception when calling UserInfoApi->apiCustomerResetpasswordPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserInfoApi()
appId = appId_example # String |  (optional)
key = key_example # String |  (optional)
password = 56 # Integer |  (optional)
confirmpassword = 56 # Integer |  (optional)
siteUrl = 56 # Integer |  (optional)

try: 
    # Reset Your Password
    api_instance.api_customer_resetpassword_post(appId=appId, key=key, password=password, confirmpassword=confirmpassword, siteUrl=siteUrl)
except ApiException as e:
    print("Exception when calling UserInfoApi->apiCustomerResetpasswordPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
key
String
password
Integer
confirmpassword
Integer
site_url
Integer

Responses

Status: 200 - OK


apiCustomerSecondaryAddressAddPost

Add Secondary Address

Add Secondary Address


/api/customer/secondary_address_add

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/customer/secondary_address_add"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInfoApi;

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

public class UserInfoApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String customerFirstName = customerFirstName_example; // String | 
        String customerLastName = customerLastName_example; // String | 
        String customerPhone = customerPhone_example; // String | 
        String customerEmail = customerEmail_example; // String | 
        String customerAddressLine1 = customerAddressLine1_example; // String | 
        String customerPostalCode = customerPostalCode_example; // String | 
        String customerAddressName = customerAddressName_example; // String | 
        String customerAddressName2 = customerAddressName2_example; // String | 
        String refrence = refrence_example; // String | 
        String customerStatus = customerStatus_example; // String | 
        String customerOrderStatus = customerOrderStatus_example; // String | 
        try {
            apiInstance.apiCustomerSecondaryAddressAddPost(appId, customerFirstName, customerLastName, customerPhone, customerEmail, customerAddressLine1, customerPostalCode, customerAddressName, customerAddressName2, refrence, customerStatus, customerOrderStatus);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerSecondaryAddressAddPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInfoApi;

public class UserInfoApiExample {

    public static void main(String[] args) {
        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String customerFirstName = customerFirstName_example; // String | 
        String customerLastName = customerLastName_example; // String | 
        String customerPhone = customerPhone_example; // String | 
        String customerEmail = customerEmail_example; // String | 
        String customerAddressLine1 = customerAddressLine1_example; // String | 
        String customerPostalCode = customerPostalCode_example; // String | 
        String customerAddressName = customerAddressName_example; // String | 
        String customerAddressName2 = customerAddressName2_example; // String | 
        String refrence = refrence_example; // String | 
        String customerStatus = customerStatus_example; // String | 
        String customerOrderStatus = customerOrderStatus_example; // String | 
        try {
            apiInstance.apiCustomerSecondaryAddressAddPost(appId, customerFirstName, customerLastName, customerPhone, customerEmail, customerAddressLine1, customerPostalCode, customerAddressName, customerAddressName2, refrence, customerStatus, customerOrderStatus);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerSecondaryAddressAddPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *customerFirstName = customerFirstName_example; //  (optional)
String *customerLastName = customerLastName_example; //  (optional)
String *customerPhone = customerPhone_example; //  (optional)
String *customerEmail = customerEmail_example; //  (optional)
String *customerAddressLine1 = customerAddressLine1_example; //  (optional)
String *customerPostalCode = customerPostalCode_example; //  (optional)
String *customerAddressName = customerAddressName_example; //  (optional)
String *customerAddressName2 = customerAddressName2_example; //  (optional)
String *refrence = refrence_example; //  (optional)
String *customerStatus = customerStatus_example; //  (optional)
String *customerOrderStatus = customerOrderStatus_example; //  (optional)

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

// Add Secondary Address
[apiInstance apiCustomerSecondaryAddressAddPostWith:appId
    customerFirstName:customerFirstName
    customerLastName:customerLastName
    customerPhone:customerPhone
    customerEmail:customerEmail
    customerAddressLine1:customerAddressLine1
    customerPostalCode:customerPostalCode
    customerAddressName:customerAddressName
    customerAddressName2:customerAddressName2
    refrence:refrence
    customerStatus:customerStatus
    customerOrderStatus:customerOrderStatus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.UserInfoApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'customerFirstName': customerFirstName_example // {{String}} 
  'customerLastName': customerLastName_example // {{String}} 
  'customerPhone': customerPhone_example // {{String}} 
  'customerEmail': customerEmail_example // {{String}} 
  'customerAddressLine1': customerAddressLine1_example // {{String}} 
  'customerPostalCode': customerPostalCode_example // {{String}} 
  'customerAddressName': customerAddressName_example // {{String}} 
  'customerAddressName2': customerAddressName2_example // {{String}} 
  'refrence': refrence_example // {{String}} 
  'customerStatus': customerStatus_example // {{String}} 
  'customerOrderStatus': customerOrderStatus_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCustomerSecondaryAddressAddPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserInfoApi();
            var appId = appId_example;  // String |  (optional) 
            var customerFirstName = customerFirstName_example;  // String |  (optional) 
            var customerLastName = customerLastName_example;  // String |  (optional) 
            var customerPhone = customerPhone_example;  // String |  (optional) 
            var customerEmail = customerEmail_example;  // String |  (optional) 
            var customerAddressLine1 = customerAddressLine1_example;  // String |  (optional) 
            var customerPostalCode = customerPostalCode_example;  // String |  (optional) 
            var customerAddressName = customerAddressName_example;  // String |  (optional) 
            var customerAddressName2 = customerAddressName2_example;  // String |  (optional) 
            var refrence = refrence_example;  // String |  (optional) 
            var customerStatus = customerStatus_example;  // String |  (optional) 
            var customerOrderStatus = customerOrderStatus_example;  // String |  (optional) 

            try
            {
                // Add Secondary Address
                apiInstance.apiCustomerSecondaryAddressAddPost(appId, customerFirstName, customerLastName, customerPhone, customerEmail, customerAddressLine1, customerPostalCode, customerAddressName, customerAddressName2, refrence, customerStatus, customerOrderStatus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInfoApi.apiCustomerSecondaryAddressAddPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserInfoApi();
$appId = appId_example; // String | 
$customerFirstName = customerFirstName_example; // String | 
$customerLastName = customerLastName_example; // String | 
$customerPhone = customerPhone_example; // String | 
$customerEmail = customerEmail_example; // String | 
$customerAddressLine1 = customerAddressLine1_example; // String | 
$customerPostalCode = customerPostalCode_example; // String | 
$customerAddressName = customerAddressName_example; // String | 
$customerAddressName2 = customerAddressName2_example; // String | 
$refrence = refrence_example; // String | 
$customerStatus = customerStatus_example; // String | 
$customerOrderStatus = customerOrderStatus_example; // String | 

try {
    $api_instance->apiCustomerSecondaryAddressAddPost($appId, $customerFirstName, $customerLastName, $customerPhone, $customerEmail, $customerAddressLine1, $customerPostalCode, $customerAddressName, $customerAddressName2, $refrence, $customerStatus, $customerOrderStatus);
} catch (Exception $e) {
    echo 'Exception when calling UserInfoApi->apiCustomerSecondaryAddressAddPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInfoApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserInfoApi->new();
my $appId = appId_example; # String | 
my $customerFirstName = customerFirstName_example; # String | 
my $customerLastName = customerLastName_example; # String | 
my $customerPhone = customerPhone_example; # String | 
my $customerEmail = customerEmail_example; # String | 
my $customerAddressLine1 = customerAddressLine1_example; # String | 
my $customerPostalCode = customerPostalCode_example; # String | 
my $customerAddressName = customerAddressName_example; # String | 
my $customerAddressName2 = customerAddressName2_example; # String | 
my $refrence = refrence_example; # String | 
my $customerStatus = customerStatus_example; # String | 
my $customerOrderStatus = customerOrderStatus_example; # String | 

eval { 
    $api_instance->apiCustomerSecondaryAddressAddPost(appId => $appId, customerFirstName => $customerFirstName, customerLastName => $customerLastName, customerPhone => $customerPhone, customerEmail => $customerEmail, customerAddressLine1 => $customerAddressLine1, customerPostalCode => $customerPostalCode, customerAddressName => $customerAddressName, customerAddressName2 => $customerAddressName2, refrence => $refrence, customerStatus => $customerStatus, customerOrderStatus => $customerOrderStatus);
};
if ($@) {
    warn "Exception when calling UserInfoApi->apiCustomerSecondaryAddressAddPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserInfoApi()
appId = appId_example # String |  (optional)
customerFirstName = customerFirstName_example # String |  (optional)
customerLastName = customerLastName_example # String |  (optional)
customerPhone = customerPhone_example # String |  (optional)
customerEmail = customerEmail_example # String |  (optional)
customerAddressLine1 = customerAddressLine1_example # String |  (optional)
customerPostalCode = customerPostalCode_example # String |  (optional)
customerAddressName = customerAddressName_example # String |  (optional)
customerAddressName2 = customerAddressName2_example # String |  (optional)
refrence = refrence_example # String |  (optional)
customerStatus = customerStatus_example # String |  (optional)
customerOrderStatus = customerOrderStatus_example # String |  (optional)

try: 
    # Add Secondary Address
    api_instance.api_customer_secondary_address_add_post(appId=appId, customerFirstName=customerFirstName, customerLastName=customerLastName, customerPhone=customerPhone, customerEmail=customerEmail, customerAddressLine1=customerAddressLine1, customerPostalCode=customerPostalCode, customerAddressName=customerAddressName, customerAddressName2=customerAddressName2, refrence=refrence, customerStatus=customerStatus, customerOrderStatus=customerOrderStatus)
except ApiException as e:
    print("Exception when calling UserInfoApi->apiCustomerSecondaryAddressAddPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
customer_first_name
String
customer_last_name
String
customer_phone
String
customer_email
String
customer_address_line1
String
customer_postal_code
String
customer_address_name
String
customer_address_name2
String
refrence
String
customer_status
String
customer_order_status
String

Responses

Status: 201 - Created


apiCustomerUpdateprofilePost

Update Customer Details

This request allows you to Update Customer Details.


/api/customer/updateprofile

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/customer/updateprofile"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInfoApi;

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

public class UserInfoApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String type = type_example; // String | 
        String customerFirstName = customerFirstName_example; // String | 
        String customerLastName = customerLastName_example; // String | 
        String customerNickName = customerNickName_example; // String | 
        Integer customerPhone = 56; // Integer | 
        String customerEmail = customerEmail_example; // String | 
        String customerBirthdate = customerBirthdate_example; // String | 
        String customerPostalCode = customerPostalCode_example; // String | 
        String customerAddressName2 = customerAddressName2_example; // String | 
        String customerCompanyName = customerCompanyName_example; // String | 
        String customerAddressLine1 = customerAddressLine1_example; // String | 
        String customerAddressLine2 = customerAddressLine2_example; // String | 
        Integer customerId = 56; // Integer | 
        try {
            apiInstance.apiCustomerUpdateprofilePost(appId, type, customerFirstName, customerLastName, customerNickName, customerPhone, customerEmail, customerBirthdate, customerPostalCode, customerAddressName2, customerCompanyName, customerAddressLine1, customerAddressLine2, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerUpdateprofilePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInfoApi;

public class UserInfoApiExample {

    public static void main(String[] args) {
        UserInfoApi apiInstance = new UserInfoApi();
        String appId = appId_example; // String | 
        String type = type_example; // String | 
        String customerFirstName = customerFirstName_example; // String | 
        String customerLastName = customerLastName_example; // String | 
        String customerNickName = customerNickName_example; // String | 
        Integer customerPhone = 56; // Integer | 
        String customerEmail = customerEmail_example; // String | 
        String customerBirthdate = customerBirthdate_example; // String | 
        String customerPostalCode = customerPostalCode_example; // String | 
        String customerAddressName2 = customerAddressName2_example; // String | 
        String customerCompanyName = customerCompanyName_example; // String | 
        String customerAddressLine1 = customerAddressLine1_example; // String | 
        String customerAddressLine2 = customerAddressLine2_example; // String | 
        Integer customerId = 56; // Integer | 
        try {
            apiInstance.apiCustomerUpdateprofilePost(appId, type, customerFirstName, customerLastName, customerNickName, customerPhone, customerEmail, customerBirthdate, customerPostalCode, customerAddressName2, customerCompanyName, customerAddressLine1, customerAddressLine2, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInfoApi#apiCustomerUpdateprofilePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *type = type_example; //  (optional)
String *customerFirstName = customerFirstName_example; //  (optional)
String *customerLastName = customerLastName_example; //  (optional)
String *customerNickName = customerNickName_example; //  (optional)
Integer *customerPhone = 56; //  (optional)
String *customerEmail = customerEmail_example; //  (optional)
String *customerBirthdate = customerBirthdate_example; //  (optional)
String *customerPostalCode = customerPostalCode_example; //  (optional)
String *customerAddressName2 = customerAddressName2_example; //  (optional)
String *customerCompanyName = customerCompanyName_example; //  (optional)
String *customerAddressLine1 = customerAddressLine1_example; //  (optional)
String *customerAddressLine2 = customerAddressLine2_example; //  (optional)
Integer *customerId = 56; //  (optional)

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

// Update Customer Details
[apiInstance apiCustomerUpdateprofilePostWith:appId
    type:type
    customerFirstName:customerFirstName
    customerLastName:customerLastName
    customerNickName:customerNickName
    customerPhone:customerPhone
    customerEmail:customerEmail
    customerBirthdate:customerBirthdate
    customerPostalCode:customerPostalCode
    customerAddressName2:customerAddressName2
    customerCompanyName:customerCompanyName
    customerAddressLine1:customerAddressLine1
    customerAddressLine2:customerAddressLine2
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.UserInfoApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'type': type_example // {{String}} 
  'customerFirstName': customerFirstName_example // {{String}} 
  'customerLastName': customerLastName_example // {{String}} 
  'customerNickName': customerNickName_example // {{String}} 
  'customerPhone': 56 // {{Integer}} 
  'customerEmail': customerEmail_example // {{String}} 
  'customerBirthdate': customerBirthdate_example // {{String}} 
  'customerPostalCode': customerPostalCode_example // {{String}} 
  'customerAddressName2': customerAddressName2_example // {{String}} 
  'customerCompanyName': customerCompanyName_example // {{String}} 
  'customerAddressLine1': customerAddressLine1_example // {{String}} 
  'customerAddressLine2': customerAddressLine2_example // {{String}} 
  'customerId': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCustomerUpdateprofilePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserInfoApi();
            var appId = appId_example;  // String |  (optional) 
            var type = type_example;  // String |  (optional) 
            var customerFirstName = customerFirstName_example;  // String |  (optional) 
            var customerLastName = customerLastName_example;  // String |  (optional) 
            var customerNickName = customerNickName_example;  // String |  (optional) 
            var customerPhone = 56;  // Integer |  (optional) 
            var customerEmail = customerEmail_example;  // String |  (optional) 
            var customerBirthdate = customerBirthdate_example;  // String |  (optional) 
            var customerPostalCode = customerPostalCode_example;  // String |  (optional) 
            var customerAddressName2 = customerAddressName2_example;  // String |  (optional) 
            var customerCompanyName = customerCompanyName_example;  // String |  (optional) 
            var customerAddressLine1 = customerAddressLine1_example;  // String |  (optional) 
            var customerAddressLine2 = customerAddressLine2_example;  // String |  (optional) 
            var customerId = 56;  // Integer |  (optional) 

            try
            {
                // Update Customer Details
                apiInstance.apiCustomerUpdateprofilePost(appId, type, customerFirstName, customerLastName, customerNickName, customerPhone, customerEmail, customerBirthdate, customerPostalCode, customerAddressName2, customerCompanyName, customerAddressLine1, customerAddressLine2, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInfoApi.apiCustomerUpdateprofilePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUserInfoApi();
$appId = appId_example; // String | 
$type = type_example; // String | 
$customerFirstName = customerFirstName_example; // String | 
$customerLastName = customerLastName_example; // String | 
$customerNickName = customerNickName_example; // String | 
$customerPhone = 56; // Integer | 
$customerEmail = customerEmail_example; // String | 
$customerBirthdate = customerBirthdate_example; // String | 
$customerPostalCode = customerPostalCode_example; // String | 
$customerAddressName2 = customerAddressName2_example; // String | 
$customerCompanyName = customerCompanyName_example; // String | 
$customerAddressLine1 = customerAddressLine1_example; // String | 
$customerAddressLine2 = customerAddressLine2_example; // String | 
$customerId = 56; // Integer | 

try {
    $api_instance->apiCustomerUpdateprofilePost($appId, $type, $customerFirstName, $customerLastName, $customerNickName, $customerPhone, $customerEmail, $customerBirthdate, $customerPostalCode, $customerAddressName2, $customerCompanyName, $customerAddressLine1, $customerAddressLine2, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling UserInfoApi->apiCustomerUpdateprofilePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInfoApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UserInfoApi->new();
my $appId = appId_example; # String | 
my $type = type_example; # String | 
my $customerFirstName = customerFirstName_example; # String | 
my $customerLastName = customerLastName_example; # String | 
my $customerNickName = customerNickName_example; # String | 
my $customerPhone = 56; # Integer | 
my $customerEmail = customerEmail_example; # String | 
my $customerBirthdate = customerBirthdate_example; # String | 
my $customerPostalCode = customerPostalCode_example; # String | 
my $customerAddressName2 = customerAddressName2_example; # String | 
my $customerCompanyName = customerCompanyName_example; # String | 
my $customerAddressLine1 = customerAddressLine1_example; # String | 
my $customerAddressLine2 = customerAddressLine2_example; # String | 
my $customerId = 56; # Integer | 

eval { 
    $api_instance->apiCustomerUpdateprofilePost(appId => $appId, type => $type, customerFirstName => $customerFirstName, customerLastName => $customerLastName, customerNickName => $customerNickName, customerPhone => $customerPhone, customerEmail => $customerEmail, customerBirthdate => $customerBirthdate, customerPostalCode => $customerPostalCode, customerAddressName2 => $customerAddressName2, customerCompanyName => $customerCompanyName, customerAddressLine1 => $customerAddressLine1, customerAddressLine2 => $customerAddressLine2, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling UserInfoApi->apiCustomerUpdateprofilePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UserInfoApi()
appId = appId_example # String |  (optional)
type = type_example # String |  (optional)
customerFirstName = customerFirstName_example # String |  (optional)
customerLastName = customerLastName_example # String |  (optional)
customerNickName = customerNickName_example # String |  (optional)
customerPhone = 56 # Integer |  (optional)
customerEmail = customerEmail_example # String |  (optional)
customerBirthdate = customerBirthdate_example # String |  (optional)
customerPostalCode = customerPostalCode_example # String |  (optional)
customerAddressName2 = customerAddressName2_example # String |  (optional)
customerCompanyName = customerCompanyName_example # String |  (optional)
customerAddressLine1 = customerAddressLine1_example # String |  (optional)
customerAddressLine2 = customerAddressLine2_example # String |  (optional)
customerId = 56 # Integer |  (optional)

try: 
    # Update Customer Details
    api_instance.api_customer_updateprofile_post(appId=appId, type=type, customerFirstName=customerFirstName, customerLastName=customerLastName, customerNickName=customerNickName, customerPhone=customerPhone, customerEmail=customerEmail, customerBirthdate=customerBirthdate, customerPostalCode=customerPostalCode, customerAddressName2=customerAddressName2, customerCompanyName=customerCompanyName, customerAddressLine1=customerAddressLine1, customerAddressLine2=customerAddressLine2, customerId=customerId)
except ApiException as e:
    print("Exception when calling UserInfoApi->apiCustomerUpdateprofilePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
type
String
customer_first_name
String
customer_last_name
String
customer_nick_name
String
customer_phone
Integer
customer_email
String
customer_birthdate
String
customer_postal_code
String
customer_address_name2
String
customer_company_name
String
customer_address_line1
String
customer_address_line2
String
customer_id
Integer

Responses

Status: 200 - OK


Vouchers

apiLoyaltyApplyLoyalityv1Post

Voucher Redeem

This request allows you to see the permissions that are granted to this account.


/api/loyalty/apply_loyalityv1

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/loyalty/apply_loyalityv1"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VouchersApi;

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

public class VouchersApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        VouchersApi apiInstance = new VouchersApi();
        String appId = appId_example; // String | 
        String productQty = productQty_example; // String | 
        String productVoucherPoints = productVoucherPoints_example; // String | 
        String customerId = customerId_example; // String | 
        String orderItemId = orderItemId_example; // String | 
        try {
            apiInstance.apiLoyaltyApplyLoyalityv1Post(appId, productQty, productVoucherPoints, customerId, orderItemId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VouchersApi#apiLoyaltyApplyLoyalityv1Post");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VouchersApi;

public class VouchersApiExample {

    public static void main(String[] args) {
        VouchersApi apiInstance = new VouchersApi();
        String appId = appId_example; // String | 
        String productQty = productQty_example; // String | 
        String productVoucherPoints = productVoucherPoints_example; // String | 
        String customerId = customerId_example; // String | 
        String orderItemId = orderItemId_example; // String | 
        try {
            apiInstance.apiLoyaltyApplyLoyalityv1Post(appId, productQty, productVoucherPoints, customerId, orderItemId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VouchersApi#apiLoyaltyApplyLoyalityv1Post");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *productQty = productQty_example; //  (optional)
String *productVoucherPoints = productVoucherPoints_example; //  (optional)
String *customerId = customerId_example; //  (optional)
String *orderItemId = orderItemId_example; //  (optional)

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

// Voucher Redeem
[apiInstance apiLoyaltyApplyLoyalityv1PostWith:appId
    productQty:productQty
    productVoucherPoints:productVoucherPoints
    customerId:customerId
    orderItemId:orderItemId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.VouchersApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'productQty': productQty_example // {{String}} 
  'productVoucherPoints': productVoucherPoints_example // {{String}} 
  'customerId': customerId_example // {{String}} 
  'orderItemId': orderItemId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiLoyaltyApplyLoyalityv1Post(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new VouchersApi();
            var appId = appId_example;  // String |  (optional) 
            var productQty = productQty_example;  // String |  (optional) 
            var productVoucherPoints = productVoucherPoints_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 
            var orderItemId = orderItemId_example;  // String |  (optional) 

            try
            {
                // Voucher Redeem
                apiInstance.apiLoyaltyApplyLoyalityv1Post(appId, productQty, productVoucherPoints, customerId, orderItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VouchersApi.apiLoyaltyApplyLoyalityv1Post: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiVouchersApi();
$appId = appId_example; // String | 
$productQty = productQty_example; // String | 
$productVoucherPoints = productVoucherPoints_example; // String | 
$customerId = customerId_example; // String | 
$orderItemId = orderItemId_example; // String | 

try {
    $api_instance->apiLoyaltyApplyLoyalityv1Post($appId, $productQty, $productVoucherPoints, $customerId, $orderItemId);
} catch (Exception $e) {
    echo 'Exception when calling VouchersApi->apiLoyaltyApplyLoyalityv1Post: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VouchersApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::VouchersApi->new();
my $appId = appId_example; # String | 
my $productQty = productQty_example; # String | 
my $productVoucherPoints = productVoucherPoints_example; # String | 
my $customerId = customerId_example; # String | 
my $orderItemId = orderItemId_example; # String | 

eval { 
    $api_instance->apiLoyaltyApplyLoyalityv1Post(appId => $appId, productQty => $productQty, productVoucherPoints => $productVoucherPoints, customerId => $customerId, orderItemId => $orderItemId);
};
if ($@) {
    warn "Exception when calling VouchersApi->apiLoyaltyApplyLoyalityv1Post: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.VouchersApi()
appId = appId_example # String |  (optional)
productQty = productQty_example # String |  (optional)
productVoucherPoints = productVoucherPoints_example # String |  (optional)
customerId = customerId_example # String |  (optional)
orderItemId = orderItemId_example # String |  (optional)

try: 
    # Voucher Redeem
    api_instance.api_loyalty_apply_loyalityv1_post(appId=appId, productQty=productQty, productVoucherPoints=productVoucherPoints, customerId=customerId, orderItemId=orderItemId)
except ApiException as e:
    print("Exception when calling VouchersApi->apiLoyaltyApplyLoyalityv1Post: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
product_qty
String
product_voucher_points
String
customer_id
String
order_item_id
String

Responses

Status: 200 - OK


apiOrdersv1AddVoucherRedeemPost

Voucher Redeem

This request allows you to see the permissions that are granted to this account.


/api/ordersv1/add_voucher_redeem

Usage and SDK Samples

curl -X POST\
\
-H "Content-Type: multipart/form-data,text/plain"\
"https://ccpl.ninjaos.com/ninjaos/api/ordersv1/add_voucher_redeem"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VouchersApi;

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

public class VouchersApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        VouchersApi apiInstance = new VouchersApi();
        String appId = appId_example; // String | 
        String productQty = productQty_example; // String | 
        String productVoucherPoints = productVoucherPoints_example; // String | 
        String customerId = customerId_example; // String | 
        String orderItemId = orderItemId_example; // String | 
        try {
            apiInstance.apiOrdersv1AddVoucherRedeemPost(appId, productQty, productVoucherPoints, customerId, orderItemId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VouchersApi#apiOrdersv1AddVoucherRedeemPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VouchersApi;

public class VouchersApiExample {

    public static void main(String[] args) {
        VouchersApi apiInstance = new VouchersApi();
        String appId = appId_example; // String | 
        String productQty = productQty_example; // String | 
        String productVoucherPoints = productVoucherPoints_example; // String | 
        String customerId = customerId_example; // String | 
        String orderItemId = orderItemId_example; // String | 
        try {
            apiInstance.apiOrdersv1AddVoucherRedeemPost(appId, productQty, productVoucherPoints, customerId, orderItemId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VouchersApi#apiOrdersv1AddVoucherRedeemPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; //  (optional)
String *productQty = productQty_example; //  (optional)
String *productVoucherPoints = productVoucherPoints_example; //  (optional)
String *customerId = customerId_example; //  (optional)
String *orderItemId = orderItemId_example; //  (optional)

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

// Voucher Redeem
[apiInstance apiOrdersv1AddVoucherRedeemPostWith:appId
    productQty:productQty
    productVoucherPoints:productVoucherPoints
    customerId:customerId
    orderItemId:orderItemId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.VouchersApi()
var opts = { 
  'appId': appId_example // {{String}} 
  'productQty': productQty_example // {{String}} 
  'productVoucherPoints': productVoucherPoints_example // {{String}} 
  'customerId': customerId_example // {{String}} 
  'orderItemId': orderItemId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiOrdersv1AddVoucherRedeemPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new VouchersApi();
            var appId = appId_example;  // String |  (optional) 
            var productQty = productQty_example;  // String |  (optional) 
            var productVoucherPoints = productVoucherPoints_example;  // String |  (optional) 
            var customerId = customerId_example;  // String |  (optional) 
            var orderItemId = orderItemId_example;  // String |  (optional) 

            try
            {
                // Voucher Redeem
                apiInstance.apiOrdersv1AddVoucherRedeemPost(appId, productQty, productVoucherPoints, customerId, orderItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VouchersApi.apiOrdersv1AddVoucherRedeemPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiVouchersApi();
$appId = appId_example; // String | 
$productQty = productQty_example; // String | 
$productVoucherPoints = productVoucherPoints_example; // String | 
$customerId = customerId_example; // String | 
$orderItemId = orderItemId_example; // String | 

try {
    $api_instance->apiOrdersv1AddVoucherRedeemPost($appId, $productQty, $productVoucherPoints, $customerId, $orderItemId);
} catch (Exception $e) {
    echo 'Exception when calling VouchersApi->apiOrdersv1AddVoucherRedeemPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VouchersApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::VouchersApi->new();
my $appId = appId_example; # String | 
my $productQty = productQty_example; # String | 
my $productVoucherPoints = productVoucherPoints_example; # String | 
my $customerId = customerId_example; # String | 
my $orderItemId = orderItemId_example; # String | 

eval { 
    $api_instance->apiOrdersv1AddVoucherRedeemPost(appId => $appId, productQty => $productQty, productVoucherPoints => $productVoucherPoints, customerId => $customerId, orderItemId => $orderItemId);
};
if ($@) {
    warn "Exception when calling VouchersApi->apiOrdersv1AddVoucherRedeemPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.VouchersApi()
appId = appId_example # String |  (optional)
productQty = productQty_example # String |  (optional)
productVoucherPoints = productVoucherPoints_example # String |  (optional)
customerId = customerId_example # String |  (optional)
orderItemId = orderItemId_example # String |  (optional)

try: 
    # Voucher Redeem
    api_instance.api_ordersv1_add_voucher_redeem_post(appId=appId, productQty=productQty, productVoucherPoints=productVoucherPoints, customerId=customerId, orderItemId=orderItemId)
except ApiException as e:
    print("Exception when calling VouchersApi->apiOrdersv1AddVoucherRedeemPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
app_id
String
product_qty
String
product_voucher_points
String
customer_id
String
order_item_id
String

Responses

Status: 200 - OK


apiPromotionApiV2VouchersGet

Get Vouchers History

This is an operation get orders report


/api/promotion_api_v2/vouchers

Usage and SDK Samples

curl -X GET\
\
"https://ccpl.ninjaos.com/ninjaos/api/promotion_api_v2/vouchers?app_id=&customer_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VouchersApi;

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

public class VouchersApiExample {

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

        // Configure OAuth2 access token for authorization: clientCredentials
        OAuth clientCredentials = (OAuth) defaultClient.getAuthentication("clientCredentials");
        clientCredentials.setAccessToken("YOUR ACCESS TOKEN");

        VouchersApi apiInstance = new VouchersApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String customerId = customerId_example; // String | Customer ID
        try {
            apiInstance.apiPromotionApiV2VouchersGet(appId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VouchersApi#apiPromotionApiV2VouchersGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VouchersApi;

public class VouchersApiExample {

    public static void main(String[] args) {
        VouchersApi apiInstance = new VouchersApi();
        String appId = appId_example; // String | App ID Which it refers unique id for every users
        String customerId = customerId_example; // String | Customer ID
        try {
            apiInstance.apiPromotionApiV2VouchersGet(appId, customerId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VouchersApi#apiPromotionApiV2VouchersGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: clientCredentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *appId = appId_example; // App ID Which it refers unique id for every users
String *customerId = customerId_example; // Customer ID

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

// Get Vouchers History
[apiInstance apiPromotionApiV2VouchersGetWith:appId
    customerId:customerId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NinjaOsApiReferenceDocs = require('ninja_os_api_reference_docs');
var defaultClient = NinjaOsApiReferenceDocs.ApiClient.instance;

// Configure OAuth2 access token for authorization: clientCredentials
var clientCredentials = defaultClient.authentications['clientCredentials'];
clientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NinjaOsApiReferenceDocs.VouchersApi()
var appId = appId_example; // {{String}} App ID Which it refers unique id for every users
var customerId = customerId_example; // {{String}} Customer ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiPromotionApiV2VouchersGet(appId, customerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: clientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new VouchersApi();
            var appId = appId_example;  // String | App ID Which it refers unique id for every users
            var customerId = customerId_example;  // String | Customer ID

            try
            {
                // Get Vouchers History
                apiInstance.apiPromotionApiV2VouchersGet(appId, customerId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VouchersApi.apiPromotionApiV2VouchersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: clientCredentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiVouchersApi();
$appId = appId_example; // String | App ID Which it refers unique id for every users
$customerId = customerId_example; // String | Customer ID

try {
    $api_instance->apiPromotionApiV2VouchersGet($appId, $customerId);
} catch (Exception $e) {
    echo 'Exception when calling VouchersApi->apiPromotionApiV2VouchersGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VouchersApi;

# Configure OAuth2 access token for authorization: clientCredentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::VouchersApi->new();
my $appId = appId_example; # String | App ID Which it refers unique id for every users
my $customerId = customerId_example; # String | Customer ID

eval { 
    $api_instance->apiPromotionApiV2VouchersGet(appId => $appId, customerId => $customerId);
};
if ($@) {
    warn "Exception when calling VouchersApi->apiPromotionApiV2VouchersGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: clientCredentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.VouchersApi()
appId = appId_example # String | App ID Which it refers unique id for every users
customerId = customerId_example # String | Customer ID

try: 
    # Get Vouchers History
    api_instance.api_promotion_api_v2_vouchers_get(appId, customerId)
except ApiException as e:
    print("Exception when calling VouchersApi->apiPromotionApiV2VouchersGet: %s\n" % e)

Parameters

Query parameters
Name Description
app_id*
String
App ID Which it refers unique id for every users
Required
customer_id*
String
Customer ID
Required

Responses

Status: 200 - OK