ShopManager API

Address

addressBook

Gets the address book of the currently logged in user


/shop-api/address-book

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://localhost/shop-api/address-book"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressApi;

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

public class AddressApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AddressApi apiInstance = new AddressApi();
        try {
            LoggedInCustomerAddressBook result = apiInstance.addressBook();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#addressBook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressApi;

public class AddressApiExample {

    public static void main(String[] args) {
        AddressApi apiInstance = new AddressApi();
        try {
            LoggedInCustomerAddressBook result = apiInstance.addressBook();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#addressBook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Gets the address book of the currently logged in user
[apiInstance addressBookWithCompletionHandler: 
              ^(LoggedInCustomerAddressBook output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');
var defaultClient = ShopManagerApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new ShopManagerApi.AddressApi()

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

namespace Example
{
    public class addressBookExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AddressApi();

            try
            {
                // Gets the address book of the currently logged in user
                LoggedInCustomerAddressBook result = apiInstance.addressBook();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressApi.addressBook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AddressApi();

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

# Configure API key authorization: bearerAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressApi->new();

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

# Configure API key authorization: bearerAuth
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressApi()

try: 
    # Gets the address book of the currently logged in user
    api_response = api_instance.address_book()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressApi->addressBook: %s\n" % e)

Parameters

Responses

Status: 200 - Successfully fetched Address Book

Status: 500 - User not logged in


createAddress

Creates a new address in the the address book


/shop-api/address-book

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "http://localhost/shop-api/address-book"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressApi;

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

public class AddressApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AddressApi apiInstance = new AddressApi();
        LoggedInCustomerAddressBookAddress content = ; // LoggedInCustomerAddressBookAddress | 
        try {
            LoggedInCustomerAddressBookAddress result = apiInstance.createAddress(content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#createAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressApi;

public class AddressApiExample {

    public static void main(String[] args) {
        AddressApi apiInstance = new AddressApi();
        LoggedInCustomerAddressBookAddress content = ; // LoggedInCustomerAddressBookAddress | 
        try {
            LoggedInCustomerAddressBookAddress result = apiInstance.createAddress(content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#createAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

LoggedInCustomerAddressBookAddress *content = ; // 

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

// Creates a new address in the the address book
[apiInstance createAddressWith:content
              completionHandler: ^(LoggedInCustomerAddressBookAddress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');
var defaultClient = ShopManagerApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new ShopManagerApi.AddressApi()

var content = ; // {LoggedInCustomerAddressBookAddress} 


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

namespace Example
{
    public class createAddressExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AddressApi();
            var content = new LoggedInCustomerAddressBookAddress(); // LoggedInCustomerAddressBookAddress | 

            try
            {
                // Creates a new address in the the address book
                LoggedInCustomerAddressBookAddress result = apiInstance.createAddress(content);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressApi.createAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AddressApi();
$content = ; // LoggedInCustomerAddressBookAddress | 

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

# Configure API key authorization: bearerAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressApi->new();
my $content = WWW::SwaggerClient::Object::LoggedInCustomerAddressBookAddress->new(); # LoggedInCustomerAddressBookAddress | 

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

# Configure API key authorization: bearerAuth
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressApi()
content =  # LoggedInCustomerAddressBookAddress | 

try: 
    # Creates a new address in the the address book
    api_response = api_instance.create_address(content)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressApi->createAddress: %s\n" % e)

Parameters

Body parameters
Name Description
content *

Responses

Status: 201 - Successfully created the address

Status: 400 - Validation failed

Status: 401 - No user is logged in

Status: 500 - The user does not own the address


deleteAddress

Deletes an address from the address book


/shop-api/address-book/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "http://localhost/shop-api/address-book/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressApi;

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

public class AddressApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AddressApi apiInstance = new AddressApi();
        Integer id = 56; // Integer | Id of the address to update
        try {
            apiInstance.deleteAddress(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#deleteAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressApi;

public class AddressApiExample {

    public static void main(String[] args) {
        AddressApi apiInstance = new AddressApi();
        Integer id = 56; // Integer | Id of the address to update
        try {
            apiInstance.deleteAddress(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#deleteAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

Integer *id = 56; // Id of the address to update

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

// Deletes an address from the address book
[apiInstance deleteAddressWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');
var defaultClient = ShopManagerApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new ShopManagerApi.AddressApi()

var id = 56; // {Integer} Id of the address to update


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

namespace Example
{
    public class deleteAddressExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AddressApi();
            var id = 56;  // Integer | Id of the address to update

            try
            {
                // Deletes an address from the address book
                apiInstance.deleteAddress(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressApi.deleteAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AddressApi();
$id = 56; // Integer | Id of the address to update

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

# Configure API key authorization: bearerAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressApi->new();
my $id = 56; # Integer | Id of the address to update

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

# Configure API key authorization: bearerAuth
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressApi()
id = 56 # Integer | Id of the address to update

try: 
    # Deletes an address from the address book
    api_instance.delete_address(id)
except ApiException as e:
    print("Exception when calling AddressApi->deleteAddress: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
Id of the address to update
Required

Responses

Status: 204 - Successfully removed the address

Status: 400 - Validation failed

Status: 401 - No user is logged in

Status: 500 - The user does not own the address


updateAddressBook

Updates an address in the address book


/shop-api/address-book/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "http://localhost/shop-api/address-book/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressApi;

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

public class AddressApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AddressApi apiInstance = new AddressApi();
        Integer id = 56; // Integer | Id of the address to update
        LoggedInCustomerAddressBookAddress content = ; // LoggedInCustomerAddressBookAddress | 
        try {
            LoggedInCustomerAddressBookAddress result = apiInstance.updateAddressBook(id, content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#updateAddressBook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressApi;

public class AddressApiExample {

    public static void main(String[] args) {
        AddressApi apiInstance = new AddressApi();
        Integer id = 56; // Integer | Id of the address to update
        LoggedInCustomerAddressBookAddress content = ; // LoggedInCustomerAddressBookAddress | 
        try {
            LoggedInCustomerAddressBookAddress result = apiInstance.updateAddressBook(id, content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#updateAddressBook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

Integer *id = 56; // Id of the address to update
LoggedInCustomerAddressBookAddress *content = ; // 

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

// Updates an address in the address book
[apiInstance updateAddressBookWith:id
    content:content
              completionHandler: ^(LoggedInCustomerAddressBookAddress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');
var defaultClient = ShopManagerApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new ShopManagerApi.AddressApi()

var id = 56; // {Integer} Id of the address to update

var content = ; // {LoggedInCustomerAddressBookAddress} 


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

namespace Example
{
    public class updateAddressBookExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AddressApi();
            var id = 56;  // Integer | Id of the address to update
            var content = new LoggedInCustomerAddressBookAddress(); // LoggedInCustomerAddressBookAddress | 

            try
            {
                // Updates an address in the address book
                LoggedInCustomerAddressBookAddress result = apiInstance.updateAddressBook(id, content);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressApi.updateAddressBook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AddressApi();
$id = 56; // Integer | Id of the address to update
$content = ; // LoggedInCustomerAddressBookAddress | 

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

# Configure API key authorization: bearerAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressApi->new();
my $id = 56; # Integer | Id of the address to update
my $content = WWW::SwaggerClient::Object::LoggedInCustomerAddressBookAddress->new(); # LoggedInCustomerAddressBookAddress | 

eval { 
    my $result = $api_instance->updateAddressBook(id => $id, content => $content);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressApi->updateAddressBook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressApi()
id = 56 # Integer | Id of the address to update
content =  # LoggedInCustomerAddressBookAddress | 

try: 
    # Updates an address in the address book
    api_response = api_instance.update_address_book(id, content)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressApi->updateAddressBook: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
Id of the address to update
Required
Body parameters
Name Description
content *

Responses

Status: 200 - Successfully updated the address

Status: 400 - Validation failed

Status: 401 - No user is logged in

Status: 500 - The user does not own the address


updateDefaultAddress

Change the default address in the address book


/shop-api/address-book/{id}/default

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "http://localhost/shop-api/address-book/{id}/default"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressApi;

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

public class AddressApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        AddressApi apiInstance = new AddressApi();
        Integer id = 56; // Integer | Id of the address to be the default address
        try {
            apiInstance.updateDefaultAddress(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#updateDefaultAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressApi;

public class AddressApiExample {

    public static void main(String[] args) {
        AddressApi apiInstance = new AddressApi();
        Integer id = 56; // Integer | Id of the address to be the default address
        try {
            apiInstance.updateDefaultAddress(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#updateDefaultAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

Integer *id = 56; // Id of the address to be the default address

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

// Change the default address in the address book
[apiInstance updateDefaultAddressWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');
var defaultClient = ShopManagerApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new ShopManagerApi.AddressApi()

var id = 56; // {Integer} Id of the address to be the default address


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

namespace Example
{
    public class updateDefaultAddressExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AddressApi();
            var id = 56;  // Integer | Id of the address to be the default address

            try
            {
                // Change the default address in the address book
                apiInstance.updateDefaultAddress(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressApi.updateDefaultAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AddressApi();
$id = 56; // Integer | Id of the address to be the default address

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

# Configure API key authorization: bearerAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressApi->new();
my $id = 56; # Integer | Id of the address to be the default address

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

# Configure API key authorization: bearerAuth
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressApi()
id = 56 # Integer | Id of the address to be the default address

try: 
    # Change the default address in the address book
    api_instance.update_default_address(id)
except ApiException as e:
    print("Exception when calling AddressApi->updateDefaultAddress: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
Id of the address to be the default address
Required

Responses

Status: 204 - Successfully updated the address

Status: 400 - Validation failed

Status: 401 - No user is logged in

Status: 500 - The user does not own the address


Cart

cartAddCoupon

Add a promotion coupon code to the cart.

This endpoint will allow you to add a promotion coupon code to the cart and receive the discount.


/shop-api/carts/{token}/coupon

Usage and SDK Samples

curl -X PUT "http://localhost/shop-api/carts/{token}/coupon"
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) {
        
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        AddCouponRequest content = ; // AddCouponRequest | 
        try {
            apiInstance.cartAddCoupon(token, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartAddCoupon");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        AddCouponRequest content = ; // AddCouponRequest | 
        try {
            apiInstance.cartAddCoupon(token, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartAddCoupon");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.
AddCouponRequest *content = ; // 

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

// Add a promotion coupon code to the cart.
[apiInstance cartAddCouponWith:token
    content:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CartApi()

var token = token_example; // {String} Cart identifier.

var content = ; // {AddCouponRequest} 


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

namespace Example
{
    public class cartAddCouponExample
    {
        public void main()
        {
            
            var apiInstance = new CartApi();
            var token = token_example;  // String | Cart identifier.
            var content = new AddCouponRequest(); // AddCouponRequest | 

            try
            {
                // Add a promotion coupon code to the cart.
                apiInstance.cartAddCoupon(token, content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.cartAddCoupon: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CartApi();
$token = token_example; // String | Cart identifier.
$content = ; // AddCouponRequest | 

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

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $token = token_example; # String | Cart identifier.
my $content = WWW::SwaggerClient::Object::AddCouponRequest->new(); # AddCouponRequest | 

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

# create an instance of the API class
api_instance = swagger_client.CartApi()
token = token_example # String | Cart identifier.
content =  # AddCouponRequest | 

try: 
    # Add a promotion coupon code to the cart.
    api_instance.cart_add_coupon(token, content)
except ApiException as e:
    print("Exception when calling CartApi->cartAddCoupon: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required
Body parameters
Name Description
content *

Responses

Status: 204 - Coupon has been assigned to the cart.

Status: 400 - Invalid input, validation failed.


cartAddItem

Add an item to your cart.

This endpoint will allow you to add a new item to your cart.


/shop-api/carts/{token}/items

Usage and SDK Samples

curl -X POST "http://localhost/shop-api/carts/{token}/items"
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) {
        
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        PutItemToCartRequest content = ; // PutItemToCartRequest | Description of an item. The smallest required amount of data is a product code and quantity for a simple product. Configurable products will require an additional `variant_code` or `options` field, but never both.
        try {
            Cart result = apiInstance.cartAddItem(token, content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartAddItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        PutItemToCartRequest content = ; // PutItemToCartRequest | Description of an item. The smallest required amount of data is a product code and quantity for a simple product. Configurable products will require an additional `variant_code` or `options` field, but never both.
        try {
            Cart result = apiInstance.cartAddItem(token, content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartAddItem");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.
PutItemToCartRequest *content = ; // Description of an item. The smallest required amount of data is a product code and quantity for a simple product. Configurable products will require an additional `variant_code` or `options` field, but never both.

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

// Add an item to your cart.
[apiInstance cartAddItemWith:token
    content:content
              completionHandler: ^(Cart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CartApi()

var token = token_example; // {String} Cart identifier.

var content = ; // {PutItemToCartRequest} Description of an item. The smallest required amount of data is a product code and quantity for a simple product. Configurable products will require an additional `variant_code` or `options` field, but never both.


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

namespace Example
{
    public class cartAddItemExample
    {
        public void main()
        {
            
            var apiInstance = new CartApi();
            var token = token_example;  // String | Cart identifier.
            var content = new PutItemToCartRequest(); // PutItemToCartRequest | Description of an item. The smallest required amount of data is a product code and quantity for a simple product. Configurable products will require an additional `variant_code` or `options` field, but never both.

            try
            {
                // Add an item to your cart.
                Cart result = apiInstance.cartAddItem(token, content);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.cartAddItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CartApi();
$token = token_example; // String | Cart identifier.
$content = ; // PutItemToCartRequest | Description of an item. The smallest required amount of data is a product code and quantity for a simple product. Configurable products will require an additional `variant_code` or `options` field, but never both.

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

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $token = token_example; # String | Cart identifier.
my $content = WWW::SwaggerClient::Object::PutItemToCartRequest->new(); # PutItemToCartRequest | Description of an item. The smallest required amount of data is a product code and quantity for a simple product. Configurable products will require an additional `variant_code` or `options` field, but never both.

eval { 
    my $result = $api_instance->cartAddItem(token => $token, content => $content);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartApi->cartAddItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CartApi()
token = token_example # String | Cart identifier.
content =  # PutItemToCartRequest | Description of an item. The smallest required amount of data is a product code and quantity for a simple product. Configurable products will require an additional `variant_code` or `options` field, but never both.

try: 
    # Add an item to your cart.
    api_response = api_instance.cart_add_item(token, content)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartApi->cartAddItem: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required
Body parameters
Name Description
content *

Responses

Status: 201 - Item has been added to the cart

Status: 400 - Invalid input, validation failed.


cartDeleteItem

Remove cart item.

This endpoint will remove one item from your cart


/shop-api/carts/{token}/items/{identifier}

Usage and SDK Samples

curl -X DELETE "http://localhost/shop-api/carts/{token}/items/{identifier}"
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) {
        
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        String identifier = identifier_example; // String | Identifier of a specific item. Can be found in the cart summary.
        try {
            apiInstance.cartDeleteItem(token, identifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartDeleteItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        String identifier = identifier_example; // String | Identifier of a specific item. Can be found in the cart summary.
        try {
            apiInstance.cartDeleteItem(token, identifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartDeleteItem");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.
String *identifier = identifier_example; // Identifier of a specific item. Can be found in the cart summary.

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

// Remove cart item.
[apiInstance cartDeleteItemWith:token
    identifier:identifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CartApi()

var token = token_example; // {String} Cart identifier.

var identifier = identifier_example; // {String} Identifier of a specific item. Can be found in the cart summary.


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

namespace Example
{
    public class cartDeleteItemExample
    {
        public void main()
        {
            
            var apiInstance = new CartApi();
            var token = token_example;  // String | Cart identifier.
            var identifier = identifier_example;  // String | Identifier of a specific item. Can be found in the cart summary.

            try
            {
                // Remove cart item.
                apiInstance.cartDeleteItem(token, identifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.cartDeleteItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CartApi();
$token = token_example; // String | Cart identifier.
$identifier = identifier_example; // String | Identifier of a specific item. Can be found in the cart summary.

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

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $token = token_example; # String | Cart identifier.
my $identifier = identifier_example; # String | Identifier of a specific item. Can be found in the cart summary.

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

# create an instance of the API class
api_instance = swagger_client.CartApi()
token = token_example # String | Cart identifier.
identifier = identifier_example # String | Identifier of a specific item. Can be found in the cart summary.

try: 
    # Remove cart item.
    api_instance.cart_delete_item(token, identifier)
except ApiException as e:
    print("Exception when calling CartApi->cartDeleteItem: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required
identifier*
String
Identifier of a specific item. Can be found in the cart summary.
Required

Responses

Status: 204 - Cart item has been removed.

Status: 400 - Invalid input (E.g. token has not been found)


cartDrop

Drop your cart.

This endpoint will remove the cart and all of the related cart items.


/shop-api/carts/{token}

Usage and SDK Samples

curl -X DELETE "http://localhost/shop-api/carts/{token}"
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) {
        
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        try {
            apiInstance.cartDrop(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartDrop");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        try {
            apiInstance.cartDrop(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartDrop");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.

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

// Drop your cart.
[apiInstance cartDropWith:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CartApi()

var token = token_example; // {String} Cart identifier.


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

namespace Example
{
    public class cartDropExample
    {
        public void main()
        {
            
            var apiInstance = new CartApi();
            var token = token_example;  // String | Cart identifier.

            try
            {
                // Drop your cart.
                apiInstance.cartDrop(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.cartDrop: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CartApi();
$token = token_example; // String | Cart identifier.

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

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $token = token_example; # String | Cart identifier.

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

# create an instance of the API class
api_instance = swagger_client.CartApi()
token = token_example # String | Cart identifier.

try: 
    # Drop your cart.
    api_instance.cart_drop(token)
except ApiException as e:
    print("Exception when calling CartApi->cartDrop: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required

Responses

Status: 204 - Cart has been dropped.

Status: 400 - Invalid input (E.g. token has not been found)


cartPickUp

Pick up your cart from the store

This endpoint will allow you to create a new cart.


/shop-api/carts

Usage and SDK Samples

curl -X POST "http://localhost/shop-api/carts"
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) {
        
        CartApi apiInstance = new CartApi();
        Options options = ; // Options | 
        try {
            Cart result = apiInstance.cartPickUp(options);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartPickUp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        Options options = ; // Options | 
        try {
            Cart result = apiInstance.cartPickUp(options);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartPickUp");
            e.printStackTrace();
        }
    }
}
Options *options = ; //  (optional)

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

// Pick up your cart from the store
[apiInstance cartPickUpWith:options
              completionHandler: ^(Cart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CartApi()

var opts = { 
  'options':  // {Options} 
};

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

namespace Example
{
    public class cartPickUpExample
    {
        public void main()
        {
            
            var apiInstance = new CartApi();
            var options = new Options(); // Options |  (optional) 

            try
            {
                // Pick up your cart from the store
                Cart result = apiInstance.cartPickUp(options);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.cartPickUp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CartApi();
$options = ; // Options | 

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

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $options = WWW::SwaggerClient::Object::Options->new(); # Options | 

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

# create an instance of the API class
api_instance = swagger_client.CartApi()
options =  # Options |  (optional)

try: 
    # Pick up your cart from the store
    api_response = api_instance.cart_pick_up(options=options)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartApi->cartPickUp: %s\n" % e)

Parameters

Body parameters
Name Description
options

Responses

Status: 201 - Cart has been picked up

Status: 400 - Invalid input


cartPutItems

Add multiple items to your cart.

This endpoint will allow you to add a new item to your cart.


/shop-api/carts/{token}/multiple-items

Usage and SDK Samples

curl -X POST "http://localhost/shop-api/carts/{token}/multiple-items"
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) {
        
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        PutItemsToCartRequest content = ; // PutItemsToCartRequest | Description of items. The same rules applied to each of the array values as to the previous point.
        try {
            Cart result = apiInstance.cartPutItems(token, content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartPutItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        PutItemsToCartRequest content = ; // PutItemsToCartRequest | Description of items. The same rules applied to each of the array values as to the previous point.
        try {
            Cart result = apiInstance.cartPutItems(token, content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartPutItems");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.
PutItemsToCartRequest *content = ; // Description of items. The same rules applied to each of the array values as to the previous point.

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

// Add multiple items to your cart.
[apiInstance cartPutItemsWith:token
    content:content
              completionHandler: ^(Cart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CartApi()

var token = token_example; // {String} Cart identifier.

var content = ; // {PutItemsToCartRequest} Description of items. The same rules applied to each of the array values as to the previous point.


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

namespace Example
{
    public class cartPutItemsExample
    {
        public void main()
        {
            
            var apiInstance = new CartApi();
            var token = token_example;  // String | Cart identifier.
            var content = new PutItemsToCartRequest(); // PutItemsToCartRequest | Description of items. The same rules applied to each of the array values as to the previous point.

            try
            {
                // Add multiple items to your cart.
                Cart result = apiInstance.cartPutItems(token, content);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.cartPutItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CartApi();
$token = token_example; // String | Cart identifier.
$content = ; // PutItemsToCartRequest | Description of items. The same rules applied to each of the array values as to the previous point.

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

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $token = token_example; # String | Cart identifier.
my $content = WWW::SwaggerClient::Object::PutItemsToCartRequest->new(); # PutItemsToCartRequest | Description of items. The same rules applied to each of the array values as to the previous point.

eval { 
    my $result = $api_instance->cartPutItems(token => $token, content => $content);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartApi->cartPutItems: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CartApi()
token = token_example # String | Cart identifier.
content =  # PutItemsToCartRequest | Description of items. The same rules applied to each of the array values as to the previous point.

try: 
    # Add multiple items to your cart.
    api_response = api_instance.cart_put_items(token, content)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartApi->cartPutItems: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required
Body parameters
Name Description
content *

Responses

Status: 201 - Item has been added to the cart

Status: 400 - Invalid input, validation failed.


cartRemoveCoupon

Remove a promotion coupon code from the cart.

This endpoint will allow you to remove a promotion coupon code from the cart.


/shop-api/carts/{token}/coupon

Usage and SDK Samples

curl -X DELETE "http://localhost/shop-api/carts/{token}/coupon"
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) {
        
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        try {
            apiInstance.cartRemoveCoupon(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartRemoveCoupon");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        try {
            apiInstance.cartRemoveCoupon(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartRemoveCoupon");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.

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

// Remove a promotion coupon code from the cart.
[apiInstance cartRemoveCouponWith:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CartApi()

var token = token_example; // {String} Cart identifier.


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

namespace Example
{
    public class cartRemoveCouponExample
    {
        public void main()
        {
            
            var apiInstance = new CartApi();
            var token = token_example;  // String | Cart identifier.

            try
            {
                // Remove a promotion coupon code from the cart.
                apiInstance.cartRemoveCoupon(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.cartRemoveCoupon: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CartApi();
$token = token_example; // String | Cart identifier.

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

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $token = token_example; # String | Cart identifier.

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

# create an instance of the API class
api_instance = swagger_client.CartApi()
token = token_example # String | Cart identifier.

try: 
    # Remove a promotion coupon code from the cart.
    api_instance.cart_remove_coupon(token)
except ApiException as e:
    print("Exception when calling CartApi->cartRemoveCoupon: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required

Responses

Status: 204 - Coupon has been removed from the cart.

Status: 400 - Invalid input, validation failed.


cartSummarize

Show summarized cart.

This endpoint shows you the current calculated state of cart.


/shop-api/carts/{token}

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/carts/{token}"
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) {
        
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        try {
            Cart result = apiInstance.cartSummarize(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartSummarize");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        try {
            Cart result = apiInstance.cartSummarize(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartSummarize");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.

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

// Show summarized cart.
[apiInstance cartSummarizeWith:token
              completionHandler: ^(Cart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CartApi()

var token = token_example; // {String} Cart identifier.


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

namespace Example
{
    public class cartSummarizeExample
    {
        public void main()
        {
            
            var apiInstance = new CartApi();
            var token = token_example;  // String | Cart identifier.

            try
            {
                // Show summarized cart.
                Cart result = apiInstance.cartSummarize(token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.cartSummarize: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CartApi();
$token = token_example; // String | Cart identifier.

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

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $token = token_example; # String | Cart identifier.

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

# create an instance of the API class
api_instance = swagger_client.CartApi()
token = token_example # String | Cart identifier.

try: 
    # Show summarized cart.
    api_response = api_instance.cart_summarize(token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartApi->cartSummarize: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required

Responses

Status: 200 - Current state of the cart, with calculated prices and related items.

Status: 400 - Invalid input (E.g. token has not been found)


cartUpdateItem

Change quantity of a cart item.


/shop-api/carts/{token}/items/{identifier}

Usage and SDK Samples

curl -X PUT "http://localhost/shop-api/carts/{token}/items/{identifier}"
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) {
        
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        String identifier = identifier_example; // String | Identifier of a specific item. Can be found in the cart summary.
        ChangeItemQuantityRequest content = ; // ChangeItemQuantityRequest | 
        try {
            apiInstance.cartUpdateItem(token, identifier, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartUpdateItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        String identifier = identifier_example; // String | Identifier of a specific item. Can be found in the cart summary.
        ChangeItemQuantityRequest content = ; // ChangeItemQuantityRequest | 
        try {
            apiInstance.cartUpdateItem(token, identifier, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#cartUpdateItem");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.
String *identifier = identifier_example; // Identifier of a specific item. Can be found in the cart summary.
ChangeItemQuantityRequest *content = ; // 

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

// Change quantity of a cart item.
[apiInstance cartUpdateItemWith:token
    identifier:identifier
    content:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CartApi()

var token = token_example; // {String} Cart identifier.

var identifier = identifier_example; // {String} Identifier of a specific item. Can be found in the cart summary.

var content = ; // {ChangeItemQuantityRequest} 


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

namespace Example
{
    public class cartUpdateItemExample
    {
        public void main()
        {
            
            var apiInstance = new CartApi();
            var token = token_example;  // String | Cart identifier.
            var identifier = identifier_example;  // String | Identifier of a specific item. Can be found in the cart summary.
            var content = new ChangeItemQuantityRequest(); // ChangeItemQuantityRequest | 

            try
            {
                // Change quantity of a cart item.
                apiInstance.cartUpdateItem(token, identifier, content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.cartUpdateItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CartApi();
$token = token_example; // String | Cart identifier.
$identifier = identifier_example; // String | Identifier of a specific item. Can be found in the cart summary.
$content = ; // ChangeItemQuantityRequest | 

try {
    $api_instance->cartUpdateItem($token, $identifier, $content);
} catch (Exception $e) {
    echo 'Exception when calling CartApi->cartUpdateItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartApi;

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $token = token_example; # String | Cart identifier.
my $identifier = identifier_example; # String | Identifier of a specific item. Can be found in the cart summary.
my $content = WWW::SwaggerClient::Object::ChangeItemQuantityRequest->new(); # ChangeItemQuantityRequest | 

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

# create an instance of the API class
api_instance = swagger_client.CartApi()
token = token_example # String | Cart identifier.
identifier = identifier_example # String | Identifier of a specific item. Can be found in the cart summary.
content =  # ChangeItemQuantityRequest | 

try: 
    # Change quantity of a cart item.
    api_instance.cart_update_item(token, identifier, content)
except ApiException as e:
    print("Exception when calling CartApi->cartUpdateItem: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required
identifier*
String
Identifier of a specific item. Can be found in the cart summary.
Required
Body parameters
Name Description
content *

Responses

Status: 204 - Quantity has been changed.

Status: 400 - Invalid input, validation failed.


estimateShippingCost

Estimates the shipping cost of the cart


/shop-api/carts/{token}/estimated-shipping-cost

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/carts/{token}/estimated-shipping-cost?countryCode=&provinceCode="
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) {
        
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        String countryCode = countryCode_example; // String | Shipping Country
        String provinceCode = provinceCode_example; // String | Province to ship to
        try {
            EstimatedShippingCost result = apiInstance.estimateShippingCost(token, countryCode, provinceCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#estimateShippingCost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartApi;

public class CartApiExample {

    public static void main(String[] args) {
        CartApi apiInstance = new CartApi();
        String token = token_example; // String | Cart identifier.
        String countryCode = countryCode_example; // String | Shipping Country
        String provinceCode = provinceCode_example; // String | Province to ship to
        try {
            EstimatedShippingCost result = apiInstance.estimateShippingCost(token, countryCode, provinceCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartApi#estimateShippingCost");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.
String *countryCode = countryCode_example; // Shipping Country
String *provinceCode = provinceCode_example; // Province to ship to

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

// Estimates the shipping cost of the cart
[apiInstance estimateShippingCostWith:token
    countryCode:countryCode
    provinceCode:provinceCode
              completionHandler: ^(EstimatedShippingCost output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CartApi()

var token = token_example; // {String} Cart identifier.

var countryCode = countryCode_example; // {String} Shipping Country

var provinceCode = provinceCode_example; // {String} Province to ship to


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

namespace Example
{
    public class estimateShippingCostExample
    {
        public void main()
        {
            
            var apiInstance = new CartApi();
            var token = token_example;  // String | Cart identifier.
            var countryCode = countryCode_example;  // String | Shipping Country
            var provinceCode = provinceCode_example;  // String | Province to ship to

            try
            {
                // Estimates the shipping cost of the cart
                EstimatedShippingCost result = apiInstance.estimateShippingCost(token, countryCode, provinceCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartApi.estimateShippingCost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CartApi();
$token = token_example; // String | Cart identifier.
$countryCode = countryCode_example; // String | Shipping Country
$provinceCode = provinceCode_example; // String | Province to ship to

try {
    $result = $api_instance->estimateShippingCost($token, $countryCode, $provinceCode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CartApi->estimateShippingCost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartApi;

my $api_instance = WWW::SwaggerClient::CartApi->new();
my $token = token_example; # String | Cart identifier.
my $countryCode = countryCode_example; # String | Shipping Country
my $provinceCode = provinceCode_example; # String | Province to ship to

eval { 
    my $result = $api_instance->estimateShippingCost(token => $token, countryCode => $countryCode, provinceCode => $provinceCode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartApi->estimateShippingCost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CartApi()
token = token_example # String | Cart identifier.
countryCode = countryCode_example # String | Shipping Country
provinceCode = provinceCode_example # String | Province to ship to

try: 
    # Estimates the shipping cost of the cart
    api_response = api_instance.estimate_shipping_cost(token, countryCode, provinceCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartApi->estimateShippingCost: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required
Query parameters
Name Description
countryCode*
String
Shipping Country
Required
provinceCode*
String
Province to ship to
Required

Responses

Status: 200 - Price was calculated

Status: 400 - Invalid input (E.g. token has not been found)


Checkout

checkoutAddress

Address cart.

This endpoint will allow you to add billing and shipping addresses to the cart and begin the checkout process. You can either define the same shipping and billing address or specify them separately.


/shop-api/checkout/{token}/address

Usage and SDK Samples

curl -X PUT "http://localhost/shop-api/checkout/{token}/address"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckoutApi;

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

public class CheckoutApiExample {

    public static void main(String[] args) {
        
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        CheckoutAddressRequest content = ; // CheckoutAddressRequest | 
        try {
            apiInstance.checkoutAddress(token, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckoutApi;

public class CheckoutApiExample {

    public static void main(String[] args) {
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        CheckoutAddressRequest content = ; // CheckoutAddressRequest | 
        try {
            apiInstance.checkoutAddress(token, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutAddress");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.
CheckoutAddressRequest *content = ; // 

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

// Address cart.
[apiInstance checkoutAddressWith:token
    content:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CheckoutApi()

var token = token_example; // {String} Cart identifier.

var content = ; // {CheckoutAddressRequest} 


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

namespace Example
{
    public class checkoutAddressExample
    {
        public void main()
        {
            
            var apiInstance = new CheckoutApi();
            var token = token_example;  // String | Cart identifier.
            var content = new CheckoutAddressRequest(); // CheckoutAddressRequest | 

            try
            {
                // Address cart.
                apiInstance.checkoutAddress(token, content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckoutApi.checkoutAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CheckoutApi();
$token = token_example; // String | Cart identifier.
$content = ; // CheckoutAddressRequest | 

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

my $api_instance = WWW::SwaggerClient::CheckoutApi->new();
my $token = token_example; # String | Cart identifier.
my $content = WWW::SwaggerClient::Object::CheckoutAddressRequest->new(); # CheckoutAddressRequest | 

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

# create an instance of the API class
api_instance = swagger_client.CheckoutApi()
token = token_example # String | Cart identifier.
content =  # CheckoutAddressRequest | 

try: 
    # Address cart.
    api_instance.checkout_address(token, content)
except ApiException as e:
    print("Exception when calling CheckoutApi->checkoutAddress: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required
Body parameters
Name Description
content *

Responses

Status: 204 - Cart has been addressed.

Status: 400 - Address not valid


checkoutChoosePaymentMethod

Choosing cart payment method.

This endpoint will allow you to choose cart a payment method.


/shop-api/checkout/{token}/payment/{id}

Usage and SDK Samples

curl -X PUT "http://localhost/shop-api/checkout/{token}/payment/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckoutApi;

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

public class CheckoutApiExample {

    public static void main(String[] args) {
        
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        String id = id_example; // String | Order number of payment for which payment method should be specified.
        CheckoutChoosePaymentMethodRequest content = ; // CheckoutChoosePaymentMethodRequest | 
        try {
            apiInstance.checkoutChoosePaymentMethod(token, id, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutChoosePaymentMethod");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckoutApi;

public class CheckoutApiExample {

    public static void main(String[] args) {
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        String id = id_example; // String | Order number of payment for which payment method should be specified.
        CheckoutChoosePaymentMethodRequest content = ; // CheckoutChoosePaymentMethodRequest | 
        try {
            apiInstance.checkoutChoosePaymentMethod(token, id, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutChoosePaymentMethod");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.
String *id = id_example; // Order number of payment for which payment method should be specified.
CheckoutChoosePaymentMethodRequest *content = ; // 

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

// Choosing cart payment method.
[apiInstance checkoutChoosePaymentMethodWith:token
    id:id
    content:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CheckoutApi()

var token = token_example; // {String} Cart identifier.

var id = id_example; // {String} Order number of payment for which payment method should be specified.

var content = ; // {CheckoutChoosePaymentMethodRequest} 


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

namespace Example
{
    public class checkoutChoosePaymentMethodExample
    {
        public void main()
        {
            
            var apiInstance = new CheckoutApi();
            var token = token_example;  // String | Cart identifier.
            var id = id_example;  // String | Order number of payment for which payment method should be specified.
            var content = new CheckoutChoosePaymentMethodRequest(); // CheckoutChoosePaymentMethodRequest | 

            try
            {
                // Choosing cart payment method.
                apiInstance.checkoutChoosePaymentMethod(token, id, content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckoutApi.checkoutChoosePaymentMethod: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CheckoutApi();
$token = token_example; // String | Cart identifier.
$id = id_example; // String | Order number of payment for which payment method should be specified.
$content = ; // CheckoutChoosePaymentMethodRequest | 

try {
    $api_instance->checkoutChoosePaymentMethod($token, $id, $content);
} catch (Exception $e) {
    echo 'Exception when calling CheckoutApi->checkoutChoosePaymentMethod: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CheckoutApi;

my $api_instance = WWW::SwaggerClient::CheckoutApi->new();
my $token = token_example; # String | Cart identifier.
my $id = id_example; # String | Order number of payment for which payment method should be specified.
my $content = WWW::SwaggerClient::Object::CheckoutChoosePaymentMethodRequest->new(); # CheckoutChoosePaymentMethodRequest | 

eval { 
    $api_instance->checkoutChoosePaymentMethod(token => $token, id => $id, content => $content);
};
if ($@) {
    warn "Exception when calling CheckoutApi->checkoutChoosePaymentMethod: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CheckoutApi()
token = token_example # String | Cart identifier.
id = id_example # String | Order number of payment for which payment method should be specified.
content =  # CheckoutChoosePaymentMethodRequest | 

try: 
    # Choosing cart payment method.
    api_instance.checkout_choose_payment_method(token, id, content)
except ApiException as e:
    print("Exception when calling CheckoutApi->checkoutChoosePaymentMethod: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required
id*
String
Order number of payment for which payment method should be specified.
Required
Body parameters
Name Description
content *

Responses

Status: 204 - Payment method has been chosen.

Status: 400 - Invalid input, validation failed.


checkoutChooseShippingMethod

Choosing a cart shipping method.

This endpoint will allow you to choose a cart shipping method.


/shop-api/checkout/{token}/shipping/{id}

Usage and SDK Samples

curl -X PUT "http://localhost/shop-api/checkout/{token}/shipping/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckoutApi;

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

public class CheckoutApiExample {

    public static void main(String[] args) {
        
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        String id = id_example; // String | Order number of shipment for which shipping method should be specified.
        CheckoutChooseShippingMethodRequest content = ; // CheckoutChooseShippingMethodRequest | 
        try {
            apiInstance.checkoutChooseShippingMethod(token, id, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutChooseShippingMethod");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckoutApi;

public class CheckoutApiExample {

    public static void main(String[] args) {
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        String id = id_example; // String | Order number of shipment for which shipping method should be specified.
        CheckoutChooseShippingMethodRequest content = ; // CheckoutChooseShippingMethodRequest | 
        try {
            apiInstance.checkoutChooseShippingMethod(token, id, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutChooseShippingMethod");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.
String *id = id_example; // Order number of shipment for which shipping method should be specified.
CheckoutChooseShippingMethodRequest *content = ; // 

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

// Choosing a cart shipping method.
[apiInstance checkoutChooseShippingMethodWith:token
    id:id
    content:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CheckoutApi()

var token = token_example; // {String} Cart identifier.

var id = id_example; // {String} Order number of shipment for which shipping method should be specified.

var content = ; // {CheckoutChooseShippingMethodRequest} 


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

namespace Example
{
    public class checkoutChooseShippingMethodExample
    {
        public void main()
        {
            
            var apiInstance = new CheckoutApi();
            var token = token_example;  // String | Cart identifier.
            var id = id_example;  // String | Order number of shipment for which shipping method should be specified.
            var content = new CheckoutChooseShippingMethodRequest(); // CheckoutChooseShippingMethodRequest | 

            try
            {
                // Choosing a cart shipping method.
                apiInstance.checkoutChooseShippingMethod(token, id, content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckoutApi.checkoutChooseShippingMethod: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CheckoutApi();
$token = token_example; // String | Cart identifier.
$id = id_example; // String | Order number of shipment for which shipping method should be specified.
$content = ; // CheckoutChooseShippingMethodRequest | 

try {
    $api_instance->checkoutChooseShippingMethod($token, $id, $content);
} catch (Exception $e) {
    echo 'Exception when calling CheckoutApi->checkoutChooseShippingMethod: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CheckoutApi;

my $api_instance = WWW::SwaggerClient::CheckoutApi->new();
my $token = token_example; # String | Cart identifier.
my $id = id_example; # String | Order number of shipment for which shipping method should be specified.
my $content = WWW::SwaggerClient::Object::CheckoutChooseShippingMethodRequest->new(); # CheckoutChooseShippingMethodRequest | 

eval { 
    $api_instance->checkoutChooseShippingMethod(token => $token, id => $id, content => $content);
};
if ($@) {
    warn "Exception when calling CheckoutApi->checkoutChooseShippingMethod: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CheckoutApi()
token = token_example # String | Cart identifier.
id = id_example # String | Order number of shipment for which shipping method should be specified.
content =  # CheckoutChooseShippingMethodRequest | 

try: 
    # Choosing a cart shipping method.
    api_instance.checkout_choose_shipping_method(token, id, content)
except ApiException as e:
    print("Exception when calling CheckoutApi->checkoutChooseShippingMethod: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required
id*
String
Order number of shipment for which shipping method should be specified.
Required
Body parameters
Name Description
content *

Responses

Status: 204 - Shipping method has been chosen.

Status: 400 - Invalid input, validation failed.


checkoutComplete

Completing checkout.

This endpoint will allow you to complete the checkout.


/shop-api/checkout/{token}/complete

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "http://localhost/shop-api/checkout/{token}/complete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckoutApi;

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

public class CheckoutApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        CheckoutCompleteRequest content = ; // CheckoutCompleteRequest | 
        try {
            apiInstance.checkoutComplete(token, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutComplete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckoutApi;

public class CheckoutApiExample {

    public static void main(String[] args) {
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        CheckoutCompleteRequest content = ; // CheckoutCompleteRequest | 
        try {
            apiInstance.checkoutComplete(token, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutComplete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *token = token_example; // Cart identifier.
CheckoutCompleteRequest *content = ; // 

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

// Completing checkout.
[apiInstance checkoutCompleteWith:token
    content:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');
var defaultClient = ShopManagerApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new ShopManagerApi.CheckoutApi()

var token = token_example; // {String} Cart identifier.

var content = ; // {CheckoutCompleteRequest} 


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

namespace Example
{
    public class checkoutCompleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CheckoutApi();
            var token = token_example;  // String | Cart identifier.
            var content = new CheckoutCompleteRequest(); // CheckoutCompleteRequest | 

            try
            {
                // Completing checkout.
                apiInstance.checkoutComplete(token, content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckoutApi.checkoutComplete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CheckoutApi();
$token = token_example; // String | Cart identifier.
$content = ; // CheckoutCompleteRequest | 

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

# Configure API key authorization: bearerAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckoutApi->new();
my $token = token_example; # String | Cart identifier.
my $content = WWW::SwaggerClient::Object::CheckoutCompleteRequest->new(); # CheckoutCompleteRequest | 

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

# Configure API key authorization: bearerAuth
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckoutApi()
token = token_example # String | Cart identifier.
content =  # CheckoutCompleteRequest | 

try: 
    # Completing checkout.
    api_instance.checkout_complete(token, content)
except ApiException as e:
    print("Exception when calling CheckoutApi->checkoutComplete: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required
Body parameters
Name Description
content *

Responses

Status: 204 - Checkout has been completed.

Status: 400 - Invalid input, validation failed.

Status: 403 - Not logged in or wrong email


checkoutShowAvailablePaymentMethods

Get available payment methods.

This endpoint will show you available payment methods for all cart payments.


/shop-api/checkout/{token}/payment

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/checkout/{token}/payment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckoutApi;

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

public class CheckoutApiExample {

    public static void main(String[] args) {
        
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        try {
            AvailablePaymentMethods result = apiInstance.checkoutShowAvailablePaymentMethods(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutShowAvailablePaymentMethods");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckoutApi;

public class CheckoutApiExample {

    public static void main(String[] args) {
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        try {
            AvailablePaymentMethods result = apiInstance.checkoutShowAvailablePaymentMethods(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutShowAvailablePaymentMethods");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.

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

// Get available payment methods.
[apiInstance checkoutShowAvailablePaymentMethodsWith:token
              completionHandler: ^(AvailablePaymentMethods output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CheckoutApi()

var token = token_example; // {String} Cart identifier.


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

namespace Example
{
    public class checkoutShowAvailablePaymentMethodsExample
    {
        public void main()
        {
            
            var apiInstance = new CheckoutApi();
            var token = token_example;  // String | Cart identifier.

            try
            {
                // Get available payment methods.
                AvailablePaymentMethods result = apiInstance.checkoutShowAvailablePaymentMethods(token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckoutApi.checkoutShowAvailablePaymentMethods: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CheckoutApi();
$token = token_example; // String | Cart identifier.

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

my $api_instance = WWW::SwaggerClient::CheckoutApi->new();
my $token = token_example; # String | Cart identifier.

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

# create an instance of the API class
api_instance = swagger_client.CheckoutApi()
token = token_example # String | Cart identifier.

try: 
    # Get available payment methods.
    api_response = api_instance.checkout_show_available_payment_methods(token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CheckoutApi->checkoutShowAvailablePaymentMethods: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required

Responses

Status: 200 - Get available payment methods.

Status: 400 - Invalid input, validation failed.


checkoutShowAvailableShippingMethods

Get available shipping methods.

This endpoint will show you available shipping methods for all cart shipments.


/shop-api/checkout/{token}/shipping

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/checkout/{token}/shipping"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckoutApi;

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

public class CheckoutApiExample {

    public static void main(String[] args) {
        
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        try {
            AvailableShippingMethods result = apiInstance.checkoutShowAvailableShippingMethods(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutShowAvailableShippingMethods");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckoutApi;

public class CheckoutApiExample {

    public static void main(String[] args) {
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        try {
            AvailableShippingMethods result = apiInstance.checkoutShowAvailableShippingMethods(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutShowAvailableShippingMethods");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.

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

// Get available shipping methods.
[apiInstance checkoutShowAvailableShippingMethodsWith:token
              completionHandler: ^(AvailableShippingMethods output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CheckoutApi()

var token = token_example; // {String} Cart identifier.


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

namespace Example
{
    public class checkoutShowAvailableShippingMethodsExample
    {
        public void main()
        {
            
            var apiInstance = new CheckoutApi();
            var token = token_example;  // String | Cart identifier.

            try
            {
                // Get available shipping methods.
                AvailableShippingMethods result = apiInstance.checkoutShowAvailableShippingMethods(token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckoutApi.checkoutShowAvailableShippingMethods: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CheckoutApi();
$token = token_example; // String | Cart identifier.

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

my $api_instance = WWW::SwaggerClient::CheckoutApi->new();
my $token = token_example; # String | Cart identifier.

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

# create an instance of the API class
api_instance = swagger_client.CheckoutApi()
token = token_example # String | Cart identifier.

try: 
    # Get available shipping methods.
    api_response = api_instance.checkout_show_available_shipping_methods(token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CheckoutApi->checkoutShowAvailableShippingMethods: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required

Responses

Status: 200 - Get available shipping methods.

Status: 400 - Invalid input, validation failed.


checkoutSummarize

Show checkout summary

This endpoint will show the summarized cart during checkout. This action is an equivalent of cart summarize action.


/shop-api/checkout/{token}

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/checkout/{token}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckoutApi;

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

public class CheckoutApiExample {

    public static void main(String[] args) {
        
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        try {
            Cart result = apiInstance.checkoutSummarize(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutSummarize");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckoutApi;

public class CheckoutApiExample {

    public static void main(String[] args) {
        CheckoutApi apiInstance = new CheckoutApi();
        String token = token_example; // String | Cart identifier.
        try {
            Cart result = apiInstance.checkoutSummarize(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutApi#checkoutSummarize");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Cart identifier.

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

// Show checkout summary
[apiInstance checkoutSummarizeWith:token
              completionHandler: ^(Cart output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.CheckoutApi()

var token = token_example; // {String} Cart identifier.


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

namespace Example
{
    public class checkoutSummarizeExample
    {
        public void main()
        {
            
            var apiInstance = new CheckoutApi();
            var token = token_example;  // String | Cart identifier.

            try
            {
                // Show checkout summary
                Cart result = apiInstance.checkoutSummarize(token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckoutApi.checkoutSummarize: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CheckoutApi();
$token = token_example; // String | Cart identifier.

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

my $api_instance = WWW::SwaggerClient::CheckoutApi->new();
my $token = token_example; # String | Cart identifier.

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

# create an instance of the API class
api_instance = swagger_client.CheckoutApi()
token = token_example # String | Cart identifier.

try: 
    # Show checkout summary
    api_response = api_instance.checkout_summarize(token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CheckoutApi->checkoutSummarize: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Cart identifier.
Required

Responses

Status: 200 - Current state of the cart, with calculated prices and related items.

Status: 400 - Invalid input (E.g. token has not been found)


Default

shopApiRestoreTokenValueGet

Create a new cart from an existing order


/shop-api/restore/{tokenValue}

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/restore/{tokenValue}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String tokenValue = tokenValue_example; // String | Id of the address to be the default address
        try {
            inline_response_200 result = apiInstance.shopApiRestoreTokenValueGet(tokenValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#shopApiRestoreTokenValueGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String tokenValue = tokenValue_example; // String | Id of the address to be the default address
        try {
            inline_response_200 result = apiInstance.shopApiRestoreTokenValueGet(tokenValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#shopApiRestoreTokenValueGet");
            e.printStackTrace();
        }
    }
}
String *tokenValue = tokenValue_example; // Id of the address to be the default address

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

// Create a new cart from an existing order
[apiInstance shopApiRestoreTokenValueGetWith:tokenValue
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.DefaultApi()

var tokenValue = tokenValue_example; // {String} Id of the address to be the default address


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

namespace Example
{
    public class shopApiRestoreTokenValueGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var tokenValue = tokenValue_example;  // String | Id of the address to be the default address

            try
            {
                // Create a new cart from an existing order
                inline_response_200 result = apiInstance.shopApiRestoreTokenValueGet(tokenValue);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.shopApiRestoreTokenValueGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$tokenValue = tokenValue_example; // String | Id of the address to be the default address

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $tokenValue = tokenValue_example; # String | Id of the address to be the default address

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

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
tokenValue = tokenValue_example # String | Id of the address to be the default address

try: 
    # Create a new cart from an existing order
    api_response = api_instance.shop_api_restore_token_value_get(tokenValue)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->shopApiRestoreTokenValueGet: %s\n" % e)

Parameters

Path parameters
Name Description
tokenValue*
String
Id of the address to be the default address
Required

Responses

Status: 200 - New TokenValue


Order

order

Shows details of specific customer's order


/shop-api/orders/{tokenValue}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://localhost/shop-api/orders/{tokenValue}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrderApi;

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

public class OrderApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        OrderApi apiInstance = new OrderApi();
        String channelCode = channelCode_example; // String | The request channel code
        String tokenValue = tokenValue_example; // String | Order token.
        try {
            PlacedOrder result = apiInstance.order(channelCode, tokenValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#order");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrderApi;

public class OrderApiExample {

    public static void main(String[] args) {
        OrderApi apiInstance = new OrderApi();
        String channelCode = channelCode_example; // String | The request channel code
        String tokenValue = tokenValue_example; // String | Order token.
        try {
            PlacedOrder result = apiInstance.order(channelCode, tokenValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#order");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *channelCode = channelCode_example; // The request channel code
String *tokenValue = tokenValue_example; // Order token.

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

// Shows details of specific customer's order
[apiInstance orderWith:channelCode
    tokenValue:tokenValue
              completionHandler: ^(PlacedOrder output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');
var defaultClient = ShopManagerApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new ShopManagerApi.OrderApi()

var channelCode = channelCode_example; // {String} The request channel code

var tokenValue = tokenValue_example; // {String} Order token.


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

namespace Example
{
    public class orderExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new OrderApi();
            var channelCode = channelCode_example;  // String | The request channel code
            var tokenValue = tokenValue_example;  // String | Order token.

            try
            {
                // Shows details of specific customer's order
                PlacedOrder result = apiInstance.order(channelCode, tokenValue);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrderApi.order: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\OrderApi();
$channelCode = channelCode_example; // String | The request channel code
$tokenValue = tokenValue_example; // String | Order token.

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

# Configure API key authorization: bearerAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrderApi->new();
my $channelCode = channelCode_example; # String | The request channel code
my $tokenValue = tokenValue_example; # String | Order token.

eval { 
    my $result = $api_instance->order(channelCode => $channelCode, tokenValue => $tokenValue);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderApi->order: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrderApi()
channelCode = channelCode_example # String | The request channel code
tokenValue = tokenValue_example # String | Order token.

try: 
    # Shows details of specific customer's order
    api_response = api_instance.order(channelCode, tokenValue)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderApi->order: %s\n" % e)

Parameters

Path parameters
Name Description
channelCode*
String
The request channel code
Required
tokenValue*
String
Order token.
Required

Responses

Status: 200 - Shows details of specific customer's order with given tokenValue

Status: 401 - User token invalid

Status: 404 - Order with given tokenValue not found


orders

Shows a list of orders of the customer


/shop-api/orders

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://localhost/shop-api/orders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrderApi;

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

public class OrderApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        OrderApi apiInstance = new OrderApi();
        String channelCode = channelCode_example; // String | The request channel code
        try {
            array[PlacedOrder] result = apiInstance.orders(channelCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#orders");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrderApi;

public class OrderApiExample {

    public static void main(String[] args) {
        OrderApi apiInstance = new OrderApi();
        String channelCode = channelCode_example; // String | The request channel code
        try {
            array[PlacedOrder] result = apiInstance.orders(channelCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#orders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *channelCode = channelCode_example; // The request channel code

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

// Shows a list of orders of the customer
[apiInstance ordersWith:channelCode
              completionHandler: ^(array[PlacedOrder] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');
var defaultClient = ShopManagerApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new ShopManagerApi.OrderApi()

var channelCode = channelCode_example; // {String} The request channel code


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

namespace Example
{
    public class ordersExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new OrderApi();
            var channelCode = channelCode_example;  // String | The request channel code

            try
            {
                // Shows a list of orders of the customer
                array[PlacedOrder] result = apiInstance.orders(channelCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrderApi.orders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\OrderApi();
$channelCode = channelCode_example; // String | The request channel code

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

# Configure API key authorization: bearerAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::OrderApi->new();
my $channelCode = channelCode_example; # String | The request channel code

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

# Configure API key authorization: bearerAuth
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.OrderApi()
channelCode = channelCode_example # String | The request channel code

try: 
    # Shows a list of orders of the customer
    api_response = api_instance.orders(channelCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderApi->orders: %s\n" % e)

Parameters

Path parameters
Name Description
channelCode*
String
The request channel code
Required

Responses

Status: 200 - Shows a list of placed orders of the customer

Status: 401 - User token invalid


Products

latestProducts

Show latest products.

This endpoint will return an array of latest products.


/shop-api/product-latest

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/product-latest?locale=&limit="
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) {
        
        ProductsApi apiInstance = new ProductsApi();
        String locale = locale_example; // String | Locale in which products should be shown.
        Integer limit = 56; // Integer | Number of expected products per page.
        try {
            array[Product] result = apiInstance.latestProducts(locale, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#latestProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String locale = locale_example; // String | Locale in which products should be shown.
        Integer limit = 56; // Integer | Number of expected products per page.
        try {
            array[Product] result = apiInstance.latestProducts(locale, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#latestProducts");
            e.printStackTrace();
        }
    }
}
String *locale = locale_example; // Locale in which products should be shown. (optional)
Integer *limit = 56; // Number of expected products per page. (optional)

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

// Show latest products.
[apiInstance latestProductsWith:locale
    limit:limit
              completionHandler: ^(array[Product] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.ProductsApi()

var opts = { 
  'locale': locale_example, // {String} Locale in which products should be shown.
  'limit': 56 // {Integer} Number of expected products per page.
};

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

namespace Example
{
    public class latestProductsExample
    {
        public void main()
        {
            
            var apiInstance = new ProductsApi();
            var locale = locale_example;  // String | Locale in which products should be shown. (optional) 
            var limit = 56;  // Integer | Number of expected products per page. (optional) 

            try
            {
                // Show latest products.
                array[Product] result = apiInstance.latestProducts(locale, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.latestProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProductsApi();
$locale = locale_example; // String | Locale in which products should be shown.
$limit = 56; // Integer | Number of expected products per page.

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

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $locale = locale_example; # String | Locale in which products should be shown.
my $limit = 56; # Integer | Number of expected products per page.

eval { 
    my $result = $api_instance->latestProducts(locale => $locale, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->latestProducts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
locale = locale_example # String | Locale in which products should be shown. (optional)
limit = 56 # Integer | Number of expected products per page. (optional)

try: 
    # Show latest products.
    api_response = api_instance.latest_products(locale=locale, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->latestProducts: %s\n" % e)

Parameters

Query parameters
Name Description
locale
String
Locale in which products should be shown.
limit
Integer
Number of expected products per page.

Responses

Status: 200 - Array of latest products.


productAddReview

Add a review to the product.

This endpoint will allow you to add a new review to the product. Remember, that it should be accepted by an administrator before it will be available in the review list.


/shop-api/products/by-code/{code}/reviews

Usage and SDK Samples

curl -X POST "http://localhost/shop-api/products/by-code/{code}/reviews"
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) {
        
        ProductsApi apiInstance = new ProductsApi();
        String code = code_example; // String | Code of expected product.
        AddReviewRequest content = ; // AddReviewRequest | 
        try {
            apiInstance.productAddReview(code, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productAddReview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String code = code_example; // String | Code of expected product.
        AddReviewRequest content = ; // AddReviewRequest | 
        try {
            apiInstance.productAddReview(code, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productAddReview");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Code of expected product.
AddReviewRequest *content = ; // 

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

// Add a review to the product.
[apiInstance productAddReviewWith:code
    content:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.ProductsApi()

var code = code_example; // {String} Code of expected product.

var content = ; // {AddReviewRequest} 


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

namespace Example
{
    public class productAddReviewExample
    {
        public void main()
        {
            
            var apiInstance = new ProductsApi();
            var code = code_example;  // String | Code of expected product.
            var content = new AddReviewRequest(); // AddReviewRequest | 

            try
            {
                // Add a review to the product.
                apiInstance.productAddReview(code, content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.productAddReview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProductsApi();
$code = code_example; // String | Code of expected product.
$content = ; // AddReviewRequest | 

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

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $code = code_example; # String | Code of expected product.
my $content = WWW::SwaggerClient::Object::AddReviewRequest->new(); # AddReviewRequest | 

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

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
code = code_example # String | Code of expected product.
content =  # AddReviewRequest | 

try: 
    # Add a review to the product.
    api_instance.product_add_review(code, content)
except ApiException as e:
    print("Exception when calling ProductsApi->productAddReview: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code of expected product.
Required
Body parameters
Name Description
content *

Responses

Status: 201 - Review has been added to the product.

Status: 400 - Invalid input, validation failed.


productAddReviewBySlug

Add a review to the product.

This endpoint will allow you to add a new review to the product. Remember, that it should be accepted by an administrator before it will be available in the review list.


/shop-api/products/by-slug/{slug}/reviews

Usage and SDK Samples

curl -X POST "http://localhost/shop-api/products/by-slug/{slug}/reviews"
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) {
        
        ProductsApi apiInstance = new ProductsApi();
        String slug = slug_example; // String | Slug of expected product.
        AddReviewRequest content = ; // AddReviewRequest | 
        try {
            apiInstance.productAddReviewBySlug(slug, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productAddReviewBySlug");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String slug = slug_example; // String | Slug of expected product.
        AddReviewRequest content = ; // AddReviewRequest | 
        try {
            apiInstance.productAddReviewBySlug(slug, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productAddReviewBySlug");
            e.printStackTrace();
        }
    }
}
String *slug = slug_example; // Slug of expected product.
AddReviewRequest *content = ; // 

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

// Add a review to the product.
[apiInstance productAddReviewBySlugWith:slug
    content:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.ProductsApi()

var slug = slug_example; // {String} Slug of expected product.

var content = ; // {AddReviewRequest} 


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

namespace Example
{
    public class productAddReviewBySlugExample
    {
        public void main()
        {
            
            var apiInstance = new ProductsApi();
            var slug = slug_example;  // String | Slug of expected product.
            var content = new AddReviewRequest(); // AddReviewRequest | 

            try
            {
                // Add a review to the product.
                apiInstance.productAddReviewBySlug(slug, content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.productAddReviewBySlug: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProductsApi();
$slug = slug_example; // String | Slug of expected product.
$content = ; // AddReviewRequest | 

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

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $slug = slug_example; # String | Slug of expected product.
my $content = WWW::SwaggerClient::Object::AddReviewRequest->new(); # AddReviewRequest | 

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

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
slug = slug_example # String | Slug of expected product.
content =  # AddReviewRequest | 

try: 
    # Add a review to the product.
    api_instance.product_add_review_by_slug(slug, content)
except ApiException as e:
    print("Exception when calling ProductsApi->productAddReviewBySlug: %s\n" % e)

Parameters

Path parameters
Name Description
slug*
String
Slug of expected product.
Required
Body parameters
Name Description
content *

Responses

Status: 201 - Review has been added to the product.

Status: 400 - Invalid input, validation failed.


productCatalog

Show product catalog.

This endpoint will return a paginated list of products for given taxon.


/shop-api/taxon-products/by-code/{taxonCode}

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/taxon-products/by-code/{taxonCode}?locale=&limit=&page="
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) {
        
        ProductsApi apiInstance = new ProductsApi();
        String taxonCode = taxonCode_example; // String | Code of taxonomy for which products should be listed.
        String locale = locale_example; // String | Locale in which products should be shown.
        Integer limit = 56; // Integer | Number of expected products per page.
        Integer page = 56; // Integer | Page number.
        try {
            ProductsPage result = apiInstance.productCatalog(taxonCode, locale, limit, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productCatalog");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String taxonCode = taxonCode_example; // String | Code of taxonomy for which products should be listed.
        String locale = locale_example; // String | Locale in which products should be shown.
        Integer limit = 56; // Integer | Number of expected products per page.
        Integer page = 56; // Integer | Page number.
        try {
            ProductsPage result = apiInstance.productCatalog(taxonCode, locale, limit, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productCatalog");
            e.printStackTrace();
        }
    }
}
String *taxonCode = taxonCode_example; // Code of taxonomy for which products should be listed.
String *locale = locale_example; // Locale in which products should be shown. (optional)
Integer *limit = 56; // Number of expected products per page. (optional)
Integer *page = 56; // Page number. (optional)

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

// Show product catalog.
[apiInstance productCatalogWith:taxonCode
    locale:locale
    limit:limit
    page:page
              completionHandler: ^(ProductsPage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.ProductsApi()

var taxonCode = taxonCode_example; // {String} Code of taxonomy for which products should be listed.

var opts = { 
  'locale': locale_example, // {String} Locale in which products should be shown.
  'limit': 56, // {Integer} Number of expected products per page.
  'page': 56 // {Integer} Page number.
};

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

namespace Example
{
    public class productCatalogExample
    {
        public void main()
        {
            
            var apiInstance = new ProductsApi();
            var taxonCode = taxonCode_example;  // String | Code of taxonomy for which products should be listed.
            var locale = locale_example;  // String | Locale in which products should be shown. (optional) 
            var limit = 56;  // Integer | Number of expected products per page. (optional) 
            var page = 56;  // Integer | Page number. (optional) 

            try
            {
                // Show product catalog.
                ProductsPage result = apiInstance.productCatalog(taxonCode, locale, limit, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.productCatalog: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProductsApi();
$taxonCode = taxonCode_example; // String | Code of taxonomy for which products should be listed.
$locale = locale_example; // String | Locale in which products should be shown.
$limit = 56; // Integer | Number of expected products per page.
$page = 56; // Integer | Page number.

try {
    $result = $api_instance->productCatalog($taxonCode, $locale, $limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->productCatalog: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $taxonCode = taxonCode_example; # String | Code of taxonomy for which products should be listed.
my $locale = locale_example; # String | Locale in which products should be shown.
my $limit = 56; # Integer | Number of expected products per page.
my $page = 56; # Integer | Page number.

eval { 
    my $result = $api_instance->productCatalog(taxonCode => $taxonCode, locale => $locale, limit => $limit, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->productCatalog: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
taxonCode = taxonCode_example # String | Code of taxonomy for which products should be listed.
locale = locale_example # String | Locale in which products should be shown. (optional)
limit = 56 # Integer | Number of expected products per page. (optional)
page = 56 # Integer | Page number. (optional)

try: 
    # Show product catalog.
    api_response = api_instance.product_catalog(taxonCode, locale=locale, limit=limit, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->productCatalog: %s\n" % e)

Parameters

Path parameters
Name Description
taxonCode*
String
Code of taxonomy for which products should be listed.
Required
Query parameters
Name Description
locale
String
Locale in which products should be shown.
limit
Integer
Number of expected products per page.
page
Integer
Page number.

Responses

Status: 200 - Paginated product list.


productCatalogBySlug

Show product catalog.

This endpoint will return a paginated list of products for given taxon.


/shop-api/taxon-products/by-slug/{taxonSlug}

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/taxon-products/by-slug/{taxonSlug}?locale=&limit=&page="
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) {
        
        ProductsApi apiInstance = new ProductsApi();
        String taxonSlug = taxonSlug_example; // String | Slug of taxonomy for which products should be listed.
        String locale = locale_example; // String | Locale in which products should be shown.
        Integer limit = 56; // Integer | Number of expected products per page.
        Integer page = 56; // Integer | Page number.
        try {
            ProductsPage result = apiInstance.productCatalogBySlug(taxonSlug, locale, limit, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productCatalogBySlug");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String taxonSlug = taxonSlug_example; // String | Slug of taxonomy for which products should be listed.
        String locale = locale_example; // String | Locale in which products should be shown.
        Integer limit = 56; // Integer | Number of expected products per page.
        Integer page = 56; // Integer | Page number.
        try {
            ProductsPage result = apiInstance.productCatalogBySlug(taxonSlug, locale, limit, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productCatalogBySlug");
            e.printStackTrace();
        }
    }
}
String *taxonSlug = taxonSlug_example; // Slug of taxonomy for which products should be listed.
String *locale = locale_example; // Locale in which products should be shown. (optional)
Integer *limit = 56; // Number of expected products per page. (optional)
Integer *page = 56; // Page number. (optional)

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

// Show product catalog.
[apiInstance productCatalogBySlugWith:taxonSlug
    locale:locale
    limit:limit
    page:page
              completionHandler: ^(ProductsPage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.ProductsApi()

var taxonSlug = taxonSlug_example; // {String} Slug of taxonomy for which products should be listed.

var opts = { 
  'locale': locale_example, // {String} Locale in which products should be shown.
  'limit': 56, // {Integer} Number of expected products per page.
  'page': 56 // {Integer} Page number.
};

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

namespace Example
{
    public class productCatalogBySlugExample
    {
        public void main()
        {
            
            var apiInstance = new ProductsApi();
            var taxonSlug = taxonSlug_example;  // String | Slug of taxonomy for which products should be listed.
            var locale = locale_example;  // String | Locale in which products should be shown. (optional) 
            var limit = 56;  // Integer | Number of expected products per page. (optional) 
            var page = 56;  // Integer | Page number. (optional) 

            try
            {
                // Show product catalog.
                ProductsPage result = apiInstance.productCatalogBySlug(taxonSlug, locale, limit, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.productCatalogBySlug: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProductsApi();
$taxonSlug = taxonSlug_example; // String | Slug of taxonomy for which products should be listed.
$locale = locale_example; // String | Locale in which products should be shown.
$limit = 56; // Integer | Number of expected products per page.
$page = 56; // Integer | Page number.

try {
    $result = $api_instance->productCatalogBySlug($taxonSlug, $locale, $limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->productCatalogBySlug: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $taxonSlug = taxonSlug_example; # String | Slug of taxonomy for which products should be listed.
my $locale = locale_example; # String | Locale in which products should be shown.
my $limit = 56; # Integer | Number of expected products per page.
my $page = 56; # Integer | Page number.

eval { 
    my $result = $api_instance->productCatalogBySlug(taxonSlug => $taxonSlug, locale => $locale, limit => $limit, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->productCatalogBySlug: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
taxonSlug = taxonSlug_example # String | Slug of taxonomy for which products should be listed.
locale = locale_example # String | Locale in which products should be shown. (optional)
limit = 56 # Integer | Number of expected products per page. (optional)
page = 56 # Integer | Page number. (optional)

try: 
    # Show product catalog.
    api_response = api_instance.product_catalog_by_slug(taxonSlug, locale=locale, limit=limit, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->productCatalogBySlug: %s\n" % e)

Parameters

Path parameters
Name Description
taxonSlug*
String
Slug of taxonomy for which products should be listed.
Required
Query parameters
Name Description
locale
String
Locale in which products should be shown.
limit
Integer
Number of expected products per page.
page
Integer
Page number.

Responses

Status: 200 - Paginated product list.


productDetails

Show a product with the given code.

This endpoint will return a product with the given code.


/shop-api/products/by-code/{code}

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/products/by-code/{code}?locale="
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) {
        
        ProductsApi apiInstance = new ProductsApi();
        String code = code_example; // String | Code of expected product.
        String locale = locale_example; // String | Locale in which products should be shown.
        try {
            ProductDetails result = apiInstance.productDetails(code, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String code = code_example; // String | Code of expected product.
        String locale = locale_example; // String | Locale in which products should be shown.
        try {
            ProductDetails result = apiInstance.productDetails(code, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productDetails");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Code of expected product.
String *locale = locale_example; // Locale in which products should be shown. (optional)

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

// Show a product with the given code.
[apiInstance productDetailsWith:code
    locale:locale
              completionHandler: ^(ProductDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.ProductsApi()

var code = code_example; // {String} Code of expected product.

var opts = { 
  'locale': locale_example // {String} Locale in which products should be shown.
};

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

namespace Example
{
    public class productDetailsExample
    {
        public void main()
        {
            
            var apiInstance = new ProductsApi();
            var code = code_example;  // String | Code of expected product.
            var locale = locale_example;  // String | Locale in which products should be shown. (optional) 

            try
            {
                // Show a product with the given code.
                ProductDetails result = apiInstance.productDetails(code, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.productDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProductsApi();
$code = code_example; // String | Code of expected product.
$locale = locale_example; // String | Locale in which products should be shown.

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

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $code = code_example; # String | Code of expected product.
my $locale = locale_example; # String | Locale in which products should be shown.

eval { 
    my $result = $api_instance->productDetails(code => $code, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->productDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
code = code_example # String | Code of expected product.
locale = locale_example # String | Locale in which products should be shown. (optional)

try: 
    # Show a product with the given code.
    api_response = api_instance.product_details(code, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->productDetails: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code of expected product.
Required
Query parameters
Name Description
locale
String
Locale in which products should be shown.

Responses

Status: 200 - Show a product with the given code.


productDetailsBySlug

Show a product with the given slug.

This endpoint will return a product with the given slug.


/shop-api/products/by-slug/{slug}

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/products/by-slug/{slug}?locale="
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) {
        
        ProductsApi apiInstance = new ProductsApi();
        String slug = slug_example; // String | Slug of expected product.
        String locale = locale_example; // String | Locale in which products should be shown.
        try {
            ProductDetails result = apiInstance.productDetailsBySlug(slug, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productDetailsBySlug");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String slug = slug_example; // String | Slug of expected product.
        String locale = locale_example; // String | Locale in which products should be shown.
        try {
            ProductDetails result = apiInstance.productDetailsBySlug(slug, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productDetailsBySlug");
            e.printStackTrace();
        }
    }
}
String *slug = slug_example; // Slug of expected product.
String *locale = locale_example; // Locale in which products should be shown. (optional)

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

// Show a product with the given slug.
[apiInstance productDetailsBySlugWith:slug
    locale:locale
              completionHandler: ^(ProductDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.ProductsApi()

var slug = slug_example; // {String} Slug of expected product.

var opts = { 
  'locale': locale_example // {String} Locale in which products should be shown.
};

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

namespace Example
{
    public class productDetailsBySlugExample
    {
        public void main()
        {
            
            var apiInstance = new ProductsApi();
            var slug = slug_example;  // String | Slug of expected product.
            var locale = locale_example;  // String | Locale in which products should be shown. (optional) 

            try
            {
                // Show a product with the given slug.
                ProductDetails result = apiInstance.productDetailsBySlug(slug, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.productDetailsBySlug: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProductsApi();
$slug = slug_example; // String | Slug of expected product.
$locale = locale_example; // String | Locale in which products should be shown.

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

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $slug = slug_example; # String | Slug of expected product.
my $locale = locale_example; # String | Locale in which products should be shown.

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

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
slug = slug_example # String | Slug of expected product.
locale = locale_example # String | Locale in which products should be shown. (optional)

try: 
    # Show a product with the given slug.
    api_response = api_instance.product_details_by_slug(slug, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->productDetailsBySlug: %s\n" % e)

Parameters

Path parameters
Name Description
slug*
String
Slug of expected product.
Required
Query parameters
Name Description
locale
String
Locale in which products should be shown.

Responses

Status: 200 - Show a product with the given slug.


productReviews

Show reviews.

This endpoint will return a paginated list of all reviews related to the product identified by slug.


/shop-api/products/by-code/{code}/reviews

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/products/by-code/{code}/reviews"
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) {
        
        ProductsApi apiInstance = new ProductsApi();
        String code = code_example; // String | Code of expected product.
        try {
            ProductReviewsPage result = apiInstance.productReviews(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productReviews");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String code = code_example; // String | Code of expected product.
        try {
            ProductReviewsPage result = apiInstance.productReviews(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productReviews");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Code of expected product.

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

// Show reviews.
[apiInstance productReviewsWith:code
              completionHandler: ^(ProductReviewsPage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.ProductsApi()

var code = code_example; // {String} Code of expected product.


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

namespace Example
{
    public class productReviewsExample
    {
        public void main()
        {
            
            var apiInstance = new ProductsApi();
            var code = code_example;  // String | Code of expected product.

            try
            {
                // Show reviews.
                ProductReviewsPage result = apiInstance.productReviews(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.productReviews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProductsApi();
$code = code_example; // String | Code of expected product.

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

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $code = code_example; # String | Code of expected product.

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

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
code = code_example # String | Code of expected product.

try: 
    # Show reviews.
    api_response = api_instance.product_reviews(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->productReviews: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code of expected product.
Required

Responses

Status: 200 - A paginated list of all reviews related to the product identified by slug.


productReviewsBySlug

Show reviews.

This endpoint will return a paginated list of all reviews related to the product identified by slug.


/shop-api/products/by-slug/{slug}/reviews

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/products/by-slug/{slug}/reviews"
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) {
        
        ProductsApi apiInstance = new ProductsApi();
        String slug = slug_example; // String | Slug of expected product.
        try {
            ProductReviewsPage result = apiInstance.productReviewsBySlug(slug);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productReviewsBySlug");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String slug = slug_example; // String | Slug of expected product.
        try {
            ProductReviewsPage result = apiInstance.productReviewsBySlug(slug);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#productReviewsBySlug");
            e.printStackTrace();
        }
    }
}
String *slug = slug_example; // Slug of expected product.

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

// Show reviews.
[apiInstance productReviewsBySlugWith:slug
              completionHandler: ^(ProductReviewsPage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.ProductsApi()

var slug = slug_example; // {String} Slug of expected product.


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

namespace Example
{
    public class productReviewsBySlugExample
    {
        public void main()
        {
            
            var apiInstance = new ProductsApi();
            var slug = slug_example;  // String | Slug of expected product.

            try
            {
                // Show reviews.
                ProductReviewsPage result = apiInstance.productReviewsBySlug(slug);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.productReviewsBySlug: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProductsApi();
$slug = slug_example; // String | Slug of expected product.

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

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $slug = slug_example; # String | Slug of expected product.

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

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
slug = slug_example # String | Slug of expected product.

try: 
    # Show reviews.
    api_response = api_instance.product_reviews_by_slug(slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->productReviewsBySlug: %s\n" % e)

Parameters

Path parameters
Name Description
slug*
String
Slug of expected product.
Required

Responses

Status: 200 - A paginated list of all reviews related to the product identified by slug.


Shopmanager

apiV1ZipsZipGet

Find the channels for a specific ZIP


/api/v1/zips/{zip}

Usage and SDK Samples

curl -X GET "http://localhost/api/v1/zips/{zip}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShopmanagerApi;

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

public class ShopmanagerApiExample {

    public static void main(String[] args) {
        
        ShopmanagerApi apiInstance = new ShopmanagerApi();
        Integer zip = 56; // Integer | 
        try {
            ZipResponse result = apiInstance.apiV1ZipsZipGet(zip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShopmanagerApi#apiV1ZipsZipGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShopmanagerApi;

public class ShopmanagerApiExample {

    public static void main(String[] args) {
        ShopmanagerApi apiInstance = new ShopmanagerApi();
        Integer zip = 56; // Integer | 
        try {
            ZipResponse result = apiInstance.apiV1ZipsZipGet(zip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShopmanagerApi#apiV1ZipsZipGet");
            e.printStackTrace();
        }
    }
}
Integer *zip = 56; // 

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

// Find the channels for a specific ZIP
[apiInstance apiV1ZipsZipGetWith:zip
              completionHandler: ^(ZipResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.ShopmanagerApi()

var zip = 56; // {Integer} 


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

namespace Example
{
    public class apiV1ZipsZipGetExample
    {
        public void main()
        {
            
            var apiInstance = new ShopmanagerApi();
            var zip = 56;  // Integer | 

            try
            {
                // Find the channels for a specific ZIP
                ZipResponse result = apiInstance.apiV1ZipsZipGet(zip);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShopmanagerApi.apiV1ZipsZipGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShopmanagerApi();
$zip = 56; // Integer | 

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

my $api_instance = WWW::SwaggerClient::ShopmanagerApi->new();
my $zip = 56; # Integer | 

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

# create an instance of the API class
api_instance = swagger_client.ShopmanagerApi()
zip = 56 # Integer | 

try: 
    # Find the channels for a specific ZIP
    api_response = api_instance.api_v1_zips_zip_get(zip)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShopmanagerApi->apiV1ZipsZipGet: %s\n" % e)

Parameters

Path parameters
Name Description
zip*
Integer
Required

Responses

Status: 200 - zipLocations for the given ZIP


Taxons

taxonDetails

Show taxon with given code.

This endpoint will return a taxon with given code, children and the root node with direct path to this taxon.


/shop-api/taxons/{code}

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/taxons/{code}?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonsApi;

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

public class TaxonsApiExample {

    public static void main(String[] args) {
        
        TaxonsApi apiInstance = new TaxonsApi();
        String code = code_example; // String | Code of expected taxon.
        String locale = locale_example; // String | Locale in which taxons should be shown.
        try {
            TaxonDetails result = apiInstance.taxonDetails(code, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonsApi#taxonDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonsApi;

public class TaxonsApiExample {

    public static void main(String[] args) {
        TaxonsApi apiInstance = new TaxonsApi();
        String code = code_example; // String | Code of expected taxon.
        String locale = locale_example; // String | Locale in which taxons should be shown.
        try {
            TaxonDetails result = apiInstance.taxonDetails(code, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonsApi#taxonDetails");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Code of expected taxon.
String *locale = locale_example; // Locale in which taxons should be shown. (optional)

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

// Show taxon with given code.
[apiInstance taxonDetailsWith:code
    locale:locale
              completionHandler: ^(TaxonDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.TaxonsApi()

var code = code_example; // {String} Code of expected taxon.

var opts = { 
  'locale': locale_example // {String} Locale in which taxons should be shown.
};

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

namespace Example
{
    public class taxonDetailsExample
    {
        public void main()
        {
            
            var apiInstance = new TaxonsApi();
            var code = code_example;  // String | Code of expected taxon.
            var locale = locale_example;  // String | Locale in which taxons should be shown. (optional) 

            try
            {
                // Show taxon with given code.
                TaxonDetails result = apiInstance.taxonDetails(code, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonsApi.taxonDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonsApi();
$code = code_example; // String | Code of expected taxon.
$locale = locale_example; // String | Locale in which taxons should be shown.

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

my $api_instance = WWW::SwaggerClient::TaxonsApi->new();
my $code = code_example; # String | Code of expected taxon.
my $locale = locale_example; # String | Locale in which taxons should be shown.

eval { 
    my $result = $api_instance->taxonDetails(code => $code, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaxonsApi->taxonDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TaxonsApi()
code = code_example # String | Code of expected taxon.
locale = locale_example # String | Locale in which taxons should be shown. (optional)

try: 
    # Show taxon with given code.
    api_response = api_instance.taxon_details(code, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonsApi->taxonDetails: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code of expected taxon.
Required
Query parameters
Name Description
locale
String
Locale in which taxons should be shown.

Responses

Status: 200 - Requested taxon with children.


taxonTree

Show taxon tree.

This endpoint will return an array of all available taxon roots with all of its children.


/shop-api/taxons

Usage and SDK Samples

curl -X GET "http://localhost/shop-api/taxons?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonsApi;

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

public class TaxonsApiExample {

    public static void main(String[] args) {
        
        TaxonsApi apiInstance = new TaxonsApi();
        String locale = locale_example; // String | Locale in which taxons should be shown.
        try {
            array[Taxon] result = apiInstance.taxonTree(locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonsApi#taxonTree");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonsApi;

public class TaxonsApiExample {

    public static void main(String[] args) {
        TaxonsApi apiInstance = new TaxonsApi();
        String locale = locale_example; // String | Locale in which taxons should be shown.
        try {
            array[Taxon] result = apiInstance.taxonTree(locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonsApi#taxonTree");
            e.printStackTrace();
        }
    }
}
String *locale = locale_example; // Locale in which taxons should be shown. (optional)

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

// Show taxon tree.
[apiInstance taxonTreeWith:locale
              completionHandler: ^(array[Taxon] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.TaxonsApi()

var opts = { 
  'locale': locale_example // {String} Locale in which taxons should be shown.
};

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

namespace Example
{
    public class taxonTreeExample
    {
        public void main()
        {
            
            var apiInstance = new TaxonsApi();
            var locale = locale_example;  // String | Locale in which taxons should be shown. (optional) 

            try
            {
                // Show taxon tree.
                array[Taxon] result = apiInstance.taxonTree(locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonsApi.taxonTree: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonsApi();
$locale = locale_example; // String | Locale in which taxons should be shown.

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

my $api_instance = WWW::SwaggerClient::TaxonsApi->new();
my $locale = locale_example; # String | Locale in which taxons should be shown.

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

# create an instance of the API class
api_instance = swagger_client.TaxonsApi()
locale = locale_example # String | Locale in which taxons should be shown. (optional)

try: 
    # Show taxon tree.
    api_response = api_instance.taxon_tree(locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonsApi->taxonTree: %s\n" % e)

Parameters

Query parameters
Name Description
locale
String
Locale in which taxons should be shown.

Responses

Status: 200 - Array of all available taxons.


Users

loginUser

Logs the user in and returns the token

This route is needed to log the user in and get an access token.


/shop-api/login

Usage and SDK Samples

curl -X POST "http://localhost/shop-api/login"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        LoginRequest content = ; // LoginRequest | 
        try {
            apiInstance.loginUser(content);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#loginUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        LoginRequest content = ; // LoginRequest | 
        try {
            apiInstance.loginUser(content);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#loginUser");
            e.printStackTrace();
        }
    }
}
LoginRequest *content = ; // 

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

// Logs the user in and returns the token
[apiInstance loginUserWith:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.UsersApi()

var content = ; // {LoginRequest} 


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

namespace Example
{
    public class loginUserExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var content = new LoginRequest(); // LoginRequest | 

            try
            {
                // Logs the user in and returns the token
                apiInstance.loginUser(content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.loginUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$content = ; // LoginRequest | 

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $content = WWW::SwaggerClient::Object::LoginRequest->new(); # LoginRequest | 

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

# create an instance of the API class
api_instance = swagger_client.UsersApi()
content =  # LoginRequest | 

try: 
    # Logs the user in and returns the token
    api_instance.login_user(content)
except ApiException as e:
    print("Exception when calling UsersApi->loginUser: %s\n" % e)

Parameters

Body parameters
Name Description
content *

Responses

Status: 200 - User was logged in


me

Provides currently logged in user details.


/shop-api/me

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://localhost/shop-api/me"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        try {
            LoggedInCustomerDetails result = apiInstance.me();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#me");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        try {
            LoggedInCustomerDetails result = apiInstance.me();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#me");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Provides currently logged in user details.
[apiInstance meWithCompletionHandler: 
              ^(LoggedInCustomerDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');
var defaultClient = ShopManagerApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new ShopManagerApi.UsersApi()

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

namespace Example
{
    public class meExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();

            try
            {
                // Provides currently logged in user details.
                LoggedInCustomerDetails result = apiInstance.me();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.me: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();

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

# Configure API key authorization: bearerAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();

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

# Configure API key authorization: bearerAuth
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()

try: 
    # Provides currently logged in user details.
    api_response = api_instance.me()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->me: %s\n" % e)

Parameters

Responses

Status: 200 - Provides currently logged in user details.

Status: 500 - There is no currently logged in user.


passwordReset

Password reset.

This endpoint resets the user password.


/shop-api/password-reset/{token}

Usage and SDK Samples

curl -X PUT "http://localhost/shop-api/password-reset/{token}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String token = token_example; // String | Password reset token.
        PasswordResetRequest content = ; // PasswordResetRequest | 
        try {
            apiInstance.passwordReset(token, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#passwordReset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String token = token_example; // String | Password reset token.
        PasswordResetRequest content = ; // PasswordResetRequest | 
        try {
            apiInstance.passwordReset(token, content);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#passwordReset");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // Password reset token.
PasswordResetRequest *content = ; // 

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

// Password reset.
[apiInstance passwordResetWith:token
    content:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.UsersApi()

var token = token_example; // {String} Password reset token.

var content = ; // {PasswordResetRequest} 


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

namespace Example
{
    public class passwordResetExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var token = token_example;  // String | Password reset token.
            var content = new PasswordResetRequest(); // PasswordResetRequest | 

            try
            {
                // Password reset.
                apiInstance.passwordReset(token, content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.passwordReset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$token = token_example; // String | Password reset token.
$content = ; // PasswordResetRequest | 

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $token = token_example; # String | Password reset token.
my $content = WWW::SwaggerClient::Object::PasswordResetRequest->new(); # PasswordResetRequest | 

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

# create an instance of the API class
api_instance = swagger_client.UsersApi()
token = token_example # String | Password reset token.
content =  # PasswordResetRequest | 

try: 
    # Password reset.
    api_instance.password_reset(token, content)
except ApiException as e:
    print("Exception when calling UsersApi->passwordReset: %s\n" % e)

Parameters

Path parameters
Name Description
token*
String
Password reset token.
Required
Body parameters
Name Description
content *

Responses

Status: 204 - Update password request success.

Status: 400 - Token not found.


registerUser

Registering a new user

This creates a new user that can log in the shop


/shop-api/register

Usage and SDK Samples

curl -X POST "http://localhost/shop-api/register"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        RegisterRequest content = ; // RegisterRequest | 
        try {
            apiInstance.registerUser(content);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#registerUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        RegisterRequest content = ; // RegisterRequest | 
        try {
            apiInstance.registerUser(content);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#registerUser");
            e.printStackTrace();
        }
    }
}
RegisterRequest *content = ; // 

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

// Registering a new user
[apiInstance registerUserWith:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.UsersApi()

var content = ; // {RegisterRequest} 


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

namespace Example
{
    public class registerUserExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var content = new RegisterRequest(); // RegisterRequest | 

            try
            {
                // Registering a new user
                apiInstance.registerUser(content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.registerUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$content = ; // RegisterRequest | 

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $content = WWW::SwaggerClient::Object::RegisterRequest->new(); # RegisterRequest | 

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

# create an instance of the API class
api_instance = swagger_client.UsersApi()
content =  # RegisterRequest | 

try: 
    # Registering a new user
    api_instance.register_user(content)
except ApiException as e:
    print("Exception when calling UsersApi->registerUser: %s\n" % e)

Parameters

Body parameters
Name Description
content *

Responses

Status: 204 - The user was successfully created

Status: 400 - There were validation errors

Status: 500 - Channel not found


requestPasswordReset

Request resetting password of user with passed email.

Email with reset password path will be sent to user. Default path for password resetting is `/password-reset/{token}`. To change it, you need to override template `@SyliusShopApi\Email\passwordReset.html.twig`.


/shop-api/request-password-reset

Usage and SDK Samples

curl -X PUT "http://localhost/shop-api/request-password-reset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        RequestPasswordResetting content = ; // RequestPasswordResetting | 
        try {
            apiInstance.requestPasswordReset(content);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#requestPasswordReset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        RequestPasswordResetting content = ; // RequestPasswordResetting | 
        try {
            apiInstance.requestPasswordReset(content);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#requestPasswordReset");
            e.printStackTrace();
        }
    }
}
RequestPasswordResetting *content = ; // 

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

// Request resetting password of user with passed email.
[apiInstance requestPasswordResetWith:content
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');

var api = new ShopManagerApi.UsersApi()

var content = ; // {RequestPasswordResetting} 


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

namespace Example
{
    public class requestPasswordResetExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var content = new RequestPasswordResetting(); // RequestPasswordResetting | 

            try
            {
                // Request resetting password of user with passed email.
                apiInstance.requestPasswordReset(content);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.requestPasswordReset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$content = ; // RequestPasswordResetting | 

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $content = WWW::SwaggerClient::Object::RequestPasswordResetting->new(); # RequestPasswordResetting | 

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

# create an instance of the API class
api_instance = swagger_client.UsersApi()
content =  # RequestPasswordResetting | 

try: 
    # Request resetting password of user with passed email.
    api_instance.request_password_reset(content)
except ApiException as e:
    print("Exception when calling UsersApi->requestPasswordReset: %s\n" % e)

Parameters

Body parameters
Name Description
content *

Responses

Status: 204 - Reset password request has been sent.

Status: 500 - User with provided email has not been found.


updateUser

Updates currently logged in users details.


/shop-api/me

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "http://localhost/shop-api/me"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearerAuth
        ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearerAuth.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        UpdateUserRequest content = ; // UpdateUserRequest | 
        try {
            LoggedInCustomerDetails result = apiInstance.updateUser(content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UpdateUserRequest content = ; // UpdateUserRequest | 
        try {
            LoggedInCustomerDetails result = apiInstance.updateUser(content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearerAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UpdateUserRequest *content = ; // 

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

// Updates currently logged in users details.
[apiInstance updateUserWith:content
              completionHandler: ^(LoggedInCustomerDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ShopManagerApi = require('shop_manager_api');
var defaultClient = ShopManagerApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new ShopManagerApi.UsersApi()

var content = ; // {UpdateUserRequest} 


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

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearerAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var content = new UpdateUserRequest(); // UpdateUserRequest | 

            try
            {
                // Updates currently logged in users details.
                LoggedInCustomerDetails result = apiInstance.updateUser(content);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$content = ; // UpdateUserRequest | 

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

# Configure API key authorization: bearerAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $content = WWW::SwaggerClient::Object::UpdateUserRequest->new(); # UpdateUserRequest | 

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

# Configure API key authorization: bearerAuth
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
content =  # UpdateUserRequest | 

try: 
    # Updates currently logged in users details.
    api_response = api_instance.update_user(content)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->updateUser: %s\n" % e)

Parameters

Body parameters
Name Description
content *

Responses

Status: 200 - User successfully updated.

Status: 401 - User token is invalid.

Status: 500 - There is no currently logged in user.