Assisted Webservices

ASMCustomer360

searchCustomer360

Retrieves the Customer 360 data.

Retrieves a list of Customer 360 data.


/{baseSiteId}/users/{userId}/customer360

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/assistedservicewebservices/{baseSiteId}/users/{userId}/customer360"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ASMCustomer360Api;

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

public class ASMCustomer360ApiExample {

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

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

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

        ASMCustomer360Api apiInstance = new ASMCustomer360Api();
        Customer360QueryList body = ; // Customer360QueryList | 
        String baseSiteId = baseSiteId_example; // String | Base site ID
        String userId = userId_example; // String | User identifier
        try {
            Customer360List result = apiInstance.searchCustomer360(body, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ASMCustomer360Api#searchCustomer360");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ASMCustomer360Api;

public class ASMCustomer360ApiExample {

    public static void main(String[] args) {
        ASMCustomer360Api apiInstance = new ASMCustomer360Api();
        Customer360QueryList body = ; // Customer360QueryList | 
        String baseSiteId = baseSiteId_example; // String | Base site ID
        String userId = userId_example; // String | User identifier
        try {
            Customer360List result = apiInstance.searchCustomer360(body, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ASMCustomer360Api#searchCustomer360");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Customer360QueryList *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site ID
String *userId = userId_example; // User identifier

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

// Retrieves the Customer 360 data.
[apiInstance searchCustomer360With:body
    baseSiteId:baseSiteId
    userId:userId
              completionHandler: ^(Customer360List output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssistedWebservices = require('assisted_webservices');
var defaultClient = AssistedWebservices.ApiClient.instance;

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

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

var api = new AssistedWebservices.ASMCustomer360Api()
var body = ; // {{Customer360QueryList}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site ID
var userId = userId_example; // {{String}} User identifier

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

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

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

            var apiInstance = new ASMCustomer360Api();
            var body = new Customer360QueryList(); // Customer360QueryList | 
            var baseSiteId = baseSiteId_example;  // String | Base site ID
            var userId = userId_example;  // String | User identifier

            try
            {
                // Retrieves the Customer 360 data.
                Customer360List result = apiInstance.searchCustomer360(body, baseSiteId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ASMCustomer360Api.searchCustomer360: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiASMCustomer360Api();
$body = ; // Customer360QueryList | 
$baseSiteId = baseSiteId_example; // String | Base site ID
$userId = userId_example; // String | User identifier

try {
    $result = $api_instance->searchCustomer360($body, $baseSiteId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ASMCustomer360Api->searchCustomer360: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ASMCustomer360Api;

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

my $api_instance = WWW::SwaggerClient::ASMCustomer360Api->new();
my $body = WWW::SwaggerClient::Object::Customer360QueryList->new(); # Customer360QueryList | 
my $baseSiteId = baseSiteId_example; # String | Base site ID
my $userId = userId_example; # String | User identifier

eval { 
    my $result = $api_instance->searchCustomer360(body => $body, baseSiteId => $baseSiteId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ASMCustomer360Api->searchCustomer360: $@\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: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ASMCustomer360Api()
body =  # Customer360QueryList | 
baseSiteId = baseSiteId_example # String | Base site ID
userId = userId_example # String | User identifier

try: 
    # Retrieves the Customer 360 data.
    api_response = api_instance.search_customer360(body, baseSiteId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ASMCustomer360Api->searchCustomer360: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site ID
Required
userId*
String
User identifier
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


CustomerListsController

getCustomerListDetails

Retrieves the details for a customer list

Retrieves the details of a customer list with a valid ID


/customerlists/{customerlist}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/assistedservicewebservices/customerlists/{customerlist}?baseSite="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerListsControllerApi;

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

public class CustomerListsControllerApiExample {

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

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

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

        CustomerListsControllerApi apiInstance = new CustomerListsControllerApi();
        String baseSite = baseSite_example; // String | ID of the base site
        String customerlist = customerlist_example; // String | ID of the customer list
        try {
            CustomerList result = apiInstance.getCustomerListDetails(baseSite, customerlist);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerListsControllerApi#getCustomerListDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerListsControllerApi;

public class CustomerListsControllerApiExample {

    public static void main(String[] args) {
        CustomerListsControllerApi apiInstance = new CustomerListsControllerApi();
        String baseSite = baseSite_example; // String | ID of the base site
        String customerlist = customerlist_example; // String | ID of the customer list
        try {
            CustomerList result = apiInstance.getCustomerListDetails(baseSite, customerlist);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerListsControllerApi#getCustomerListDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSite = baseSite_example; // ID of the base site
String *customerlist = customerlist_example; // ID of the customer list

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

// Retrieves the details for a customer list
[apiInstance getCustomerListDetailsWith:baseSite
    customerlist:customerlist
              completionHandler: ^(CustomerList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssistedWebservices = require('assisted_webservices');
var defaultClient = AssistedWebservices.ApiClient.instance;

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

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

var api = new AssistedWebservices.CustomerListsControllerApi()
var baseSite = baseSite_example; // {{String}} ID of the base site
var customerlist = customerlist_example; // {{String}} ID of the customer list

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

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

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

            var apiInstance = new CustomerListsControllerApi();
            var baseSite = baseSite_example;  // String | ID of the base site
            var customerlist = customerlist_example;  // String | ID of the customer list

            try
            {
                // Retrieves the details for a customer list
                CustomerList result = apiInstance.getCustomerListDetails(baseSite, customerlist);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerListsControllerApi.getCustomerListDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCustomerListsControllerApi();
$baseSite = baseSite_example; // String | ID of the base site
$customerlist = customerlist_example; // String | ID of the customer list

try {
    $result = $api_instance->getCustomerListDetails($baseSite, $customerlist);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerListsControllerApi->getCustomerListDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerListsControllerApi;

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

my $api_instance = WWW::SwaggerClient::CustomerListsControllerApi->new();
my $baseSite = baseSite_example; # String | ID of the base site
my $customerlist = customerlist_example; # String | ID of the customer list

eval { 
    my $result = $api_instance->getCustomerListDetails(baseSite => $baseSite, customerlist => $customerlist);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerListsControllerApi->getCustomerListDetails: $@\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: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerListsControllerApi()
baseSite = baseSite_example # String | ID of the base site
customerlist = customerlist_example # String | ID of the customer list

try: 
    # Retrieves the details for a customer list
    api_response = api_instance.get_customer_list_details(baseSite, customerlist)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerListsControllerApi->getCustomerListDetails: %s\n" % e)

Parameters

Path parameters
Name Description
customerlist*
String
ID of the customer list
Required
Query parameters
Name Description
baseSite*
String
ID of the base site
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCustomerLists

Retrieves customer lists

Retrieves a list of all customer lists. This can only be done when logged in ASM.


/customerlists

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/assistedservicewebservices/customerlists?baseSite="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerListsControllerApi;

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

public class CustomerListsControllerApiExample {

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

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

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

        CustomerListsControllerApi apiInstance = new CustomerListsControllerApi();
        String baseSite = baseSite_example; // String | ID of the base site
        try {
            UserGroupList result = apiInstance.getCustomerLists(baseSite);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerListsControllerApi#getCustomerLists");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerListsControllerApi;

public class CustomerListsControllerApiExample {

    public static void main(String[] args) {
        CustomerListsControllerApi apiInstance = new CustomerListsControllerApi();
        String baseSite = baseSite_example; // String | ID of the base site
        try {
            UserGroupList result = apiInstance.getCustomerLists(baseSite);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerListsControllerApi#getCustomerLists");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSite = baseSite_example; // ID of the base site

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

// Retrieves customer lists
[apiInstance getCustomerListsWith:baseSite
              completionHandler: ^(UserGroupList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssistedWebservices = require('assisted_webservices');
var defaultClient = AssistedWebservices.ApiClient.instance;

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

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

var api = new AssistedWebservices.CustomerListsControllerApi()
var baseSite = baseSite_example; // {{String}} ID of the base site

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

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

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

            var apiInstance = new CustomerListsControllerApi();
            var baseSite = baseSite_example;  // String | ID of the base site

            try
            {
                // Retrieves customer lists
                UserGroupList result = apiInstance.getCustomerLists(baseSite);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerListsControllerApi.getCustomerLists: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCustomerListsControllerApi();
$baseSite = baseSite_example; // String | ID of the base site

try {
    $result = $api_instance->getCustomerLists($baseSite);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerListsControllerApi->getCustomerLists: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerListsControllerApi;

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

my $api_instance = WWW::SwaggerClient::CustomerListsControllerApi->new();
my $baseSite = baseSite_example; # String | ID of the base site

eval { 
    my $result = $api_instance->getCustomerLists(baseSite => $baseSite);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerListsControllerApi->getCustomerLists: $@\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: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerListsControllerApi()
baseSite = baseSite_example # String | ID of the base site

try: 
    # Retrieves customer lists
    api_response = api_instance.get_customer_lists(baseSite)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerListsControllerApi->getCustomerLists: %s\n" % e)

Parameters

Query parameters
Name Description
baseSite*
String
ID of the base site
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


CustomersController

autoComplete

Retrieves autocomplete information on customers based on the customer query


/customers/autocomplete

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json"\
"http://localhost:9001/assistedservicewebservices/customers/autocomplete?baseSite=&customerQuery="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersControllerApi;

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

public class CustomersControllerApiExample {

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

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

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

        CustomersControllerApi apiInstance = new CustomersControllerApi();
        String baseSite = baseSite_example; // String | ID of the base site
        String customerQuery = customerQuery_example; // String | Customer query: first characters of customer email or part of name. A BadRequestException is thrown when the query is too short. Minimum query length can be updated via `assistedserviceswebservices.customer.suggestions.minimum.query.length` property.
        try {
            array[CustomerSuggestion] result = apiInstance.autoComplete(baseSite, customerQuery);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersControllerApi#autoComplete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersControllerApi;

public class CustomersControllerApiExample {

    public static void main(String[] args) {
        CustomersControllerApi apiInstance = new CustomersControllerApi();
        String baseSite = baseSite_example; // String | ID of the base site
        String customerQuery = customerQuery_example; // String | Customer query: first characters of customer email or part of name. A BadRequestException is thrown when the query is too short. Minimum query length can be updated via `assistedserviceswebservices.customer.suggestions.minimum.query.length` property.
        try {
            array[CustomerSuggestion] result = apiInstance.autoComplete(baseSite, customerQuery);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersControllerApi#autoComplete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSite = baseSite_example; // ID of the base site
String *customerQuery = customerQuery_example; // Customer query: first characters of customer email or part of name. A BadRequestException is thrown when the query is too short. Minimum query length can be updated via `assistedserviceswebservices.customer.suggestions.minimum.query.length` property.

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

// Retrieves autocomplete information on customers based on the customer query
[apiInstance autoCompleteWith:baseSite
    customerQuery:customerQuery
              completionHandler: ^(array[CustomerSuggestion] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssistedWebservices = require('assisted_webservices');
var defaultClient = AssistedWebservices.ApiClient.instance;

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

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

var api = new AssistedWebservices.CustomersControllerApi()
var baseSite = baseSite_example; // {{String}} ID of the base site
var customerQuery = customerQuery_example; // {{String}} Customer query: first characters of customer email or part of name. A BadRequestException is thrown when the query is too short. Minimum query length can be updated via `assistedserviceswebservices.customer.suggestions.minimum.query.length` property.

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

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

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

            var apiInstance = new CustomersControllerApi();
            var baseSite = baseSite_example;  // String | ID of the base site
            var customerQuery = customerQuery_example;  // String | Customer query: first characters of customer email or part of name. A BadRequestException is thrown when the query is too short. Minimum query length can be updated via `assistedserviceswebservices.customer.suggestions.minimum.query.length` property.

            try
            {
                // Retrieves autocomplete information on customers based on the customer query
                array[CustomerSuggestion] result = apiInstance.autoComplete(baseSite, customerQuery);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersControllerApi.autoComplete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCustomersControllerApi();
$baseSite = baseSite_example; // String | ID of the base site
$customerQuery = customerQuery_example; // String | Customer query: first characters of customer email or part of name. A BadRequestException is thrown when the query is too short. Minimum query length can be updated via `assistedserviceswebservices.customer.suggestions.minimum.query.length` property.

try {
    $result = $api_instance->autoComplete($baseSite, $customerQuery);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersControllerApi->autoComplete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomersControllerApi;

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

my $api_instance = WWW::SwaggerClient::CustomersControllerApi->new();
my $baseSite = baseSite_example; # String | ID of the base site
my $customerQuery = customerQuery_example; # String | Customer query: first characters of customer email or part of name. A BadRequestException is thrown when the query is too short. Minimum query length can be updated via `assistedserviceswebservices.customer.suggestions.minimum.query.length` property.

eval { 
    my $result = $api_instance->autoComplete(baseSite => $baseSite, customerQuery => $customerQuery);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomersControllerApi->autoComplete: $@\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: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomersControllerApi()
baseSite = baseSite_example # String | ID of the base site
customerQuery = customerQuery_example # String | Customer query: first characters of customer email or part of name. A BadRequestException is thrown when the query is too short. Minimum query length can be updated via `assistedserviceswebservices.customer.suggestions.minimum.query.length` property.

try: 
    # Retrieves autocomplete information on customers based on the customer query
    api_response = api_instance.auto_complete(baseSite, customerQuery)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomersControllerApi->autoComplete: %s\n" % e)

Parameters

Query parameters
Name Description
baseSite*
String
ID of the base site
Required
customerQuery*
String
Customer query: first characters of customer email or part of name. A BadRequestException is thrown when the query is too short. Minimum query length can be updated via `assistedserviceswebservices.customer.suggestions.minimum.query.length` property.
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


bindCart

Creates a bind between the provided customer ID and an anonymous cart.


/bind-cart

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/assistedservicewebservices/bind-cart?baseSite=&cartId=&customerId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersControllerApi;

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

public class CustomersControllerApiExample {

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

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

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

        CustomersControllerApi apiInstance = new CustomersControllerApi();
        String baseSite = baseSite_example; // String | ID of the base site
        String cartId = cartId_example; // String | ID of the anonymous Cart
        String customerId = customerId_example; // String | ID of the Customer
        try {
            'String' result = apiInstance.bindCart(baseSite, cartId, customerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersControllerApi#bindCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersControllerApi;

public class CustomersControllerApiExample {

    public static void main(String[] args) {
        CustomersControllerApi apiInstance = new CustomersControllerApi();
        String baseSite = baseSite_example; // String | ID of the base site
        String cartId = cartId_example; // String | ID of the anonymous Cart
        String customerId = customerId_example; // String | ID of the Customer
        try {
            'String' result = apiInstance.bindCart(baseSite, cartId, customerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersControllerApi#bindCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSite = baseSite_example; // ID of the base site
String *cartId = cartId_example; // ID of the anonymous Cart
String *customerId = customerId_example; // ID of the Customer

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

// Creates a bind between the provided customer ID and an anonymous cart.
[apiInstance bindCartWith:baseSite
    cartId:cartId
    customerId:customerId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssistedWebservices = require('assisted_webservices');
var defaultClient = AssistedWebservices.ApiClient.instance;

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

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

var api = new AssistedWebservices.CustomersControllerApi()
var baseSite = baseSite_example; // {{String}} ID of the base site
var cartId = cartId_example; // {{String}} ID of the anonymous Cart
var customerId = customerId_example; // {{String}} ID of the Customer

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

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

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

            var apiInstance = new CustomersControllerApi();
            var baseSite = baseSite_example;  // String | ID of the base site
            var cartId = cartId_example;  // String | ID of the anonymous Cart
            var customerId = customerId_example;  // String | ID of the Customer

            try
            {
                // Creates a bind between the provided customer ID and an anonymous cart.
                'String' result = apiInstance.bindCart(baseSite, cartId, customerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersControllerApi.bindCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCustomersControllerApi();
$baseSite = baseSite_example; // String | ID of the base site
$cartId = cartId_example; // String | ID of the anonymous Cart
$customerId = customerId_example; // String | ID of the Customer

try {
    $result = $api_instance->bindCart($baseSite, $cartId, $customerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersControllerApi->bindCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomersControllerApi;

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

my $api_instance = WWW::SwaggerClient::CustomersControllerApi->new();
my $baseSite = baseSite_example; # String | ID of the base site
my $cartId = cartId_example; # String | ID of the anonymous Cart
my $customerId = customerId_example; # String | ID of the Customer

eval { 
    my $result = $api_instance->bindCart(baseSite => $baseSite, cartId => $cartId, customerId => $customerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomersControllerApi->bindCart: $@\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: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomersControllerApi()
baseSite = baseSite_example # String | ID of the base site
cartId = cartId_example # String | ID of the anonymous Cart
customerId = customerId_example # String | ID of the Customer

try: 
    # Creates a bind between the provided customer ID and an anonymous cart.
    api_response = api_instance.bind_cart(baseSite, cartId, customerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomersControllerApi->bindCart: %s\n" % e)

Parameters

Query parameters
Name Description
baseSite*
String
ID of the base site
Required
cartId*
String
ID of the anonymous Cart
Required
customerId*
String
ID of the Customer
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getPageableCustomers

Retrieves customers

Retrieves a paginated list of customers based on the provided query parameters. If a query term is present it will return customers based on that provided value. If the customerListId is present, it will ignore the query term and only retrieve customers that are associated to that customer list. If orderId parameter is present, it will ignore the previous parameters and it will retrieve the customer associated to the given order. This can only be done by a user who is logged in ASM.


/customers/search

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/assistedservicewebservices/customers/search?baseSite=¤tPage=&customerListId=&orderId=&pageSize=&query=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersControllerApi;

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

public class CustomersControllerApiExample {

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

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

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

        CustomersControllerApi apiInstance = new CustomersControllerApi();
        String baseSite = baseSite_example; // String | ID of the base site
        Integer currentPage = 56; // Integer | Current page
        String customerListId = customerListId_example; // String | ID of the customer list
        String orderId = orderId_example; // String | ID of the order
        Integer pageSize = 56; // Integer | Page size
        String query = query_example; // String | Customer unique ID search term
        String sort = sort_example; // String | Sort parameter. Possible values include: byUidAsc, byUidDesc,  byNameAsc, byNameDesc
        try {
            CustomerSearchPage result = apiInstance.getPageableCustomers(baseSite, currentPage, customerListId, orderId, pageSize, query, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersControllerApi#getPageableCustomers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersControllerApi;

public class CustomersControllerApiExample {

    public static void main(String[] args) {
        CustomersControllerApi apiInstance = new CustomersControllerApi();
        String baseSite = baseSite_example; // String | ID of the base site
        Integer currentPage = 56; // Integer | Current page
        String customerListId = customerListId_example; // String | ID of the customer list
        String orderId = orderId_example; // String | ID of the order
        Integer pageSize = 56; // Integer | Page size
        String query = query_example; // String | Customer unique ID search term
        String sort = sort_example; // String | Sort parameter. Possible values include: byUidAsc, byUidDesc,  byNameAsc, byNameDesc
        try {
            CustomerSearchPage result = apiInstance.getPageableCustomers(baseSite, currentPage, customerListId, orderId, pageSize, query, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersControllerApi#getPageableCustomers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSite = baseSite_example; // ID of the base site
Integer *currentPage = 56; // Current page (optional) (default to 0)
String *customerListId = customerListId_example; // ID of the customer list (optional)
String *orderId = orderId_example; // ID of the order (optional)
Integer *pageSize = 56; // Page size (optional) (default to 20)
String *query = query_example; // Customer unique ID search term (optional)
String *sort = sort_example; // Sort parameter. Possible values include: byUidAsc, byUidDesc,  byNameAsc, byNameDesc (optional)

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

// Retrieves customers
[apiInstance getPageableCustomersWith:baseSite
    currentPage:currentPage
    customerListId:customerListId
    orderId:orderId
    pageSize:pageSize
    query:query
    sort:sort
              completionHandler: ^(CustomerSearchPage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssistedWebservices = require('assisted_webservices');
var defaultClient = AssistedWebservices.ApiClient.instance;

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

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

var api = new AssistedWebservices.CustomersControllerApi()
var baseSite = baseSite_example; // {{String}} ID of the base site
var opts = { 
  'currentPage': 56, // {{Integer}} Current page
  'customerListId': customerListId_example, // {{String}} ID of the customer list
  'orderId': orderId_example, // {{String}} ID of the order
  'pageSize': 56, // {{Integer}} Page size
  'query': query_example, // {{String}} Customer unique ID search term
  'sort': sort_example // {{String}} Sort parameter. Possible values include: byUidAsc, byUidDesc,  byNameAsc, byNameDesc
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPageableCustomers(baseSite, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CustomersControllerApi();
            var baseSite = baseSite_example;  // String | ID of the base site
            var currentPage = 56;  // Integer | Current page (optional)  (default to 0)
            var customerListId = customerListId_example;  // String | ID of the customer list (optional) 
            var orderId = orderId_example;  // String | ID of the order (optional) 
            var pageSize = 56;  // Integer | Page size (optional)  (default to 20)
            var query = query_example;  // String | Customer unique ID search term (optional) 
            var sort = sort_example;  // String | Sort parameter. Possible values include: byUidAsc, byUidDesc,  byNameAsc, byNameDesc (optional) 

            try
            {
                // Retrieves customers
                CustomerSearchPage result = apiInstance.getPageableCustomers(baseSite, currentPage, customerListId, orderId, pageSize, query, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersControllerApi.getPageableCustomers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCustomersControllerApi();
$baseSite = baseSite_example; // String | ID of the base site
$currentPage = 56; // Integer | Current page
$customerListId = customerListId_example; // String | ID of the customer list
$orderId = orderId_example; // String | ID of the order
$pageSize = 56; // Integer | Page size
$query = query_example; // String | Customer unique ID search term
$sort = sort_example; // String | Sort parameter. Possible values include: byUidAsc, byUidDesc,  byNameAsc, byNameDesc

try {
    $result = $api_instance->getPageableCustomers($baseSite, $currentPage, $customerListId, $orderId, $pageSize, $query, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersControllerApi->getPageableCustomers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomersControllerApi;

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

my $api_instance = WWW::SwaggerClient::CustomersControllerApi->new();
my $baseSite = baseSite_example; # String | ID of the base site
my $currentPage = 56; # Integer | Current page
my $customerListId = customerListId_example; # String | ID of the customer list
my $orderId = orderId_example; # String | ID of the order
my $pageSize = 56; # Integer | Page size
my $query = query_example; # String | Customer unique ID search term
my $sort = sort_example; # String | Sort parameter. Possible values include: byUidAsc, byUidDesc,  byNameAsc, byNameDesc

eval { 
    my $result = $api_instance->getPageableCustomers(baseSite => $baseSite, currentPage => $currentPage, customerListId => $customerListId, orderId => $orderId, pageSize => $pageSize, query => $query, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomersControllerApi->getPageableCustomers: $@\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: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomersControllerApi()
baseSite = baseSite_example # String | ID of the base site
currentPage = 56 # Integer | Current page (optional) (default to 0)
customerListId = customerListId_example # String | ID of the customer list (optional)
orderId = orderId_example # String | ID of the order (optional)
pageSize = 56 # Integer | Page size (optional) (default to 20)
query = query_example # String | Customer unique ID search term (optional)
sort = sort_example # String | Sort parameter. Possible values include: byUidAsc, byUidDesc,  byNameAsc, byNameDesc (optional)

try: 
    # Retrieves customers
    api_response = api_instance.get_pageable_customers(baseSite, currentPage=currentPage, customerListId=customerListId, orderId=orderId, pageSize=pageSize, query=query, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomersControllerApi->getPageableCustomers: %s\n" % e)

Parameters

Query parameters
Name Description
baseSite*
String
ID of the base site
Required
currentPage
Integer (int32)
Current page
customerListId
String
ID of the customer list
orderId
String
ID of the order
pageSize
Integer (int32)
Page size
query
String
Customer unique ID search term
sort
String
Sort parameter. Possible values include: byUidAsc, byUidDesc, byNameAsc, byNameDesc

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found