Commerce Webservices

AccommodationCarts

addLeadGuestDetails

Add lead guest details

Adds or updates the lead guest details for a room stays in the cart. Also specifies the expected guest occupancy for the given room stay.


/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/leadGuest

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/leadGuest"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        LeadGuest body = ; // LeadGuest | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addLeadGuestDetails(body, baseSiteId, cartId, roomStayRefNumber, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#addLeadGuestDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        LeadGuest body = ; // LeadGuest | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addLeadGuestDetails(body, baseSiteId, cartId, roomStayRefNumber, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#addLeadGuestDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
LeadGuest *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *roomStayRefNumber = 56; // Room Stay unique identifier - identifies a room stay in the cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Add lead guest details
[apiInstance addLeadGuestDetailsWith:body
    baseSiteId:baseSiteId
    cartId:cartId
    roomStayRefNumber:roomStayRefNumber
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var body = ; // {{LeadGuest}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var roomStayRefNumber = 56; // {{Integer}} Room Stay unique identifier - identifies a room stay in the cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationCartsApi();
            var body = new LeadGuest(); // LeadGuest | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var roomStayRefNumber = 56;  // Integer | Room Stay unique identifier - identifies a room stay in the cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Add lead guest details
                'String' result = apiInstance.addLeadGuestDetails(body, baseSiteId, cartId, roomStayRefNumber, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.addLeadGuestDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$body = ; // LeadGuest | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $body = WWW::SwaggerClient::Object::LeadGuest->new(); # LeadGuest | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $roomStayRefNumber = 56; # Integer | Room Stay unique identifier - identifies a room stay in the cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->addLeadGuestDetails(body => $body, baseSiteId => $baseSiteId, cartId => $cartId, roomStayRefNumber => $roomStayRefNumber, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->addLeadGuestDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
body =  # LeadGuest | 
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
roomStayRefNumber = 56 # Integer | Room Stay unique identifier - identifies a room stay in the cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Add lead guest details
    api_response = api_instance.add_lead_guest_details(body, baseSiteId, cartId, roomStayRefNumber, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->addLeadGuestDetails: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
roomStayRefNumber*
Integer (int32)
Room Stay unique identifier - identifies a room stay in the cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


addRoomStay

Perform the add room stays to cart.

Add rates and included services to the cart for the period specified in the request.


/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        AddRoomStayToCartRequest body = ; // AddRoomStayToCartRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addRoomStay(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#addRoomStay");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        AddRoomStayToCartRequest body = ; // AddRoomStayToCartRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addRoomStay(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#addRoomStay");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AddRoomStayToCartRequest *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Perform the add room stays to cart.
[apiInstance addRoomStayWith:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var body = ; // {{AddRoomStayToCartRequest}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationCartsApi();
            var body = new AddRoomStayToCartRequest(); // AddRoomStayToCartRequest | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Perform the add room stays to cart.
                'String' result = apiInstance.addRoomStay(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.addRoomStay: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$body = ; // AddRoomStayToCartRequest | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $body = WWW::SwaggerClient::Object::AddRoomStayToCartRequest->new(); # AddRoomStayToCartRequest | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->addRoomStay(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->addRoomStay: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
body =  # AddRoomStayToCartRequest | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Perform the add room stays to cart.
    api_response = api_instance.add_room_stay(body, sap.cxSalesApplication, baseSiteId, cartId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->addRoomStay: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


changeRoomStayDates

Modifies check in and check out dates against room rates in the cart

Applies dates change to all the room stays in the cart, in case of availability of all the selected accommodations and all the selected rate plans.


/{baseSiteId}/users/{userId}/carts/{cartId}/changeStayDates

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/changeStayDates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        UpdateRoomStaysRequest body = ; // UpdateRoomStaysRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.changeRoomStayDates(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#changeRoomStayDates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        UpdateRoomStaysRequest body = ; // UpdateRoomStaysRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.changeRoomStayDates(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#changeRoomStayDates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UpdateRoomStaysRequest *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Modifies check in and check out dates against room rates in the cart
[apiInstance changeRoomStayDatesWith:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var body = ; // {{UpdateRoomStaysRequest}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationCartsApi();
            var body = new UpdateRoomStaysRequest(); // UpdateRoomStaysRequest | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Modifies check in and check out dates against room rates in the cart
                apiInstance.changeRoomStayDates(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.changeRoomStayDates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$body = ; // UpdateRoomStaysRequest | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->changeRoomStayDates($body, $sap.cxSalesApplication, $baseSiteId, $cartId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationCartsApi->changeRoomStayDates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationCartsApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRoomStaysRequest->new(); # UpdateRoomStaysRequest | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->changeRoomStayDates(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->changeRoomStayDates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
body =  # UpdateRoomStaysRequest | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Modifies check in and check out dates against room rates in the cart
    api_instance.change_room_stay_dates(body, sap.cxSalesApplication, baseSiteId, cartId, userId)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->changeRoomStayDates: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Name Type Format Description

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Internal Server Error


createServiceEntry

Add accommodation service entry to cart

Adds an accommodation service entry linked to the specified room stay


/{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        AddServiceEntryRequest body = ; // AddServiceEntryRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.createServiceEntry(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#createServiceEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        AddServiceEntryRequest body = ; // AddServiceEntryRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.createServiceEntry(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#createServiceEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AddServiceEntryRequest *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Add accommodation service entry to cart
[apiInstance createServiceEntryWith:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var body = ; // {{AddServiceEntryRequest}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationCartsApi();
            var body = new AddServiceEntryRequest(); // AddServiceEntryRequest | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Add accommodation service entry to cart
                apiInstance.createServiceEntry(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.createServiceEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$body = ; // AddServiceEntryRequest | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->createServiceEntry($body, $sap.cxSalesApplication, $baseSiteId, $cartId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationCartsApi->createServiceEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationCartsApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $body = WWW::SwaggerClient::Object::AddServiceEntryRequest->new(); # AddServiceEntryRequest | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->createServiceEntry(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->createServiceEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
body =  # AddServiceEntryRequest | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Add accommodation service entry to cart
    api_instance.create_service_entry(body, sap.cxSalesApplication, baseSiteId, cartId, userId)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->createServiceEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


deleteAccommodationServiceEntry

Delete accommodation service entry from cart

Deletes an accommodation service entry linked to the specified room stay


/{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries/{entryId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries/{entryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.deleteAccommodationServiceEntry(baseSiteId, cartId, entryId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#deleteAccommodationServiceEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.deleteAccommodationServiceEntry(baseSiteId, cartId, entryId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#deleteAccommodationServiceEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *entryId = 56; // The entry identifier. Each entry in a cart has an entry identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Delete accommodation service entry from cart
[apiInstance deleteAccommodationServiceEntryWith:baseSiteId
    cartId:cartId
    entryId:entryId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryId = 56; // {{Integer}} The entry identifier. Each entry in a cart has an entry identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryId = 56;  // Integer | The entry identifier. Each entry in a cart has an entry identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Delete accommodation service entry from cart
                apiInstance.deleteAccommodationServiceEntry(baseSiteId, cartId, entryId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.deleteAccommodationServiceEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->deleteAccommodationServiceEntry($baseSiteId, $cartId, $entryId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationCartsApi->deleteAccommodationServiceEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationCartsApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryId = 56; # Integer | The entry identifier. Each entry in a cart has an entry identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->deleteAccommodationServiceEntry(baseSiteId => $baseSiteId, cartId => $cartId, entryId => $entryId, userId => $userId);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->deleteAccommodationServiceEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryId = 56 # Integer | The entry identifier. Each entry in a cart has an entry identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Delete accommodation service entry from cart
    api_instance.delete_accommodation_service_entry(baseSiteId, cartId, entryId, userId)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->deleteAccommodationServiceEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryId*
Integer (int32)
The entry identifier. Each entry in a cart has an entry identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


deleteRoomStay

Deletes a room stay from cart.

Deletes the specified room stay from the cart, if present, and all the associated products.


/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.deleteRoomStay(baseSiteId, cartId, roomStayRefNumber, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#deleteRoomStay");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.deleteRoomStay(baseSiteId, cartId, roomStayRefNumber, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#deleteRoomStay");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *roomStayRefNumber = 56; // Room Stay unique identifier - identifies a room stay in the cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Deletes a room stay from cart.
[apiInstance deleteRoomStayWith:baseSiteId
    cartId:cartId
    roomStayRefNumber:roomStayRefNumber
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var roomStayRefNumber = 56; // {{Integer}} Room Stay unique identifier - identifies a room stay in the cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var roomStayRefNumber = 56;  // Integer | Room Stay unique identifier - identifies a room stay in the cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Deletes a room stay from cart.
                'String' result = apiInstance.deleteRoomStay(baseSiteId, cartId, roomStayRefNumber, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.deleteRoomStay: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $roomStayRefNumber = 56; # Integer | Room Stay unique identifier - identifies a room stay in the cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->deleteRoomStay(baseSiteId => $baseSiteId, cartId => $cartId, roomStayRefNumber => $roomStayRefNumber, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->deleteRoomStay: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
roomStayRefNumber = 56 # Integer | Room Stay unique identifier - identifies a room stay in the cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Deletes a room stay from cart.
    api_response = api_instance.delete_room_stay(baseSiteId, cartId, roomStayRefNumber, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->deleteRoomStay: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
roomStayRefNumber*
Integer (int32)
Room Stay unique identifier - identifies a room stay in the cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


getAccommodationServiceEntry

Gets details of an accommodation service entry.

Gets the details of an accommodation service cart entry, such as the product added, the quantity in cart, and price information.


/{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries/{entryId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries/{entryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.getAccommodationServiceEntry(baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#getAccommodationServiceEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.getAccommodationServiceEntry(baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#getAccommodationServiceEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *entryId = 56; // The entry identifier. Each entry in a cart has an entry identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Gets details of an accommodation service entry.
[apiInstance getAccommodationServiceEntryWith:baseSiteId
    cartId:cartId
    entryId:entryId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryId = 56; // {{Integer}} The entry identifier. Each entry in a cart has an entry identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryId = 56;  // Integer | The entry identifier. Each entry in a cart has an entry identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Gets details of an accommodation service entry.
                'String' result = apiInstance.getAccommodationServiceEntry(baseSiteId, cartId, entryId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.getAccommodationServiceEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryId = 56; # Integer | The entry identifier. Each entry in a cart has an entry identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->getAccommodationServiceEntry(baseSiteId => $baseSiteId, cartId => $cartId, entryId => $entryId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->getAccommodationServiceEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryId = 56 # Integer | The entry identifier. Each entry in a cart has an entry identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Gets details of an accommodation service entry.
    api_response = api_instance.get_accommodation_service_entry(baseSiteId, cartId, entryId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->getAccommodationServiceEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryId*
Integer (int32)
The entry identifier. Each entry in a cart has an entry identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getAvailableAccommodationServices

Searches for all available services

Searches for all available services for the room stays present in the cart with the given ID


/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/accommodationServices

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/accommodationServices"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String roomStayRefNumber = roomStayRefNumber_example; // String | The room stay reference number for which the services are returned
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getAvailableAccommodationServices(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#getAvailableAccommodationServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String roomStayRefNumber = roomStayRefNumber_example; // String | The room stay reference number for which the services are returned
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getAvailableAccommodationServices(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#getAvailableAccommodationServices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *roomStayRefNumber = roomStayRefNumber_example; // The room stay reference number for which the services are returned
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

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

// Searches for all available services
[apiInstance getAvailableAccommodationServicesWith:baseSiteId
    cartId:cartId
    roomStayRefNumber:roomStayRefNumber
    sap.cxSalesApplication:sap.cxSalesApplication
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var roomStayRefNumber = roomStayRefNumber_example; // {{String}} The room stay reference number for which the services are returned
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvailableAccommodationServices(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AccommodationCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var roomStayRefNumber = roomStayRefNumber_example;  // String | The room stay reference number for which the services are returned
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Searches for all available services
                'String' result = apiInstance.getAvailableAccommodationServices(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.getAvailableAccommodationServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$roomStayRefNumber = roomStayRefNumber_example; // String | The room stay reference number for which the services are returned
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getAvailableAccommodationServices($baseSiteId, $cartId, $roomStayRefNumber, $sap.cxSalesApplication, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationCartsApi->getAvailableAccommodationServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationCartsApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $roomStayRefNumber = roomStayRefNumber_example; # String | The room stay reference number for which the services are returned
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getAvailableAccommodationServices(baseSiteId => $baseSiteId, cartId => $cartId, roomStayRefNumber => $roomStayRefNumber, sap.cxSalesApplication => $sap.cxSalesApplication, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->getAvailableAccommodationServices: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
roomStayRefNumber = roomStayRefNumber_example # String | The room stay reference number for which the services are returned
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Searches for all available services
    api_response = api_instance.get_available_accommodation_services(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->getAvailableAccommodationServices: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
roomStayRefNumber*
String
The room stay reference number for which the services are returned
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-sales-application*
String
The sales application code
Required

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 422 - Unprocessable Entity)

Status: 500 - Server Error


getGuaranteesForRoomStay

Returns guarantees for a room stay

Returns information about the guarantees applied to the given room stays according with the selected rate plan


/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/guarantees

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/guarantees"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String roomStayRefNumber = roomStayRefNumber_example; // String | The room stay reference number for which the services are returned
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            GuaranteeList result = apiInstance.getGuaranteesForRoomStay(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#getGuaranteesForRoomStay");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String roomStayRefNumber = roomStayRefNumber_example; // String | The room stay reference number for which the services are returned
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            GuaranteeList result = apiInstance.getGuaranteesForRoomStay(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#getGuaranteesForRoomStay");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *roomStayRefNumber = roomStayRefNumber_example; // The room stay reference number for which the services are returned
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

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

// Returns guarantees for a room stay
[apiInstance getGuaranteesForRoomStayWith:baseSiteId
    cartId:cartId
    roomStayRefNumber:roomStayRefNumber
    sap.cxSalesApplication:sap.cxSalesApplication
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^(GuaranteeList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var roomStayRefNumber = roomStayRefNumber_example; // {{String}} The room stay reference number for which the services are returned
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGuaranteesForRoomStay(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AccommodationCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var roomStayRefNumber = roomStayRefNumber_example;  // String | The room stay reference number for which the services are returned
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Returns guarantees for a room stay
                GuaranteeList result = apiInstance.getGuaranteesForRoomStay(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.getGuaranteesForRoomStay: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$roomStayRefNumber = roomStayRefNumber_example; // String | The room stay reference number for which the services are returned
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getGuaranteesForRoomStay($baseSiteId, $cartId, $roomStayRefNumber, $sap.cxSalesApplication, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationCartsApi->getGuaranteesForRoomStay: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationCartsApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $roomStayRefNumber = roomStayRefNumber_example; # String | The room stay reference number for which the services are returned
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getGuaranteesForRoomStay(baseSiteId => $baseSiteId, cartId => $cartId, roomStayRefNumber => $roomStayRefNumber, sap.cxSalesApplication => $sap.cxSalesApplication, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->getGuaranteesForRoomStay: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
roomStayRefNumber = roomStayRefNumber_example # String | The room stay reference number for which the services are returned
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Returns guarantees for a room stay
    api_response = api_instance.get_guarantees_for_room_stay(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->getGuaranteesForRoomStay: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
roomStayRefNumber*
String
The room stay reference number for which the services are returned
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-sales-application*
String
The sales application code
Required

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


getPenaltiesForRoomStay

Returns cancel penalties for a room stay

Returns information about the cancel penalties applied to the given room stays according with the selected rate plan


/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/cancelPenalties

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/cancelPenalties"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String roomStayRefNumber = roomStayRefNumber_example; // String | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            CancelPenaltyList result = apiInstance.getPenaltiesForRoomStay(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#getPenaltiesForRoomStay");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String roomStayRefNumber = roomStayRefNumber_example; // String | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            CancelPenaltyList result = apiInstance.getPenaltiesForRoomStay(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#getPenaltiesForRoomStay");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *roomStayRefNumber = roomStayRefNumber_example; // The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

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

// Returns cancel penalties for a room stay
[apiInstance getPenaltiesForRoomStayWith:baseSiteId
    cartId:cartId
    roomStayRefNumber:roomStayRefNumber
    sap.cxSalesApplication:sap.cxSalesApplication
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^(CancelPenaltyList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var roomStayRefNumber = roomStayRefNumber_example; // {{String}} The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPenaltiesForRoomStay(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AccommodationCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var roomStayRefNumber = roomStayRefNumber_example;  // String | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Returns cancel penalties for a room stay
                CancelPenaltyList result = apiInstance.getPenaltiesForRoomStay(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.getPenaltiesForRoomStay: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$roomStayRefNumber = roomStayRefNumber_example; // String | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getPenaltiesForRoomStay($baseSiteId, $cartId, $roomStayRefNumber, $sap.cxSalesApplication, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationCartsApi->getPenaltiesForRoomStay: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationCartsApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $roomStayRefNumber = roomStayRefNumber_example; # String | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getPenaltiesForRoomStay(baseSiteId => $baseSiteId, cartId => $cartId, roomStayRefNumber => $roomStayRefNumber, sap.cxSalesApplication => $sap.cxSalesApplication, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->getPenaltiesForRoomStay: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
roomStayRefNumber = roomStayRefNumber_example # String | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Returns cancel penalties for a room stay
    api_response = api_instance.get_penalties_for_room_stay(baseSiteId, cartId, roomStayRefNumber, sap.cxSalesApplication, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->getPenaltiesForRoomStay: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
roomStayRefNumber*
String
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-sales-application*
String
The sales application code
Required

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


updateServiceEntry

Update accommodation service entry to cart

Updates an accommodation service entry linked to the specified room stay


/{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries/{entryId}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/serviceEntries/{entryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;

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

public class AccommodationCartsApiExample {

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

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

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

        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        AddServiceEntryRequest body = ; // AddServiceEntryRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.updateServiceEntry(body, sap.cxSalesApplication, baseSiteId, cartId, entryId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#updateServiceEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationCartsApi;

public class AccommodationCartsApiExample {

    public static void main(String[] args) {
        AccommodationCartsApi apiInstance = new AccommodationCartsApi();
        AddServiceEntryRequest body = ; // AddServiceEntryRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.updateServiceEntry(body, sap.cxSalesApplication, baseSiteId, cartId, entryId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationCartsApi#updateServiceEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AddServiceEntryRequest *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *entryId = 56; // The entry identifier. Each entry in a cart has an entry identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Update accommodation service entry to cart
[apiInstance updateServiceEntryWith:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    cartId:cartId
    entryId:entryId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationCartsApi()
var body = ; // {{AddServiceEntryRequest}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryId = 56; // {{Integer}} The entry identifier. Each entry in a cart has an entry identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationCartsApi();
            var body = new AddServiceEntryRequest(); // AddServiceEntryRequest | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryId = 56;  // Integer | The entry identifier. Each entry in a cart has an entry identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Update accommodation service entry to cart
                apiInstance.updateServiceEntry(body, sap.cxSalesApplication, baseSiteId, cartId, entryId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationCartsApi.updateServiceEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$body = ; // AddServiceEntryRequest | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->updateServiceEntry($body, $sap.cxSalesApplication, $baseSiteId, $cartId, $entryId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationCartsApi->updateServiceEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationCartsApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $body = WWW::SwaggerClient::Object::AddServiceEntryRequest->new(); # AddServiceEntryRequest | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryId = 56; # Integer | The entry identifier. Each entry in a cart has an entry identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->updateServiceEntry(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, cartId => $cartId, entryId => $entryId, userId => $userId);
};
if ($@) {
    warn "Exception when calling AccommodationCartsApi->updateServiceEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
body =  # AddServiceEntryRequest | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryId = 56 # Integer | The entry identifier. Each entry in a cart has an entry identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Update accommodation service entry to cart
    api_instance.update_service_entry(body, sap.cxSalesApplication, baseSiteId, cartId, entryId, userId)
except ApiException as e:
    print("Exception when calling AccommodationCartsApi->updateServiceEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryId*
Integer (int32)
The entry identifier. Each entry in a cart has an entry identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


AccommodationOfferings

getAccommodationOffering

Returns information about a specific accommodation offering

Returns detailed information about the given accommodation offering, alongside with the available rates for any room type defined in the property


/{baseSiteId}/accommodationOfferings/{accommodationOfferingCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/accommodationOfferings/{accommodationOfferingCode}?checkInDate=&checkOutDate=&roomGuestOccupancy="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationOfferingsApi;

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

public class AccommodationOfferingsApiExample {

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

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

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

        AccommodationOfferingsApi apiInstance = new AccommodationOfferingsApi();
        String accommodationOfferingCode = accommodationOfferingCode_example; // String | Accommodation offering identifier
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String checkInDate = checkInDate_example; // String | The check in date
        String checkOutDate = checkOutDate_example; // String | The check out date
        String roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room in form of - comma separated. For example, 2-adult:1-child:1-infant
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        try {
            AccommodationOfferingDetails result = apiInstance.getAccommodationOffering(accommodationOfferingCode, baseSiteId, checkInDate, checkOutDate, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage, sap.cxAcceptCurrency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOfferingsApi#getAccommodationOffering");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationOfferingsApi;

public class AccommodationOfferingsApiExample {

    public static void main(String[] args) {
        AccommodationOfferingsApi apiInstance = new AccommodationOfferingsApi();
        String accommodationOfferingCode = accommodationOfferingCode_example; // String | Accommodation offering identifier
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String checkInDate = checkInDate_example; // String | The check in date
        String checkOutDate = checkOutDate_example; // String | The check out date
        String roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room in form of - comma separated. For example, 2-adult:1-child:1-infant
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        try {
            AccommodationOfferingDetails result = apiInstance.getAccommodationOffering(accommodationOfferingCode, baseSiteId, checkInDate, checkOutDate, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage, sap.cxAcceptCurrency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOfferingsApi#getAccommodationOffering");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accommodationOfferingCode = accommodationOfferingCode_example; // Accommodation offering identifier
String *baseSiteId = baseSiteId_example; // Base site identifier
String *checkInDate = checkInDate_example; // The check in date
String *checkOutDate = checkOutDate_example; // The check out date
String *roomGuestOccupancy = roomGuestOccupancy_example; // The guest occupancy per room in form of - comma separated. For example, 2-adult:1-child:1-infant
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
String *sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // Requested Currency for the client (optional)

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

// Returns information about a specific accommodation offering
[apiInstance getAccommodationOfferingWith:accommodationOfferingCode
    baseSiteId:baseSiteId
    checkInDate:checkInDate
    checkOutDate:checkOutDate
    roomGuestOccupancy:roomGuestOccupancy
    sap.cxSalesApplication:sap.cxSalesApplication
    acceptLanguage:acceptLanguage
    sap.cxAcceptCurrency:sap.cxAcceptCurrency
              completionHandler: ^(AccommodationOfferingDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationOfferingsApi()
var accommodationOfferingCode = accommodationOfferingCode_example; // {{String}} Accommodation offering identifier
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var checkInDate = checkInDate_example; // {{String}} The check in date
var checkOutDate = checkOutDate_example; // {{String}} The check out date
var roomGuestOccupancy = roomGuestOccupancy_example; // {{String}} The guest occupancy per room in form of - comma separated. For example, 2-adult:1-child:1-infant
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'sap.cxAcceptCurrency': sap.cxAcceptCurrency_example // {{String}} Requested Currency for the client
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccommodationOffering(accommodationOfferingCode, baseSiteId, checkInDate, checkOutDate, roomGuestOccupancy, sap.cxSalesApplication, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AccommodationOfferingsApi();
            var accommodationOfferingCode = accommodationOfferingCode_example;  // String | Accommodation offering identifier
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var checkInDate = checkInDate_example;  // String | The check in date
            var checkOutDate = checkOutDate_example;  // String | The check out date
            var roomGuestOccupancy = roomGuestOccupancy_example;  // String | The guest occupancy per room in form of - comma separated. For example, 2-adult:1-child:1-infant
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var sap.cxAcceptCurrency = sap.cxAcceptCurrency_example;  // String | Requested Currency for the client (optional) 

            try
            {
                // Returns information about a specific accommodation offering
                AccommodationOfferingDetails result = apiInstance.getAccommodationOffering(accommodationOfferingCode, baseSiteId, checkInDate, checkOutDate, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage, sap.cxAcceptCurrency);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationOfferingsApi.getAccommodationOffering: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationOfferingsApi();
$accommodationOfferingCode = accommodationOfferingCode_example; // String | Accommodation offering identifier
$baseSiteId = baseSiteId_example; // String | Base site identifier
$checkInDate = checkInDate_example; // String | The check in date
$checkOutDate = checkOutDate_example; // String | The check out date
$roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room in form of - comma separated. For example, 2-adult:1-child:1-infant
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client

try {
    $result = $api_instance->getAccommodationOffering($accommodationOfferingCode, $baseSiteId, $checkInDate, $checkOutDate, $roomGuestOccupancy, $sap.cxSalesApplication, $acceptLanguage, $sap.cxAcceptCurrency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationOfferingsApi->getAccommodationOffering: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationOfferingsApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationOfferingsApi->new();
my $accommodationOfferingCode = accommodationOfferingCode_example; # String | Accommodation offering identifier
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $checkInDate = checkInDate_example; # String | The check in date
my $checkOutDate = checkOutDate_example; # String | The check out date
my $roomGuestOccupancy = roomGuestOccupancy_example; # String | The guest occupancy per room in form of - comma separated. For example, 2-adult:1-child:1-infant
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; # String | Requested Currency for the client

eval { 
    my $result = $api_instance->getAccommodationOffering(accommodationOfferingCode => $accommodationOfferingCode, baseSiteId => $baseSiteId, checkInDate => $checkInDate, checkOutDate => $checkOutDate, roomGuestOccupancy => $roomGuestOccupancy, sap.cxSalesApplication => $sap.cxSalesApplication, acceptLanguage => $acceptLanguage, sap.cxAcceptCurrency => $sap.cxAcceptCurrency);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationOfferingsApi->getAccommodationOffering: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationOfferingsApi()
accommodationOfferingCode = accommodationOfferingCode_example # String | Accommodation offering identifier
baseSiteId = baseSiteId_example # String | Base site identifier
checkInDate = checkInDate_example # String | The check in date
checkOutDate = checkOutDate_example # String | The check out date
roomGuestOccupancy = roomGuestOccupancy_example # String | The guest occupancy per room in form of - comma separated. For example, 2-adult:1-child:1-infant
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
sap.cxAcceptCurrency = sap.cxAcceptCurrency_example # String | Requested Currency for the client (optional)

try: 
    # Returns information about a specific accommodation offering
    api_response = api_instance.get_accommodation_offering(accommodationOfferingCode, baseSiteId, checkInDate, checkOutDate, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage=acceptLanguage, sap.cxAcceptCurrency=sap.cxAcceptCurrency)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationOfferingsApi->getAccommodationOffering: %s\n" % e)

Parameters

Path parameters
Name Description
accommodationOfferingCode*
String
Accommodation offering identifier
Required
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-accept-currency
String
Requested Currency for the client
sap.cx-sales-application*
String
The sales application code
Required
Query parameters
Name Description
checkInDate*
String
The check in date
Required
checkOutDate*
String
The check out date
Required
roomGuestOccupancy*
String
The guest occupancy per room in form of <qty>-<ptc> comma separated. For example, 2-adult:1-child:1-infant
Required

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getAllReviews

Returns the list of reviews

Returns the list of reviews for a given property proving information about the rating and the user who submitted it


/{baseSiteId}/accommodationOfferings/{accommodationOfferingCode}/reviews

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/accommodationOfferings/{accommodationOfferingCode}/reviews"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationOfferingsApi;

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

public class AccommodationOfferingsApiExample {

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

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

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

        AccommodationOfferingsApi apiInstance = new AccommodationOfferingsApi();
        String accommodationOfferingCode = accommodationOfferingCode_example; // String | Accommodation offering identifier
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            CustomerReviewList result = apiInstance.getAllReviews(accommodationOfferingCode, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOfferingsApi#getAllReviews");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationOfferingsApi;

public class AccommodationOfferingsApiExample {

    public static void main(String[] args) {
        AccommodationOfferingsApi apiInstance = new AccommodationOfferingsApi();
        String accommodationOfferingCode = accommodationOfferingCode_example; // String | Accommodation offering identifier
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            CustomerReviewList result = apiInstance.getAllReviews(accommodationOfferingCode, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOfferingsApi#getAllReviews");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accommodationOfferingCode = accommodationOfferingCode_example; // Accommodation offering identifier
String *baseSiteId = baseSiteId_example; // Base site identifier

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

// Returns the list of reviews
[apiInstance getAllReviewsWith:accommodationOfferingCode
    baseSiteId:baseSiteId
              completionHandler: ^(CustomerReviewList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationOfferingsApi()
var accommodationOfferingCode = accommodationOfferingCode_example; // {{String}} Accommodation offering identifier
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier

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

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

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

            var apiInstance = new AccommodationOfferingsApi();
            var accommodationOfferingCode = accommodationOfferingCode_example;  // String | Accommodation offering identifier
            var baseSiteId = baseSiteId_example;  // String | Base site identifier

            try
            {
                // Returns the list of reviews
                CustomerReviewList result = apiInstance.getAllReviews(accommodationOfferingCode, baseSiteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationOfferingsApi.getAllReviews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationOfferingsApi();
$accommodationOfferingCode = accommodationOfferingCode_example; // String | Accommodation offering identifier
$baseSiteId = baseSiteId_example; // String | Base site identifier

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

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

my $api_instance = WWW::SwaggerClient::AccommodationOfferingsApi->new();
my $accommodationOfferingCode = accommodationOfferingCode_example; # String | Accommodation offering identifier
my $baseSiteId = baseSiteId_example; # String | Base site identifier

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

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

# create an instance of the API class
api_instance = swagger_client.AccommodationOfferingsApi()
accommodationOfferingCode = accommodationOfferingCode_example # String | Accommodation offering identifier
baseSiteId = baseSiteId_example # String | Base site identifier

try: 
    # Returns the list of reviews
    api_response = api_instance.get_all_reviews(accommodationOfferingCode, baseSiteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationOfferingsApi->getAllReviews: %s\n" % e)

Parameters

Path parameters
Name Description
accommodationOfferingCode*
String
Accommodation offering identifier
Required
baseSiteId*
String
Base site identifier
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


AccommodationOrders

addRoomRequest

Add a room request

Add a request to the room stay in the form of a text message


/{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/requests

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/requests"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationOrdersApi;

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

public class AccommodationOrdersApiExample {

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

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

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

        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        RequestMessage body = ; // RequestMessage | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.addRoomRequest(body, baseSiteId, orderId, roomStayRefNumber, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#addRoomRequest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationOrdersApi;

public class AccommodationOrdersApiExample {

    public static void main(String[] args) {
        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        RequestMessage body = ; // RequestMessage | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.addRoomRequest(body, baseSiteId, orderId, roomStayRefNumber, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#addRoomRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
RequestMessage *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
Integer *roomStayRefNumber = 56; // Room Stay unique identifier - identifies a room stay in the cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Add a room request
[apiInstance addRoomRequestWith:body
    baseSiteId:baseSiteId
    orderId:orderId
    roomStayRefNumber:roomStayRefNumber
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationOrdersApi()
var body = ; // {{RequestMessage}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var roomStayRefNumber = 56; // {{Integer}} Room Stay unique identifier - identifies a room stay in the cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationOrdersApi();
            var body = new RequestMessage(); // RequestMessage | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var roomStayRefNumber = 56;  // Integer | Room Stay unique identifier - identifies a room stay in the cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Add a room request
                apiInstance.addRoomRequest(body, baseSiteId, orderId, roomStayRefNumber, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationOrdersApi.addRoomRequest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationOrdersApi();
$body = ; // RequestMessage | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->addRoomRequest($body, $baseSiteId, $orderId, $roomStayRefNumber, $userId);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationOrdersApi->addRoomRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationOrdersApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationOrdersApi->new();
my $body = WWW::SwaggerClient::Object::RequestMessage->new(); # RequestMessage | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $roomStayRefNumber = 56; # Integer | Room Stay unique identifier - identifies a room stay in the cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->addRoomRequest(body => $body, baseSiteId => $baseSiteId, orderId => $orderId, roomStayRefNumber => $roomStayRefNumber, userId => $userId);
};
if ($@) {
    warn "Exception when calling AccommodationOrdersApi->addRoomRequest: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationOrdersApi()
body =  # RequestMessage | 
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
roomStayRefNumber = 56 # Integer | Room Stay unique identifier - identifies a room stay in the cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Add a room request
    api_instance.add_room_request(body, baseSiteId, orderId, roomStayRefNumber, userId)
except ApiException as e:
    print("Exception when calling AccommodationOrdersApi->addRoomRequest: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
roomStayRefNumber*
Integer (int32)
Room Stay unique identifier - identifies a room stay in the cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found)

Status: 422 - Unprocessable Entity

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


cancelAccommodationReservation

Cancels the accommodation reservation from the given order

Cancel the accommodation reservation, releasing stocks and triggering refund procedure when applicable


/{baseSiteId}/users/{userId}/orders/{orderId}/reservations/accommodationReservation/cancel

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/reservations/accommodationReservation/cancel"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationOrdersApi;

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

public class AccommodationOrdersApiExample {

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

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

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

        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.cancelAccommodationReservation(baseSiteId, orderId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#cancelAccommodationReservation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationOrdersApi;

public class AccommodationOrdersApiExample {

    public static void main(String[] args) {
        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.cancelAccommodationReservation(baseSiteId, orderId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#cancelAccommodationReservation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Cancels the accommodation reservation from the given order
[apiInstance cancelAccommodationReservationWith:baseSiteId
    orderId:orderId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Cancels the accommodation reservation from the given order
                apiInstance.cancelAccommodationReservation(baseSiteId, orderId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationOrdersApi.cancelAccommodationReservation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->cancelAccommodationReservation($baseSiteId, $orderId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationOrdersApi->cancelAccommodationReservation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationOrdersApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->cancelAccommodationReservation(baseSiteId => $baseSiteId, orderId => $orderId, userId => $userId);
};
if ($@) {
    warn "Exception when calling AccommodationOrdersApi->cancelAccommodationReservation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Cancels the accommodation reservation from the given order
    api_instance.cancel_accommodation_reservation(baseSiteId, orderId, userId)
except ApiException as e:
    print("Exception when calling AccommodationOrdersApi->cancelAccommodationReservation: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found)

Status: 422 - Unprocessable Entity

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


evaluateStayDatesChange

Evaluate if stay dates can be amended

Evaluate if changing the stay dates is possible also in terms of availability and returns pricing indication when allowed.


/{baseSiteId}/users/{userId}/orders/{orderId}/evaluateStayDatesChange

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/evaluateStayDatesChange?checkInDate=&checkOutDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationOrdersApi;

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

public class AccommodationOrdersApiExample {

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

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

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

        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String checkInDate = checkInDate_example; // String | The check in date
        String checkOutDate = checkOutDate_example; // String | The check out date
        String orderId = orderId_example; // String | Order unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.evaluateStayDatesChange(baseSiteId, checkInDate, checkOutDate, orderId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#evaluateStayDatesChange");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationOrdersApi;

public class AccommodationOrdersApiExample {

    public static void main(String[] args) {
        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String checkInDate = checkInDate_example; // String | The check in date
        String checkOutDate = checkOutDate_example; // String | The check out date
        String orderId = orderId_example; // String | Order unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.evaluateStayDatesChange(baseSiteId, checkInDate, checkOutDate, orderId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#evaluateStayDatesChange");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *checkInDate = checkInDate_example; // The check in date
String *checkOutDate = checkOutDate_example; // The check out date
String *orderId = orderId_example; // Order unique identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Evaluate if stay dates can be amended
[apiInstance evaluateStayDatesChangeWith:baseSiteId
    checkInDate:checkInDate
    checkOutDate:checkOutDate
    orderId:orderId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var checkInDate = checkInDate_example; // {{String}} The check in date
var checkOutDate = checkOutDate_example; // {{String}} The check out date
var orderId = orderId_example; // {{String}} Order unique identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var checkInDate = checkInDate_example;  // String | The check in date
            var checkOutDate = checkOutDate_example;  // String | The check out date
            var orderId = orderId_example;  // String | Order unique identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Evaluate if stay dates can be amended
                'String' result = apiInstance.evaluateStayDatesChange(baseSiteId, checkInDate, checkOutDate, orderId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationOrdersApi.evaluateStayDatesChange: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$checkInDate = checkInDate_example; // String | The check in date
$checkOutDate = checkOutDate_example; // String | The check out date
$orderId = orderId_example; // String | Order unique identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AccommodationOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $checkInDate = checkInDate_example; # String | The check in date
my $checkOutDate = checkOutDate_example; # String | The check out date
my $orderId = orderId_example; # String | Order unique identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->evaluateStayDatesChange(baseSiteId => $baseSiteId, checkInDate => $checkInDate, checkOutDate => $checkOutDate, orderId => $orderId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationOrdersApi->evaluateStayDatesChange: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
checkInDate = checkInDate_example # String | The check in date
checkOutDate = checkOutDate_example # String | The check out date
orderId = orderId_example # String | Order unique identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Evaluate if stay dates can be amended
    api_response = api_instance.evaluate_stay_dates_change(baseSiteId, checkInDate, checkOutDate, orderId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationOrdersApi->evaluateStayDatesChange: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
checkInDate*
String
The check in date
Required
checkOutDate*
String
The check out date
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Internal Server Error


getRoomRequests

Gets all room request

Gets all the request for the specified room stay


/{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/requests

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/requests"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationOrdersApi;

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

public class AccommodationOrdersApiExample {

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

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

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

        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            RoomStayRequestList result = apiInstance.getRoomRequests(baseSiteId, orderId, roomStayRefNumber, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#getRoomRequests");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationOrdersApi;

public class AccommodationOrdersApiExample {

    public static void main(String[] args) {
        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            RoomStayRequestList result = apiInstance.getRoomRequests(baseSiteId, orderId, roomStayRefNumber, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#getRoomRequests");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
Integer *roomStayRefNumber = 56; // Room Stay unique identifier - identifies a room stay in the cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Gets all room request
[apiInstance getRoomRequestsWith:baseSiteId
    orderId:orderId
    roomStayRefNumber:roomStayRefNumber
    userId:userId
              completionHandler: ^(RoomStayRequestList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var roomStayRefNumber = 56; // {{Integer}} Room Stay unique identifier - identifies a room stay in the cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var roomStayRefNumber = 56;  // Integer | Room Stay unique identifier - identifies a room stay in the cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Gets all room request
                RoomStayRequestList result = apiInstance.getRoomRequests(baseSiteId, orderId, roomStayRefNumber, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationOrdersApi.getRoomRequests: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AccommodationOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $roomStayRefNumber = 56; # Integer | Room Stay unique identifier - identifies a room stay in the cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->getRoomRequests(baseSiteId => $baseSiteId, orderId => $orderId, roomStayRefNumber => $roomStayRefNumber, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationOrdersApi->getRoomRequests: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
roomStayRefNumber = 56 # Integer | Room Stay unique identifier - identifies a room stay in the cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Gets all room request
    api_response = api_instance.get_room_requests(baseSiteId, orderId, roomStayRefNumber, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationOrdersApi->getRoomRequests: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
roomStayRefNumber*
Integer (int32)
Room Stay unique identifier - identifies a room stay in the cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found)

Status: 422 - Unprocessable Entity

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


removeRoomRequests

Removes a room stay request

Removes a room stay request from the list of requests for a given room stay


/{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/requests/{requestId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/requests/{requestId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationOrdersApi;

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

public class AccommodationOrdersApiExample {

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

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

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

        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String requestId = requestId_example; // String | Request identifier
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeRoomRequests(baseSiteId, orderId, requestId, roomStayRefNumber, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#removeRoomRequests");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationOrdersApi;

public class AccommodationOrdersApiExample {

    public static void main(String[] args) {
        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String requestId = requestId_example; // String | Request identifier
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeRoomRequests(baseSiteId, orderId, requestId, roomStayRefNumber, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#removeRoomRequests");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
String *requestId = requestId_example; // Request identifier
Integer *roomStayRefNumber = 56; // Room Stay unique identifier - identifies a room stay in the cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Removes a room stay request
[apiInstance removeRoomRequestsWith:baseSiteId
    orderId:orderId
    requestId:requestId
    roomStayRefNumber:roomStayRefNumber
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var requestId = requestId_example; // {{String}} Request identifier
var roomStayRefNumber = 56; // {{Integer}} Room Stay unique identifier - identifies a room stay in the cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeRoomRequests(baseSiteId, orderId, requestId, roomStayRefNumber, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AccommodationOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var requestId = requestId_example;  // String | Request identifier
            var roomStayRefNumber = 56;  // Integer | Room Stay unique identifier - identifies a room stay in the cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Removes a room stay request
                apiInstance.removeRoomRequests(baseSiteId, orderId, requestId, roomStayRefNumber, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationOrdersApi.removeRoomRequests: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$requestId = requestId_example; // String | Request identifier
$roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->removeRoomRequests($baseSiteId, $orderId, $requestId, $roomStayRefNumber, $userId);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationOrdersApi->removeRoomRequests: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationOrdersApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $requestId = requestId_example; # String | Request identifier
my $roomStayRefNumber = 56; # Integer | Room Stay unique identifier - identifies a room stay in the cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->removeRoomRequests(baseSiteId => $baseSiteId, orderId => $orderId, requestId => $requestId, roomStayRefNumber => $roomStayRefNumber, userId => $userId);
};
if ($@) {
    warn "Exception when calling AccommodationOrdersApi->removeRoomRequests: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
requestId = requestId_example # String | Request identifier
roomStayRefNumber = 56 # Integer | Room Stay unique identifier - identifies a room stay in the cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Removes a room stay request
    api_instance.remove_room_requests(baseSiteId, orderId, requestId, roomStayRefNumber, userId)
except ApiException as e:
    print("Exception when calling AccommodationOrdersApi->removeRoomRequests: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
requestId*
String
Request identifier
Required
roomStayRefNumber*
Integer (int32)
Room Stay unique identifier - identifies a room stay in the cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found)

Status: 422 - Unprocessable Entity

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


writeReview

Allows the user to write a customer review

Allows the user to write a customer review for the property for which the booking has been placed and for the specific room stay passed as parameter. The review will be then visible if approved among the reviews for the relative property.


/{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/writeReview

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/roomStays/{roomStayRefNumber}/writeReview"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationOrdersApi;

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

public class AccommodationOrdersApiExample {

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

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

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

        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        CustomerReviewRequest body = ; // CustomerReviewRequest | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.writeReview(body, baseSiteId, orderId, roomStayRefNumber, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#writeReview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationOrdersApi;

public class AccommodationOrdersApiExample {

    public static void main(String[] args) {
        AccommodationOrdersApi apiInstance = new AccommodationOrdersApi();
        CustomerReviewRequest body = ; // CustomerReviewRequest | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.writeReview(body, baseSiteId, orderId, roomStayRefNumber, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationOrdersApi#writeReview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CustomerReviewRequest *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
Integer *roomStayRefNumber = 56; // Room Stay unique identifier - identifies a room stay in the cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Allows the user to write a customer review
[apiInstance writeReviewWith:body
    baseSiteId:baseSiteId
    orderId:orderId
    roomStayRefNumber:roomStayRefNumber
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationOrdersApi()
var body = ; // {{CustomerReviewRequest}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var roomStayRefNumber = 56; // {{Integer}} Room Stay unique identifier - identifies a room stay in the cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AccommodationOrdersApi();
            var body = new CustomerReviewRequest(); // CustomerReviewRequest | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var roomStayRefNumber = 56;  // Integer | Room Stay unique identifier - identifies a room stay in the cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Allows the user to write a customer review
                'String' result = apiInstance.writeReview(body, baseSiteId, orderId, roomStayRefNumber, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationOrdersApi.writeReview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationOrdersApi();
$body = ; // CustomerReviewRequest | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AccommodationOrdersApi->new();
my $body = WWW::SwaggerClient::Object::CustomerReviewRequest->new(); # CustomerReviewRequest | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $roomStayRefNumber = 56; # Integer | Room Stay unique identifier - identifies a room stay in the cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->writeReview(body => $body, baseSiteId => $baseSiteId, orderId => $orderId, roomStayRefNumber => $roomStayRefNumber, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationOrdersApi->writeReview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationOrdersApi()
body =  # CustomerReviewRequest | 
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
roomStayRefNumber = 56 # Integer | Room Stay unique identifier - identifies a room stay in the cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Allows the user to write a customer review
    api_response = api_instance.write_review(body, baseSiteId, orderId, roomStayRefNumber, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationOrdersApi->writeReview: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
roomStayRefNumber*
Integer (int32)
Room Stay unique identifier - identifies a room stay in the cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


AccommodationSearch

doAccommodationSearch


/{baseSiteId}/accommodations

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json,application/xml"\
"http://localhost:9001/occ/v2/{baseSiteId}/accommodations?checkInDate=&checkOutDate=¤tPage=&destinationLocation=&filter=&pageSize=&roomGuestOccupancy=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationSearchApi;

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

public class AccommodationSearchApiExample {

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

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

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

        AccommodationSearchApi apiInstance = new AccommodationSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String checkInDate = checkInDate_example; // String | The check in date
        String checkOutDate = checkOutDate_example; // String | The check out date
        String destinationLocation = destinationLocation_example; // String | The destination location code
        String roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        Integer currentPage = 56; // Integer | The page number
        String filter = filter_example; // String | The attribute for which the results are filtered. Multiple filters are allowed.
        Integer pageSize = 56; // Integer | The page size
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        String sort = sort_example; // String | The attribute for which the results are sorted.
        try {
            AccommodationSearchResponse result = apiInstance.doAccommodationSearch(baseSiteId, checkInDate, checkOutDate, destinationLocation, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage, currentPage, filter, pageSize, sap.cxAcceptCurrency, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationSearchApi#doAccommodationSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationSearchApi;

public class AccommodationSearchApiExample {

    public static void main(String[] args) {
        AccommodationSearchApi apiInstance = new AccommodationSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String checkInDate = checkInDate_example; // String | The check in date
        String checkOutDate = checkOutDate_example; // String | The check out date
        String destinationLocation = destinationLocation_example; // String | The destination location code
        String roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        Integer currentPage = 56; // Integer | The page number
        String filter = filter_example; // String | The attribute for which the results are filtered. Multiple filters are allowed.
        Integer pageSize = 56; // Integer | The page size
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        String sort = sort_example; // String | The attribute for which the results are sorted.
        try {
            AccommodationSearchResponse result = apiInstance.doAccommodationSearch(baseSiteId, checkInDate, checkOutDate, destinationLocation, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage, currentPage, filter, pageSize, sap.cxAcceptCurrency, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationSearchApi#doAccommodationSearch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *checkInDate = checkInDate_example; // The check in date
String *checkOutDate = checkOutDate_example; // The check out date
String *destinationLocation = destinationLocation_example; // The destination location code
String *roomGuestOccupancy = roomGuestOccupancy_example; // The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
Integer *currentPage = 56; // The page number (optional) (default to 1)
String *filter = filter_example; // The attribute for which the results are filtered. Multiple filters are allowed. (optional)
Integer *pageSize = 56; // The page size (optional) (default to 10)
String *sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // Requested Currency for the client (optional)
String *sort = sort_example; // The attribute for which the results are sorted. (optional)

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

[apiInstance doAccommodationSearchWith:baseSiteId
    checkInDate:checkInDate
    checkOutDate:checkOutDate
    destinationLocation:destinationLocation
    roomGuestOccupancy:roomGuestOccupancy
    sap.cxSalesApplication:sap.cxSalesApplication
    acceptLanguage:acceptLanguage
    currentPage:currentPage
    filter:filter
    pageSize:pageSize
    sap.cxAcceptCurrency:sap.cxAcceptCurrency
    sort:sort
              completionHandler: ^(AccommodationSearchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationSearchApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var checkInDate = checkInDate_example; // {{String}} The check in date
var checkOutDate = checkOutDate_example; // {{String}} The check out date
var destinationLocation = destinationLocation_example; // {{String}} The destination location code
var roomGuestOccupancy = roomGuestOccupancy_example; // {{String}} The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'currentPage': 56, // {{Integer}} The page number
  'filter': filter_example, // {{String}} The attribute for which the results are filtered. Multiple filters are allowed.
  'pageSize': 56, // {{Integer}} The page size
  'sap.cxAcceptCurrency': sap.cxAcceptCurrency_example, // {{String}} Requested Currency for the client
  'sort': sort_example // {{String}} The attribute for which the results are sorted.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doAccommodationSearch(baseSiteId, checkInDate, checkOutDate, destinationLocation, roomGuestOccupancy, sap.cxSalesApplication, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AccommodationSearchApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var checkInDate = checkInDate_example;  // String | The check in date
            var checkOutDate = checkOutDate_example;  // String | The check out date
            var destinationLocation = destinationLocation_example;  // String | The destination location code
            var roomGuestOccupancy = roomGuestOccupancy_example;  // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var currentPage = 56;  // Integer | The page number (optional)  (default to 1)
            var filter = filter_example;  // String | The attribute for which the results are filtered. Multiple filters are allowed. (optional) 
            var pageSize = 56;  // Integer | The page size (optional)  (default to 10)
            var sap.cxAcceptCurrency = sap.cxAcceptCurrency_example;  // String | Requested Currency for the client (optional) 
            var sort = sort_example;  // String | The attribute for which the results are sorted. (optional) 

            try
            {
                AccommodationSearchResponse result = apiInstance.doAccommodationSearch(baseSiteId, checkInDate, checkOutDate, destinationLocation, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage, currentPage, filter, pageSize, sap.cxAcceptCurrency, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationSearchApi.doAccommodationSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationSearchApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$checkInDate = checkInDate_example; // String | The check in date
$checkOutDate = checkOutDate_example; // String | The check out date
$destinationLocation = destinationLocation_example; // String | The destination location code
$roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$currentPage = 56; // Integer | The page number
$filter = filter_example; // String | The attribute for which the results are filtered. Multiple filters are allowed.
$pageSize = 56; // Integer | The page size
$sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
$sort = sort_example; // String | The attribute for which the results are sorted.

try {
    $result = $api_instance->doAccommodationSearch($baseSiteId, $checkInDate, $checkOutDate, $destinationLocation, $roomGuestOccupancy, $sap.cxSalesApplication, $acceptLanguage, $currentPage, $filter, $pageSize, $sap.cxAcceptCurrency, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationSearchApi->doAccommodationSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationSearchApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationSearchApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $checkInDate = checkInDate_example; # String | The check in date
my $checkOutDate = checkOutDate_example; # String | The check out date
my $destinationLocation = destinationLocation_example; # String | The destination location code
my $roomGuestOccupancy = roomGuestOccupancy_example; # String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $currentPage = 56; # Integer | The page number
my $filter = filter_example; # String | The attribute for which the results are filtered. Multiple filters are allowed.
my $pageSize = 56; # Integer | The page size
my $sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; # String | Requested Currency for the client
my $sort = sort_example; # String | The attribute for which the results are sorted.

eval { 
    my $result = $api_instance->doAccommodationSearch(baseSiteId => $baseSiteId, checkInDate => $checkInDate, checkOutDate => $checkOutDate, destinationLocation => $destinationLocation, roomGuestOccupancy => $roomGuestOccupancy, sap.cxSalesApplication => $sap.cxSalesApplication, acceptLanguage => $acceptLanguage, currentPage => $currentPage, filter => $filter, pageSize => $pageSize, sap.cxAcceptCurrency => $sap.cxAcceptCurrency, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationSearchApi->doAccommodationSearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationSearchApi()
baseSiteId = baseSiteId_example # String | Base site identifier
checkInDate = checkInDate_example # String | The check in date
checkOutDate = checkOutDate_example # String | The check out date
destinationLocation = destinationLocation_example # String | The destination location code
roomGuestOccupancy = roomGuestOccupancy_example # String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
currentPage = 56 # Integer | The page number (optional) (default to 1)
filter = filter_example # String | The attribute for which the results are filtered. Multiple filters are allowed. (optional)
pageSize = 56 # Integer | The page size (optional) (default to 10)
sap.cxAcceptCurrency = sap.cxAcceptCurrency_example # String | Requested Currency for the client (optional)
sort = sort_example # String | The attribute for which the results are sorted. (optional)

try: 
    api_response = api_instance.do_accommodation_search(baseSiteId, checkInDate, checkOutDate, destinationLocation, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage=acceptLanguage, currentPage=currentPage, filter=filter, pageSize=pageSize, sap.cxAcceptCurrency=sap.cxAcceptCurrency, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationSearchApi->doAccommodationSearch: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-accept-currency
String
Requested Currency for the client
sap.cx-sales-application*
String
The sales application code
Required
Query parameters
Name Description
checkInDate*
String
The check in date
Required
checkOutDate*
String
The check out date
Required
currentPage
Integer (int32)
The page number
destinationLocation*
String
The destination location code
Required
filter
String
The attribute for which the results are filtered. Multiple filters are allowed.
pageSize
Integer (int32)
The page size
roomGuestOccupancy*
String
The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
Required
sort
String
The attribute for which the results are sorted.

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


AccommodationSuggestions

getAccommodationSuggestions

Returns a list of suggestions for the given text

Returns a list of suggestions for the given text. A suggestion can be a location or a specific property matching the criteria.


/{baseSiteId}/accommodationSuggestions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/accommodationSuggestions?searchText="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationSuggestionsApi;

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

public class AccommodationSuggestionsApiExample {

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

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

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

        AccommodationSuggestionsApi apiInstance = new AccommodationSuggestionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String searchText = searchText_example; // String | The text to search
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            AccommodationSuggestionList result = apiInstance.getAccommodationSuggestions(baseSiteId, sap.cxSalesApplication, searchText, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationSuggestionsApi#getAccommodationSuggestions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccommodationSuggestionsApi;

public class AccommodationSuggestionsApiExample {

    public static void main(String[] args) {
        AccommodationSuggestionsApi apiInstance = new AccommodationSuggestionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String searchText = searchText_example; // String | The text to search
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            AccommodationSuggestionList result = apiInstance.getAccommodationSuggestions(baseSiteId, sap.cxSalesApplication, searchText, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccommodationSuggestionsApi#getAccommodationSuggestions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *searchText = searchText_example; // The text to search
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

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

// Returns a list of suggestions for the given text
[apiInstance getAccommodationSuggestionsWith:baseSiteId
    sap.cxSalesApplication:sap.cxSalesApplication
    searchText:searchText
    acceptLanguage:acceptLanguage
              completionHandler: ^(AccommodationSuggestionList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AccommodationSuggestionsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var searchText = searchText_example; // {{String}} The text to search
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccommodationSuggestions(baseSiteId, sap.cxSalesApplication, searchText, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AccommodationSuggestionsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var searchText = searchText_example;  // String | The text to search
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Returns a list of suggestions for the given text
                AccommodationSuggestionList result = apiInstance.getAccommodationSuggestions(baseSiteId, sap.cxSalesApplication, searchText, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccommodationSuggestionsApi.getAccommodationSuggestions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAccommodationSuggestionsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$searchText = searchText_example; // String | The text to search
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getAccommodationSuggestions($baseSiteId, $sap.cxSalesApplication, $searchText, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccommodationSuggestionsApi->getAccommodationSuggestions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationSuggestionsApi;

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

my $api_instance = WWW::SwaggerClient::AccommodationSuggestionsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $searchText = searchText_example; # String | The text to search
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getAccommodationSuggestions(baseSiteId => $baseSiteId, sap.cxSalesApplication => $sap.cxSalesApplication, searchText => $searchText, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccommodationSuggestionsApi->getAccommodationSuggestions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AccommodationSuggestionsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
searchText = searchText_example # String | The text to search
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Returns a list of suggestions for the given text
    api_response = api_instance.get_accommodation_suggestions(baseSiteId, sap.cxSalesApplication, searchText, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccommodationSuggestionsApi->getAccommodationSuggestions: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-sales-application*
String
The sales application code
Required
Query parameters
Name Description
searchText*
String
The text to search
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


Address

validateAddress

Verifies address.

Verifies provided address.


/{baseSiteId}/users/{userId}/addresses/verification

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/addresses/verification?fields="
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 OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

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

        AddressApi apiInstance = new AddressApi();
        Address body = ; // Address | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            AddressValidation result = apiInstance.validateAddress(body, baseSiteId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#validateAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressApi;

public class AddressApiExample {

    public static void main(String[] args) {
        AddressApi apiInstance = new AddressApi();
        Address body = ; // Address | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            AddressValidation result = apiInstance.validateAddress(body, baseSiteId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#validateAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Address *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Verifies address.
[apiInstance validateAddressWith:body
    baseSiteId:baseSiteId
    userId:userId
    fields:fields
              completionHandler: ^(AddressValidation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AddressApi()
var body = ; // {{Address}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateAddress(bodybaseSiteIduserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AddressApi();
            var body = new Address(); // Address | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Verifies address.
                AddressValidation result = apiInstance.validateAddress(body, baseSiteId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressApi.validateAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAddressApi();
$body = ; // Address | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::AddressApi->new();
my $body = WWW::SwaggerClient::Object::Address->new(); # Address | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

# create an instance of the API class
api_instance = swagger_client.AddressApi()
body =  # Address | 
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Verifies address.
    api_response = api_instance.validate_address(body, baseSiteId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressApi->validateAddress: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Addresses

createAddress

Creates a new address.

Creates a new address and adds it to the customer's address list.


/{baseSiteId}/users/{userId}/addresses

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/addresses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressesApi;

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

public class AddressesApiExample {

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

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

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

        AddressesApi apiInstance = new AddressesApi();
        Address body = ; // Address | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.createAddress(body, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#createAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressesApi;

public class AddressesApiExample {

    public static void main(String[] args) {
        AddressesApi apiInstance = new AddressesApi();
        Address body = ; // Address | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.createAddress(body, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#createAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Address *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Creates a new address.
[apiInstance createAddressWith:body
    baseSiteId:baseSiteId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AddressesApi()
var body = ; // {{Address}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAddress(bodybaseSiteIduserId, 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 OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AddressesApi();
            var body = new Address(); // Address | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Creates a new address.
                'String' result = apiInstance.createAddress(body, baseSiteId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressesApi.createAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAddressesApi();
$body = ; // Address | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AddressesApi->new();
my $body = WWW::SwaggerClient::Object::Address->new(); # Address | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

# create an instance of the API class
api_instance = swagger_client.AddressesApi()
body =  # Address | 
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Creates a new address.
    api_response = api_instance.create_address(body, baseSiteId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressesApi->createAddress: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


getAddress

Get details of a specific address.

Returns detailed information about address with a given id.


/{baseSiteId}/users/{userId}/addresses/{addressId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/addresses/{addressId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressesApi;

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

public class AddressesApiExample {

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

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

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

        AddressesApi apiInstance = new AddressesApi();
        String addressId = addressId_example; // String | Address identifier.
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getAddress(addressId, baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#getAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressesApi;

public class AddressesApiExample {

    public static void main(String[] args) {
        AddressesApi apiInstance = new AddressesApi();
        String addressId = addressId_example; // String | Address identifier.
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getAddress(addressId, baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#getAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *addressId = addressId_example; // Address identifier.
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

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

// Get details of a specific address.
[apiInstance getAddressWith:addressId
    baseSiteId:baseSiteId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AddressesApi()
var addressId = addressId_example; // {{String}} Address identifier.
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAddress(addressId, baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AddressesApi();
            var addressId = addressId_example;  // String | Address identifier.
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get details of a specific address.
                'String' result = apiInstance.getAddress(addressId, baseSiteId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressesApi.getAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAddressesApi();
$addressId = addressId_example; // String | Address identifier.
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

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

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

my $api_instance = WWW::SwaggerClient::AddressesApi->new();
my $addressId = addressId_example; # String | Address identifier.
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getAddress(addressId => $addressId, baseSiteId => $baseSiteId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressesApi->getAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AddressesApi()
addressId = addressId_example # String | Address identifier.
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get details of a specific address.
    api_response = api_instance.get_address(addressId, baseSiteId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressesApi->getAddress: %s\n" % e)

Parameters

Path parameters
Name Description
addressId*
String
Address identifier.
Required
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


getAddresses

Get customer's addresses

Returns the list of customer's addresses.


/{baseSiteId}/users/{userId}/addresses

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/addresses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressesApi;

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

public class AddressesApiExample {

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

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

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

        AddressesApi apiInstance = new AddressesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getAddresses(baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#getAddresses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressesApi;

public class AddressesApiExample {

    public static void main(String[] args) {
        AddressesApi apiInstance = new AddressesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getAddresses(baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#getAddresses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

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

// Get customer's addresses
[apiInstance getAddressesWith:baseSiteId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AddressesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAddresses(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new AddressesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get customer's addresses
                'String' result = apiInstance.getAddresses(baseSiteId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressesApi.getAddresses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAddressesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

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

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

my $api_instance = WWW::SwaggerClient::AddressesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

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

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

# create an instance of the API class
api_instance = swagger_client.AddressesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get customer's addresses
    api_response = api_instance.get_addresses(baseSiteId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressesApi->getAddresses: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


removeAddress

Delete customer's address.

Deletes customer's address and removes it from the list.


/{baseSiteId}/users/{userId}/addresses/{addressId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/addresses/{addressId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressesApi;

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

public class AddressesApiExample {

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

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

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

        AddressesApi apiInstance = new AddressesApi();
        String addressId = addressId_example; // String | Address identifier.
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeAddress(addressId, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#removeAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressesApi;

public class AddressesApiExample {

    public static void main(String[] args) {
        AddressesApi apiInstance = new AddressesApi();
        String addressId = addressId_example; // String | Address identifier.
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeAddress(addressId, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#removeAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *addressId = addressId_example; // Address identifier.
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Delete customer's address.
[apiInstance removeAddressWith:addressId
    baseSiteId:baseSiteId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AddressesApi()
var addressId = addressId_example; // {{String}} Address identifier.
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AddressesApi();
            var addressId = addressId_example;  // String | Address identifier.
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Delete customer's address.
                'String' result = apiInstance.removeAddress(addressId, baseSiteId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressesApi.removeAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAddressesApi();
$addressId = addressId_example; // String | Address identifier.
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AddressesApi->new();
my $addressId = addressId_example; # String | Address identifier.
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

# create an instance of the API class
api_instance = swagger_client.AddressesApi()
addressId = addressId_example # String | Address identifier.
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Delete customer's address.
    api_response = api_instance.remove_address(addressId, baseSiteId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressesApi->removeAddress: %s\n" % e)

Parameters

Path parameters
Name Description
addressId*
String
Address identifier.
Required
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


replaceAddress

Updates the address

Updates the address. Attributes not provided in the request will be defined again (set to null or default).


/{baseSiteId}/users/{userId}/addresses/{addressId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/addresses/{addressId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressesApi;

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

public class AddressesApiExample {

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

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

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

        AddressesApi apiInstance = new AddressesApi();
        Address body = ; // Address | 
        String addressId = addressId_example; // String | Address identifier.
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.replaceAddress(body, addressId, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#replaceAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressesApi;

public class AddressesApiExample {

    public static void main(String[] args) {
        AddressesApi apiInstance = new AddressesApi();
        Address body = ; // Address | 
        String addressId = addressId_example; // String | Address identifier.
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.replaceAddress(body, addressId, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#replaceAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Address *body = ; // 
String *addressId = addressId_example; // Address identifier.
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Updates the address
[apiInstance replaceAddressWith:body
    addressId:addressId
    baseSiteId:baseSiteId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AddressesApi()
var body = ; // {{Address}} 
var addressId = addressId_example; // {{String}} Address identifier.
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AddressesApi();
            var body = new Address(); // Address | 
            var addressId = addressId_example;  // String | Address identifier.
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Updates the address
                'String' result = apiInstance.replaceAddress(body, addressId, baseSiteId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressesApi.replaceAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAddressesApi();
$body = ; // Address | 
$addressId = addressId_example; // String | Address identifier.
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AddressesApi->new();
my $body = WWW::SwaggerClient::Object::Address->new(); # Address | 
my $addressId = addressId_example; # String | Address identifier.
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->replaceAddress(body => $body, addressId => $addressId, baseSiteId => $baseSiteId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressesApi->replaceAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AddressesApi()
body =  # Address | 
addressId = addressId_example # String | Address identifier.
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Updates the address
    api_response = api_instance.replace_address(body, addressId, baseSiteId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressesApi->replaceAddress: %s\n" % e)

Parameters

Path parameters
Name Description
addressId*
String
Address identifier.
Required
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


updateAddress

Updates the address.

Updates the address. Only attributes provided in the request body will be changed.


/{baseSiteId}/users/{userId}/addresses/{addressId}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/addresses/{addressId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressesApi;

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

public class AddressesApiExample {

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

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

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

        AddressesApi apiInstance = new AddressesApi();
        Address body = ; // Address | 
        String addressId = addressId_example; // String | Address identifier.
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.updateAddress(body, addressId, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#updateAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressesApi;

public class AddressesApiExample {

    public static void main(String[] args) {
        AddressesApi apiInstance = new AddressesApi();
        Address body = ; // Address | 
        String addressId = addressId_example; // String | Address identifier.
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.updateAddress(body, addressId, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#updateAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Address *body = ; // 
String *addressId = addressId_example; // Address identifier.
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Updates the address.
[apiInstance updateAddressWith:body
    addressId:addressId
    baseSiteId:baseSiteId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.AddressesApi()
var body = ; // {{Address}} 
var addressId = addressId_example; // {{String}} Address identifier.
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new AddressesApi();
            var body = new Address(); // Address | 
            var addressId = addressId_example;  // String | Address identifier.
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Updates the address.
                'String' result = apiInstance.updateAddress(body, addressId, baseSiteId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressesApi.updateAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAddressesApi();
$body = ; // Address | 
$addressId = addressId_example; // String | Address identifier.
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::AddressesApi->new();
my $body = WWW::SwaggerClient::Object::Address->new(); # Address | 
my $addressId = addressId_example; # String | Address identifier.
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->updateAddress(body => $body, addressId => $addressId, baseSiteId => $baseSiteId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressesApi->updateAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AddressesApi()
body =  # Address | 
addressId = addressId_example # String | Address identifier.
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Updates the address.
    api_response = api_instance.update_address(body, addressId, baseSiteId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressesApi->updateAddress: %s\n" % e)

Parameters

Path parameters
Name Description
addressId*
String
Address identifier.
Required
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


BaseSites

getBaseSites

Get all base sites.

Get all base sites with corresponding base stores details in FULL mode.


/basesites

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/basesites?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BaseSitesApi;

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

public class BaseSitesApiExample {

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

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

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

        BaseSitesApi apiInstance = new BaseSitesApi();
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            BaseSiteList result = apiInstance.getBaseSites(fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BaseSitesApi#getBaseSites");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BaseSitesApi;

public class BaseSitesApiExample {

    public static void main(String[] args) {
        BaseSitesApi apiInstance = new BaseSitesApi();
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            BaseSiteList result = apiInstance.getBaseSites(fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BaseSitesApi#getBaseSites");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get all base sites.
[apiInstance getBaseSitesWith:fields
              completionHandler: ^(BaseSiteList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.BaseSitesApi()
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBaseSites(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new BaseSitesApi();
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get all base sites.
                BaseSiteList result = apiInstance.getBaseSites(fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BaseSitesApi.getBaseSites: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiBaseSitesApi();
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::BaseSitesApi->new();
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

# create an instance of the API class
api_instance = swagger_client.BaseSitesApi()
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get all base sites.
    api_response = api_instance.get_base_sites(fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BaseSitesApi->getBaseSites: %s\n" % e)

Parameters

Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


BaseStores

getBaseStore

Get a base store.

Returns details of a specific base store based on its identifier. The response contains detailed base store information.


/{baseSiteId}/basestores/{baseStoreUid}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/basestores/{baseStoreUid}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BaseStoresApi;

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

public class BaseStoresApiExample {

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

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

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

        BaseStoresApi apiInstance = new BaseStoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String baseStoreUid = baseStoreUid_example; // String | Base store name
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            BaseStore result = apiInstance.getBaseStore(baseSiteId, baseStoreUid, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BaseStoresApi#getBaseStore");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BaseStoresApi;

public class BaseStoresApiExample {

    public static void main(String[] args) {
        BaseStoresApi apiInstance = new BaseStoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String baseStoreUid = baseStoreUid_example; // String | Base store name
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            BaseStore result = apiInstance.getBaseStore(baseSiteId, baseStoreUid, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BaseStoresApi#getBaseStore");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *baseStoreUid = baseStoreUid_example; // Base store name
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get a base store.
[apiInstance getBaseStoreWith:baseSiteId
    baseStoreUid:baseStoreUid
    fields:fields
              completionHandler: ^(BaseStore output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.BaseStoresApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var baseStoreUid = baseStoreUid_example; // {{String}} Base store name
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBaseStore(baseSiteId, baseStoreUid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new BaseStoresApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var baseStoreUid = baseStoreUid_example;  // String | Base store name
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a base store.
                BaseStore result = apiInstance.getBaseStore(baseSiteId, baseStoreUid, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BaseStoresApi.getBaseStore: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiBaseStoresApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$baseStoreUid = baseStoreUid_example; // String | Base store name
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::BaseStoresApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $baseStoreUid = baseStoreUid_example; # String | Base store name
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

# create an instance of the API class
api_instance = swagger_client.BaseStoresApi()
baseSiteId = baseSiteId_example # String | Base site identifier
baseStoreUid = baseStoreUid_example # String | Base store name
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a base store.
    api_response = api_instance.get_base_store(baseSiteId, baseStoreUid, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BaseStoresApi->getBaseStore: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
baseStoreUid*
String
Base store name
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


CartAddresses

createCartDeliveryAddress

Creates a delivery address for the cart.

Creates an address and assigns it to the cart as the delivery address.


/{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartAddressesApi;

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

public class CartAddressesApiExample {

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

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

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

        CartAddressesApi apiInstance = new CartAddressesApi();
        Address body = ; // Address | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Address result = apiInstance.createCartDeliveryAddress(body, baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartAddressesApi#createCartDeliveryAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartAddressesApi;

public class CartAddressesApiExample {

    public static void main(String[] args) {
        CartAddressesApi apiInstance = new CartAddressesApi();
        Address body = ; // Address | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Address result = apiInstance.createCartDeliveryAddress(body, baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartAddressesApi#createCartDeliveryAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Address *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Creates a delivery address for the cart.
[apiInstance createCartDeliveryAddressWith:body
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
              completionHandler: ^(Address output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartAddressesApi()
var body = ; // {{Address}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCartDeliveryAddress(bodybaseSiteIdcartIduserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartAddressesApi();
            var body = new Address(); // Address | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Creates a delivery address for the cart.
                Address result = apiInstance.createCartDeliveryAddress(body, baseSiteId, cartId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartAddressesApi.createCartDeliveryAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartAddressesApi();
$body = ; // Address | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartAddressesApi->new();
my $body = WWW::SwaggerClient::Object::Address->new(); # Address | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->createCartDeliveryAddress(body => $body, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartAddressesApi->createCartDeliveryAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartAddressesApi()
body =  # Address | 
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Creates a delivery address for the cart.
    api_response = api_instance.create_cart_delivery_address(body, baseSiteId, cartId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartAddressesApi->createCartDeliveryAddress: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeCartDeliveryAddress

Deletes the delivery address from the cart.

Deletes the delivery address from the specified cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartAddressesApi;

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

public class CartAddressesApiExample {

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

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

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

        CartAddressesApi apiInstance = new CartAddressesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeCartDeliveryAddress(baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartAddressesApi#removeCartDeliveryAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartAddressesApi;

public class CartAddressesApiExample {

    public static void main(String[] args) {
        CartAddressesApi apiInstance = new CartAddressesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeCartDeliveryAddress(baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartAddressesApi#removeCartDeliveryAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Deletes the delivery address from the cart.
[apiInstance removeCartDeliveryAddressWith:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartAddressesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new CartAddressesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Deletes the delivery address from the cart.
                apiInstance.removeCartDeliveryAddress(baseSiteId, cartId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartAddressesApi.removeCartDeliveryAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartAddressesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->removeCartDeliveryAddress($baseSiteId, $cartId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CartAddressesApi->removeCartDeliveryAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartAddressesApi;

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

my $api_instance = WWW::SwaggerClient::CartAddressesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->removeCartDeliveryAddress(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
};
if ($@) {
    warn "Exception when calling CartAddressesApi->removeCartDeliveryAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartAddressesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Deletes the delivery address from the cart.
    api_instance.remove_cart_delivery_address(baseSiteId, cartId, userId)
except ApiException as e:
    print("Exception when calling CartAddressesApi->removeCartDeliveryAddress: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replaceCartDeliveryAddress

Sets a delivery address for the cart.

Sets a delivery address for the cart. The address country must be placed among the delivery countries of the current base store.


/{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery?addressId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartAddressesApi;

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

public class CartAddressesApiExample {

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

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

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

        CartAddressesApi apiInstance = new CartAddressesApi();
        String addressId = addressId_example; // String | Address identifier
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.replaceCartDeliveryAddress(addressId, baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartAddressesApi#replaceCartDeliveryAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartAddressesApi;

public class CartAddressesApiExample {

    public static void main(String[] args) {
        CartAddressesApi apiInstance = new CartAddressesApi();
        String addressId = addressId_example; // String | Address identifier
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.replaceCartDeliveryAddress(addressId, baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartAddressesApi#replaceCartDeliveryAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *addressId = addressId_example; // Address identifier
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Sets a delivery address for the cart.
[apiInstance replaceCartDeliveryAddressWith:addressId
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartAddressesApi()
var addressId = addressId_example; // {{String}} Address identifier
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new CartAddressesApi();
            var addressId = addressId_example;  // String | Address identifier
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Sets a delivery address for the cart.
                apiInstance.replaceCartDeliveryAddress(addressId, baseSiteId, cartId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartAddressesApi.replaceCartDeliveryAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartAddressesApi();
$addressId = addressId_example; // String | Address identifier
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->replaceCartDeliveryAddress($addressId, $baseSiteId, $cartId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CartAddressesApi->replaceCartDeliveryAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartAddressesApi;

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

my $api_instance = WWW::SwaggerClient::CartAddressesApi->new();
my $addressId = addressId_example; # String | Address identifier
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->replaceCartDeliveryAddress(addressId => $addressId, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
};
if ($@) {
    warn "Exception when calling CartAddressesApi->replaceCartDeliveryAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartAddressesApi()
addressId = addressId_example # String | Address identifier
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Sets a delivery address for the cart.
    api_instance.replace_cart_delivery_address(addressId, baseSiteId, cartId, userId)
except ApiException as e:
    print("Exception when calling CartAddressesApi->replaceCartDeliveryAddress: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
addressId*
String
Address identifier
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


CartDeliveryModes

getCartDeliveryMode

Get the delivery mode selected for the cart.

Returns the delivery mode selected for the cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartDeliveryModesApi;

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

public class CartDeliveryModesApiExample {

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

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

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

        CartDeliveryModesApi apiInstance = new CartDeliveryModesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            DeliveryMode result = apiInstance.getCartDeliveryMode(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartDeliveryModesApi#getCartDeliveryMode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartDeliveryModesApi;

public class CartDeliveryModesApiExample {

    public static void main(String[] args) {
        CartDeliveryModesApi apiInstance = new CartDeliveryModesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            DeliveryMode result = apiInstance.getCartDeliveryMode(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartDeliveryModesApi#getCartDeliveryMode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get the delivery mode selected for the cart.
[apiInstance getCartDeliveryModeWith:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
              completionHandler: ^(DeliveryMode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartDeliveryModesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCartDeliveryMode(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartDeliveryModesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get the delivery mode selected for the cart.
                DeliveryMode result = apiInstance.getCartDeliveryMode(baseSiteId, cartId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartDeliveryModesApi.getCartDeliveryMode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartDeliveryModesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartDeliveryModesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCartDeliveryMode(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartDeliveryModesApi->getCartDeliveryMode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartDeliveryModesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get the delivery mode selected for the cart.
    api_response = api_instance.get_cart_delivery_mode(baseSiteId, cartId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartDeliveryModesApi->getCartDeliveryMode: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCartDeliveryModes

Get all delivery modes for the current store and delivery address.

Returns all delivery modes supported for the current base store and cart delivery address. A delivery address must be set for the cart, otherwise an empty list will be returned.


/{baseSiteId}/users/{userId}/carts/{cartId}/deliverymodes

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/deliverymodes?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartDeliveryModesApi;

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

public class CartDeliveryModesApiExample {

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

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

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

        CartDeliveryModesApi apiInstance = new CartDeliveryModesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            DeliveryModeList result = apiInstance.getCartDeliveryModes(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartDeliveryModesApi#getCartDeliveryModes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartDeliveryModesApi;

public class CartDeliveryModesApiExample {

    public static void main(String[] args) {
        CartDeliveryModesApi apiInstance = new CartDeliveryModesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            DeliveryModeList result = apiInstance.getCartDeliveryModes(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartDeliveryModesApi#getCartDeliveryModes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get all delivery modes for the current store and delivery address.
[apiInstance getCartDeliveryModesWith:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
              completionHandler: ^(DeliveryModeList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartDeliveryModesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCartDeliveryModes(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartDeliveryModesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get all delivery modes for the current store and delivery address.
                DeliveryModeList result = apiInstance.getCartDeliveryModes(baseSiteId, cartId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartDeliveryModesApi.getCartDeliveryModes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartDeliveryModesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartDeliveryModesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCartDeliveryModes(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartDeliveryModesApi->getCartDeliveryModes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartDeliveryModesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get all delivery modes for the current store and delivery address.
    api_response = api_instance.get_cart_delivery_modes(baseSiteId, cartId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartDeliveryModesApi->getCartDeliveryModes: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeCartDeliveryMode

Deletes the delivery mode from the cart.

Deletes the delivery mode from the specified cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartDeliveryModesApi;

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

public class CartDeliveryModesApiExample {

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

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

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

        CartDeliveryModesApi apiInstance = new CartDeliveryModesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeCartDeliveryMode(baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartDeliveryModesApi#removeCartDeliveryMode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartDeliveryModesApi;

public class CartDeliveryModesApiExample {

    public static void main(String[] args) {
        CartDeliveryModesApi apiInstance = new CartDeliveryModesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeCartDeliveryMode(baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartDeliveryModesApi#removeCartDeliveryMode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Deletes the delivery mode from the cart.
[apiInstance removeCartDeliveryModeWith:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartDeliveryModesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new CartDeliveryModesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Deletes the delivery mode from the cart.
                apiInstance.removeCartDeliveryMode(baseSiteId, cartId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartDeliveryModesApi.removeCartDeliveryMode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartDeliveryModesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->removeCartDeliveryMode($baseSiteId, $cartId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CartDeliveryModesApi->removeCartDeliveryMode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartDeliveryModesApi;

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

my $api_instance = WWW::SwaggerClient::CartDeliveryModesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->removeCartDeliveryMode(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
};
if ($@) {
    warn "Exception when calling CartDeliveryModesApi->removeCartDeliveryMode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartDeliveryModesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Deletes the delivery mode from the cart.
    api_instance.remove_cart_delivery_mode(baseSiteId, cartId, userId)
except ApiException as e:
    print("Exception when calling CartDeliveryModesApi->removeCartDeliveryMode: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replaceCartDeliveryMode

Sets the delivery mode for a cart.

Sets the delivery mode with a given identifier for the cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode?deliveryModeId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartDeliveryModesApi;

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

public class CartDeliveryModesApiExample {

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

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

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

        CartDeliveryModesApi apiInstance = new CartDeliveryModesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String deliveryModeId = deliveryModeId_example; // String | Delivery mode identifier (code)
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.replaceCartDeliveryMode(baseSiteId, cartId, deliveryModeId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartDeliveryModesApi#replaceCartDeliveryMode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartDeliveryModesApi;

public class CartDeliveryModesApiExample {

    public static void main(String[] args) {
        CartDeliveryModesApi apiInstance = new CartDeliveryModesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String deliveryModeId = deliveryModeId_example; // String | Delivery mode identifier (code)
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.replaceCartDeliveryMode(baseSiteId, cartId, deliveryModeId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartDeliveryModesApi#replaceCartDeliveryMode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *deliveryModeId = deliveryModeId_example; // Delivery mode identifier (code)
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Sets the delivery mode for a cart.
[apiInstance replaceCartDeliveryModeWith:baseSiteId
    cartId:cartId
    deliveryModeId:deliveryModeId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartDeliveryModesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var deliveryModeId = deliveryModeId_example; // {{String}} Delivery mode identifier (code)
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new CartDeliveryModesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var deliveryModeId = deliveryModeId_example;  // String | Delivery mode identifier (code)
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Sets the delivery mode for a cart.
                apiInstance.replaceCartDeliveryMode(baseSiteId, cartId, deliveryModeId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartDeliveryModesApi.replaceCartDeliveryMode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartDeliveryModesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$deliveryModeId = deliveryModeId_example; // String | Delivery mode identifier (code)
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->replaceCartDeliveryMode($baseSiteId, $cartId, $deliveryModeId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CartDeliveryModesApi->replaceCartDeliveryMode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartDeliveryModesApi;

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

my $api_instance = WWW::SwaggerClient::CartDeliveryModesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $deliveryModeId = deliveryModeId_example; # String | Delivery mode identifier (code)
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->replaceCartDeliveryMode(baseSiteId => $baseSiteId, cartId => $cartId, deliveryModeId => $deliveryModeId, userId => $userId);
};
if ($@) {
    warn "Exception when calling CartDeliveryModesApi->replaceCartDeliveryMode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartDeliveryModesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
deliveryModeId = deliveryModeId_example # String | Delivery mode identifier (code)
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Sets the delivery mode for a cart.
    api_instance.replace_cart_delivery_mode(baseSiteId, cartId, deliveryModeId, userId)
except ApiException as e:
    print("Exception when calling CartDeliveryModesApi->replaceCartDeliveryMode: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
deliveryModeId*
String
Delivery mode identifier (code)
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


CartEntries

createCartEntry

Adds a product to the cart.

Adds a product to the specified cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/entries

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/entries?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartEntriesApi;

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

public class CartEntriesApiExample {

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

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

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

        CartEntriesApi apiInstance = new CartEntriesApi();
        OrderEntry body = ; // OrderEntry | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CartModification result = apiInstance.createCartEntry(body, baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#createCartEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartEntriesApi;

public class CartEntriesApiExample {

    public static void main(String[] args) {
        CartEntriesApi apiInstance = new CartEntriesApi();
        OrderEntry body = ; // OrderEntry | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CartModification result = apiInstance.createCartEntry(body, baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#createCartEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OrderEntry *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Adds a product to the cart.
[apiInstance createCartEntryWith:body
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
              completionHandler: ^(CartModification output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartEntriesApi()
var body = ; // {{OrderEntry}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCartEntry(bodybaseSiteIdcartIduserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartEntriesApi();
            var body = new OrderEntry(); // OrderEntry | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Adds a product to the cart.
                CartModification result = apiInstance.createCartEntry(body, baseSiteId, cartId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartEntriesApi.createCartEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartEntriesApi();
$body = ; // OrderEntry | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartEntriesApi->new();
my $body = WWW::SwaggerClient::Object::OrderEntry->new(); # OrderEntry | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->createCartEntry(body => $body, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartEntriesApi->createCartEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartEntriesApi()
body =  # OrderEntry | 
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Adds a product to the cart.
    api_response = api_instance.create_cart_entry(body, baseSiteId, cartId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartEntriesApi->createCartEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCartEntries

Get cart entries.

Returns cart entries.


/{baseSiteId}/users/{userId}/carts/{cartId}/entries

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/entries?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartEntriesApi;

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

public class CartEntriesApiExample {

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

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

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

        CartEntriesApi apiInstance = new CartEntriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            OrderEntryList result = apiInstance.getCartEntries(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#getCartEntries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartEntriesApi;

public class CartEntriesApiExample {

    public static void main(String[] args) {
        CartEntriesApi apiInstance = new CartEntriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            OrderEntryList result = apiInstance.getCartEntries(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#getCartEntries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get cart entries.
[apiInstance getCartEntriesWith:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
              completionHandler: ^(OrderEntryList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartEntriesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCartEntries(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartEntriesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get cart entries.
                OrderEntryList result = apiInstance.getCartEntries(baseSiteId, cartId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartEntriesApi.getCartEntries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartEntriesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartEntriesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCartEntries(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartEntriesApi->getCartEntries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartEntriesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get cart entries.
    api_response = api_instance.get_cart_entries(baseSiteId, cartId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartEntriesApi->getCartEntries: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCartEntry

Get the details of the cart entries.

Returns the details of the cart entries.


/{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartEntriesApi;

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

public class CartEntriesApiExample {

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

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

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

        CartEntriesApi apiInstance = new CartEntriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Long entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            OrderEntry result = apiInstance.getCartEntry(baseSiteId, cartId, entryNumber, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#getCartEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartEntriesApi;

public class CartEntriesApiExample {

    public static void main(String[] args) {
        CartEntriesApi apiInstance = new CartEntriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Long entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            OrderEntry result = apiInstance.getCartEntry(baseSiteId, cartId, entryNumber, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#getCartEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Long *entryNumber = 789; // The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get the details of the cart entries.
[apiInstance getCartEntryWith:baseSiteId
    cartId:cartId
    entryNumber:entryNumber
    userId:userId
    fields:fields
              completionHandler: ^(OrderEntry output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartEntriesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryNumber = 789; // {{Long}} The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCartEntry(baseSiteId, cartId, entryNumber, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartEntriesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryNumber = 789;  // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get the details of the cart entries.
                OrderEntry result = apiInstance.getCartEntry(baseSiteId, cartId, entryNumber, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartEntriesApi.getCartEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartEntriesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartEntriesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryNumber = 789; # Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCartEntry(baseSiteId => $baseSiteId, cartId => $cartId, entryNumber => $entryNumber, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartEntriesApi->getCartEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartEntriesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryNumber = 789 # Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get the details of the cart entries.
    api_response = api_instance.get_cart_entry(baseSiteId, cartId, entryNumber, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartEntriesApi->getCartEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryNumber*
Long (int64)
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeCartEntry

Deletes cart entry.

Deletes cart entry by entry number.


/{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartEntriesApi;

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

public class CartEntriesApiExample {

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

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

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

        CartEntriesApi apiInstance = new CartEntriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Long entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeCartEntry(baseSiteId, cartId, entryNumber, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#removeCartEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartEntriesApi;

public class CartEntriesApiExample {

    public static void main(String[] args) {
        CartEntriesApi apiInstance = new CartEntriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Long entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeCartEntry(baseSiteId, cartId, entryNumber, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#removeCartEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Long *entryNumber = 789; // The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Deletes cart entry.
[apiInstance removeCartEntryWith:baseSiteId
    cartId:cartId
    entryNumber:entryNumber
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartEntriesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryNumber = 789; // {{Long}} The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new CartEntriesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryNumber = 789;  // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Deletes cart entry.
                apiInstance.removeCartEntry(baseSiteId, cartId, entryNumber, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartEntriesApi.removeCartEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartEntriesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->removeCartEntry($baseSiteId, $cartId, $entryNumber, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CartEntriesApi->removeCartEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartEntriesApi;

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

my $api_instance = WWW::SwaggerClient::CartEntriesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryNumber = 789; # Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->removeCartEntry(baseSiteId => $baseSiteId, cartId => $cartId, entryNumber => $entryNumber, userId => $userId);
};
if ($@) {
    warn "Exception when calling CartEntriesApi->removeCartEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartEntriesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryNumber = 789 # Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Deletes cart entry.
    api_instance.remove_cart_entry(baseSiteId, cartId, entryNumber, userId)
except ApiException as e:
    print("Exception when calling CartEntriesApi->removeCartEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryNumber*
Long (int64)
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replaceCartEntry

Set quantity and store details of a cart entry.

Updates the quantity of a single cart entry and the details of the store where the cart entry will be picked up. Attributes not provided in request will be defined again (set to null or default)


/{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartEntriesApi;

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

public class CartEntriesApiExample {

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

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

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

        CartEntriesApi apiInstance = new CartEntriesApi();
        OrderEntry body = ; // OrderEntry | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Long entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CartModification result = apiInstance.replaceCartEntry(body, baseSiteId, cartId, entryNumber, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#replaceCartEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartEntriesApi;

public class CartEntriesApiExample {

    public static void main(String[] args) {
        CartEntriesApi apiInstance = new CartEntriesApi();
        OrderEntry body = ; // OrderEntry | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Long entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CartModification result = apiInstance.replaceCartEntry(body, baseSiteId, cartId, entryNumber, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#replaceCartEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OrderEntry *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Long *entryNumber = 789; // The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Set quantity and store details of a cart entry.
[apiInstance replaceCartEntryWith:body
    baseSiteId:baseSiteId
    cartId:cartId
    entryNumber:entryNumber
    userId:userId
    fields:fields
              completionHandler: ^(CartModification output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartEntriesApi()
var body = ; // {{OrderEntry}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryNumber = 789; // {{Long}} The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.replaceCartEntry(bodybaseSiteIdcartIdentryNumberuserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartEntriesApi();
            var body = new OrderEntry(); // OrderEntry | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryNumber = 789;  // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Set quantity and store details of a cart entry.
                CartModification result = apiInstance.replaceCartEntry(body, baseSiteId, cartId, entryNumber, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartEntriesApi.replaceCartEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartEntriesApi();
$body = ; // OrderEntry | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartEntriesApi->new();
my $body = WWW::SwaggerClient::Object::OrderEntry->new(); # OrderEntry | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryNumber = 789; # Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->replaceCartEntry(body => $body, baseSiteId => $baseSiteId, cartId => $cartId, entryNumber => $entryNumber, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartEntriesApi->replaceCartEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartEntriesApi()
body =  # OrderEntry | 
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryNumber = 789 # Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Set quantity and store details of a cart entry.
    api_response = api_instance.replace_cart_entry(body, baseSiteId, cartId, entryNumber, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartEntriesApi->replaceCartEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryNumber*
Long (int64)
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


updateCartEntry

Update quantity and store details of a cart entry.

Updates the quantity of a single cart entry and the details of the store where the cart entry will be picked up.


/{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartEntriesApi;

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

public class CartEntriesApiExample {

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

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

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

        CartEntriesApi apiInstance = new CartEntriesApi();
        OrderEntry body = ; // OrderEntry | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Long entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CartModification result = apiInstance.updateCartEntry(body, baseSiteId, cartId, entryNumber, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#updateCartEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartEntriesApi;

public class CartEntriesApiExample {

    public static void main(String[] args) {
        CartEntriesApi apiInstance = new CartEntriesApi();
        OrderEntry body = ; // OrderEntry | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Long entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CartModification result = apiInstance.updateCartEntry(body, baseSiteId, cartId, entryNumber, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntriesApi#updateCartEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OrderEntry *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Long *entryNumber = 789; // The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Update quantity and store details of a cart entry.
[apiInstance updateCartEntryWith:body
    baseSiteId:baseSiteId
    cartId:cartId
    entryNumber:entryNumber
    userId:userId
    fields:fields
              completionHandler: ^(CartModification output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartEntriesApi()
var body = ; // {{OrderEntry}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryNumber = 789; // {{Long}} The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCartEntry(bodybaseSiteIdcartIdentryNumberuserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartEntriesApi();
            var body = new OrderEntry(); // OrderEntry | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryNumber = 789;  // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Update quantity and store details of a cart entry.
                CartModification result = apiInstance.updateCartEntry(body, baseSiteId, cartId, entryNumber, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartEntriesApi.updateCartEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartEntriesApi();
$body = ; // OrderEntry | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryNumber = 789; // Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartEntriesApi->new();
my $body = WWW::SwaggerClient::Object::OrderEntry->new(); # OrderEntry | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryNumber = 789; # Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->updateCartEntry(body => $body, baseSiteId => $baseSiteId, cartId => $cartId, entryNumber => $entryNumber, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartEntriesApi->updateCartEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartEntriesApi()
body =  # OrderEntry | 
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryNumber = 789 # Long | The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Update quantity and store details of a cart entry.
    api_response = api_instance.update_cart_entry(body, baseSiteId, cartId, entryNumber, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartEntriesApi->updateCartEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryNumber*
Long (int64)
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


CartEntryGroups

addToCartEntryGroup

Add a product to a cart entry group.

Adds a product to a cart entry group.


/{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartEntryGroupsApi;

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

public class CartEntryGroupsApiExample {

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

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

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

        CartEntryGroupsApi apiInstance = new CartEntryGroupsApi();
        OrderEntry body = ; // OrderEntry | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryGroupNumber = 56; // Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CartModification result = apiInstance.addToCartEntryGroup(body, baseSiteId, cartId, entryGroupNumber, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntryGroupsApi#addToCartEntryGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartEntryGroupsApi;

public class CartEntryGroupsApiExample {

    public static void main(String[] args) {
        CartEntryGroupsApi apiInstance = new CartEntryGroupsApi();
        OrderEntry body = ; // OrderEntry | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryGroupNumber = 56; // Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CartModification result = apiInstance.addToCartEntryGroup(body, baseSiteId, cartId, entryGroupNumber, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntryGroupsApi#addToCartEntryGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OrderEntry *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *entryGroupNumber = 56; // Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Add a product to a cart entry group.
[apiInstance addToCartEntryGroupWith:body
    baseSiteId:baseSiteId
    cartId:cartId
    entryGroupNumber:entryGroupNumber
    userId:userId
    fields:fields
              completionHandler: ^(CartModification output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartEntryGroupsApi()
var body = ; // {{OrderEntry}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryGroupNumber = 56; // {{Integer}} Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addToCartEntryGroup(bodybaseSiteIdcartIdentryGroupNumberuserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartEntryGroupsApi();
            var body = new OrderEntry(); // OrderEntry | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryGroupNumber = 56;  // Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Add a product to a cart entry group.
                CartModification result = apiInstance.addToCartEntryGroup(body, baseSiteId, cartId, entryGroupNumber, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartEntryGroupsApi.addToCartEntryGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartEntryGroupsApi();
$body = ; // OrderEntry | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryGroupNumber = 56; // Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartEntryGroupsApi->new();
my $body = WWW::SwaggerClient::Object::OrderEntry->new(); # OrderEntry | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryGroupNumber = 56; # Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->addToCartEntryGroup(body => $body, baseSiteId => $baseSiteId, cartId => $cartId, entryGroupNumber => $entryGroupNumber, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartEntryGroupsApi->addToCartEntryGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartEntryGroupsApi()
body =  # OrderEntry | 
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryGroupNumber = 56 # Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Add a product to a cart entry group.
    api_response = api_instance.add_to_cart_entry_group(body, baseSiteId, cartId, entryGroupNumber, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartEntryGroupsApi->addToCartEntryGroup: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryGroupNumber*
Integer (int32)
Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeCartEntryGroup

Delete an entry group.

Removes an entry group from an associated cart. The entry group is identified by an entryGroupNumber. The cart is identified by the cartId.


/{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartEntryGroupsApi;

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

public class CartEntryGroupsApiExample {

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

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

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

        CartEntryGroupsApi apiInstance = new CartEntryGroupsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryGroupNumber = 56; // Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeCartEntryGroup(baseSiteId, cartId, entryGroupNumber, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntryGroupsApi#removeCartEntryGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartEntryGroupsApi;

public class CartEntryGroupsApiExample {

    public static void main(String[] args) {
        CartEntryGroupsApi apiInstance = new CartEntryGroupsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryGroupNumber = 56; // Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeCartEntryGroup(baseSiteId, cartId, entryGroupNumber, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartEntryGroupsApi#removeCartEntryGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *entryGroupNumber = 56; // Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Delete an entry group.
[apiInstance removeCartEntryGroupWith:baseSiteId
    cartId:cartId
    entryGroupNumber:entryGroupNumber
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartEntryGroupsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryGroupNumber = 56; // {{Integer}} Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new CartEntryGroupsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryGroupNumber = 56;  // Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Delete an entry group.
                apiInstance.removeCartEntryGroup(baseSiteId, cartId, entryGroupNumber, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartEntryGroupsApi.removeCartEntryGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartEntryGroupsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryGroupNumber = 56; // Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->removeCartEntryGroup($baseSiteId, $cartId, $entryGroupNumber, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CartEntryGroupsApi->removeCartEntryGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartEntryGroupsApi;

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

my $api_instance = WWW::SwaggerClient::CartEntryGroupsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryGroupNumber = 56; # Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->removeCartEntryGroup(baseSiteId => $baseSiteId, cartId => $cartId, entryGroupNumber => $entryGroupNumber, userId => $userId);
};
if ($@) {
    warn "Exception when calling CartEntryGroupsApi->removeCartEntryGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartEntryGroupsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryGroupNumber = 56 # Integer | Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Delete an entry group.
    api_instance.remove_cart_entry_group(baseSiteId, cartId, entryGroupNumber, userId)
except ApiException as e:
    print("Exception when calling CartEntryGroupsApi->removeCartEntryGroup: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryGroupNumber*
Integer (int32)
Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


CartPromotions

doApplyCartPromotion

Enables promotions based on the promotionsId of the cart.

Enables a promotion for the order based on the promotionId defined for the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.


/{baseSiteId}/users/{userId}/carts/{cartId}/promotions

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/promotions?promotionId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartPromotionsApi;

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

public class CartPromotionsApiExample {

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

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

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

        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String promotionId = promotionId_example; // String | Promotion identifier (code)
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.doApplyCartPromotion(baseSiteId, cartId, promotionId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#doApplyCartPromotion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartPromotionsApi;

public class CartPromotionsApiExample {

    public static void main(String[] args) {
        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String promotionId = promotionId_example; // String | Promotion identifier (code)
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.doApplyCartPromotion(baseSiteId, cartId, promotionId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#doApplyCartPromotion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *promotionId = promotionId_example; // Promotion identifier (code)
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Enables promotions based on the promotionsId of the cart.
[apiInstance doApplyCartPromotionWith:baseSiteId
    cartId:cartId
    promotionId:promotionId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartPromotionsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var promotionId = promotionId_example; // {{String}} Promotion identifier (code)
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new CartPromotionsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var promotionId = promotionId_example;  // String | Promotion identifier (code)
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Enables promotions based on the promotionsId of the cart.
                apiInstance.doApplyCartPromotion(baseSiteId, cartId, promotionId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartPromotionsApi.doApplyCartPromotion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartPromotionsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$promotionId = promotionId_example; // String | Promotion identifier (code)
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->doApplyCartPromotion($baseSiteId, $cartId, $promotionId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CartPromotionsApi->doApplyCartPromotion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartPromotionsApi;

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

my $api_instance = WWW::SwaggerClient::CartPromotionsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $promotionId = promotionId_example; # String | Promotion identifier (code)
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->doApplyCartPromotion(baseSiteId => $baseSiteId, cartId => $cartId, promotionId => $promotionId, userId => $userId);
};
if ($@) {
    warn "Exception when calling CartPromotionsApi->doApplyCartPromotion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartPromotionsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
promotionId = promotionId_example # String | Promotion identifier (code)
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Enables promotions based on the promotionsId of the cart.
    api_instance.do_apply_cart_promotion(baseSiteId, cartId, promotionId, userId)
except ApiException as e:
    print("Exception when calling CartPromotionsApi->doApplyCartPromotion: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
promotionId*
String
Promotion identifier (code)
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


doApplyCartVoucher

Applies a voucher based on the voucherId defined for the cart.

Applies a voucher based on the voucherId defined for the specified cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/vouchers

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/vouchers?voucherId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartPromotionsApi;

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

public class CartPromotionsApiExample {

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

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

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

        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String voucherId = voucherId_example; // String | Voucher identifier (code)
        try {
            apiInstance.doApplyCartVoucher(baseSiteId, cartId, userId, voucherId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#doApplyCartVoucher");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartPromotionsApi;

public class CartPromotionsApiExample {

    public static void main(String[] args) {
        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String voucherId = voucherId_example; // String | Voucher identifier (code)
        try {
            apiInstance.doApplyCartVoucher(baseSiteId, cartId, userId, voucherId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#doApplyCartVoucher");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *voucherId = voucherId_example; // Voucher identifier (code)

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

// Applies a voucher based on the voucherId defined for the cart.
[apiInstance doApplyCartVoucherWith:baseSiteId
    cartId:cartId
    userId:userId
    voucherId:voucherId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartPromotionsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var voucherId = voucherId_example; // {{String}} Voucher identifier (code)

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

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

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

            var apiInstance = new CartPromotionsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var voucherId = voucherId_example;  // String | Voucher identifier (code)

            try
            {
                // Applies a voucher based on the voucherId defined for the cart.
                apiInstance.doApplyCartVoucher(baseSiteId, cartId, userId, voucherId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartPromotionsApi.doApplyCartVoucher: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartPromotionsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$voucherId = voucherId_example; // String | Voucher identifier (code)

try {
    $api_instance->doApplyCartVoucher($baseSiteId, $cartId, $userId, $voucherId);
} catch (Exception $e) {
    echo 'Exception when calling CartPromotionsApi->doApplyCartVoucher: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartPromotionsApi;

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

my $api_instance = WWW::SwaggerClient::CartPromotionsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $voucherId = voucherId_example; # String | Voucher identifier (code)

eval { 
    $api_instance->doApplyCartVoucher(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, voucherId => $voucherId);
};
if ($@) {
    warn "Exception when calling CartPromotionsApi->doApplyCartVoucher: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartPromotionsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
voucherId = voucherId_example # String | Voucher identifier (code)

try: 
    # Applies a voucher based on the voucherId defined for the cart.
    api_instance.do_apply_cart_voucher(baseSiteId, cartId, userId, voucherId)
except ApiException as e:
    print("Exception when calling CartPromotionsApi->doApplyCartVoucher: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
voucherId*
String
Voucher identifier (code)
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCartPromotion

Get information about promotion applied on cart.

Returns information about a promotion (with a specific promotionId), that has been applied on the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.


/{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartPromotionsApi;

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

public class CartPromotionsApiExample {

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

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

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

        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String promotionId = promotionId_example; // String | Promotion identifier (code)
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PromotionResultList result = apiInstance.getCartPromotion(baseSiteId, cartId, promotionId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#getCartPromotion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartPromotionsApi;

public class CartPromotionsApiExample {

    public static void main(String[] args) {
        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String promotionId = promotionId_example; // String | Promotion identifier (code)
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PromotionResultList result = apiInstance.getCartPromotion(baseSiteId, cartId, promotionId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#getCartPromotion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *promotionId = promotionId_example; // Promotion identifier (code)
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get information about promotion applied on cart.
[apiInstance getCartPromotionWith:baseSiteId
    cartId:cartId
    promotionId:promotionId
    userId:userId
    fields:fields
              completionHandler: ^(PromotionResultList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartPromotionsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var promotionId = promotionId_example; // {{String}} Promotion identifier (code)
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCartPromotion(baseSiteId, cartId, promotionId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartPromotionsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var promotionId = promotionId_example;  // String | Promotion identifier (code)
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get information about promotion applied on cart.
                PromotionResultList result = apiInstance.getCartPromotion(baseSiteId, cartId, promotionId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartPromotionsApi.getCartPromotion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartPromotionsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$promotionId = promotionId_example; // String | Promotion identifier (code)
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartPromotionsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $promotionId = promotionId_example; # String | Promotion identifier (code)
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCartPromotion(baseSiteId => $baseSiteId, cartId => $cartId, promotionId => $promotionId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartPromotionsApi->getCartPromotion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartPromotionsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
promotionId = promotionId_example # String | Promotion identifier (code)
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get information about promotion applied on cart.
    api_response = api_instance.get_cart_promotion(baseSiteId, cartId, promotionId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartPromotionsApi->getCartPromotion: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
promotionId*
String
Promotion identifier (code)
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCartPromotions

Get information about promotions applied on cart.

Returns information about the promotions applied on the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.


/{baseSiteId}/users/{userId}/carts/{cartId}/promotions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/promotions?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartPromotionsApi;

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

public class CartPromotionsApiExample {

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

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

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

        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PromotionResultList result = apiInstance.getCartPromotions(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#getCartPromotions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartPromotionsApi;

public class CartPromotionsApiExample {

    public static void main(String[] args) {
        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PromotionResultList result = apiInstance.getCartPromotions(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#getCartPromotions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get information about promotions applied on cart.
[apiInstance getCartPromotionsWith:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
              completionHandler: ^(PromotionResultList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartPromotionsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCartPromotions(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartPromotionsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get information about promotions applied on cart.
                PromotionResultList result = apiInstance.getCartPromotions(baseSiteId, cartId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartPromotionsApi.getCartPromotions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartPromotionsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartPromotionsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCartPromotions(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartPromotionsApi->getCartPromotions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartPromotionsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get information about promotions applied on cart.
    api_response = api_instance.get_cart_promotions(baseSiteId, cartId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartPromotionsApi->getCartPromotions: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCartVouchers

Get a list of vouchers applied to the cart.

Returns a list of vouchers applied to the cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/vouchers

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/vouchers?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartPromotionsApi;

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

public class CartPromotionsApiExample {

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

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

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

        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            VoucherList result = apiInstance.getCartVouchers(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#getCartVouchers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartPromotionsApi;

public class CartPromotionsApiExample {

    public static void main(String[] args) {
        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            VoucherList result = apiInstance.getCartVouchers(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#getCartVouchers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get a list of vouchers applied to the cart.
[apiInstance getCartVouchersWith:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
              completionHandler: ^(VoucherList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartPromotionsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCartVouchers(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartPromotionsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a list of vouchers applied to the cart.
                VoucherList result = apiInstance.getCartVouchers(baseSiteId, cartId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartPromotionsApi.getCartVouchers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartPromotionsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CartPromotionsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCartVouchers(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartPromotionsApi->getCartVouchers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartPromotionsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a list of vouchers applied to the cart.
    api_response = api_instance.get_cart_vouchers(baseSiteId, cartId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartPromotionsApi->getCartVouchers: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeCartPromotion

Disables the promotion based on the promotionsId of the cart.

Disables the promotion for the order based on the promotionId defined for the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.


/{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartPromotionsApi;

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

public class CartPromotionsApiExample {

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

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

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

        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String promotionId = promotionId_example; // String | Promotion identifier (code)
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeCartPromotion(baseSiteId, cartId, promotionId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#removeCartPromotion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartPromotionsApi;

public class CartPromotionsApiExample {

    public static void main(String[] args) {
        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String promotionId = promotionId_example; // String | Promotion identifier (code)
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.removeCartPromotion(baseSiteId, cartId, promotionId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#removeCartPromotion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *promotionId = promotionId_example; // Promotion identifier (code)
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Disables the promotion based on the promotionsId of the cart.
[apiInstance removeCartPromotionWith:baseSiteId
    cartId:cartId
    promotionId:promotionId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartPromotionsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var promotionId = promotionId_example; // {{String}} Promotion identifier (code)
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new CartPromotionsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var promotionId = promotionId_example;  // String | Promotion identifier (code)
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Disables the promotion based on the promotionsId of the cart.
                apiInstance.removeCartPromotion(baseSiteId, cartId, promotionId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartPromotionsApi.removeCartPromotion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartPromotionsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$promotionId = promotionId_example; // String | Promotion identifier (code)
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->removeCartPromotion($baseSiteId, $cartId, $promotionId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CartPromotionsApi->removeCartPromotion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartPromotionsApi;

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

my $api_instance = WWW::SwaggerClient::CartPromotionsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $promotionId = promotionId_example; # String | Promotion identifier (code)
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->removeCartPromotion(baseSiteId => $baseSiteId, cartId => $cartId, promotionId => $promotionId, userId => $userId);
};
if ($@) {
    warn "Exception when calling CartPromotionsApi->removeCartPromotion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartPromotionsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
promotionId = promotionId_example # String | Promotion identifier (code)
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Disables the promotion based on the promotionsId of the cart.
    api_instance.remove_cart_promotion(baseSiteId, cartId, promotionId, userId)
except ApiException as e:
    print("Exception when calling CartPromotionsApi->removeCartPromotion: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
promotionId*
String
Promotion identifier (code)
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeCartVoucher

Deletes a voucher defined for the current cart.

Deletes a voucher based on the voucherId defined for the current cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/vouchers/{voucherId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/vouchers/{voucherId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartPromotionsApi;

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

public class CartPromotionsApiExample {

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

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

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

        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String voucherId = voucherId_example; // String | Voucher identifier (code)
        try {
            apiInstance.removeCartVoucher(baseSiteId, cartId, userId, voucherId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#removeCartVoucher");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartPromotionsApi;

public class CartPromotionsApiExample {

    public static void main(String[] args) {
        CartPromotionsApi apiInstance = new CartPromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String voucherId = voucherId_example; // String | Voucher identifier (code)
        try {
            apiInstance.removeCartVoucher(baseSiteId, cartId, userId, voucherId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartPromotionsApi#removeCartVoucher");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *voucherId = voucherId_example; // Voucher identifier (code)

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

// Deletes a voucher defined for the current cart.
[apiInstance removeCartVoucherWith:baseSiteId
    cartId:cartId
    userId:userId
    voucherId:voucherId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartPromotionsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var voucherId = voucherId_example; // {{String}} Voucher identifier (code)

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

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

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

            var apiInstance = new CartPromotionsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var voucherId = voucherId_example;  // String | Voucher identifier (code)

            try
            {
                // Deletes a voucher defined for the current cart.
                apiInstance.removeCartVoucher(baseSiteId, cartId, userId, voucherId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartPromotionsApi.removeCartVoucher: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartPromotionsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$voucherId = voucherId_example; // String | Voucher identifier (code)

try {
    $api_instance->removeCartVoucher($baseSiteId, $cartId, $userId, $voucherId);
} catch (Exception $e) {
    echo 'Exception when calling CartPromotionsApi->removeCartVoucher: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartPromotionsApi;

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

my $api_instance = WWW::SwaggerClient::CartPromotionsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $voucherId = voucherId_example; # String | Voucher identifier (code)

eval { 
    $api_instance->removeCartVoucher(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, voucherId => $voucherId);
};
if ($@) {
    warn "Exception when calling CartPromotionsApi->removeCartVoucher: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartPromotionsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
voucherId = voucherId_example # String | Voucher identifier (code)

try: 
    # Deletes a voucher defined for the current cart.
    api_instance.remove_cart_voucher(baseSiteId, cartId, userId, voucherId)
except ApiException as e:
    print("Exception when calling CartPromotionsApi->removeCartVoucher: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
voucherId*
String
Voucher identifier (code)
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Carts

getCarts

Get all customer carts.

Lists all customer carts.


/{baseSiteId}/users/{userId}/carts

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts?currentPage=&fields=&pageSize=&savedCartsOnly=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CartsApi;

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

public class CartsApiExample {

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

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

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

        CartsApi apiInstance = new CartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        Integer currentPage = 56; // Integer | Optional pagination parameter in case of savedCartsOnly == true. Default value 0.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20.
        Boolean savedCartsOnly = true; // Boolean | Optional parameter. If the parameter is provided and its value is true, only saved carts are returned.
        String sort = sort_example; // String | Optional sort criterion in case of savedCartsOnly == true. No default value.
        try {
            CartList result = apiInstance.getCarts(baseSiteId, userId, currentPage, fields, pageSize, savedCartsOnly, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartsApi#getCarts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CartsApi;

public class CartsApiExample {

    public static void main(String[] args) {
        CartsApi apiInstance = new CartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        Integer currentPage = 56; // Integer | Optional pagination parameter in case of savedCartsOnly == true. Default value 0.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20.
        Boolean savedCartsOnly = true; // Boolean | Optional parameter. If the parameter is provided and its value is true, only saved carts are returned.
        String sort = sort_example; // String | Optional sort criterion in case of savedCartsOnly == true. No default value.
        try {
            CartList result = apiInstance.getCarts(baseSiteId, userId, currentPage, fields, pageSize, savedCartsOnly, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CartsApi#getCarts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Integer *currentPage = 56; // Optional pagination parameter in case of savedCartsOnly == true. Default value 0. (optional) (default to 0)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
Integer *pageSize = 56; // Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20. (optional) (default to 20)
Boolean *savedCartsOnly = true; // Optional parameter. If the parameter is provided and its value is true, only saved carts are returned. (optional) (default to false)
String *sort = sort_example; // Optional sort criterion in case of savedCartsOnly == true. No default value. (optional)

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

// Get all customer carts.
[apiInstance getCartsWith:baseSiteId
    userId:userId
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    savedCartsOnly:savedCartsOnly
    sort:sort
              completionHandler: ^(CartList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'currentPage': 56, // {{Integer}} Optional pagination parameter in case of savedCartsOnly == true. Default value 0.
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'pageSize': 56, // {{Integer}} Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20.
  'savedCartsOnly': true, // {{Boolean}} Optional parameter. If the parameter is provided and its value is true, only saved carts are returned.
  'sort': sort_example // {{String}} Optional sort criterion in case of savedCartsOnly == true. No default value.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCarts(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var currentPage = 56;  // Integer | Optional pagination parameter in case of savedCartsOnly == true. Default value 0. (optional)  (default to 0)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20. (optional)  (default to 20)
            var savedCartsOnly = true;  // Boolean | Optional parameter. If the parameter is provided and its value is true, only saved carts are returned. (optional)  (default to false)
            var sort = sort_example;  // String | Optional sort criterion in case of savedCartsOnly == true. No default value. (optional) 

            try
            {
                // Get all customer carts.
                CartList result = apiInstance.getCarts(baseSiteId, userId, currentPage, fields, pageSize, savedCartsOnly, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CartsApi.getCarts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$currentPage = 56; // Integer | Optional pagination parameter in case of savedCartsOnly == true. Default value 0.
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$pageSize = 56; // Integer | Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20.
$savedCartsOnly = true; // Boolean | Optional parameter. If the parameter is provided and its value is true, only saved carts are returned.
$sort = sort_example; // String | Optional sort criterion in case of savedCartsOnly == true. No default value.

try {
    $result = $api_instance->getCarts($baseSiteId, $userId, $currentPage, $fields, $pageSize, $savedCartsOnly, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CartsApi->getCarts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CartsApi;

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

my $api_instance = WWW::SwaggerClient::CartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $currentPage = 56; # Integer | Optional pagination parameter in case of savedCartsOnly == true. Default value 0.
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $pageSize = 56; # Integer | Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20.
my $savedCartsOnly = true; # Boolean | Optional parameter. If the parameter is provided and its value is true, only saved carts are returned.
my $sort = sort_example; # String | Optional sort criterion in case of savedCartsOnly == true. No default value.

eval { 
    my $result = $api_instance->getCarts(baseSiteId => $baseSiteId, userId => $userId, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, savedCartsOnly => $savedCartsOnly, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CartsApi->getCarts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
currentPage = 56 # Integer | Optional pagination parameter in case of savedCartsOnly == true. Default value 0. (optional) (default to 0)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
pageSize = 56 # Integer | Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20. (optional) (default to 20)
savedCartsOnly = true # Boolean | Optional parameter. If the parameter is provided and its value is true, only saved carts are returned. (optional) (default to false)
sort = sort_example # String | Optional sort criterion in case of savedCartsOnly == true. No default value. (optional)

try: 
    # Get all customer carts.
    api_response = api_instance.get_carts(baseSiteId, userId, currentPage=currentPage, fields=fields, pageSize=pageSize, savedCartsOnly=savedCartsOnly, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CartsApi->getCarts: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
currentPage
Integer (int32)
Optional pagination parameter in case of savedCartsOnly == true. Default value 0.
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
pageSize
Integer (int32)
Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20.
savedCartsOnly
Boolean
Optional parameter. If the parameter is provided and its value is true, only saved carts are returned.
sort
String
Optional sort criterion in case of savedCartsOnly == true. No default value.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Catalogs

getCatalog

Get a catalog

Returns information about a catalog based on its ID, along with the versions defined for the current base store.


/{baseSiteId}/catalogs/{catalogId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/catalogs/{catalogId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogsApi;

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

public class CatalogsApiExample {

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

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

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

        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | Catalog identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Catalog result = apiInstance.getCatalog(baseSiteId, catalogId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getCatalog");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogsApi;

public class CatalogsApiExample {

    public static void main(String[] args) {
        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | Catalog identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Catalog result = apiInstance.getCatalog(baseSiteId, catalogId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getCatalog");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *catalogId = catalogId_example; // Catalog identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get a catalog
[apiInstance getCatalogWith:baseSiteId
    catalogId:catalogId
    fields:fields
              completionHandler: ^(Catalog output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CatalogsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var catalogId = catalogId_example; // {{String}} Catalog identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCatalog(baseSiteId, catalogId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CatalogsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var catalogId = catalogId_example;  // String | Catalog identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a catalog
                Catalog result = apiInstance.getCatalog(baseSiteId, catalogId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogsApi.getCatalog: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCatalogsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$catalogId = catalogId_example; // String | Catalog identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CatalogsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $catalogId = catalogId_example; # String | Catalog identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

# create an instance of the API class
api_instance = swagger_client.CatalogsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
catalogId = catalogId_example # String | Catalog identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a catalog
    api_response = api_instance.get_catalog(baseSiteId, catalogId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogsApi->getCatalog: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
catalogId*
String
Catalog identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCatalogVersion

Get information about catalog version

Returns information about the catalog version that exists for the current base store.


/{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogsApi;

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

public class CatalogsApiExample {

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

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

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

        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | Catalog identifier
        String catalogVersionId = catalogVersionId_example; // String | Catalog version identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CatalogVersion result = apiInstance.getCatalogVersion(baseSiteId, catalogId, catalogVersionId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getCatalogVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogsApi;

public class CatalogsApiExample {

    public static void main(String[] args) {
        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | Catalog identifier
        String catalogVersionId = catalogVersionId_example; // String | Catalog version identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CatalogVersion result = apiInstance.getCatalogVersion(baseSiteId, catalogId, catalogVersionId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getCatalogVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *catalogId = catalogId_example; // Catalog identifier
String *catalogVersionId = catalogVersionId_example; // Catalog version identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get information about catalog version
[apiInstance getCatalogVersionWith:baseSiteId
    catalogId:catalogId
    catalogVersionId:catalogVersionId
    fields:fields
              completionHandler: ^(CatalogVersion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CatalogsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var catalogId = catalogId_example; // {{String}} Catalog identifier
var catalogVersionId = catalogVersionId_example; // {{String}} Catalog version identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCatalogVersion(baseSiteId, catalogId, catalogVersionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CatalogsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var catalogId = catalogId_example;  // String | Catalog identifier
            var catalogVersionId = catalogVersionId_example;  // String | Catalog version identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get information about catalog version
                CatalogVersion result = apiInstance.getCatalogVersion(baseSiteId, catalogId, catalogVersionId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogsApi.getCatalogVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCatalogsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$catalogId = catalogId_example; // String | Catalog identifier
$catalogVersionId = catalogVersionId_example; // String | Catalog version identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getCatalogVersion($baseSiteId, $catalogId, $catalogVersionId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogsApi->getCatalogVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CatalogsApi;

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

my $api_instance = WWW::SwaggerClient::CatalogsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $catalogId = catalogId_example; # String | Catalog identifier
my $catalogVersionId = catalogVersionId_example; # String | Catalog version identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCatalogVersion(baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersionId => $catalogVersionId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CatalogsApi->getCatalogVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CatalogsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
catalogId = catalogId_example # String | Catalog identifier
catalogVersionId = catalogVersionId_example # String | Catalog version identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get information about catalog version
    api_response = api_instance.get_catalog_version(baseSiteId, catalogId, catalogVersionId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogsApi->getCatalogVersion: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
catalogId*
String
Catalog identifier
Required
catalogVersionId*
String
Catalog version identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCatalogs

Get a list of catalogs

Returns all catalogs with versions defined for the base store.


/{baseSiteId}/catalogs

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/catalogs?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogsApi;

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

public class CatalogsApiExample {

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

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

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

        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CatalogList result = apiInstance.getCatalogs(baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getCatalogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogsApi;

public class CatalogsApiExample {

    public static void main(String[] args) {
        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CatalogList result = apiInstance.getCatalogs(baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getCatalogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get a list of catalogs
[apiInstance getCatalogsWith:baseSiteId
    fields:fields
              completionHandler: ^(CatalogList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CatalogsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCatalogs(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CatalogsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a list of catalogs
                CatalogList result = apiInstance.getCatalogs(baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogsApi.getCatalogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCatalogsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

my $api_instance = WWW::SwaggerClient::CatalogsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

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

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

# create an instance of the API class
api_instance = swagger_client.CatalogsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a list of catalogs
    api_response = api_instance.get_catalogs(baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogsApi->getCatalogs: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCategories

Get information about catagory in a catalog version

Returns information about a specified category that exists in a catalog version available for the current base store.


/{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}/categories/{categoryId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}/categories/{categoryId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogsApi;

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

public class CatalogsApiExample {

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

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

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

        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | Catalog identifier
        String catalogVersionId = catalogVersionId_example; // String | Catalog version identifier
        String categoryId = categoryId_example; // String | Category identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CategoryHierarchy result = apiInstance.getCategories(baseSiteId, catalogId, catalogVersionId, categoryId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getCategories");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogsApi;

public class CatalogsApiExample {

    public static void main(String[] args) {
        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | Catalog identifier
        String catalogVersionId = catalogVersionId_example; // String | Catalog version identifier
        String categoryId = categoryId_example; // String | Category identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CategoryHierarchy result = apiInstance.getCategories(baseSiteId, catalogId, catalogVersionId, categoryId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getCategories");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *catalogId = catalogId_example; // Catalog identifier
String *catalogVersionId = catalogVersionId_example; // Catalog version identifier
String *categoryId = categoryId_example; // Category identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

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

// Get information about catagory in a catalog version
[apiInstance getCategoriesWith:baseSiteId
    catalogId:catalogId
    catalogVersionId:catalogVersionId
    categoryId:categoryId
    fields:fields
              completionHandler: ^(CategoryHierarchy output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.CatalogsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var catalogId = catalogId_example; // {{String}} Catalog identifier
var catalogVersionId = catalogVersionId_example; // {{String}} Catalog version identifier
var categoryId = categoryId_example; // {{String}} Category identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategories(baseSiteId, catalogId, catalogVersionId, categoryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CatalogsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var catalogId = catalogId_example;  // String | Catalog identifier
            var catalogVersionId = catalogVersionId_example;  // String | Catalog version identifier
            var categoryId = categoryId_example;  // String | Category identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get information about catagory in a catalog version
                CategoryHierarchy result = apiInstance.getCategories(baseSiteId, catalogId, catalogVersionId, categoryId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogsApi.getCategories: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCatalogsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$catalogId = catalogId_example; // String | Catalog identifier
$catalogVersionId = catalogVersionId_example; // String | Catalog version identifier
$categoryId = categoryId_example; // String | Category identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getCategories($baseSiteId, $catalogId, $catalogVersionId, $categoryId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogsApi->getCategories: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CatalogsApi;

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

my $api_instance = WWW::SwaggerClient::CatalogsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $catalogId = catalogId_example; # String | Catalog identifier
my $catalogVersionId = catalogVersionId_example; # String | Catalog version identifier
my $categoryId = categoryId_example; # String | Category identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCategories(baseSiteId => $baseSiteId, catalogId => $catalogId, catalogVersionId => $catalogVersionId, categoryId => $categoryId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CatalogsApi->getCategories: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CatalogsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
catalogId = catalogId_example # String | Catalog identifier
catalogVersionId = catalogVersionId_example # String | Catalog version identifier
categoryId = categoryId_example # String | Category identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get information about catagory in a catalog version
    api_response = api_instance.get_categories(baseSiteId, catalogId, catalogVersionId, categoryId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogsApi->getCategories: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
catalogId*
String
Catalog identifier
Required
catalogVersionId*
String
Catalog version identifier
Required
categoryId*
String
Category identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Consents

fetchAllConsents

Fetch the list of consents

Fetch the list of all consents available in the system for a given base site


/{baseSiteId}/users/{userId}/consenttemplates

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/consenttemplates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsentsApi;

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

public class ConsentsApiExample {

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

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

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

        ConsentsApi apiInstance = new ConsentsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            ConsentTemplateList result = apiInstance.fetchAllConsents(baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#fetchAllConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsentsApi;

public class ConsentsApiExample {

    public static void main(String[] args) {
        ConsentsApi apiInstance = new ConsentsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            ConsentTemplateList result = apiInstance.fetchAllConsents(baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#fetchAllConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Fetch the list of consents
[apiInstance fetchAllConsentsWith:baseSiteId
    userId:userId
              completionHandler: ^(ConsentTemplateList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.ConsentsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new ConsentsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Fetch the list of consents
                ConsentTemplateList result = apiInstance.fetchAllConsents(baseSiteId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsentsApi.fetchAllConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiConsentsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::ConsentsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

# create an instance of the API class
api_instance = swagger_client.ConsentsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Fetch the list of consents
    api_response = api_instance.fetch_all_consents(baseSiteId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsentsApi->fetchAllConsents: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getConsentTemplate

Fetch the consent.

If user has not given or withdrawn consent to the template, no given or withdraw date is returned.


/{baseSiteId}/users/{userId}/consenttemplates/{consentTemplateId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/consenttemplates/{consentTemplateId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsentsApi;

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

public class ConsentsApiExample {

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

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

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

        ConsentsApi apiInstance = new ConsentsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String consentTemplateId = consentTemplateId_example; // String | Consent template id.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            ConsentTemplate result = apiInstance.getConsentTemplate(baseSiteId, consentTemplateId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#getConsentTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsentsApi;

public class ConsentsApiExample {

    public static void main(String[] args) {
        ConsentsApi apiInstance = new ConsentsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String consentTemplateId = consentTemplateId_example; // String | Consent template id.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            ConsentTemplate result = apiInstance.getConsentTemplate(baseSiteId, consentTemplateId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#getConsentTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *consentTemplateId = consentTemplateId_example; // Consent template id.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Fetch the consent.
[apiInstance getConsentTemplateWith:baseSiteId
    consentTemplateId:consentTemplateId
    userId:userId
              completionHandler: ^(ConsentTemplate output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.ConsentsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var consentTemplateId = consentTemplateId_example; // {{String}} Consent template id.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new ConsentsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var consentTemplateId = consentTemplateId_example;  // String | Consent template id.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Fetch the consent.
                ConsentTemplate result = apiInstance.getConsentTemplate(baseSiteId, consentTemplateId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsentsApi.getConsentTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiConsentsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$consentTemplateId = consentTemplateId_example; // String | Consent template id.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::ConsentsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $consentTemplateId = consentTemplateId_example; # String | Consent template id.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

# create an instance of the API class
api_instance = swagger_client.ConsentsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
consentTemplateId = consentTemplateId_example # String | Consent template id.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Fetch the consent.
    api_response = api_instance.get_consent_template(baseSiteId, consentTemplateId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsentsApi->getConsentTemplate: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
consentTemplateId*
String
Consent template id.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


grantConsent

Allows to grant a consent

Allows to give a consent on a specific consent template


/{baseSiteId}/users/{userId}/consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/consents?consentTemplateId=&consentTemplateVersion="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsentsApi;

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

public class ConsentsApiExample {

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

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

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

        ConsentsApi apiInstance = new ConsentsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String consentTemplateId = consentTemplateId_example; // String | Consent template ID.
        Integer consentTemplateVersion = 56; // Integer | Consent template version.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.grantConsent(baseSiteId, consentTemplateId, consentTemplateVersion, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#grantConsent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsentsApi;

public class ConsentsApiExample {

    public static void main(String[] args) {
        ConsentsApi apiInstance = new ConsentsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String consentTemplateId = consentTemplateId_example; // String | Consent template ID.
        Integer consentTemplateVersion = 56; // Integer | Consent template version.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.grantConsent(baseSiteId, consentTemplateId, consentTemplateVersion, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#grantConsent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *consentTemplateId = consentTemplateId_example; // Consent template ID.
Integer *consentTemplateVersion = 56; // Consent template version.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Allows to grant a consent
[apiInstance grantConsentWith:baseSiteId
    consentTemplateId:consentTemplateId
    consentTemplateVersion:consentTemplateVersion
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.ConsentsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var consentTemplateId = consentTemplateId_example; // {{String}} Consent template ID.
var consentTemplateVersion = 56; // {{Integer}} Consent template version.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new ConsentsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var consentTemplateId = consentTemplateId_example;  // String | Consent template ID.
            var consentTemplateVersion = 56;  // Integer | Consent template version.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Allows to grant a consent
                'String' result = apiInstance.grantConsent(baseSiteId, consentTemplateId, consentTemplateVersion, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsentsApi.grantConsent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiConsentsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$consentTemplateId = consentTemplateId_example; // String | Consent template ID.
$consentTemplateVersion = 56; // Integer | Consent template version.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

my $api_instance = WWW::SwaggerClient::ConsentsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $consentTemplateId = consentTemplateId_example; # String | Consent template ID.
my $consentTemplateVersion = 56; # Integer | Consent template version.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->grantConsent(baseSiteId => $baseSiteId, consentTemplateId => $consentTemplateId, consentTemplateVersion => $consentTemplateVersion, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsentsApi->grantConsent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.ConsentsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
consentTemplateId = consentTemplateId_example # String | Consent template ID.
consentTemplateVersion = 56 # Integer | Consent template version.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Allows to grant a consent
    api_response = api_instance.grant_consent(baseSiteId, consentTemplateId, consentTemplateVersion, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsentsApi->grantConsent: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
consentTemplateId*
String
Consent template ID.
Required
consentTemplateVersion*
Integer (int32)
Consent template version.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


removeConsent

Withdraws the user consent for a given consent code.

If the user consent was given, the consent is withdrawn. If consent was already withdrawn then returns consent already withdrawn error. If there is no such consent then returns not found. If the current user is an anonymous user then returns access denied error.


/{baseSiteId}/users/{userId}/consents/{consentCode}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/consents/{consentCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsentsApi;

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

public class ConsentsApiExample {

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

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

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

        ConsentsApi apiInstance = new ConsentsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String consentCode = consentCode_example; // String | Consent code.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeConsent(baseSiteId, consentCode, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#removeConsent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsentsApi;

public class ConsentsApiExample {

    public static void main(String[] args) {
        ConsentsApi apiInstance = new ConsentsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String consentCode = consentCode_example; // String | Consent code.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeConsent(baseSiteId, consentCode, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsentsApi#removeConsent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *consentCode = consentCode_example; // Consent code.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

// Withdraws the user consent for a given consent code.
[apiInstance removeConsentWith:baseSiteId
    consentCode:consentCode
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

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

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

var api = new CommerceWebservices.ConsentsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var consentCode = consentCode_example; // {{String}} Consent code.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

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

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

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

            var apiInstance = new ConsentsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var consentCode = consentCode_example;  // String | Consent code.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Withdraws the user consent for a given consent code.
                'String' result = apiInstance.removeConsent(baseSiteId, consentCode, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsentsApi.removeConsent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiConsentsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$consentCode = consentCode_example; // String | Consent code.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->removeConsent($baseSiteId, $consentCode, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsentsApi->removeConsent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsentsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ConsentsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $consentCode = consentCode_example; # String | Consent code.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->removeConsent(baseSiteId => $baseSiteId, consentCode => $consentCode, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsentsApi->removeConsent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ConsentsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
consentCode = consentCode_example # String | Consent code.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Withdraws the user consent for a given consent code.
    api_response = api_instance.remove_consent(baseSiteId, consentCode, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsentsApi->removeConsent: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
consentCode*
String
Consent code.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity: business rules validation errors

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


Countries

getCountries

Get a list of countries.

If the value of type equals to shipping, then return shipping countries. If the value of type equals to billing, then return billing countries. If the value of type is not given, return all countries. The list is sorted alphabetically.


/{baseSiteId}/countries

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/countries?fields=&type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CountriesApi;

import java.io.File;
import java.util.*;

public class CountriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CountriesApi apiInstance = new CountriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        String type = type_example; // String | The type of countries.
        try {
            CountryList result = apiInstance.getCountries(baseSiteId, fields, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountriesApi#getCountries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CountriesApi;

public class CountriesApiExample {

    public static void main(String[] args) {
        CountriesApi apiInstance = new CountriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        String type = type_example; // String | The type of countries.
        try {
            CountryList result = apiInstance.getCountries(baseSiteId, fields, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountriesApi#getCountries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
String *type = type_example; // The type of countries. (optional)

CountriesApi *apiInstance = [[CountriesApi alloc] init];

// Get a list of countries.
[apiInstance getCountriesWith:baseSiteId
    fields:fields
    type:type
              completionHandler: ^(CountryList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.CountriesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'type': type_example // {{String}} The type of countries.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCountries(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCountriesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CountriesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var type = type_example;  // String | The type of countries. (optional) 

            try
            {
                // Get a list of countries.
                CountryList result = apiInstance.getCountries(baseSiteId, fields, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CountriesApi.getCountries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCountriesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$type = type_example; // String | The type of countries.

try {
    $result = $api_instance->getCountries($baseSiteId, $fields, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountriesApi->getCountries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CountriesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CountriesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $type = type_example; # String | The type of countries.

eval { 
    my $result = $api_instance->getCountries(baseSiteId => $baseSiteId, fields => $fields, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountriesApi->getCountries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CountriesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
type = type_example # String | The type of countries. (optional)

try: 
    # Get a list of countries.
    api_response = api_instance.get_countries(baseSiteId, fields=fields, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountriesApi->getCountries: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
type
String
The type of countries.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCountryRegions

Fetch the list of regions for the provided country.

Lists all regions.


/{baseSiteId}/countries/{countyIsoCode}/regions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/countries/{countyIsoCode}/regions?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CountriesApi;

import java.io.File;
import java.util.*;

public class CountriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CountriesApi apiInstance = new CountriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String countyIsoCode = countyIsoCode_example; // String | An ISO code for a country
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            RegionList result = apiInstance.getCountryRegions(baseSiteId, countyIsoCode, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountriesApi#getCountryRegions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CountriesApi;

public class CountriesApiExample {

    public static void main(String[] args) {
        CountriesApi apiInstance = new CountriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String countyIsoCode = countyIsoCode_example; // String | An ISO code for a country
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            RegionList result = apiInstance.getCountryRegions(baseSiteId, countyIsoCode, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CountriesApi#getCountryRegions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *countyIsoCode = countyIsoCode_example; // An ISO code for a country
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

CountriesApi *apiInstance = [[CountriesApi alloc] init];

// Fetch the list of regions for the provided country.
[apiInstance getCountryRegionsWith:baseSiteId
    countyIsoCode:countyIsoCode
    fields:fields
              completionHandler: ^(RegionList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.CountriesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var countyIsoCode = countyIsoCode_example; // {{String}} An ISO code for a country
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCountryRegions(baseSiteId, countyIsoCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCountryRegionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CountriesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var countyIsoCode = countyIsoCode_example;  // String | An ISO code for a country
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Fetch the list of regions for the provided country.
                RegionList result = apiInstance.getCountryRegions(baseSiteId, countyIsoCode, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CountriesApi.getCountryRegions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCountriesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$countyIsoCode = countyIsoCode_example; // String | An ISO code for a country
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getCountryRegions($baseSiteId, $countyIsoCode, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountriesApi->getCountryRegions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CountriesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CountriesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $countyIsoCode = countyIsoCode_example; # String | An ISO code for a country
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCountryRegions(baseSiteId => $baseSiteId, countyIsoCode => $countyIsoCode, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CountriesApi->getCountryRegions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CountriesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
countyIsoCode = countyIsoCode_example # String | An ISO code for a country
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Fetch the list of regions for the provided country.
    api_response = api_instance.get_country_regions(baseSiteId, countyIsoCode, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CountriesApi->getCountryRegions: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
countyIsoCode*
String
An ISO code for a country
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


CustomerGroups

createCustomerGroup

Creates a new customer group.

Creates a new customer group that is a direct subgroup of a customergroup. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.


/{baseSiteId}/customergroups

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/customergroups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerGroupsApi;

import java.io.File;
import java.util.*;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        UserGroup body = ; // UserGroup | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            apiInstance.createCustomerGroup(body, baseSiteId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#createCustomerGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerGroupsApi;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        UserGroup body = ; // UserGroup | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            apiInstance.createCustomerGroup(body, baseSiteId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#createCustomerGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UserGroup *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier

CustomerGroupsApi *apiInstance = [[CustomerGroupsApi alloc] init];

// Creates a new customer group.
[apiInstance createCustomerGroupWith:body
    baseSiteId:baseSiteId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.CustomerGroupsApi()
var body = ; // {{UserGroup}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createCustomerGroup(bodybaseSiteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCustomerGroupExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerGroupsApi();
            var body = new UserGroup(); // UserGroup | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier

            try
            {
                // Creates a new customer group.
                apiInstance.createCustomerGroup(body, baseSiteId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerGroupsApi.createCustomerGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerGroupsApi();
$body = ; // UserGroup | 
$baseSiteId = baseSiteId_example; // String | Base site identifier

try {
    $api_instance->createCustomerGroup($body, $baseSiteId);
} catch (Exception $e) {
    echo 'Exception when calling CustomerGroupsApi->createCustomerGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerGroupsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerGroupsApi->new();
my $body = WWW::SwaggerClient::Object::UserGroup->new(); # UserGroup | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier

eval { 
    $api_instance->createCustomerGroup(body => $body, baseSiteId => $baseSiteId);
};
if ($@) {
    warn "Exception when calling CustomerGroupsApi->createCustomerGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerGroupsApi()
body =  # UserGroup | 
baseSiteId = baseSiteId_example # String | Base site identifier

try: 
    # Creates a new customer group.
    api_instance.create_customer_group(body, baseSiteId)
except ApiException as e:
    print("Exception when calling CustomerGroupsApi->createCustomerGroup: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCustomerGroup

Get a specific customer group.

Returns a customer group with a specific groupId. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.


/{baseSiteId}/customergroups/{groupId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/customergroups/{groupId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerGroupsApi;

import java.io.File;
import java.util.*;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String groupId = groupId_example; // String | Group identifier.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            UserGroup result = apiInstance.getCustomerGroup(baseSiteId, groupId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#getCustomerGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerGroupsApi;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String groupId = groupId_example; // String | Group identifier.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            UserGroup result = apiInstance.getCustomerGroup(baseSiteId, groupId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#getCustomerGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *groupId = groupId_example; // Group identifier.
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)

CustomerGroupsApi *apiInstance = [[CustomerGroupsApi alloc] init];

// Get a specific customer group.
[apiInstance getCustomerGroupWith:baseSiteId
    groupId:groupId
    fields:fields
              completionHandler: ^(UserGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.CustomerGroupsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var groupId = groupId_example; // {{String}} Group identifier.
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCustomerGroup(baseSiteId, groupId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCustomerGroupExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerGroupsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var groupId = groupId_example;  // String | Group identifier.
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to BASIC)

            try
            {
                // Get a specific customer group.
                UserGroup result = apiInstance.getCustomerGroup(baseSiteId, groupId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerGroupsApi.getCustomerGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerGroupsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$groupId = groupId_example; // String | Group identifier.
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getCustomerGroup($baseSiteId, $groupId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerGroupsApi->getCustomerGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerGroupsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerGroupsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $groupId = groupId_example; # String | Group identifier.
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCustomerGroup(baseSiteId => $baseSiteId, groupId => $groupId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerGroupsApi->getCustomerGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerGroupsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
groupId = groupId_example # String | Group identifier.
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)

try: 
    # Get a specific customer group.
    api_response = api_instance.get_customer_group(baseSiteId, groupId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerGroupsApi->getCustomerGroup: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
groupId*
String
Group identifier.
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCustomerGroups

Get all subgroups of a customergroup.

Returns all customer groups that are direct subgroups of a customergroup. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.


/{baseSiteId}/customergroups

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/customergroups?currentPage=&fields=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerGroupsApi;

import java.io.File;
import java.util.*;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        Integer currentPage = 56; // Integer | Current page number (starts with 0).
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | Number of customer group returned in one page.
        try {
            UserGroupList result = apiInstance.getCustomerGroups(baseSiteId, currentPage, fields, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#getCustomerGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerGroupsApi;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        Integer currentPage = 56; // Integer | Current page number (starts with 0).
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | Number of customer group returned in one page.
        try {
            UserGroupList result = apiInstance.getCustomerGroups(baseSiteId, currentPage, fields, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#getCustomerGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
Integer *currentPage = 56; // Current page number (starts with 0). (optional) (default to 0)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)
Integer *pageSize = 56; // Number of customer group returned in one page. (optional) (default to 20)

CustomerGroupsApi *apiInstance = [[CustomerGroupsApi alloc] init];

// Get all subgroups of a customergroup.
[apiInstance getCustomerGroupsWith:baseSiteId
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
              completionHandler: ^(UserGroupList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.CustomerGroupsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'currentPage': 56, // {{Integer}} Current page number (starts with 0).
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'pageSize': 56 // {{Integer}} Number of customer group returned in one page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCustomerGroups(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCustomerGroupsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerGroupsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var currentPage = 56;  // Integer | Current page number (starts with 0). (optional)  (default to 0)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to BASIC)
            var pageSize = 56;  // Integer | Number of customer group returned in one page. (optional)  (default to 20)

            try
            {
                // Get all subgroups of a customergroup.
                UserGroupList result = apiInstance.getCustomerGroups(baseSiteId, currentPage, fields, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerGroupsApi.getCustomerGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerGroupsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$currentPage = 56; // Integer | Current page number (starts with 0).
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$pageSize = 56; // Integer | Number of customer group returned in one page.

try {
    $result = $api_instance->getCustomerGroups($baseSiteId, $currentPage, $fields, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerGroupsApi->getCustomerGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerGroupsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerGroupsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $currentPage = 56; # Integer | Current page number (starts with 0).
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $pageSize = 56; # Integer | Number of customer group returned in one page.

eval { 
    my $result = $api_instance->getCustomerGroups(baseSiteId => $baseSiteId, currentPage => $currentPage, fields => $fields, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerGroupsApi->getCustomerGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerGroupsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
currentPage = 56 # Integer | Current page number (starts with 0). (optional) (default to 0)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)
pageSize = 56 # Integer | Number of customer group returned in one page. (optional) (default to 20)

try: 
    # Get all subgroups of a customergroup.
    api_response = api_instance.get_customer_groups(baseSiteId, currentPage=currentPage, fields=fields, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerGroupsApi->getCustomerGroups: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
currentPage
Integer (int32)
Current page number (starts with 0).
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
pageSize
Integer (int32)
Number of customer group returned in one page.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeUsersFromCustomerGroup

Deletes a user from a customer group.

Deletes user from a customer group. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.


/{baseSiteId}/customergroups/{groupId}/members/{userId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/customergroups/{groupId}/members/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerGroupsApi;

import java.io.File;
import java.util.*;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String groupId = groupId_example; // String | Group identifier.
        String userId = userId_example; // String | User identifier.
        try {
            apiInstance.removeUsersFromCustomerGroup(baseSiteId, groupId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#removeUsersFromCustomerGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerGroupsApi;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String groupId = groupId_example; // String | Group identifier.
        String userId = userId_example; // String | User identifier.
        try {
            apiInstance.removeUsersFromCustomerGroup(baseSiteId, groupId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#removeUsersFromCustomerGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *groupId = groupId_example; // Group identifier.
String *userId = userId_example; // User identifier.

CustomerGroupsApi *apiInstance = [[CustomerGroupsApi alloc] init];

// Deletes a user from a customer group.
[apiInstance removeUsersFromCustomerGroupWith:baseSiteId
    groupId:groupId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.CustomerGroupsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var groupId = groupId_example; // {{String}} Group identifier.
var userId = userId_example; // {{String}} User identifier.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeUsersFromCustomerGroup(baseSiteId, groupId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeUsersFromCustomerGroupExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerGroupsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var groupId = groupId_example;  // String | Group identifier.
            var userId = userId_example;  // String | User identifier.

            try
            {
                // Deletes a user from a customer group.
                apiInstance.removeUsersFromCustomerGroup(baseSiteId, groupId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerGroupsApi.removeUsersFromCustomerGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerGroupsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$groupId = groupId_example; // String | Group identifier.
$userId = userId_example; // String | User identifier.

try {
    $api_instance->removeUsersFromCustomerGroup($baseSiteId, $groupId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CustomerGroupsApi->removeUsersFromCustomerGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerGroupsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerGroupsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $groupId = groupId_example; # String | Group identifier.
my $userId = userId_example; # String | User identifier.

eval { 
    $api_instance->removeUsersFromCustomerGroup(baseSiteId => $baseSiteId, groupId => $groupId, userId => $userId);
};
if ($@) {
    warn "Exception when calling CustomerGroupsApi->removeUsersFromCustomerGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerGroupsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
groupId = groupId_example # String | Group identifier.
userId = userId_example # String | User identifier.

try: 
    # Deletes a user from a customer group.
    api_instance.remove_users_from_customer_group(baseSiteId, groupId, userId)
except ApiException as e:
    print("Exception when calling CustomerGroupsApi->removeUsersFromCustomerGroup: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
groupId*
String
Group identifier.
Required
userId*
String
User identifier.
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replaceUsersForCustomerGroup

Sets members for a user group.

Sets members for a user group. The list of existing members is overwritten with a new one. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.


/{baseSiteId}/customergroups/{groupId}/members

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/customergroups/{groupId}/members"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerGroupsApi;

import java.io.File;
import java.util.*;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        MemberList body = ; // MemberList | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String groupId = groupId_example; // String | Group identifier.
        try {
            apiInstance.replaceUsersForCustomerGroup(body, baseSiteId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#replaceUsersForCustomerGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerGroupsApi;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        MemberList body = ; // MemberList | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String groupId = groupId_example; // String | Group identifier.
        try {
            apiInstance.replaceUsersForCustomerGroup(body, baseSiteId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#replaceUsersForCustomerGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
MemberList *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *groupId = groupId_example; // Group identifier.

CustomerGroupsApi *apiInstance = [[CustomerGroupsApi alloc] init];

// Sets members for a user group.
[apiInstance replaceUsersForCustomerGroupWith:body
    baseSiteId:baseSiteId
    groupId:groupId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.CustomerGroupsApi()
var body = ; // {{MemberList}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var groupId = groupId_example; // {{String}} Group identifier.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.replaceUsersForCustomerGroup(bodybaseSiteIdgroupId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class replaceUsersForCustomerGroupExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerGroupsApi();
            var body = new MemberList(); // MemberList | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var groupId = groupId_example;  // String | Group identifier.

            try
            {
                // Sets members for a user group.
                apiInstance.replaceUsersForCustomerGroup(body, baseSiteId, groupId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerGroupsApi.replaceUsersForCustomerGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerGroupsApi();
$body = ; // MemberList | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$groupId = groupId_example; // String | Group identifier.

try {
    $api_instance->replaceUsersForCustomerGroup($body, $baseSiteId, $groupId);
} catch (Exception $e) {
    echo 'Exception when calling CustomerGroupsApi->replaceUsersForCustomerGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerGroupsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerGroupsApi->new();
my $body = WWW::SwaggerClient::Object::MemberList->new(); # MemberList | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $groupId = groupId_example; # String | Group identifier.

eval { 
    $api_instance->replaceUsersForCustomerGroup(body => $body, baseSiteId => $baseSiteId, groupId => $groupId);
};
if ($@) {
    warn "Exception when calling CustomerGroupsApi->replaceUsersForCustomerGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerGroupsApi()
body =  # MemberList | 
baseSiteId = baseSiteId_example # String | Base site identifier
groupId = groupId_example # String | Group identifier.

try: 
    # Sets members for a user group.
    api_instance.replace_users_for_customer_group(body, baseSiteId, groupId)
except ApiException as e:
    print("Exception when calling CustomerGroupsApi->replaceUsersForCustomerGroup: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
groupId*
String
Group identifier.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


updateCustomerGroupWithUsers

Assigns user(s) to a customer group.

Assigns user(s) to a customer group. To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.


/{baseSiteId}/customergroups/{groupId}/members

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/customergroups/{groupId}/members"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerGroupsApi;

import java.io.File;
import java.util.*;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        MemberList body = ; // MemberList | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String groupId = groupId_example; // String | Group identifier.
        try {
            apiInstance.updateCustomerGroupWithUsers(body, baseSiteId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#updateCustomerGroupWithUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerGroupsApi;

public class CustomerGroupsApiExample {

    public static void main(String[] args) {
        CustomerGroupsApi apiInstance = new CustomerGroupsApi();
        MemberList body = ; // MemberList | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String groupId = groupId_example; // String | Group identifier.
        try {
            apiInstance.updateCustomerGroupWithUsers(body, baseSiteId, groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerGroupsApi#updateCustomerGroupWithUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
MemberList *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *groupId = groupId_example; // Group identifier.

CustomerGroupsApi *apiInstance = [[CustomerGroupsApi alloc] init];

// Assigns user(s) to a customer group.
[apiInstance updateCustomerGroupWithUsersWith:body
    baseSiteId:baseSiteId
    groupId:groupId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.CustomerGroupsApi()
var body = ; // {{MemberList}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var groupId = groupId_example; // {{String}} Group identifier.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCustomerGroupWithUsers(bodybaseSiteIdgroupId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCustomerGroupWithUsersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerGroupsApi();
            var body = new MemberList(); // MemberList | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var groupId = groupId_example;  // String | Group identifier.

            try
            {
                // Assigns user(s) to a customer group.
                apiInstance.updateCustomerGroupWithUsers(body, baseSiteId, groupId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerGroupsApi.updateCustomerGroupWithUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerGroupsApi();
$body = ; // MemberList | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$groupId = groupId_example; // String | Group identifier.

try {
    $api_instance->updateCustomerGroupWithUsers($body, $baseSiteId, $groupId);
} catch (Exception $e) {
    echo 'Exception when calling CustomerGroupsApi->updateCustomerGroupWithUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerGroupsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerGroupsApi->new();
my $body = WWW::SwaggerClient::Object::MemberList->new(); # MemberList | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $groupId = groupId_example; # String | Group identifier.

eval { 
    $api_instance->updateCustomerGroupWithUsers(body => $body, baseSiteId => $baseSiteId, groupId => $groupId);
};
if ($@) {
    warn "Exception when calling CustomerGroupsApi->updateCustomerGroupWithUsers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerGroupsApi()
body =  # MemberList | 
baseSiteId = baseSiteId_example # String | Base site identifier
groupId = groupId_example # String | Group identifier.

try: 
    # Assigns user(s) to a customer group.
    api_instance.update_customer_group_with_users(body, baseSiteId, groupId)
except ApiException as e:
    print("Exception when calling CustomerGroupsApi->updateCustomerGroupWithUsers: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
groupId*
String
Group identifier.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


DealCarts

addDealToCart

Perform the add deal to cart.

Add a deal to the cart, as a combination of transportation for a return journey, and associated room stays and additional products. Only one deal can be in the cart at the same time.


/{baseSiteId}/users/{userId}/carts/{cartId}/deals

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/deals"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DealCartsApi;

import java.io.File;
import java.util.*;

public class DealCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        DealCartsApi apiInstance = new DealCartsApi();
        AddDealToCart body = ; // AddDealToCart | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addDealToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DealCartsApi#addDealToCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DealCartsApi;

public class DealCartsApiExample {

    public static void main(String[] args) {
        DealCartsApi apiInstance = new DealCartsApi();
        AddDealToCart body = ; // AddDealToCart | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addDealToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DealCartsApi#addDealToCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AddDealToCart *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

DealCartsApi *apiInstance = [[DealCartsApi alloc] init];

// Perform the add deal to cart.
[apiInstance addDealToCartWith:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.DealCartsApi()
var body = ; // {{AddDealToCart}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDealToCart(bodysap.cxSalesApplicationbaseSiteIdcartIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addDealToCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DealCartsApi();
            var body = new AddDealToCart(); // AddDealToCart | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Perform the add deal to cart.
                'String' result = apiInstance.addDealToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DealCartsApi.addDealToCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDealCartsApi();
$body = ; // AddDealToCart | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->addDealToCart($body, $sap.cxSalesApplication, $baseSiteId, $cartId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealCartsApi->addDealToCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DealCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DealCartsApi->new();
my $body = WWW::SwaggerClient::Object::AddDealToCart->new(); # AddDealToCart | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->addDealToCart(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DealCartsApi->addDealToCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DealCartsApi()
body =  # AddDealToCart | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Perform the add deal to cart.
    api_response = api_instance.add_deal_to_cart(body, sap.cxSalesApplication, baseSiteId, cartId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealCartsApi->addDealToCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No content

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable entity: business rules validation errors

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


DealSearch

getAvailableDates

Gets for the available dates of a specific deal

Gets for the available dates for a specific deal, in the specified interval.


/{baseSiteId}/deals/{dealId}/availableDates

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/deals/{dealId}/availableDates?endingDate=&startingDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DealSearchApi;

import java.io.File;
import java.util.*;

public class DealSearchApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        DealSearchApi apiInstance = new DealSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String dealId = dealId_example; // String | The deal unique identifier
        String endingDate = endingDate_example; // String | The ending date
        String startingDate = startingDate_example; // String | The starting date
        try {
            DateList result = apiInstance.getAvailableDates(baseSiteId, dealId, endingDate, startingDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DealSearchApi#getAvailableDates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DealSearchApi;

public class DealSearchApiExample {

    public static void main(String[] args) {
        DealSearchApi apiInstance = new DealSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String dealId = dealId_example; // String | The deal unique identifier
        String endingDate = endingDate_example; // String | The ending date
        String startingDate = startingDate_example; // String | The starting date
        try {
            DateList result = apiInstance.getAvailableDates(baseSiteId, dealId, endingDate, startingDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DealSearchApi#getAvailableDates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *dealId = dealId_example; // The deal unique identifier
String *endingDate = endingDate_example; // The ending date
String *startingDate = startingDate_example; // The starting date

DealSearchApi *apiInstance = [[DealSearchApi alloc] init];

// Gets for the available dates of a specific deal
[apiInstance getAvailableDatesWith:baseSiteId
    dealId:dealId
    endingDate:endingDate
    startingDate:startingDate
              completionHandler: ^(DateList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.DealSearchApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var dealId = dealId_example; // {{String}} The deal unique identifier
var endingDate = endingDate_example; // {{String}} The ending date
var startingDate = startingDate_example; // {{String}} The starting date

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvailableDates(baseSiteId, dealId, endingDate, startingDate, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAvailableDatesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DealSearchApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var dealId = dealId_example;  // String | The deal unique identifier
            var endingDate = endingDate_example;  // String | The ending date
            var startingDate = startingDate_example;  // String | The starting date

            try
            {
                // Gets for the available dates of a specific deal
                DateList result = apiInstance.getAvailableDates(baseSiteId, dealId, endingDate, startingDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DealSearchApi.getAvailableDates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDealSearchApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$dealId = dealId_example; // String | The deal unique identifier
$endingDate = endingDate_example; // String | The ending date
$startingDate = startingDate_example; // String | The starting date

try {
    $result = $api_instance->getAvailableDates($baseSiteId, $dealId, $endingDate, $startingDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealSearchApi->getAvailableDates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DealSearchApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DealSearchApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $dealId = dealId_example; # String | The deal unique identifier
my $endingDate = endingDate_example; # String | The ending date
my $startingDate = startingDate_example; # String | The starting date

eval { 
    my $result = $api_instance->getAvailableDates(baseSiteId => $baseSiteId, dealId => $dealId, endingDate => $endingDate, startingDate => $startingDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DealSearchApi->getAvailableDates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DealSearchApi()
baseSiteId = baseSiteId_example # String | Base site identifier
dealId = dealId_example # String | The deal unique identifier
endingDate = endingDate_example # String | The ending date
startingDate = startingDate_example # String | The starting date

try: 
    # Gets for the available dates of a specific deal
    api_response = api_instance.get_available_dates(baseSiteId, dealId, endingDate, startingDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealSearchApi->getAvailableDates: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
dealId*
String
The deal unique identifier
Required
Query parameters
Name Description
endingDate*
String
The ending date
Required
startingDate*
String
The starting date
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getBundleTemplateFromCategory

Searches for the list of deals for a given category

Search for the deals belonging to the category passed as argument. Details about the deals will be returned and the level will depend on the extent of the fields attribute


/{baseSiteId}/deals

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/deals?dealCategory=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DealSearchApi;

import java.io.File;
import java.util.*;

public class DealSearchApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        DealSearchApi apiInstance = new DealSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String dealCategory = dealCategory_example; // String | The deal category unique identifier
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        try {
            DealSearchResponse result = apiInstance.getBundleTemplateFromCategory(baseSiteId, dealCategory, sap.cxSalesApplication, acceptLanguage, fields, sap.cxAcceptCurrency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DealSearchApi#getBundleTemplateFromCategory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DealSearchApi;

public class DealSearchApiExample {

    public static void main(String[] args) {
        DealSearchApi apiInstance = new DealSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String dealCategory = dealCategory_example; // String | The deal category unique identifier
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        try {
            DealSearchResponse result = apiInstance.getBundleTemplateFromCategory(baseSiteId, dealCategory, sap.cxSalesApplication, acceptLanguage, fields, sap.cxAcceptCurrency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DealSearchApi#getBundleTemplateFromCategory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *dealCategory = dealCategory_example; // The deal category unique identifier
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)
String *sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // Requested Currency for the client (optional)

DealSearchApi *apiInstance = [[DealSearchApi alloc] init];

// Searches for the list of deals for a given category
[apiInstance getBundleTemplateFromCategoryWith:baseSiteId
    dealCategory:dealCategory
    sap.cxSalesApplication:sap.cxSalesApplication
    acceptLanguage:acceptLanguage
    fields:fields
    sap.cxAcceptCurrency:sap.cxAcceptCurrency
              completionHandler: ^(DealSearchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.DealSearchApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var dealCategory = dealCategory_example; // {{String}} The deal category unique identifier
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'sap.cxAcceptCurrency': sap.cxAcceptCurrency_example // {{String}} Requested Currency for the client
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBundleTemplateFromCategory(baseSiteId, dealCategory, sap.cxSalesApplication, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBundleTemplateFromCategoryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DealSearchApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var dealCategory = dealCategory_example;  // String | The deal category unique identifier
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to BASIC)
            var sap.cxAcceptCurrency = sap.cxAcceptCurrency_example;  // String | Requested Currency for the client (optional) 

            try
            {
                // Searches for the list of deals for a given category
                DealSearchResponse result = apiInstance.getBundleTemplateFromCategory(baseSiteId, dealCategory, sap.cxSalesApplication, acceptLanguage, fields, sap.cxAcceptCurrency);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DealSearchApi.getBundleTemplateFromCategory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDealSearchApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$dealCategory = dealCategory_example; // String | The deal category unique identifier
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client

try {
    $result = $api_instance->getBundleTemplateFromCategory($baseSiteId, $dealCategory, $sap.cxSalesApplication, $acceptLanguage, $fields, $sap.cxAcceptCurrency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealSearchApi->getBundleTemplateFromCategory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DealSearchApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DealSearchApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $dealCategory = dealCategory_example; # String | The deal category unique identifier
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; # String | Requested Currency for the client

eval { 
    my $result = $api_instance->getBundleTemplateFromCategory(baseSiteId => $baseSiteId, dealCategory => $dealCategory, sap.cxSalesApplication => $sap.cxSalesApplication, acceptLanguage => $acceptLanguage, fields => $fields, sap.cxAcceptCurrency => $sap.cxAcceptCurrency);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DealSearchApi->getBundleTemplateFromCategory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DealSearchApi()
baseSiteId = baseSiteId_example # String | Base site identifier
dealCategory = dealCategory_example # String | The deal category unique identifier
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)
sap.cxAcceptCurrency = sap.cxAcceptCurrency_example # String | Requested Currency for the client (optional)

try: 
    # Searches for the list of deals for a given category
    api_response = api_instance.get_bundle_template_from_category(baseSiteId, dealCategory, sap.cxSalesApplication, acceptLanguage=acceptLanguage, fields=fields, sap.cxAcceptCurrency=sap.cxAcceptCurrency)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealSearchApi->getBundleTemplateFromCategory: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-accept-currency
String
Requested Currency for the client
sap.cx-sales-application*
String
The sales application code
Required
Query parameters
Name Description
dealCategory*
String
The deal category unique identifier
Required
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getDealCategories

Get a list of deal categories.

Lists all available deal categories


/{baseSiteId}/dealCategories

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/dealCategories"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DealSearchApi;

import java.io.File;
import java.util.*;

public class DealSearchApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        DealSearchApi apiInstance = new DealSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            DealCategoryList result = apiInstance.getDealCategories(baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DealSearchApi#getDealCategories");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DealSearchApi;

public class DealSearchApiExample {

    public static void main(String[] args) {
        DealSearchApi apiInstance = new DealSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            DealCategoryList result = apiInstance.getDealCategories(baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DealSearchApi#getDealCategories");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier

DealSearchApi *apiInstance = [[DealSearchApi alloc] init];

// Get a list of deal categories.
[apiInstance getDealCategoriesWith:baseSiteId
              completionHandler: ^(DealCategoryList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.DealSearchApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDealCategories(baseSiteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDealCategoriesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DealSearchApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier

            try
            {
                // Get a list of deal categories.
                DealCategoryList result = apiInstance.getDealCategories(baseSiteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DealSearchApi.getDealCategories: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDealSearchApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier

try {
    $result = $api_instance->getDealCategories($baseSiteId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealSearchApi->getDealCategories: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DealSearchApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DealSearchApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier

eval { 
    my $result = $api_instance->getDealCategories(baseSiteId => $baseSiteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DealSearchApi->getDealCategories: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DealSearchApi()
baseSiteId = baseSiteId_example # String | Base site identifier

try: 
    # Get a list of deal categories.
    api_response = api_instance.get_deal_categories(baseSiteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealSearchApi->getDealCategories: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getDealDetails

Searches for the details of a specific deal

Search for the details for a specific deal including a stay in the given accommodation offering and the list of available transportation options, plus an optional set of additional products


/{baseSiteId}/deals/{dealId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/deals/{dealId}?departureDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DealSearchApi;

import java.io.File;
import java.util.*;

public class DealSearchApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        DealSearchApi apiInstance = new DealSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String dealId = dealId_example; // String | The deal unique identifier
        String departureDate = departureDate_example; // String | The departure date
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        try {
            DealDetailsResponse result = apiInstance.getDealDetails(baseSiteId, dealId, departureDate, sap.cxSalesApplication, acceptLanguage, sap.cxAcceptCurrency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DealSearchApi#getDealDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DealSearchApi;

public class DealSearchApiExample {

    public static void main(String[] args) {
        DealSearchApi apiInstance = new DealSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String dealId = dealId_example; // String | The deal unique identifier
        String departureDate = departureDate_example; // String | The departure date
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        try {
            DealDetailsResponse result = apiInstance.getDealDetails(baseSiteId, dealId, departureDate, sap.cxSalesApplication, acceptLanguage, sap.cxAcceptCurrency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DealSearchApi#getDealDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *dealId = dealId_example; // The deal unique identifier
String *departureDate = departureDate_example; // The departure date
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
String *sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // Requested Currency for the client (optional)

DealSearchApi *apiInstance = [[DealSearchApi alloc] init];

// Searches for the details of a specific deal
[apiInstance getDealDetailsWith:baseSiteId
    dealId:dealId
    departureDate:departureDate
    sap.cxSalesApplication:sap.cxSalesApplication
    acceptLanguage:acceptLanguage
    sap.cxAcceptCurrency:sap.cxAcceptCurrency
              completionHandler: ^(DealDetailsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.DealSearchApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var dealId = dealId_example; // {{String}} The deal unique identifier
var departureDate = departureDate_example; // {{String}} The departure date
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'sap.cxAcceptCurrency': sap.cxAcceptCurrency_example // {{String}} Requested Currency for the client
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDealDetails(baseSiteId, dealId, departureDate, sap.cxSalesApplication, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDealDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DealSearchApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var dealId = dealId_example;  // String | The deal unique identifier
            var departureDate = departureDate_example;  // String | The departure date
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var sap.cxAcceptCurrency = sap.cxAcceptCurrency_example;  // String | Requested Currency for the client (optional) 

            try
            {
                // Searches for the details of a specific deal
                DealDetailsResponse result = apiInstance.getDealDetails(baseSiteId, dealId, departureDate, sap.cxSalesApplication, acceptLanguage, sap.cxAcceptCurrency);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DealSearchApi.getDealDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDealSearchApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$dealId = dealId_example; // String | The deal unique identifier
$departureDate = departureDate_example; // String | The departure date
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client

try {
    $result = $api_instance->getDealDetails($baseSiteId, $dealId, $departureDate, $sap.cxSalesApplication, $acceptLanguage, $sap.cxAcceptCurrency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DealSearchApi->getDealDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DealSearchApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DealSearchApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $dealId = dealId_example; # String | The deal unique identifier
my $departureDate = departureDate_example; # String | The departure date
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; # String | Requested Currency for the client

eval { 
    my $result = $api_instance->getDealDetails(baseSiteId => $baseSiteId, dealId => $dealId, departureDate => $departureDate, sap.cxSalesApplication => $sap.cxSalesApplication, acceptLanguage => $acceptLanguage, sap.cxAcceptCurrency => $sap.cxAcceptCurrency);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DealSearchApi->getDealDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DealSearchApi()
baseSiteId = baseSiteId_example # String | Base site identifier
dealId = dealId_example # String | The deal unique identifier
departureDate = departureDate_example # String | The departure date
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
sap.cxAcceptCurrency = sap.cxAcceptCurrency_example # String | Requested Currency for the client (optional)

try: 
    # Searches for the details of a specific deal
    api_response = api_instance.get_deal_details(baseSiteId, dealId, departureDate, sap.cxSalesApplication, acceptLanguage=acceptLanguage, sap.cxAcceptCurrency=sap.cxAcceptCurrency)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DealSearchApi->getDealDetails: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
dealId*
String
The deal unique identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-accept-currency
String
Requested Currency for the client
sap.cx-sales-application*
String
The sales application code
Required
Query parameters
Name Description
departureDate*
String
The departure date
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


Export

getExportedProducts

Get a list of product exports.

Used for product export. Depending on the timestamp parameter, it can return all products or only products modified after the given time.


/{baseSiteId}/export/products

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/export/products?catalog=¤tPage=&fields=&pageSize=×tamp=&version="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExportApi;

import java.io.File;
import java.util.*;

public class ExportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ExportApi apiInstance = new ExportApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalog = catalog_example; // String | The catalog to retrieve products from. The catalog must be provided along with the version.
        Integer currentPage = 56; // Integer | The current result page requested.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | The number of results returned per page.
        String timestamp = timestamp_example; // String | When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
        String version = version_example; // String | The catalog version. The catalog version must be provided along with the catalog.
        try {
            ProductList result = apiInstance.getExportedProducts(baseSiteId, catalog, currentPage, fields, pageSize, timestamp, version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportApi#getExportedProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExportApi;

public class ExportApiExample {

    public static void main(String[] args) {
        ExportApi apiInstance = new ExportApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalog = catalog_example; // String | The catalog to retrieve products from. The catalog must be provided along with the version.
        Integer currentPage = 56; // Integer | The current result page requested.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | The number of results returned per page.
        String timestamp = timestamp_example; // String | When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
        String version = version_example; // String | The catalog version. The catalog version must be provided along with the catalog.
        try {
            ProductList result = apiInstance.getExportedProducts(baseSiteId, catalog, currentPage, fields, pageSize, timestamp, version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExportApi#getExportedProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *catalog = catalog_example; // The catalog to retrieve products from. The catalog must be provided along with the version. (optional)
Integer *currentPage = 56; // The current result page requested. (optional) (default to 0)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
Integer *pageSize = 56; // The number of results returned per page. (optional) (default to 20)
String *timestamp = timestamp_example; // When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000). (optional)
String *version = version_example; // The catalog version. The catalog version must be provided along with the catalog. (optional)

ExportApi *apiInstance = [[ExportApi alloc] init];

// Get a list of product exports.
[apiInstance getExportedProductsWith:baseSiteId
    catalog:catalog
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    timestamp:timestamp
    version:version
              completionHandler: ^(ProductList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ExportApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'catalog': catalog_example, // {{String}} The catalog to retrieve products from. The catalog must be provided along with the version.
  'currentPage': 56, // {{Integer}} The current result page requested.
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'pageSize': 56, // {{Integer}} The number of results returned per page.
  'timestamp': timestamp_example, // {{String}} When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
  'version': version_example // {{String}} The catalog version. The catalog version must be provided along with the catalog.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExportedProducts(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExportedProductsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ExportApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var catalog = catalog_example;  // String | The catalog to retrieve products from. The catalog must be provided along with the version. (optional) 
            var currentPage = 56;  // Integer | The current result page requested. (optional)  (default to 0)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | The number of results returned per page. (optional)  (default to 20)
            var timestamp = timestamp_example;  // String | When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000). (optional) 
            var version = version_example;  // String | The catalog version. The catalog version must be provided along with the catalog. (optional) 

            try
            {
                // Get a list of product exports.
                ProductList result = apiInstance.getExportedProducts(baseSiteId, catalog, currentPage, fields, pageSize, timestamp, version);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExportApi.getExportedProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiExportApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$catalog = catalog_example; // String | The catalog to retrieve products from. The catalog must be provided along with the version.
$currentPage = 56; // Integer | The current result page requested.
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$pageSize = 56; // Integer | The number of results returned per page.
$timestamp = timestamp_example; // String | When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
$version = version_example; // String | The catalog version. The catalog version must be provided along with the catalog.

try {
    $result = $api_instance->getExportedProducts($baseSiteId, $catalog, $currentPage, $fields, $pageSize, $timestamp, $version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportApi->getExportedProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExportApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ExportApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $catalog = catalog_example; # String | The catalog to retrieve products from. The catalog must be provided along with the version.
my $currentPage = 56; # Integer | The current result page requested.
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $pageSize = 56; # Integer | The number of results returned per page.
my $timestamp = timestamp_example; # String | When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
my $version = version_example; # String | The catalog version. The catalog version must be provided along with the catalog.

eval { 
    my $result = $api_instance->getExportedProducts(baseSiteId => $baseSiteId, catalog => $catalog, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, timestamp => $timestamp, version => $version);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportApi->getExportedProducts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ExportApi()
baseSiteId = baseSiteId_example # String | Base site identifier
catalog = catalog_example # String | The catalog to retrieve products from. The catalog must be provided along with the version. (optional)
currentPage = 56 # Integer | The current result page requested. (optional) (default to 0)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
pageSize = 56 # Integer | The number of results returned per page. (optional) (default to 20)
timestamp = timestamp_example # String | When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000). (optional)
version = version_example # String | The catalog version. The catalog version must be provided along with the catalog. (optional)

try: 
    # Get a list of product exports.
    api_response = api_instance.get_exported_products(baseSiteId, catalog=catalog, currentPage=currentPage, fields=fields, pageSize=pageSize, timestamp=timestamp, version=version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExportApi->getExportedProducts: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
catalog
String
The catalog to retrieve products from. The catalog must be provided along with the version.
currentPage
Integer (int32)
The current result page requested.
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
pageSize
Integer (int32)
The number of results returned per page.
timestamp
String
When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
version
String
The catalog version. The catalog version must be provided along with the catalog.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Feeds

getOrderStatusFeed

Get a list of orders with status updates.

Returns the orders that have changed status. Returns only the elements from the current baseSite that have been updated after the provided timestamp.


/{baseSiteId}/feeds/orders/statusfeed

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/feeds/orders/statusfeed?fields=×tamp="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FeedsApi;

import java.io.File;
import java.util.*;

public class FeedsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        FeedsApi apiInstance = new FeedsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String timestamp = timestamp_example; // String | Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            OrderStatusUpdateElementList result = apiInstance.getOrderStatusFeed(baseSiteId, timestamp, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#getOrderStatusFeed");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FeedsApi;

public class FeedsApiExample {

    public static void main(String[] args) {
        FeedsApi apiInstance = new FeedsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String timestamp = timestamp_example; // String | Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            OrderStatusUpdateElementList result = apiInstance.getOrderStatusFeed(baseSiteId, timestamp, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FeedsApi#getOrderStatusFeed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *timestamp = timestamp_example; // Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

FeedsApi *apiInstance = [[FeedsApi alloc] init];

// Get a list of orders with status updates.
[apiInstance getOrderStatusFeedWith:baseSiteId
    timestamp:timestamp
    fields:fields
              completionHandler: ^(OrderStatusUpdateElementList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.FeedsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var timestamp = timestamp_example; // {{String}} Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderStatusFeed(baseSiteId, timestamp, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrderStatusFeedExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FeedsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var timestamp = timestamp_example;  // String | Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a list of orders with status updates.
                OrderStatusUpdateElementList result = apiInstance.getOrderStatusFeed(baseSiteId, timestamp, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FeedsApi.getOrderStatusFeed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFeedsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$timestamp = timestamp_example; // String | Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getOrderStatusFeed($baseSiteId, $timestamp, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->getOrderStatusFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FeedsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FeedsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $timestamp = timestamp_example; # String | Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getOrderStatusFeed(baseSiteId => $baseSiteId, timestamp => $timestamp, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FeedsApi->getOrderStatusFeed: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FeedsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
timestamp = timestamp_example # String | Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a list of orders with status updates.
    api_response = api_instance.get_order_status_feed(baseSiteId, timestamp, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FeedsApi->getOrderStatusFeed: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
timestamp*
String
Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


ForgottenPasswords

doResetPassword

Reset password after customer's clicked forgotten password link.

Reset password after customer's clicked forgotten password link. A new password needs to be provided.


/{baseSiteId}/resetpassword

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/resetpassword"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ForgottenPasswordsApi;

import java.io.File;
import java.util.*;

public class ForgottenPasswordsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ForgottenPasswordsApi apiInstance = new ForgottenPasswordsApi();
        ResetPassword body = ; // ResetPassword | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            apiInstance.doResetPassword(body, baseSiteId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ForgottenPasswordsApi#doResetPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ForgottenPasswordsApi;

public class ForgottenPasswordsApiExample {

    public static void main(String[] args) {
        ForgottenPasswordsApi apiInstance = new ForgottenPasswordsApi();
        ResetPassword body = ; // ResetPassword | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            apiInstance.doResetPassword(body, baseSiteId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ForgottenPasswordsApi#doResetPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ResetPassword *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier

ForgottenPasswordsApi *apiInstance = [[ForgottenPasswordsApi alloc] init];

// Reset password after customer's clicked forgotten password link.
[apiInstance doResetPasswordWith:body
    baseSiteId:baseSiteId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ForgottenPasswordsApi()
var body = ; // {{ResetPassword}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.doResetPassword(bodybaseSiteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class doResetPasswordExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ForgottenPasswordsApi();
            var body = new ResetPassword(); // ResetPassword | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier

            try
            {
                // Reset password after customer's clicked forgotten password link.
                apiInstance.doResetPassword(body, baseSiteId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ForgottenPasswordsApi.doResetPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiForgottenPasswordsApi();
$body = ; // ResetPassword | 
$baseSiteId = baseSiteId_example; // String | Base site identifier

try {
    $api_instance->doResetPassword($body, $baseSiteId);
} catch (Exception $e) {
    echo 'Exception when calling ForgottenPasswordsApi->doResetPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ForgottenPasswordsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ForgottenPasswordsApi->new();
my $body = WWW::SwaggerClient::Object::ResetPassword->new(); # ResetPassword | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier

eval { 
    $api_instance->doResetPassword(body => $body, baseSiteId => $baseSiteId);
};
if ($@) {
    warn "Exception when calling ForgottenPasswordsApi->doResetPassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ForgottenPasswordsApi()
body =  # ResetPassword | 
baseSiteId = baseSiteId_example # String | Base site identifier

try: 
    # Reset password after customer's clicked forgotten password link.
    api_instance.do_reset_password(body, baseSiteId)
except ApiException as e:
    print("Exception when calling ForgottenPasswordsApi->doResetPassword: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Accepted

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


doRestorePassword

Generates a token to restore a customer's forgotten password.

Generates a token in order to restore a customer's forgotten password.


/{baseSiteId}/forgottenpasswordtokens

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/forgottenpasswordtokens?userId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ForgottenPasswordsApi;

import java.io.File;
import java.util.*;

public class ForgottenPasswordsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ForgottenPasswordsApi apiInstance = new ForgottenPasswordsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | Customer's user id. Customer user id is case insensitive.
        try {
            apiInstance.doRestorePassword(baseSiteId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ForgottenPasswordsApi#doRestorePassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ForgottenPasswordsApi;

public class ForgottenPasswordsApiExample {

    public static void main(String[] args) {
        ForgottenPasswordsApi apiInstance = new ForgottenPasswordsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | Customer's user id. Customer user id is case insensitive.
        try {
            apiInstance.doRestorePassword(baseSiteId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ForgottenPasswordsApi#doRestorePassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // Customer's user id. Customer user id is case insensitive.

ForgottenPasswordsApi *apiInstance = [[ForgottenPasswordsApi alloc] init];

// Generates a token to restore a customer's forgotten password.
[apiInstance doRestorePasswordWith:baseSiteId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ForgottenPasswordsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} Customer's user id. Customer user id is case insensitive.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.doRestorePassword(baseSiteId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class doRestorePasswordExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ForgottenPasswordsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | Customer's user id. Customer user id is case insensitive.

            try
            {
                // Generates a token to restore a customer's forgotten password.
                apiInstance.doRestorePassword(baseSiteId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ForgottenPasswordsApi.doRestorePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiForgottenPasswordsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | Customer's user id. Customer user id is case insensitive.

try {
    $api_instance->doRestorePassword($baseSiteId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling ForgottenPasswordsApi->doRestorePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ForgottenPasswordsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ForgottenPasswordsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | Customer's user id. Customer user id is case insensitive.

eval { 
    $api_instance->doRestorePassword(baseSiteId => $baseSiteId, userId => $userId);
};
if ($@) {
    warn "Exception when calling ForgottenPasswordsApi->doRestorePassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ForgottenPasswordsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | Customer's user id. Customer user id is case insensitive.

try: 
    # Generates a token to restore a customer's forgotten password.
    api_instance.do_restore_password(baseSiteId, userId)
except ApiException as e:
    print("Exception when calling ForgottenPasswordsApi->doRestorePassword: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
userId*
String
Customer's user id. Customer user id is case insensitive.
Required

Responses

Status: 202 - Accepted

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


FutureStocks

getFutureStocks

Gets the future product availability for the specified product.

Returns a list of future product availability of the specified product.


/{baseSiteId}/users/{userId}/futureStocks/{productCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json,application/xml"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/futureStocks/{productCode}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FutureStocksApi;

import java.io.File;
import java.util.*;

public class FutureStocksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        FutureStocksApi apiInstance = new FutureStocksApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            ProductFutureStocks result = apiInstance.getFutureStocks(baseSiteId, productCode, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FutureStocksApi#getFutureStocks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FutureStocksApi;

public class FutureStocksApiExample {

    public static void main(String[] args) {
        FutureStocksApi apiInstance = new FutureStocksApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            ProductFutureStocks result = apiInstance.getFutureStocks(baseSiteId, productCode, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FutureStocksApi#getFutureStocks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *productCode = productCode_example; // Product identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

FutureStocksApi *apiInstance = [[FutureStocksApi alloc] init];

// Gets the future product availability for the specified product.
[apiInstance getFutureStocksWith:baseSiteId
    productCode:productCode
    userId:userId
    fields:fields
              completionHandler: ^(ProductFutureStocks output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.FutureStocksApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var productCode = productCode_example; // {{String}} Product identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFutureStocks(baseSiteId, productCode, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFutureStocksExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FutureStocksApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var productCode = productCode_example;  // String | Product identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Gets the future product availability for the specified product.
                ProductFutureStocks result = apiInstance.getFutureStocks(baseSiteId, productCode, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FutureStocksApi.getFutureStocks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFutureStocksApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$productCode = productCode_example; // String | Product identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getFutureStocks($baseSiteId, $productCode, $userId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FutureStocksApi->getFutureStocks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FutureStocksApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FutureStocksApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $productCode = productCode_example; # String | Product identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getFutureStocks(baseSiteId => $baseSiteId, productCode => $productCode, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FutureStocksApi->getFutureStocks: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FutureStocksApi()
baseSiteId = baseSiteId_example # String | Base site identifier
productCode = productCode_example # String | Product identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Gets the future product availability for the specified product.
    api_response = api_instance.get_future_stocks(baseSiteId, productCode, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FutureStocksApi->getFutureStocks: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
productCode*
String
Product identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getFutureStocksList

Gets the future product availability for the list of specified products.

Returns a list of product codes with a list of future product availability.


/{baseSiteId}/users/{userId}/futureStocks

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json,application/xml"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/futureStocks?fields=&productCodes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FutureStocksApi;

import java.io.File;
import java.util.*;

public class FutureStocksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        FutureStocksApi apiInstance = new FutureStocksApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCodes = productCodes_example; // String | Products identifiers.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            ProductFutureStocksList result = apiInstance.getFutureStocksList(baseSiteId, productCodes, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FutureStocksApi#getFutureStocksList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FutureStocksApi;

public class FutureStocksApiExample {

    public static void main(String[] args) {
        FutureStocksApi apiInstance = new FutureStocksApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCodes = productCodes_example; // String | Products identifiers.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            ProductFutureStocksList result = apiInstance.getFutureStocksList(baseSiteId, productCodes, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FutureStocksApi#getFutureStocksList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *productCodes = productCodes_example; // Products identifiers.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

FutureStocksApi *apiInstance = [[FutureStocksApi alloc] init];

// Gets the future product availability for the list of specified products.
[apiInstance getFutureStocksListWith:baseSiteId
    productCodes:productCodes
    userId:userId
    fields:fields
              completionHandler: ^(ProductFutureStocksList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.FutureStocksApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var productCodes = productCodes_example; // {{String}} Products identifiers.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFutureStocksList(baseSiteId, productCodes, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFutureStocksListExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FutureStocksApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var productCodes = productCodes_example;  // String | Products identifiers.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Gets the future product availability for the list of specified products.
                ProductFutureStocksList result = apiInstance.getFutureStocksList(baseSiteId, productCodes, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FutureStocksApi.getFutureStocksList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFutureStocksApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$productCodes = productCodes_example; // String | Products identifiers.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getFutureStocksList($baseSiteId, $productCodes, $userId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FutureStocksApi->getFutureStocksList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FutureStocksApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FutureStocksApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $productCodes = productCodes_example; # String | Products identifiers.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getFutureStocksList(baseSiteId => $baseSiteId, productCodes => $productCodes, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FutureStocksApi->getFutureStocksList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FutureStocksApi()
baseSiteId = baseSiteId_example # String | Base site identifier
productCodes = productCodes_example # String | Products identifiers.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Gets the future product availability for the list of specified products.
    api_response = api_instance.get_future_stocks_list(baseSiteId, productCodes, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FutureStocksApi->getFutureStocksList: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
productCodes*
String
Products identifiers.
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


LoginNotification

doPublishSuccessfulLoginEvent

Notify about successful login.

Publish notification event about successful login.


/{baseSiteId}/users/{userId}/loginnotification

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/loginnotification"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoginNotificationApi;

import java.io.File;
import java.util.*;

public class LoginNotificationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        LoginNotificationApi apiInstance = new LoginNotificationApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier.
        try {
            apiInstance.doPublishSuccessfulLoginEvent(baseSiteId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginNotificationApi#doPublishSuccessfulLoginEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LoginNotificationApi;

public class LoginNotificationApiExample {

    public static void main(String[] args) {
        LoginNotificationApi apiInstance = new LoginNotificationApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier.
        try {
            apiInstance.doPublishSuccessfulLoginEvent(baseSiteId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginNotificationApi#doPublishSuccessfulLoginEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier.

LoginNotificationApi *apiInstance = [[LoginNotificationApi alloc] init];

// Notify about successful login.
[apiInstance doPublishSuccessfulLoginEventWith:baseSiteId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.LoginNotificationApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.doPublishSuccessfulLoginEvent(baseSiteId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class doPublishSuccessfulLoginEventExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new LoginNotificationApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier.

            try
            {
                // Notify about successful login.
                apiInstance.doPublishSuccessfulLoginEvent(baseSiteId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoginNotificationApi.doPublishSuccessfulLoginEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiLoginNotificationApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier.

try {
    $api_instance->doPublishSuccessfulLoginEvent($baseSiteId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling LoginNotificationApi->doPublishSuccessfulLoginEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LoginNotificationApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::LoginNotificationApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier.

eval { 
    $api_instance->doPublishSuccessfulLoginEvent(baseSiteId => $baseSiteId, userId => $userId);
};
if ($@) {
    warn "Exception when calling LoginNotificationApi->doPublishSuccessfulLoginEvent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.LoginNotificationApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier.

try: 
    # Notify about successful login.
    api_instance.do_publish_successful_login_event(baseSiteId, userId)
except ApiException as e:
    print("Exception when calling LoginNotificationApi->doPublishSuccessfulLoginEvent: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier.
Required

Responses

Status: 202 - Accepted

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Miscs

getCardTypes

Get a list of supported payment card types.

Lists supported payment card types.


/{baseSiteId}/cardtypes

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/cardtypes?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MiscsApi;

import java.io.File;
import java.util.*;

public class MiscsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        MiscsApi apiInstance = new MiscsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CardTypeList result = apiInstance.getCardTypes(baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscsApi#getCardTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MiscsApi;

public class MiscsApiExample {

    public static void main(String[] args) {
        MiscsApi apiInstance = new MiscsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CardTypeList result = apiInstance.getCardTypes(baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscsApi#getCardTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

MiscsApi *apiInstance = [[MiscsApi alloc] init];

// Get a list of supported payment card types.
[apiInstance getCardTypesWith:baseSiteId
    fields:fields
              completionHandler: ^(CardTypeList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.MiscsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCardTypes(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCardTypesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MiscsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a list of supported payment card types.
                CardTypeList result = apiInstance.getCardTypes(baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MiscsApi.getCardTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMiscsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getCardTypes($baseSiteId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiscsApi->getCardTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MiscsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MiscsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getCardTypes(baseSiteId => $baseSiteId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiscsApi->getCardTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MiscsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a list of supported payment card types.
    api_response = api_instance.get_card_types(baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiscsApi->getCardTypes: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getDeliveryCountries

Get a list of shipping countries.

Lists all supported delivery countries for the current store. The list is sorted alphabetically.


/{baseSiteId}/deliverycountries

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/deliverycountries?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MiscsApi;

import java.io.File;
import java.util.*;

public class MiscsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        MiscsApi apiInstance = new MiscsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CountryList result = apiInstance.getDeliveryCountries(baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscsApi#getDeliveryCountries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MiscsApi;

public class MiscsApiExample {

    public static void main(String[] args) {
        MiscsApi apiInstance = new MiscsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            CountryList result = apiInstance.getDeliveryCountries(baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscsApi#getDeliveryCountries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

MiscsApi *apiInstance = [[MiscsApi alloc] init];

// Get a list of shipping countries.
[apiInstance getDeliveryCountriesWith:baseSiteId
    fields:fields
              completionHandler: ^(CountryList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.MiscsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliveryCountries(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDeliveryCountriesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MiscsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a list of shipping countries.
                CountryList result = apiInstance.getDeliveryCountries(baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MiscsApi.getDeliveryCountries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMiscsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getDeliveryCountries($baseSiteId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiscsApi->getDeliveryCountries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MiscsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MiscsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getDeliveryCountries(baseSiteId => $baseSiteId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiscsApi->getDeliveryCountries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MiscsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a list of shipping countries.
    api_response = api_instance.get_delivery_countries(baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiscsApi->getDeliveryCountries: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getTitles

Get a list of all localized titles.

Lists all localized titles.


/{baseSiteId}/titles

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/titles?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MiscsApi;

import java.io.File;
import java.util.*;

public class MiscsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        MiscsApi apiInstance = new MiscsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            TitleList result = apiInstance.getTitles(baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscsApi#getTitles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MiscsApi;

public class MiscsApiExample {

    public static void main(String[] args) {
        MiscsApi apiInstance = new MiscsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            TitleList result = apiInstance.getTitles(baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscsApi#getTitles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

MiscsApi *apiInstance = [[MiscsApi alloc] init];

// Get a list of all localized titles.
[apiInstance getTitlesWith:baseSiteId
    fields:fields
              completionHandler: ^(TitleList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.MiscsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTitles(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTitlesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MiscsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a list of all localized titles.
                TitleList result = apiInstance.getTitles(baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MiscsApi.getTitles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMiscsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getTitles($baseSiteId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiscsApi->getTitles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MiscsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MiscsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getTitles(baseSiteId => $baseSiteId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiscsApi->getTitles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MiscsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a list of all localized titles.
    api_response = api_instance.get_titles(baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiscsApi->getTitles: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Orders

countUserOrders

Get total number of orders.

In the response header, the "x-total-count" indicates the total number of orders placed by a specified user for a specified base store.


/{baseSiteId}/users/{userId}/orders

Usage and SDK Samples

curl -X HEAD\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders?statuses="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        OrdersApi apiInstance = new OrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String statuses = statuses_example; // String | Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID.
        try {
            apiInstance.countUserOrders(baseSiteId, userId, statuses);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#countUserOrders");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrdersApi;

public class OrdersApiExample {

    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String statuses = statuses_example; // String | Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID.
        try {
            apiInstance.countUserOrders(baseSiteId, userId, statuses);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#countUserOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *statuses = statuses_example; // Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID. (optional)

OrdersApi *apiInstance = [[OrdersApi alloc] init];

// Get total number of orders.
[apiInstance countUserOrdersWith:baseSiteId
    userId:userId
    statuses:statuses
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.OrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'statuses': statuses_example // {{String}} Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.countUserOrders(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class countUserOrdersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var statuses = statuses_example;  // String | Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID. (optional) 

            try
            {
                // Get total number of orders.
                apiInstance.countUserOrders(baseSiteId, userId, statuses);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.countUserOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$statuses = statuses_example; // String | Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID.

try {
    $api_instance->countUserOrders($baseSiteId, $userId, $statuses);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->countUserOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $statuses = statuses_example; # String | Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID.

eval { 
    $api_instance->countUserOrders(baseSiteId => $baseSiteId, userId => $userId, statuses => $statuses);
};
if ($@) {
    warn "Exception when calling OrdersApi->countUserOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
statuses = statuses_example # String | Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID. (optional)

try: 
    # Get total number of orders.
    api_instance.count_user_orders(baseSiteId, userId, statuses=statuses)
except ApiException as e:
    print("Exception when calling OrdersApi->countUserOrders: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
statuses
String
Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


doCancelOrder

Cancel an order.

Cancels an order partially or completely


/{baseSiteId}/users/{userId}/orders/{code}/cancellation

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{code}/cancellation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        OrdersApi apiInstance = new OrdersApi();
        CancellationRequestEntryInputList body = ; // CancellationRequestEntryInputList | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Order code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.doCancelOrder(body, baseSiteId, code, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#doCancelOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrdersApi;

public class OrdersApiExample {

    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        CancellationRequestEntryInputList body = ; // CancellationRequestEntryInputList | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Order code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.doCancelOrder(body, baseSiteId, code, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#doCancelOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CancellationRequestEntryInputList *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *code = code_example; // Order code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

OrdersApi *apiInstance = [[OrdersApi alloc] init];

// Cancel an order.
[apiInstance doCancelOrderWith:body
    baseSiteId:baseSiteId
    code:code
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.OrdersApi()
var body = ; // {{CancellationRequestEntryInputList}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var code = code_example; // {{String}} Order code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.doCancelOrder(bodybaseSiteIdcodeuserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class doCancelOrderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var body = new CancellationRequestEntryInputList(); // CancellationRequestEntryInputList | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var code = code_example;  // String | Order code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Cancel an order.
                apiInstance.doCancelOrder(body, baseSiteId, code, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.doCancelOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiOrdersApi();
$body = ; // CancellationRequestEntryInputList | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$code = code_example; // String | Order code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->doCancelOrder($body, $baseSiteId, $code, $userId);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->doCancelOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrdersApi->new();
my $body = WWW::SwaggerClient::Object::CancellationRequestEntryInputList->new(); # CancellationRequestEntryInputList | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $code = code_example; # String | Order code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->doCancelOrder(body => $body, baseSiteId => $baseSiteId, code => $code, userId => $userId);
};
if ($@) {
    warn "Exception when calling OrdersApi->doCancelOrder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrdersApi()
body =  # CancellationRequestEntryInputList | 
baseSiteId = baseSiteId_example # String | Base site identifier
code = code_example # String | Order code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Cancel an order.
    api_instance.do_cancel_order(body, baseSiteId, code, userId)
except ApiException as e:
    print("Exception when calling OrdersApi->doCancelOrder: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
code*
String
Order code
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getOrder1

Get a order.

Returns details of a specific order based on the order GUID (Globally Unique Identifier) or the order CODE. The response contains detailed order information.


/{baseSiteId}/orders/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/orders/{code}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrdersApi;

import java.io.File;
import java.util.*;

public class OrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        OrdersApi apiInstance = new OrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Order GUID (Globally Unique Identifier) or order CODE
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Order result = apiInstance.getOrder1(baseSiteId, code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#getOrder1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrdersApi;

public class OrdersApiExample {

    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Order GUID (Globally Unique Identifier) or order CODE
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Order result = apiInstance.getOrder1(baseSiteId, code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#getOrder1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *code = code_example; // Order GUID (Globally Unique Identifier) or order CODE
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

OrdersApi *apiInstance = [[OrdersApi alloc] init];

// Get a order.
[apiInstance getOrder1With:baseSiteId
    code:code
    fields:fields
              completionHandler: ^(Order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.OrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var code = code_example; // {{String}} Order GUID (Globally Unique Identifier) or order CODE
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrder1(baseSiteId, code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrder1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var code = code_example;  // String | Order GUID (Globally Unique Identifier) or order CODE
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a order.
                Order result = apiInstance.getOrder1(baseSiteId, code, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrdersApi.getOrder1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$code = code_example; // String | Order GUID (Globally Unique Identifier) or order CODE
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getOrder1($baseSiteId, $code, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->getOrder1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::OrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $code = code_example; # String | Order GUID (Globally Unique Identifier) or order CODE
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getOrder1(baseSiteId => $baseSiteId, code => $code, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->getOrder1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.OrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
code = code_example # String | Order GUID (Globally Unique Identifier) or order CODE
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a order.
    api_response = api_instance.get_order1(baseSiteId, code, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->getOrder1: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
code*
String
Order GUID (Globally Unique Identifier) or order CODE
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PackageCartsController

addPackageToCart

Perform the add package to cart.

Adds a package, consisting in a combination of a transportation and room stays for all the specified travellers


/{baseSiteId}/users/{userId}/carts/{cartId}/packages

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/packages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PackageCartsControllerApi;

import java.io.File;
import java.util.*;

public class PackageCartsControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PackageCartsControllerApi apiInstance = new PackageCartsControllerApi();
        AddPackageToCartRequest body = ; // AddPackageToCartRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.addPackageToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageCartsControllerApi#addPackageToCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PackageCartsControllerApi;

public class PackageCartsControllerApiExample {

    public static void main(String[] args) {
        PackageCartsControllerApi apiInstance = new PackageCartsControllerApi();
        AddPackageToCartRequest body = ; // AddPackageToCartRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.addPackageToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageCartsControllerApi#addPackageToCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AddPackageToCartRequest *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

PackageCartsControllerApi *apiInstance = [[PackageCartsControllerApi alloc] init];

// Perform the add package to cart.
[apiInstance addPackageToCartWith:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PackageCartsControllerApi()
var body = ; // {{AddPackageToCartRequest}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addPackageToCart(bodysap.cxSalesApplicationbaseSiteIdcartIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addPackageToCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PackageCartsControllerApi();
            var body = new AddPackageToCartRequest(); // AddPackageToCartRequest | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Perform the add package to cart.
                apiInstance.addPackageToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PackageCartsControllerApi.addPackageToCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPackageCartsControllerApi();
$body = ; // AddPackageToCartRequest | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->addPackageToCart($body, $sap.cxSalesApplication, $baseSiteId, $cartId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling PackageCartsControllerApi->addPackageToCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PackageCartsControllerApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PackageCartsControllerApi->new();
my $body = WWW::SwaggerClient::Object::AddPackageToCartRequest->new(); # AddPackageToCartRequest | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->addPackageToCart(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
};
if ($@) {
    warn "Exception when calling PackageCartsControllerApi->addPackageToCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PackageCartsControllerApi()
body =  # AddPackageToCartRequest | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Perform the add package to cart.
    api_instance.add_package_to_cart(body, sap.cxSalesApplication, baseSiteId, cartId, userId)
except ApiException as e:
    print("Exception when calling PackageCartsControllerApi->addPackageToCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


PackageSearch

getPackageDetails

Searches for the details of a specific package

Search for the details for a specific package including a stay in the given accommodation offering and the list of available transportation options.


/{baseSiteId}/packages/{accommodationOfferingCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/packages/{accommodationOfferingCode}?arrivalLocation=&arrivalLocationType=&cabinPreference=&departureDate=&departureLocation=&departureLocationType=&returnDate=&roomGuestOccupancy=&transportOfferingType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PackageSearchApi;

import java.io.File;
import java.util.*;

public class PackageSearchApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PackageSearchApi apiInstance = new PackageSearchApi();
        String accommodationOfferingCode = accommodationOfferingCode_example; // String | The accommodation offering code
        String arrivalLocation = arrivalLocation_example; // String | The arrival location code
        String arrivalLocationType = arrivalLocationType_example; // String | The arrival location type
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cabinPreference = cabinPreference_example; // String | The cabin Preference
        String departureDate = departureDate_example; // String | The departure date
        String departureLocation = departureLocation_example; // String | The departure location code
        String departureLocationType = departureLocationType_example; // String | The departure location type
        String returnDate = returnDate_example; // String | The return date
        String roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        String transportOfferingType = transportOfferingType_example; // String | The Transport Offering Type
        try {
            PackageDetailsResponse result = apiInstance.getPackageDetails(accommodationOfferingCode, arrivalLocation, arrivalLocationType, baseSiteId, cabinPreference, departureDate, departureLocation, departureLocationType, returnDate, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage, sap.cxAcceptCurrency, transportOfferingType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageSearchApi#getPackageDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PackageSearchApi;

public class PackageSearchApiExample {

    public static void main(String[] args) {
        PackageSearchApi apiInstance = new PackageSearchApi();
        String accommodationOfferingCode = accommodationOfferingCode_example; // String | The accommodation offering code
        String arrivalLocation = arrivalLocation_example; // String | The arrival location code
        String arrivalLocationType = arrivalLocationType_example; // String | The arrival location type
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cabinPreference = cabinPreference_example; // String | The cabin Preference
        String departureDate = departureDate_example; // String | The departure date
        String departureLocation = departureLocation_example; // String | The departure location code
        String departureLocationType = departureLocationType_example; // String | The departure location type
        String returnDate = returnDate_example; // String | The return date
        String roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        String transportOfferingType = transportOfferingType_example; // String | The Transport Offering Type
        try {
            PackageDetailsResponse result = apiInstance.getPackageDetails(accommodationOfferingCode, arrivalLocation, arrivalLocationType, baseSiteId, cabinPreference, departureDate, departureLocation, departureLocationType, returnDate, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage, sap.cxAcceptCurrency, transportOfferingType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageSearchApi#getPackageDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *accommodationOfferingCode = accommodationOfferingCode_example; // The accommodation offering code
String *arrivalLocation = arrivalLocation_example; // The arrival location code
String *arrivalLocationType = arrivalLocationType_example; // The arrival location type
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cabinPreference = cabinPreference_example; // The cabin Preference
String *departureDate = departureDate_example; // The departure date
String *departureLocation = departureLocation_example; // The departure location code
String *departureLocationType = departureLocationType_example; // The departure location type
String *returnDate = returnDate_example; // The return date
String *roomGuestOccupancy = roomGuestOccupancy_example; // The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
String *sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // Requested Currency for the client (optional)
String *transportOfferingType = transportOfferingType_example; // The Transport Offering Type (optional)

PackageSearchApi *apiInstance = [[PackageSearchApi alloc] init];

// Searches for the details of a specific package
[apiInstance getPackageDetailsWith:accommodationOfferingCode
    arrivalLocation:arrivalLocation
    arrivalLocationType:arrivalLocationType
    baseSiteId:baseSiteId
    cabinPreference:cabinPreference
    departureDate:departureDate
    departureLocation:departureLocation
    departureLocationType:departureLocationType
    returnDate:returnDate
    roomGuestOccupancy:roomGuestOccupancy
    sap.cxSalesApplication:sap.cxSalesApplication
    acceptLanguage:acceptLanguage
    sap.cxAcceptCurrency:sap.cxAcceptCurrency
    transportOfferingType:transportOfferingType
              completionHandler: ^(PackageDetailsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PackageSearchApi()
var accommodationOfferingCode = accommodationOfferingCode_example; // {{String}} The accommodation offering code
var arrivalLocation = arrivalLocation_example; // {{String}} The arrival location code
var arrivalLocationType = arrivalLocationType_example; // {{String}} The arrival location type
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cabinPreference = cabinPreference_example; // {{String}} The cabin Preference
var departureDate = departureDate_example; // {{String}} The departure date
var departureLocation = departureLocation_example; // {{String}} The departure location code
var departureLocationType = departureLocationType_example; // {{String}} The departure location type
var returnDate = returnDate_example; // {{String}} The return date
var roomGuestOccupancy = roomGuestOccupancy_example; // {{String}} The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'sap.cxAcceptCurrency': sap.cxAcceptCurrency_example, // {{String}} Requested Currency for the client
  'transportOfferingType': transportOfferingType_example // {{String}} The Transport Offering Type
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPackageDetails(accommodationOfferingCode, arrivalLocation, arrivalLocationType, baseSiteId, cabinPreference, departureDate, departureLocation, departureLocationType, returnDate, roomGuestOccupancy, sap.cxSalesApplication, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPackageDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PackageSearchApi();
            var accommodationOfferingCode = accommodationOfferingCode_example;  // String | The accommodation offering code
            var arrivalLocation = arrivalLocation_example;  // String | The arrival location code
            var arrivalLocationType = arrivalLocationType_example;  // String | The arrival location type
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cabinPreference = cabinPreference_example;  // String | The cabin Preference
            var departureDate = departureDate_example;  // String | The departure date
            var departureLocation = departureLocation_example;  // String | The departure location code
            var departureLocationType = departureLocationType_example;  // String | The departure location type
            var returnDate = returnDate_example;  // String | The return date
            var roomGuestOccupancy = roomGuestOccupancy_example;  // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var sap.cxAcceptCurrency = sap.cxAcceptCurrency_example;  // String | Requested Currency for the client (optional) 
            var transportOfferingType = transportOfferingType_example;  // String | The Transport Offering Type (optional) 

            try
            {
                // Searches for the details of a specific package
                PackageDetailsResponse result = apiInstance.getPackageDetails(accommodationOfferingCode, arrivalLocation, arrivalLocationType, baseSiteId, cabinPreference, departureDate, departureLocation, departureLocationType, returnDate, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage, sap.cxAcceptCurrency, transportOfferingType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PackageSearchApi.getPackageDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPackageSearchApi();
$accommodationOfferingCode = accommodationOfferingCode_example; // String | The accommodation offering code
$arrivalLocation = arrivalLocation_example; // String | The arrival location code
$arrivalLocationType = arrivalLocationType_example; // String | The arrival location type
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cabinPreference = cabinPreference_example; // String | The cabin Preference
$departureDate = departureDate_example; // String | The departure date
$departureLocation = departureLocation_example; // String | The departure location code
$departureLocationType = departureLocationType_example; // String | The departure location type
$returnDate = returnDate_example; // String | The return date
$roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
$transportOfferingType = transportOfferingType_example; // String | The Transport Offering Type

try {
    $result = $api_instance->getPackageDetails($accommodationOfferingCode, $arrivalLocation, $arrivalLocationType, $baseSiteId, $cabinPreference, $departureDate, $departureLocation, $departureLocationType, $returnDate, $roomGuestOccupancy, $sap.cxSalesApplication, $acceptLanguage, $sap.cxAcceptCurrency, $transportOfferingType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PackageSearchApi->getPackageDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PackageSearchApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PackageSearchApi->new();
my $accommodationOfferingCode = accommodationOfferingCode_example; # String | The accommodation offering code
my $arrivalLocation = arrivalLocation_example; # String | The arrival location code
my $arrivalLocationType = arrivalLocationType_example; # String | The arrival location type
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cabinPreference = cabinPreference_example; # String | The cabin Preference
my $departureDate = departureDate_example; # String | The departure date
my $departureLocation = departureLocation_example; # String | The departure location code
my $departureLocationType = departureLocationType_example; # String | The departure location type
my $returnDate = returnDate_example; # String | The return date
my $roomGuestOccupancy = roomGuestOccupancy_example; # String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; # String | Requested Currency for the client
my $transportOfferingType = transportOfferingType_example; # String | The Transport Offering Type

eval { 
    my $result = $api_instance->getPackageDetails(accommodationOfferingCode => $accommodationOfferingCode, arrivalLocation => $arrivalLocation, arrivalLocationType => $arrivalLocationType, baseSiteId => $baseSiteId, cabinPreference => $cabinPreference, departureDate => $departureDate, departureLocation => $departureLocation, departureLocationType => $departureLocationType, returnDate => $returnDate, roomGuestOccupancy => $roomGuestOccupancy, sap.cxSalesApplication => $sap.cxSalesApplication, acceptLanguage => $acceptLanguage, sap.cxAcceptCurrency => $sap.cxAcceptCurrency, transportOfferingType => $transportOfferingType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PackageSearchApi->getPackageDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PackageSearchApi()
accommodationOfferingCode = accommodationOfferingCode_example # String | The accommodation offering code
arrivalLocation = arrivalLocation_example # String | The arrival location code
arrivalLocationType = arrivalLocationType_example # String | The arrival location type
baseSiteId = baseSiteId_example # String | Base site identifier
cabinPreference = cabinPreference_example # String | The cabin Preference
departureDate = departureDate_example # String | The departure date
departureLocation = departureLocation_example # String | The departure location code
departureLocationType = departureLocationType_example # String | The departure location type
returnDate = returnDate_example # String | The return date
roomGuestOccupancy = roomGuestOccupancy_example # String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
sap.cxAcceptCurrency = sap.cxAcceptCurrency_example # String | Requested Currency for the client (optional)
transportOfferingType = transportOfferingType_example # String | The Transport Offering Type (optional)

try: 
    # Searches for the details of a specific package
    api_response = api_instance.get_package_details(accommodationOfferingCode, arrivalLocation, arrivalLocationType, baseSiteId, cabinPreference, departureDate, departureLocation, departureLocationType, returnDate, roomGuestOccupancy, sap.cxSalesApplication, acceptLanguage=acceptLanguage, sap.cxAcceptCurrency=sap.cxAcceptCurrency, transportOfferingType=transportOfferingType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PackageSearchApi->getPackageDetails: %s\n" % e)

Parameters

Path parameters
Name Description
accommodationOfferingCode*
String
The accommodation offering code
Required
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-accept-currency
String
Requested Currency for the client
sap.cx-sales-application*
String
The sales application code
Required
Query parameters
Name Description
arrivalLocation*
String
The arrival location code
Required
arrivalLocationType*
String
The arrival location type
Required
cabinPreference*
String
The cabin Preference
Required
departureDate*
String
The departure date
Required
departureLocation*
String
The departure location code
Required
departureLocationType*
String
The departure location type
Required
returnDate*
String
The return date
Required
roomGuestOccupancy*
String
The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
Required
transportOfferingType
String
The Transport Offering Type

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


searchPackages

Searches for packages fulfilling the search criteria

Searches for packages, where a package is identified by a combination of a transportation and an accommodation stay for all the specified travellers, fulfilling the search criteria.


/{baseSiteId}/packages

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/packages?arrivalLocation=&arrivalLocationType=&cabinPreference=¤tPage=&departureDate=&departureLocation=&departureLocationType=&pageSize=&returnDate=&roomGuestOccupancy=&transportOfferingType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PackageSearchApi;

import java.io.File;
import java.util.*;

public class PackageSearchApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PackageSearchApi apiInstance = new PackageSearchApi();
        String arrivalLocation = arrivalLocation_example; // String | The arrival location code
        String arrivalLocationType = arrivalLocationType_example; // String | The arrival location type
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cabinPreference = cabinPreference_example; // String | The cabin Preference
        String departureDate = departureDate_example; // String | The departure date
        String departureLocation = departureLocation_example; // String | The departure location code
        String departureLocationType = departureLocationType_example; // String | The departure location type
        String returnDate = returnDate_example; // String | The return date
        String roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        Integer currentPage = 56; // Integer | The page number
        Integer pageSize = 56; // Integer | The page size
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        String transportOfferingType = transportOfferingType_example; // String | The Transport Offering Type
        try {
            'String' result = apiInstance.searchPackages(arrivalLocation, arrivalLocationType, baseSiteId, cabinPreference, departureDate, departureLocation, departureLocationType, returnDate, roomGuestOccupancy, sap.cxSalesApplication, userId, acceptLanguage, currentPage, pageSize, sap.cxAcceptCurrency, transportOfferingType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageSearchApi#searchPackages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PackageSearchApi;

public class PackageSearchApiExample {

    public static void main(String[] args) {
        PackageSearchApi apiInstance = new PackageSearchApi();
        String arrivalLocation = arrivalLocation_example; // String | The arrival location code
        String arrivalLocationType = arrivalLocationType_example; // String | The arrival location type
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cabinPreference = cabinPreference_example; // String | The cabin Preference
        String departureDate = departureDate_example; // String | The departure date
        String departureLocation = departureLocation_example; // String | The departure location code
        String departureLocationType = departureLocationType_example; // String | The departure location type
        String returnDate = returnDate_example; // String | The return date
        String roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        Integer currentPage = 56; // Integer | The page number
        Integer pageSize = 56; // Integer | The page size
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        String transportOfferingType = transportOfferingType_example; // String | The Transport Offering Type
        try {
            'String' result = apiInstance.searchPackages(arrivalLocation, arrivalLocationType, baseSiteId, cabinPreference, departureDate, departureLocation, departureLocationType, returnDate, roomGuestOccupancy, sap.cxSalesApplication, userId, acceptLanguage, currentPage, pageSize, sap.cxAcceptCurrency, transportOfferingType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageSearchApi#searchPackages");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *arrivalLocation = arrivalLocation_example; // The arrival location code
String *arrivalLocationType = arrivalLocationType_example; // The arrival location type
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cabinPreference = cabinPreference_example; // The cabin Preference
String *departureDate = departureDate_example; // The departure date
String *departureLocation = departureLocation_example; // The departure location code
String *departureLocationType = departureLocationType_example; // The departure location type
String *returnDate = returnDate_example; // The return date
String *roomGuestOccupancy = roomGuestOccupancy_example; // The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
Integer *currentPage = 56; // The page number (optional) (default to 1)
Integer *pageSize = 56; // The page size (optional) (default to 10)
String *sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // Requested Currency for the client (optional)
String *transportOfferingType = transportOfferingType_example; // The Transport Offering Type (optional)

PackageSearchApi *apiInstance = [[PackageSearchApi alloc] init];

// Searches for packages fulfilling the search criteria
[apiInstance searchPackagesWith:arrivalLocation
    arrivalLocationType:arrivalLocationType
    baseSiteId:baseSiteId
    cabinPreference:cabinPreference
    departureDate:departureDate
    departureLocation:departureLocation
    departureLocationType:departureLocationType
    returnDate:returnDate
    roomGuestOccupancy:roomGuestOccupancy
    sap.cxSalesApplication:sap.cxSalesApplication
    userId:userId
    acceptLanguage:acceptLanguage
    currentPage:currentPage
    pageSize:pageSize
    sap.cxAcceptCurrency:sap.cxAcceptCurrency
    transportOfferingType:transportOfferingType
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PackageSearchApi()
var arrivalLocation = arrivalLocation_example; // {{String}} The arrival location code
var arrivalLocationType = arrivalLocationType_example; // {{String}} The arrival location type
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cabinPreference = cabinPreference_example; // {{String}} The cabin Preference
var departureDate = departureDate_example; // {{String}} The departure date
var departureLocation = departureLocation_example; // {{String}} The departure location code
var departureLocationType = departureLocationType_example; // {{String}} The departure location type
var returnDate = returnDate_example; // {{String}} The return date
var roomGuestOccupancy = roomGuestOccupancy_example; // {{String}} The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'currentPage': 56, // {{Integer}} The page number
  'pageSize': 56, // {{Integer}} The page size
  'sap.cxAcceptCurrency': sap.cxAcceptCurrency_example, // {{String}} Requested Currency for the client
  'transportOfferingType': transportOfferingType_example // {{String}} The Transport Offering Type
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchPackages(arrivalLocation, arrivalLocationType, baseSiteId, cabinPreference, departureDate, departureLocation, departureLocationType, returnDate, roomGuestOccupancy, sap.cxSalesApplication, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchPackagesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PackageSearchApi();
            var arrivalLocation = arrivalLocation_example;  // String | The arrival location code
            var arrivalLocationType = arrivalLocationType_example;  // String | The arrival location type
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cabinPreference = cabinPreference_example;  // String | The cabin Preference
            var departureDate = departureDate_example;  // String | The departure date
            var departureLocation = departureLocation_example;  // String | The departure location code
            var departureLocationType = departureLocationType_example;  // String | The departure location type
            var returnDate = returnDate_example;  // String | The return date
            var roomGuestOccupancy = roomGuestOccupancy_example;  // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var currentPage = 56;  // Integer | The page number (optional)  (default to 1)
            var pageSize = 56;  // Integer | The page size (optional)  (default to 10)
            var sap.cxAcceptCurrency = sap.cxAcceptCurrency_example;  // String | Requested Currency for the client (optional) 
            var transportOfferingType = transportOfferingType_example;  // String | The Transport Offering Type (optional) 

            try
            {
                // Searches for packages fulfilling the search criteria
                'String' result = apiInstance.searchPackages(arrivalLocation, arrivalLocationType, baseSiteId, cabinPreference, departureDate, departureLocation, departureLocationType, returnDate, roomGuestOccupancy, sap.cxSalesApplication, userId, acceptLanguage, currentPage, pageSize, sap.cxAcceptCurrency, transportOfferingType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PackageSearchApi.searchPackages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPackageSearchApi();
$arrivalLocation = arrivalLocation_example; // String | The arrival location code
$arrivalLocationType = arrivalLocationType_example; // String | The arrival location type
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cabinPreference = cabinPreference_example; // String | The cabin Preference
$departureDate = departureDate_example; // String | The departure date
$departureLocation = departureLocation_example; // String | The departure location code
$departureLocationType = departureLocationType_example; // String | The departure location type
$returnDate = returnDate_example; // String | The return date
$roomGuestOccupancy = roomGuestOccupancy_example; // String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$currentPage = 56; // Integer | The page number
$pageSize = 56; // Integer | The page size
$sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
$transportOfferingType = transportOfferingType_example; // String | The Transport Offering Type

try {
    $result = $api_instance->searchPackages($arrivalLocation, $arrivalLocationType, $baseSiteId, $cabinPreference, $departureDate, $departureLocation, $departureLocationType, $returnDate, $roomGuestOccupancy, $sap.cxSalesApplication, $userId, $acceptLanguage, $currentPage, $pageSize, $sap.cxAcceptCurrency, $transportOfferingType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PackageSearchApi->searchPackages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PackageSearchApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PackageSearchApi->new();
my $arrivalLocation = arrivalLocation_example; # String | The arrival location code
my $arrivalLocationType = arrivalLocationType_example; # String | The arrival location type
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cabinPreference = cabinPreference_example; # String | The cabin Preference
my $departureDate = departureDate_example; # String | The departure date
my $departureLocation = departureLocation_example; # String | The departure location code
my $departureLocationType = departureLocationType_example; # String | The departure location type
my $returnDate = returnDate_example; # String | The return date
my $roomGuestOccupancy = roomGuestOccupancy_example; # String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $currentPage = 56; # Integer | The page number
my $pageSize = 56; # Integer | The page size
my $sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; # String | Requested Currency for the client
my $transportOfferingType = transportOfferingType_example; # String | The Transport Offering Type

eval { 
    my $result = $api_instance->searchPackages(arrivalLocation => $arrivalLocation, arrivalLocationType => $arrivalLocationType, baseSiteId => $baseSiteId, cabinPreference => $cabinPreference, departureDate => $departureDate, departureLocation => $departureLocation, departureLocationType => $departureLocationType, returnDate => $returnDate, roomGuestOccupancy => $roomGuestOccupancy, sap.cxSalesApplication => $sap.cxSalesApplication, userId => $userId, acceptLanguage => $acceptLanguage, currentPage => $currentPage, pageSize => $pageSize, sap.cxAcceptCurrency => $sap.cxAcceptCurrency, transportOfferingType => $transportOfferingType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PackageSearchApi->searchPackages: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PackageSearchApi()
arrivalLocation = arrivalLocation_example # String | The arrival location code
arrivalLocationType = arrivalLocationType_example # String | The arrival location type
baseSiteId = baseSiteId_example # String | Base site identifier
cabinPreference = cabinPreference_example # String | The cabin Preference
departureDate = departureDate_example # String | The departure date
departureLocation = departureLocation_example # String | The departure location code
departureLocationType = departureLocationType_example # String | The departure location type
returnDate = returnDate_example # String | The return date
roomGuestOccupancy = roomGuestOccupancy_example # String | The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
currentPage = 56 # Integer | The page number (optional) (default to 1)
pageSize = 56 # Integer | The page size (optional) (default to 10)
sap.cxAcceptCurrency = sap.cxAcceptCurrency_example # String | Requested Currency for the client (optional)
transportOfferingType = transportOfferingType_example # String | The Transport Offering Type (optional)

try: 
    # Searches for packages fulfilling the search criteria
    api_response = api_instance.search_packages(arrivalLocation, arrivalLocationType, baseSiteId, cabinPreference, departureDate, departureLocation, departureLocationType, returnDate, roomGuestOccupancy, sap.cxSalesApplication, userId, acceptLanguage=acceptLanguage, currentPage=currentPage, pageSize=pageSize, sap.cxAcceptCurrency=sap.cxAcceptCurrency, transportOfferingType=transportOfferingType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PackageSearchApi->searchPackages: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-accept-currency
String
Requested Currency for the client
sap.cx-sales-application*
String
The sales application code
Required
Query parameters
Name Description
arrivalLocation*
String
The arrival location code
Required
arrivalLocationType*
String
The arrival location type
Required
cabinPreference*
String
The cabin Preference
Required
currentPage
Integer (int32)
The page number
departureDate*
String
The departure date
Required
departureLocation*
String
The departure location code
Required
departureLocationType*
String
The departure location type
Required
pageSize
Integer (int32)
The page size
returnDate*
String
The return date
Required
roomGuestOccupancy*
String
The guest occupancy per room, with occupancy per type of guest comma separated and in the form -. For example, 2-adult:1-child:1-infant
Required
transportOfferingType
String
The Transport Offering Type

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


PaymentDetails

getPaymentDetails

Get customer's credit card payment details.

Returns a customer's credit card payment details for the specified paymentDetailsId.


/{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            PaymentDetails result = apiInstance.getPaymentDetails(baseSiteId, paymentDetailsId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getPaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            PaymentDetails result = apiInstance.getPaymentDetails(baseSiteId, paymentDetailsId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *paymentDetailsId = paymentDetailsId_example; // Payment details identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get customer's credit card payment details.
[apiInstance getPaymentDetailsWith:baseSiteId
    paymentDetailsId:paymentDetailsId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^(PaymentDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PaymentDetailsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var paymentDetailsId = paymentDetailsId_example; // {{String}} Payment details identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPaymentDetails(baseSiteId, paymentDetailsId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var paymentDetailsId = paymentDetailsId_example;  // String | Payment details identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get customer's credit card payment details.
                PaymentDetails result = apiInstance.getPaymentDetails(baseSiteId, paymentDetailsId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getPaymentDetails($baseSiteId, $paymentDetailsId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $paymentDetailsId = paymentDetailsId_example; # String | Payment details identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getPaymentDetails(baseSiteId => $baseSiteId, paymentDetailsId => $paymentDetailsId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
paymentDetailsId = paymentDetailsId_example # String | Payment details identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get customer's credit card payment details.
    api_response = api_instance.get_payment_details(baseSiteId, paymentDetailsId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
paymentDetailsId*
String
Payment details identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


getPaymentDetailsList

Get customer's credit card payment details list.

Return customer's credit card payment details list.


/{baseSiteId}/users/{userId}/paymentdetails

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/paymentdetails"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            PaymentDetailsList result = apiInstance.getPaymentDetailsList(baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getPaymentDetailsList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            PaymentDetailsList result = apiInstance.getPaymentDetailsList(baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getPaymentDetailsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get customer's credit card payment details list.
[apiInstance getPaymentDetailsListWith:baseSiteId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^(PaymentDetailsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PaymentDetailsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPaymentDetailsList(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPaymentDetailsListExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get customer's credit card payment details list.
                PaymentDetailsList result = apiInstance.getPaymentDetailsList(baseSiteId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getPaymentDetailsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getPaymentDetailsList($baseSiteId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getPaymentDetailsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getPaymentDetailsList(baseSiteId => $baseSiteId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getPaymentDetailsList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get customer's credit card payment details list.
    api_response = api_instance.get_payment_details_list(baseSiteId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getPaymentDetailsList: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


removePaymentDetails

Deletes customer's credit card payment details.

Deletes a customer's credit card payment details based on a specified paymentDetailsId.


/{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removePaymentDetails(baseSiteId, paymentDetailsId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#removePaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removePaymentDetails(baseSiteId, paymentDetailsId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#removePaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *paymentDetailsId = paymentDetailsId_example; // Payment details identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Deletes customer's credit card payment details.
[apiInstance removePaymentDetailsWith:baseSiteId
    paymentDetailsId:paymentDetailsId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PaymentDetailsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var paymentDetailsId = paymentDetailsId_example; // {{String}} Payment details identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removePaymentDetails(baseSiteId, paymentDetailsId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removePaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var paymentDetailsId = paymentDetailsId_example;  // String | Payment details identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Deletes customer's credit card payment details.
                'String' result = apiInstance.removePaymentDetails(baseSiteId, paymentDetailsId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.removePaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->removePaymentDetails($baseSiteId, $paymentDetailsId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->removePaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $paymentDetailsId = paymentDetailsId_example; # String | Payment details identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->removePaymentDetails(baseSiteId => $baseSiteId, paymentDetailsId => $paymentDetailsId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->removePaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
paymentDetailsId = paymentDetailsId_example # String | Payment details identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Deletes customer's credit card payment details.
    api_response = api_instance.remove_payment_details(baseSiteId, paymentDetailsId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->removePaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
paymentDetailsId*
String
Payment details identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


replacePaymentDetails

Updates existing customer's credit card payment info.

Updates existing customer's credit card payment info based on the payment info ID. Attributes not given in request will be defined again (set to null or default).


/{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        PaymentDetails body = ; // PaymentDetails | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.replacePaymentDetails(body, baseSiteId, paymentDetailsId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#replacePaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        PaymentDetails body = ; // PaymentDetails | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.replacePaymentDetails(body, baseSiteId, paymentDetailsId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#replacePaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PaymentDetails *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *paymentDetailsId = paymentDetailsId_example; // Payment details identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Updates existing customer's credit card payment info.
[apiInstance replacePaymentDetailsWith:body
    baseSiteId:baseSiteId
    paymentDetailsId:paymentDetailsId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PaymentDetailsApi()
var body = ; // {{PaymentDetails}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var paymentDetailsId = paymentDetailsId_example; // {{String}} Payment details identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.replacePaymentDetails(bodybaseSiteIdpaymentDetailsIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class replacePaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var body = new PaymentDetails(); // PaymentDetails | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var paymentDetailsId = paymentDetailsId_example;  // String | Payment details identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Updates existing customer's credit card payment info.
                'String' result = apiInstance.replacePaymentDetails(body, baseSiteId, paymentDetailsId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.replacePaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$body = ; // PaymentDetails | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->replacePaymentDetails($body, $baseSiteId, $paymentDetailsId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->replacePaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $body = WWW::SwaggerClient::Object::PaymentDetails->new(); # PaymentDetails | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $paymentDetailsId = paymentDetailsId_example; # String | Payment details identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->replacePaymentDetails(body => $body, baseSiteId => $baseSiteId, paymentDetailsId => $paymentDetailsId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->replacePaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
body =  # PaymentDetails | 
baseSiteId = baseSiteId_example # String | Base site identifier
paymentDetailsId = paymentDetailsId_example # String | Payment details identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Updates existing customer's credit card payment info.
    api_response = api_instance.replace_payment_details(body, baseSiteId, paymentDetailsId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->replacePaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
paymentDetailsId*
String
Payment details identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


updatePaymentDetails

Updates existing customer's credit card payment details.

Updates an existing customer's credit card payment details based on the specified paymentDetailsId. Only those attributes provided in the request will be updated.


/{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        PaymentDetails body = ; // PaymentDetails | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.updatePaymentDetails(body, baseSiteId, paymentDetailsId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#updatePaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        PaymentDetails body = ; // PaymentDetails | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.updatePaymentDetails(body, baseSiteId, paymentDetailsId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#updatePaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PaymentDetails *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *paymentDetailsId = paymentDetailsId_example; // Payment details identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Updates existing customer's credit card payment details.
[apiInstance updatePaymentDetailsWith:body
    baseSiteId:baseSiteId
    paymentDetailsId:paymentDetailsId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PaymentDetailsApi()
var body = ; // {{PaymentDetails}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var paymentDetailsId = paymentDetailsId_example; // {{String}} Payment details identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePaymentDetails(bodybaseSiteIdpaymentDetailsIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updatePaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var body = new PaymentDetails(); // PaymentDetails | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var paymentDetailsId = paymentDetailsId_example;  // String | Payment details identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Updates existing customer's credit card payment details.
                'String' result = apiInstance.updatePaymentDetails(body, baseSiteId, paymentDetailsId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.updatePaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$body = ; // PaymentDetails | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->updatePaymentDetails($body, $baseSiteId, $paymentDetailsId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->updatePaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $body = WWW::SwaggerClient::Object::PaymentDetails->new(); # PaymentDetails | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $paymentDetailsId = paymentDetailsId_example; # String | Payment details identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->updatePaymentDetails(body => $body, baseSiteId => $baseSiteId, paymentDetailsId => $paymentDetailsId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->updatePaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
body =  # PaymentDetails | 
baseSiteId = baseSiteId_example # String | Base site identifier
paymentDetailsId = paymentDetailsId_example # String | Payment details identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Updates existing customer's credit card payment details.
    api_response = api_instance.update_payment_details(body, baseSiteId, paymentDetailsId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->updatePaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
paymentDetailsId*
String
Payment details identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


PaymentModes

getPaymentModes

Gets all available payment modes.

Gets all payment modes defined for the base store.


/{baseSiteId}/paymentmodes

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/paymentmodes?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentModesApi;

import java.io.File;
import java.util.*;

public class PaymentModesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PaymentModesApi apiInstance = new PaymentModesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PaymentModeList result = apiInstance.getPaymentModes(baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentModesApi#getPaymentModes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentModesApi;

public class PaymentModesApiExample {

    public static void main(String[] args) {
        PaymentModesApi apiInstance = new PaymentModesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PaymentModeList result = apiInstance.getPaymentModes(baseSiteId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentModesApi#getPaymentModes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

PaymentModesApi *apiInstance = [[PaymentModesApi alloc] init];

// Gets all available payment modes.
[apiInstance getPaymentModesWith:baseSiteId
    fields:fields
              completionHandler: ^(PaymentModeList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PaymentModesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPaymentModes(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPaymentModesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentModesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Gets all available payment modes.
                PaymentModeList result = apiInstance.getPaymentModes(baseSiteId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentModesApi.getPaymentModes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentModesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getPaymentModes($baseSiteId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentModesApi->getPaymentModes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentModesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentModesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getPaymentModes(baseSiteId => $baseSiteId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentModesApi->getPaymentModes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentModesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Gets all available payment modes.
    api_response = api_instance.get_payment_modes(baseSiteId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentModesApi->getPaymentModes: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Products

countProductStockByLocation

Get header with a total number of product's stock levels.

In the response header, the "x-total-count" indicates the total number of a product's stock levels. The following two sets of parameters are available: location (required); or longitude (required), and latitude (required).


/{baseSiteId}/products/{productCode}/stock

Usage and SDK Samples

curl -X HEAD\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/{productCode}/stock?latitude=&location=&longitude="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        Double latitude = 1.2; // Double | Latitude location parameter.
        String location = location_example; // String | Free-text location
        Double longitude = 1.2; // Double | Longitude location parameter.
        try {
            apiInstance.countProductStockByLocation(baseSiteId, productCode, latitude, location, longitude);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#countProductStockByLocation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        Double latitude = 1.2; // Double | Latitude location parameter.
        String location = location_example; // String | Free-text location
        Double longitude = 1.2; // Double | Longitude location parameter.
        try {
            apiInstance.countProductStockByLocation(baseSiteId, productCode, latitude, location, longitude);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#countProductStockByLocation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *productCode = productCode_example; // Product identifier
Double *latitude = 1.2; // Latitude location parameter. (optional)
String *location = location_example; // Free-text location (optional)
Double *longitude = 1.2; // Longitude location parameter. (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get header with a total number of product's stock levels.
[apiInstance countProductStockByLocationWith:baseSiteId
    productCode:productCode
    latitude:latitude
    location:location
    longitude:longitude
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var productCode = productCode_example; // {{String}} Product identifier
var opts = { 
  'latitude': 1.2, // {{Double}} Latitude location parameter.
  'location': location_example, // {{String}} Free-text location
  'longitude': 1.2 // {{Double}} Longitude location parameter.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.countProductStockByLocation(baseSiteId, productCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class countProductStockByLocationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var productCode = productCode_example;  // String | Product identifier
            var latitude = 1.2;  // Double | Latitude location parameter. (optional) 
            var location = location_example;  // String | Free-text location (optional) 
            var longitude = 1.2;  // Double | Longitude location parameter. (optional) 

            try
            {
                // Get header with a total number of product's stock levels.
                apiInstance.countProductStockByLocation(baseSiteId, productCode, latitude, location, longitude);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.countProductStockByLocation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$productCode = productCode_example; // String | Product identifier
$latitude = 1.2; // Double | Latitude location parameter.
$location = location_example; // String | Free-text location
$longitude = 1.2; // Double | Longitude location parameter.

try {
    $api_instance->countProductStockByLocation($baseSiteId, $productCode, $latitude, $location, $longitude);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->countProductStockByLocation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $productCode = productCode_example; # String | Product identifier
my $latitude = 1.2; # Double | Latitude location parameter.
my $location = location_example; # String | Free-text location
my $longitude = 1.2; # Double | Longitude location parameter.

eval { 
    $api_instance->countProductStockByLocation(baseSiteId => $baseSiteId, productCode => $productCode, latitude => $latitude, location => $location, longitude => $longitude);
};
if ($@) {
    warn "Exception when calling ProductsApi->countProductStockByLocation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
productCode = productCode_example # String | Product identifier
latitude = 1.2 # Double | Latitude location parameter. (optional)
location = location_example # String | Free-text location (optional)
longitude = 1.2 # Double | Longitude location parameter. (optional)

try: 
    # Get header with a total number of product's stock levels.
    api_instance.count_product_stock_by_location(baseSiteId, productCode, latitude=latitude, location=location, longitude=longitude)
except ApiException as e:
    print("Exception when calling ProductsApi->countProductStockByLocation: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
productCode*
String
Product identifier
Required
Query parameters
Name Description
latitude
Double (double)
Latitude location parameter.
location
String
Free-text location
longitude
Double (double)
Longitude location parameter.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


countProducts

Get a header with total number of products.

In the response header, the "x-total-count" indicates the total number of products satisfying a query.


/{baseSiteId}/products/search

Usage and SDK Samples

curl -X HEAD\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/search?query="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String query = query_example; // String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2
        try {
            apiInstance.countProducts(baseSiteId, query);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#countProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String query = query_example; // String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2
        try {
            apiInstance.countProducts(baseSiteId, query);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#countProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *query = query_example; // Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get a header with total number of products.
[apiInstance countProductsWith:baseSiteId
    query:query
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'query': query_example // {{String}} Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.countProducts(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class countProductsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var query = query_example;  // String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 (optional) 

            try
            {
                // Get a header with total number of products.
                apiInstance.countProducts(baseSiteId, query);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.countProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$query = query_example; // String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2

try {
    $api_instance->countProducts($baseSiteId, $query);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->countProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $query = query_example; # String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2

eval { 
    $api_instance->countProducts(baseSiteId => $baseSiteId, query => $query);
};
if ($@) {
    warn "Exception when calling ProductsApi->countProducts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
query = query_example # String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 (optional)

try: 
    # Get a header with total number of products.
    api_instance.count_products(baseSiteId, query=query)
except ApiException as e:
    print("Exception when calling ProductsApi->countProducts: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
query
String
Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


createProductReview

Creates a new customer review as an anonymous user.

Creates a new customer review as an anonymous user. Review data needs to be provided.


/{baseSiteId}/products/{productCode}/reviews

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/{productCode}/reviews?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        Review body = ; // Review | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Review result = apiInstance.createProductReview(body, baseSiteId, productCode, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#createProductReview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        Review body = ; // Review | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Review result = apiInstance.createProductReview(body, baseSiteId, productCode, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#createProductReview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Review *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *productCode = productCode_example; // Product identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Creates a new customer review as an anonymous user.
[apiInstance createProductReviewWith:body
    baseSiteId:baseSiteId
    productCode:productCode
    fields:fields
              completionHandler: ^(Review output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var body = ; // {{Review}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var productCode = productCode_example; // {{String}} Product identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProductReview(bodybaseSiteIdproductCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProductReviewExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var body = new Review(); // Review | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var productCode = productCode_example;  // String | Product identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Creates a new customer review as an anonymous user.
                Review result = apiInstance.createProductReview(body, baseSiteId, productCode, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.createProductReview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$body = ; // Review | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$productCode = productCode_example; // String | Product identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->createProductReview($body, $baseSiteId, $productCode, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->createProductReview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $body = WWW::SwaggerClient::Object::Review->new(); # Review | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $productCode = productCode_example; # String | Product identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->createProductReview(body => $body, baseSiteId => $baseSiteId, productCode => $productCode, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->createProductReview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
body =  # Review | 
baseSiteId = baseSiteId_example # String | Base site identifier
productCode = productCode_example # String | Product identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Creates a new customer review as an anonymous user.
    api_response = api_instance.create_product_review(body, baseSiteId, productCode, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->createProductReview: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
productCode*
String
Product identifier
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getExpressUpdateProducts

Get products added to the express update feed.

Returns products added to the express update feed. Returns only elements updated after the provided timestamp. The queue is cleared using a defined cronjob.


/{baseSiteId}/products/expressupdate

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/expressupdate?catalog=&fields=×tamp="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String timestamp = timestamp_example; // String | Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.
        String catalog = catalog_example; // String | Only products from this catalog are returned. Format: catalogId:catalogVersion
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            ProductExpressUpdateElementList result = apiInstance.getExpressUpdateProducts(baseSiteId, timestamp, catalog, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getExpressUpdateProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String timestamp = timestamp_example; // String | Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.
        String catalog = catalog_example; // String | Only products from this catalog are returned. Format: catalogId:catalogVersion
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            ProductExpressUpdateElementList result = apiInstance.getExpressUpdateProducts(baseSiteId, timestamp, catalog, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getExpressUpdateProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *timestamp = timestamp_example; // Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.
String *catalog = catalog_example; // Only products from this catalog are returned. Format: catalogId:catalogVersion (optional)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get products added to the express update feed.
[apiInstance getExpressUpdateProductsWith:baseSiteId
    timestamp:timestamp
    catalog:catalog
    fields:fields
              completionHandler: ^(ProductExpressUpdateElementList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var timestamp = timestamp_example; // {{String}} Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.
var opts = { 
  'catalog': catalog_example, // {{String}} Only products from this catalog are returned. Format: catalogId:catalogVersion
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExpressUpdateProducts(baseSiteId, timestamp, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExpressUpdateProductsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var timestamp = timestamp_example;  // String | Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.
            var catalog = catalog_example;  // String | Only products from this catalog are returned. Format: catalogId:catalogVersion (optional) 
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get products added to the express update feed.
                ProductExpressUpdateElementList result = apiInstance.getExpressUpdateProducts(baseSiteId, timestamp, catalog, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getExpressUpdateProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$timestamp = timestamp_example; // String | Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.
$catalog = catalog_example; // String | Only products from this catalog are returned. Format: catalogId:catalogVersion
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getExpressUpdateProducts($baseSiteId, $timestamp, $catalog, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getExpressUpdateProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $timestamp = timestamp_example; # String | Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.
my $catalog = catalog_example; # String | Only products from this catalog are returned. Format: catalogId:catalogVersion
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getExpressUpdateProducts(baseSiteId => $baseSiteId, timestamp => $timestamp, catalog => $catalog, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getExpressUpdateProducts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
timestamp = timestamp_example # String | Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.
catalog = catalog_example # String | Only products from this catalog are returned. Format: catalogId:catalogVersion (optional)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get products added to the express update feed.
    api_response = api_instance.get_express_update_products(baseSiteId, timestamp, catalog=catalog, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getExpressUpdateProducts: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
catalog
String
Only products from this catalog are returned. Format: catalogId:catalogVersion
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
timestamp*
String
Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getLocationProductStock

Get a product's stock level.

Returns a product's stock levels sorted by distance from the specified location, which is provided using the free-text "location" parameter, or by using the longitude and latitude parameters. The following two sets of parameters are available: location (required), currentPage (optional), pageSize (optional); or longitude (required), latitude (required), currentPage (optional), pageSize(optional).


/{baseSiteId}/products/{productCode}/stock

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/{productCode}/stock?currentPage=&fields=&latitude=&location=&longitude=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        Integer currentPage = 56; // Integer | The current result page requested.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Double latitude = 1.2; // Double | Latitude location parameter.
        String location = location_example; // String | Free-text location
        Double longitude = 1.2; // Double | Longitude location parameter.
        Integer pageSize = 56; // Integer | The number of results returned per page.
        try {
            StoreFinderStockSearchPage result = apiInstance.getLocationProductStock(baseSiteId, productCode, currentPage, fields, latitude, location, longitude, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getLocationProductStock");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        Integer currentPage = 56; // Integer | The current result page requested.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Double latitude = 1.2; // Double | Latitude location parameter.
        String location = location_example; // String | Free-text location
        Double longitude = 1.2; // Double | Longitude location parameter.
        Integer pageSize = 56; // Integer | The number of results returned per page.
        try {
            StoreFinderStockSearchPage result = apiInstance.getLocationProductStock(baseSiteId, productCode, currentPage, fields, latitude, location, longitude, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getLocationProductStock");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *productCode = productCode_example; // Product identifier
Integer *currentPage = 56; // The current result page requested. (optional) (default to 0)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
Double *latitude = 1.2; // Latitude location parameter. (optional)
String *location = location_example; // Free-text location (optional)
Double *longitude = 1.2; // Longitude location parameter. (optional)
Integer *pageSize = 56; // The number of results returned per page. (optional) (default to 20)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get a product's stock level.
[apiInstance getLocationProductStockWith:baseSiteId
    productCode:productCode
    currentPage:currentPage
    fields:fields
    latitude:latitude
    location:location
    longitude:longitude
    pageSize:pageSize
              completionHandler: ^(StoreFinderStockSearchPage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var productCode = productCode_example; // {{String}} Product identifier
var opts = { 
  'currentPage': 56, // {{Integer}} The current result page requested.
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'latitude': 1.2, // {{Double}} Latitude location parameter.
  'location': location_example, // {{String}} Free-text location
  'longitude': 1.2, // {{Double}} Longitude location parameter.
  'pageSize': 56 // {{Integer}} The number of results returned per page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLocationProductStock(baseSiteId, productCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLocationProductStockExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var productCode = productCode_example;  // String | Product identifier
            var currentPage = 56;  // Integer | The current result page requested. (optional)  (default to 0)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var latitude = 1.2;  // Double | Latitude location parameter. (optional) 
            var location = location_example;  // String | Free-text location (optional) 
            var longitude = 1.2;  // Double | Longitude location parameter. (optional) 
            var pageSize = 56;  // Integer | The number of results returned per page. (optional)  (default to 20)

            try
            {
                // Get a product's stock level.
                StoreFinderStockSearchPage result = apiInstance.getLocationProductStock(baseSiteId, productCode, currentPage, fields, latitude, location, longitude, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getLocationProductStock: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$productCode = productCode_example; // String | Product identifier
$currentPage = 56; // Integer | The current result page requested.
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$latitude = 1.2; // Double | Latitude location parameter.
$location = location_example; // String | Free-text location
$longitude = 1.2; // Double | Longitude location parameter.
$pageSize = 56; // Integer | The number of results returned per page.

try {
    $result = $api_instance->getLocationProductStock($baseSiteId, $productCode, $currentPage, $fields, $latitude, $location, $longitude, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getLocationProductStock: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $productCode = productCode_example; # String | Product identifier
my $currentPage = 56; # Integer | The current result page requested.
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $latitude = 1.2; # Double | Latitude location parameter.
my $location = location_example; # String | Free-text location
my $longitude = 1.2; # Double | Longitude location parameter.
my $pageSize = 56; # Integer | The number of results returned per page.

eval { 
    my $result = $api_instance->getLocationProductStock(baseSiteId => $baseSiteId, productCode => $productCode, currentPage => $currentPage, fields => $fields, latitude => $latitude, location => $location, longitude => $longitude, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getLocationProductStock: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
productCode = productCode_example # String | Product identifier
currentPage = 56 # Integer | The current result page requested. (optional) (default to 0)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
latitude = 1.2 # Double | Latitude location parameter. (optional)
location = location_example # String | Free-text location (optional)
longitude = 1.2 # Double | Longitude location parameter. (optional)
pageSize = 56 # Integer | The number of results returned per page. (optional) (default to 20)

try: 
    # Get a product's stock level.
    api_response = api_instance.get_location_product_stock(baseSiteId, productCode, currentPage=currentPage, fields=fields, latitude=latitude, location=location, longitude=longitude, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getLocationProductStock: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
productCode*
String
Product identifier
Required
Query parameters
Name Description
currentPage
Integer (int32)
The current result page requested.
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
latitude
Double (double)
Latitude location parameter.
location
String
Free-text location
longitude
Double (double)
Longitude location parameter.
pageSize
Integer (int32)
The number of results returned per page.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getProduct

Get product details.

Returns details of a single product according to a product code.


/{baseSiteId}/products/{productCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/{productCode}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Product result = apiInstance.getProduct(baseSiteId, productCode, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProduct");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Product result = apiInstance.getProduct(baseSiteId, productCode, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProduct");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *productCode = productCode_example; // Product identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get product details.
[apiInstance getProductWith:baseSiteId
    productCode:productCode
    fields:fields
              completionHandler: ^(Product output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var productCode = productCode_example; // {{String}} Product identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProduct(baseSiteId, productCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var productCode = productCode_example;  // String | Product identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get product details.
                Product result = apiInstance.getProduct(baseSiteId, productCode, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProduct: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$productCode = productCode_example; // String | Product identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getProduct($baseSiteId, $productCode, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProduct: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $productCode = productCode_example; # String | Product identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getProduct(baseSiteId => $baseSiteId, productCode => $productCode, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProduct: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
productCode = productCode_example # String | Product identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get product details.
    api_response = api_instance.get_product(baseSiteId, productCode, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProduct: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
productCode*
String
Product identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getProductReferences

Get a product reference

Returns references for a product with a given product code. Reference type specifies which references to return.


/{baseSiteId}/products/{productCode}/references

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/{productCode}/references?fields=&pageSize=&referenceType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | Maximum size of returned results.
        String referenceType = referenceType_example; // String | Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used.
        try {
            ProductReferenceList result = apiInstance.getProductReferences(baseSiteId, productCode, fields, pageSize, referenceType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductReferences");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | Maximum size of returned results.
        String referenceType = referenceType_example; // String | Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used.
        try {
            ProductReferenceList result = apiInstance.getProductReferences(baseSiteId, productCode, fields, pageSize, referenceType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductReferences");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *productCode = productCode_example; // Product identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
Integer *pageSize = 56; // Maximum size of returned results. (optional) (default to 2147483647)
String *referenceType = referenceType_example; // Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used. (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get a product reference
[apiInstance getProductReferencesWith:baseSiteId
    productCode:productCode
    fields:fields
    pageSize:pageSize
    referenceType:referenceType
              completionHandler: ^(ProductReferenceList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var productCode = productCode_example; // {{String}} Product identifier
var opts = { 
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'pageSize': 56, // {{Integer}} Maximum size of returned results.
  'referenceType': referenceType_example // {{String}} Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductReferences(baseSiteId, productCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductReferencesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var productCode = productCode_example;  // String | Product identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | Maximum size of returned results. (optional)  (default to 2147483647)
            var referenceType = referenceType_example;  // String | Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used. (optional) 

            try
            {
                // Get a product reference
                ProductReferenceList result = apiInstance.getProductReferences(baseSiteId, productCode, fields, pageSize, referenceType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProductReferences: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$productCode = productCode_example; // String | Product identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$pageSize = 56; // Integer | Maximum size of returned results.
$referenceType = referenceType_example; // String | Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used.

try {
    $result = $api_instance->getProductReferences($baseSiteId, $productCode, $fields, $pageSize, $referenceType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProductReferences: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $productCode = productCode_example; # String | Product identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $pageSize = 56; # Integer | Maximum size of returned results.
my $referenceType = referenceType_example; # String | Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used.

eval { 
    my $result = $api_instance->getProductReferences(baseSiteId => $baseSiteId, productCode => $productCode, fields => $fields, pageSize => $pageSize, referenceType => $referenceType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProductReferences: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
productCode = productCode_example # String | Product identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
pageSize = 56 # Integer | Maximum size of returned results. (optional) (default to 2147483647)
referenceType = referenceType_example # String | Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used. (optional)

try: 
    # Get a product reference
    api_response = api_instance.get_product_references(baseSiteId, productCode, fields=fields, pageSize=pageSize, referenceType=referenceType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProductReferences: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
productCode*
String
Product identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
pageSize
Integer (int32)
Maximum size of returned results.
referenceType
String
Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getProductReviews

Get reviews for a product

Returns the reviews for a product with a given product code.


/{baseSiteId}/products/{productCode}/reviews

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/{productCode}/reviews?fields=&maxCount="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer maxCount = 56; // Integer | Maximum count of reviews
        try {
            ReviewList result = apiInstance.getProductReviews(baseSiteId, productCode, fields, maxCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductReviews");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer maxCount = 56; // Integer | Maximum count of reviews
        try {
            ReviewList result = apiInstance.getProductReviews(baseSiteId, productCode, fields, maxCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductReviews");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *productCode = productCode_example; // Product identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
Integer *maxCount = 56; // Maximum count of reviews (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get reviews for a product
[apiInstance getProductReviewsWith:baseSiteId
    productCode:productCode
    fields:fields
    maxCount:maxCount
              completionHandler: ^(ReviewList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var productCode = productCode_example; // {{String}} Product identifier
var opts = { 
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'maxCount': 56 // {{Integer}} Maximum count of reviews
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductReviews(baseSiteId, productCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductReviewsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var productCode = productCode_example;  // String | Product identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var maxCount = 56;  // Integer | Maximum count of reviews (optional) 

            try
            {
                // Get reviews for a product
                ReviewList result = apiInstance.getProductReviews(baseSiteId, productCode, fields, maxCount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProductReviews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$productCode = productCode_example; // String | Product identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$maxCount = 56; // Integer | Maximum count of reviews

try {
    $result = $api_instance->getProductReviews($baseSiteId, $productCode, $fields, $maxCount);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProductReviews: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $productCode = productCode_example; # String | Product identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $maxCount = 56; # Integer | Maximum count of reviews

eval { 
    my $result = $api_instance->getProductReviews(baseSiteId => $baseSiteId, productCode => $productCode, fields => $fields, maxCount => $maxCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProductReviews: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
productCode = productCode_example # String | Product identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
maxCount = 56 # Integer | Maximum count of reviews (optional)

try: 
    # Get reviews for a product
    api_response = api_instance.get_product_reviews(baseSiteId, productCode, fields=fields, maxCount=maxCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProductReviews: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
productCode*
String
Product identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
maxCount
Integer (int32)
Maximum count of reviews

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getProducts

Get a list of products and additional data

Returns a list of products and additional data, such as available facets, available sorting, and pagination options. It can also include spelling suggestions. To make spelling suggestions work, you need to make sure that "enableSpellCheck" on the SearchQuery is set to "true" (by default, it should already be set to "true"). You also need to have indexed properties configured to be used for spellchecking.


/{baseSiteId}/products/search

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/search?currentPage=&fields=&pageSize=&query=&searchQueryContext=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        Integer currentPage = 56; // Integer | The current result page requested.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | The number of results returned per page.
        String query = query_example; // String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2
        String searchQueryContext = searchQueryContext_example; // String | The context to be used in the search query.
        String sort = sort_example; // String | Sorting method applied to the return results.
        try {
            ProductSearchPage result = apiInstance.getProducts(baseSiteId, currentPage, fields, pageSize, query, searchQueryContext, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        Integer currentPage = 56; // Integer | The current result page requested.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | The number of results returned per page.
        String query = query_example; // String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2
        String searchQueryContext = searchQueryContext_example; // String | The context to be used in the search query.
        String sort = sort_example; // String | Sorting method applied to the return results.
        try {
            ProductSearchPage result = apiInstance.getProducts(baseSiteId, currentPage, fields, pageSize, query, searchQueryContext, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
Integer *currentPage = 56; // The current result page requested. (optional) (default to 0)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
Integer *pageSize = 56; // The number of results returned per page. (optional) (default to 20)
String *query = query_example; // Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 (optional)
String *searchQueryContext = searchQueryContext_example; // The context to be used in the search query. (optional)
String *sort = sort_example; // Sorting method applied to the return results. (optional)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get a list of products and additional data
[apiInstance getProductsWith:baseSiteId
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    query:query
    searchQueryContext:searchQueryContext
    sort:sort
              completionHandler: ^(ProductSearchPage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'currentPage': 56, // {{Integer}} The current result page requested.
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'pageSize': 56, // {{Integer}} The number of results returned per page.
  'query': query_example, // {{String}} Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2
  'searchQueryContext': searchQueryContext_example, // {{String}} The context to be used in the search query.
  'sort': sort_example // {{String}} Sorting method applied to the return results.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProducts(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var currentPage = 56;  // Integer | The current result page requested. (optional)  (default to 0)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | The number of results returned per page. (optional)  (default to 20)
            var query = query_example;  // String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 (optional) 
            var searchQueryContext = searchQueryContext_example;  // String | The context to be used in the search query. (optional) 
            var sort = sort_example;  // String | Sorting method applied to the return results. (optional) 

            try
            {
                // Get a list of products and additional data
                ProductSearchPage result = apiInstance.getProducts(baseSiteId, currentPage, fields, pageSize, query, searchQueryContext, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$currentPage = 56; // Integer | The current result page requested.
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$pageSize = 56; // Integer | The number of results returned per page.
$query = query_example; // String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2
$searchQueryContext = searchQueryContext_example; // String | The context to be used in the search query.
$sort = sort_example; // String | Sorting method applied to the return results.

try {
    $result = $api_instance->getProducts($baseSiteId, $currentPage, $fields, $pageSize, $query, $searchQueryContext, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $currentPage = 56; # Integer | The current result page requested.
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $pageSize = 56; # Integer | The number of results returned per page.
my $query = query_example; # String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2
my $searchQueryContext = searchQueryContext_example; # String | The context to be used in the search query.
my $sort = sort_example; # String | Sorting method applied to the return results.

eval { 
    my $result = $api_instance->getProducts(baseSiteId => $baseSiteId, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, query => $query, searchQueryContext => $searchQueryContext, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProducts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
currentPage = 56 # Integer | The current result page requested. (optional) (default to 0)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
pageSize = 56 # Integer | The number of results returned per page. (optional) (default to 20)
query = query_example # String | Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 (optional)
searchQueryContext = searchQueryContext_example # String | The context to be used in the search query. (optional)
sort = sort_example # String | Sorting method applied to the return results. (optional)

try: 
    # Get a list of products and additional data
    api_response = api_instance.get_products(baseSiteId, currentPage=currentPage, fields=fields, pageSize=pageSize, query=query, searchQueryContext=searchQueryContext, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProducts: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
currentPage
Integer (int32)
The current result page requested.
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
pageSize
Integer (int32)
The number of results returned per page.
query
String
Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2
searchQueryContext
String
The context to be used in the search query.
sort
String
Sorting method applied to the return results.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getStoreProductStock

Get a product's stock level for a store

Returns a product's stock level for a particular store (in other words, for a particular point of sale).


/{baseSiteId}/products/{productCode}/stock/{storeName}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/{productCode}/stock/{storeName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String storeName = storeName_example; // String | Store identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Stock result = apiInstance.getStoreProductStock(baseSiteId, productCode, storeName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getStoreProductStock");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String productCode = productCode_example; // String | Product identifier
        String storeName = storeName_example; // String | Store identifier
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Stock result = apiInstance.getStoreProductStock(baseSiteId, productCode, storeName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getStoreProductStock");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *productCode = productCode_example; // Product identifier
String *storeName = storeName_example; // Store identifier
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get a product's stock level for a store
[apiInstance getStoreProductStockWith:baseSiteId
    productCode:productCode
    storeName:storeName
    fields:fields
              completionHandler: ^(Stock output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var productCode = productCode_example; // {{String}} Product identifier
var storeName = storeName_example; // {{String}} Store identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStoreProductStock(baseSiteId, productCode, storeName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStoreProductStockExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var productCode = productCode_example;  // String | Product identifier
            var storeName = storeName_example;  // String | Store identifier
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a product's stock level for a store
                Stock result = apiInstance.getStoreProductStock(baseSiteId, productCode, storeName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getStoreProductStock: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$productCode = productCode_example; // String | Product identifier
$storeName = storeName_example; // String | Store identifier
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getStoreProductStock($baseSiteId, $productCode, $storeName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getStoreProductStock: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $productCode = productCode_example; # String | Product identifier
my $storeName = storeName_example; # String | Store identifier
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getStoreProductStock(baseSiteId => $baseSiteId, productCode => $productCode, storeName => $storeName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getStoreProductStock: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
productCode = productCode_example # String | Product identifier
storeName = storeName_example # String | Store identifier
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a product's stock level for a store
    api_response = api_instance.get_store_product_stock(baseSiteId, productCode, storeName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getStoreProductStock: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
productCode*
String
Product identifier
Required
storeName*
String
Store identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getSuggestions

Get a list of available suggestions

Returns a list of all available suggestions related to a given term and limits the results to a specific value of the max parameter.


/{baseSiteId}/products/suggestions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/products/suggestions?fields=&max=&term="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String term = term_example; // String | Specified term
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer max = 56; // Integer | Specifies the limit of results.
        try {
            SuggestionList result = apiInstance.getSuggestions(baseSiteId, term, fields, max);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getSuggestions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String term = term_example; // String | Specified term
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer max = 56; // Integer | Specifies the limit of results.
        try {
            SuggestionList result = apiInstance.getSuggestions(baseSiteId, term, fields, max);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getSuggestions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *term = term_example; // Specified term
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
Integer *max = 56; // Specifies the limit of results. (optional) (default to 10)

ProductsApi *apiInstance = [[ProductsApi alloc] init];

// Get a list of available suggestions
[apiInstance getSuggestionsWith:baseSiteId
    term:term
    fields:fields
    max:max
              completionHandler: ^(SuggestionList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var term = term_example; // {{String}} Specified term
var opts = { 
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'max': 56 // {{Integer}} Specifies the limit of results.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSuggestions(baseSiteId, term, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSuggestionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var term = term_example;  // String | Specified term
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var max = 56;  // Integer | Specifies the limit of results. (optional)  (default to 10)

            try
            {
                // Get a list of available suggestions
                SuggestionList result = apiInstance.getSuggestions(baseSiteId, term, fields, max);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getSuggestions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$term = term_example; // String | Specified term
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$max = 56; // Integer | Specifies the limit of results.

try {
    $result = $api_instance->getSuggestions($baseSiteId, $term, $fields, $max);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getSuggestions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $term = term_example; # String | Specified term
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $max = 56; # Integer | Specifies the limit of results.

eval { 
    my $result = $api_instance->getSuggestions(baseSiteId => $baseSiteId, term => $term, fields => $fields, max => $max);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getSuggestions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
term = term_example # String | Specified term
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
max = 56 # Integer | Specifies the limit of results. (optional) (default to 10)

try: 
    # Get a list of available suggestions
    api_response = api_instance.get_suggestions(baseSiteId, term, fields=fields, max=max)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getSuggestions: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
max
Integer (int32)
Specifies the limit of results.
term*
String
Specified term
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Promotions

getPromotion

Get a promotion based on code

Returns details of a single promotion specified by a promotion code. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine.


/{baseSiteId}/promotions/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/promotions/{code}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PromotionsApi;

import java.io.File;
import java.util.*;

public class PromotionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PromotionsApi apiInstance = new PromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Promotion identifier (code)
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Promotion result = apiInstance.getPromotion(baseSiteId, code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromotionsApi#getPromotion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PromotionsApi;

public class PromotionsApiExample {

    public static void main(String[] args) {
        PromotionsApi apiInstance = new PromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Promotion identifier (code)
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Promotion result = apiInstance.getPromotion(baseSiteId, code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PromotionsApi#getPromotion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *code = code_example; // Promotion identifier (code)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)

PromotionsApi *apiInstance = [[PromotionsApi alloc] init];

// Get a promotion based on code
[apiInstance getPromotionWith:baseSiteId
    code:code
    fields:fields
              completionHandler: ^(Promotion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PromotionsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var code = code_example; // {{String}} Promotion identifier (code)
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPromotion(baseSiteId, code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPromotionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PromotionsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var code = code_example;  // String | Promotion identifier (code)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to BASIC)

            try
            {
                // Get a promotion based on code
                Promotion result = apiInstance.getPromotion(baseSiteId, code, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PromotionsApi.getPromotion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPromotionsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$code = code_example; // String | Promotion identifier (code)
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getPromotion($baseSiteId, $code, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PromotionsApi->getPromotion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PromotionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PromotionsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $code = code_example; # String | Promotion identifier (code)
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getPromotion(baseSiteId => $baseSiteId, code => $code, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PromotionsApi->getPromotion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PromotionsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
code = code_example # String | Promotion identifier (code)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)

try: 
    # Get a promotion based on code
    api_response = api_instance.get_promotion(baseSiteId, code, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PromotionsApi->getPromotion: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
code*
String
Promotion identifier (code)
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getPromotions

Get a list of promotions.

Returns promotions defined for a current base site. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine.


/{baseSiteId}/promotions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/promotions?fields=&promotionGroup=&type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PromotionsApi;

import java.io.File;
import java.util.*;

public class PromotionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PromotionsApi apiInstance = new PromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String type = type_example; // String | Defines what type of promotions should be returned. Values supported for that parameter are: 
  • all: All available promotions are returned
  • product: Only product promotions are returned
  • order: Only order promotions are returned
String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL String promotionGroup = promotionGroup_example; // String | Only promotions from this group are returned try { PromotionList result = apiInstance.getPromotions(baseSiteId, type, fields, promotionGroup); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling PromotionsApi#getPromotions"); e.printStackTrace(); } } }
import io.swagger.client.api.PromotionsApi;

public class PromotionsApiExample {

    public static void main(String[] args) {
        PromotionsApi apiInstance = new PromotionsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String type = type_example; // String | Defines what type of promotions should be returned. Values supported for that parameter are: 
  • all: All available promotions are returned
  • product: Only product promotions are returned
  • order: Only order promotions are returned
String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL String promotionGroup = promotionGroup_example; // String | Only promotions from this group are returned try { PromotionList result = apiInstance.getPromotions(baseSiteId, type, fields, promotionGroup); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling PromotionsApi#getPromotions"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *type = type_example; // Defines what type of promotions should be returned. Values supported for that parameter are: 
  • all: All available promotions are returned
  • product: Only product promotions are returned
  • order: Only order promotions are returned
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC) String *promotionGroup = promotionGroup_example; // Only promotions from this group are returned (optional) PromotionsApi *apiInstance = [[PromotionsApi alloc] init]; // Get a list of promotions. [apiInstance getPromotionsWith:baseSiteId type:type fields:fields promotionGroup:promotionGroup completionHandler: ^(PromotionList output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.PromotionsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var type = type_example; // {{String}} Defines what type of promotions should be returned. Values supported for that parameter are: 
  • all: All available promotions are returned
  • product: Only product promotions are returned
  • order: Only order promotions are returned
var opts = { 'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL 'promotionGroup': promotionGroup_example // {{String}} Only promotions from this group are returned }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getPromotions(baseSiteId, type, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPromotionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PromotionsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var type = type_example;  // String | Defines what type of promotions should be returned. Values supported for that parameter are: 
  • all: All available promotions are returned
  • product: Only product promotions are returned
  • order: Only order promotions are returned
var fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC) var promotionGroup = promotionGroup_example; // String | Only promotions from this group are returned (optional) try { // Get a list of promotions. PromotionList result = apiInstance.getPromotions(baseSiteId, type, fields, promotionGroup); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling PromotionsApi.getPromotions: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPromotionsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$type = type_example; // String | Defines what type of promotions should be returned. Values supported for that parameter are: 
  • all: All available promotions are returned
  • product: Only product promotions are returned
  • order: Only order promotions are returned
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL $promotionGroup = promotionGroup_example; // String | Only promotions from this group are returned try { $result = $api_instance->getPromotions($baseSiteId, $type, $fields, $promotionGroup); print_r($result); } catch (Exception $e) { echo 'Exception when calling PromotionsApi->getPromotions: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PromotionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PromotionsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $type = type_example; # String | Defines what type of promotions should be returned. Values supported for that parameter are: 
  • all: All available promotions are returned
  • product: Only product promotions are returned
  • order: Only order promotions are returned
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL my $promotionGroup = promotionGroup_example; # String | Only promotions from this group are returned eval { my $result = $api_instance->getPromotions(baseSiteId => $baseSiteId, type => $type, fields => $fields, promotionGroup => $promotionGroup); print Dumper($result); }; if ($@) { warn "Exception when calling PromotionsApi->getPromotions: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PromotionsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
type = type_example # String | Defines what type of promotions should be returned. Values supported for that parameter are: 
  • all: All available promotions are returned
  • product: Only product promotions are returned
  • order: Only order promotions are returned
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC) promotionGroup = promotionGroup_example # String | Only promotions from this group are returned (optional) try: # Get a list of promotions. api_response = api_instance.get_promotions(baseSiteId, type, fields=fields, promotionGroup=promotionGroup) pprint(api_response) except ApiException as e: print("Exception when calling PromotionsApi->getPromotions: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
promotionGroup
String
Only promotions from this group are returned
type*
String
Defines what type of promotions should be returned. Values supported for that parameter are: <ul><li>all: All available promotions are returned</li><li>product: Only product promotions are returned</li><li>order: Only order promotions are returned</li></ul>
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


ReturnRequests

createReturnRequest

Create an order return request.

Creates an order return request.


/{baseSiteId}/users/{userId}/orderReturns

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orderReturns?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReturnRequestsApi;

import java.io.File;
import java.util.*;

public class ReturnRequestsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ReturnRequestsApi apiInstance = new ReturnRequestsApi();
        ReturnRequestEntryInputList body = ; // ReturnRequestEntryInputList | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            ReturnRequest result = apiInstance.createReturnRequest(body, baseSiteId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnRequestsApi#createReturnRequest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReturnRequestsApi;

public class ReturnRequestsApiExample {

    public static void main(String[] args) {
        ReturnRequestsApi apiInstance = new ReturnRequestsApi();
        ReturnRequestEntryInputList body = ; // ReturnRequestEntryInputList | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            ReturnRequest result = apiInstance.createReturnRequest(body, baseSiteId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnRequestsApi#createReturnRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ReturnRequestEntryInputList *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

ReturnRequestsApi *apiInstance = [[ReturnRequestsApi alloc] init];

// Create an order return request.
[apiInstance createReturnRequestWith:body
    baseSiteId:baseSiteId
    userId:userId
    fields:fields
              completionHandler: ^(ReturnRequest output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ReturnRequestsApi()
var body = ; // {{ReturnRequestEntryInputList}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createReturnRequest(bodybaseSiteIduserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createReturnRequestExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReturnRequestsApi();
            var body = new ReturnRequestEntryInputList(); // ReturnRequestEntryInputList | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Create an order return request.
                ReturnRequest result = apiInstance.createReturnRequest(body, baseSiteId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReturnRequestsApi.createReturnRequest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReturnRequestsApi();
$body = ; // ReturnRequestEntryInputList | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->createReturnRequest($body, $baseSiteId, $userId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnRequestsApi->createReturnRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReturnRequestsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReturnRequestsApi->new();
my $body = WWW::SwaggerClient::Object::ReturnRequestEntryInputList->new(); # ReturnRequestEntryInputList | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->createReturnRequest(body => $body, baseSiteId => $baseSiteId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReturnRequestsApi->createReturnRequest: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReturnRequestsApi()
body =  # ReturnRequestEntryInputList | 
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Create an order return request.
    api_response = api_instance.create_return_request(body, baseSiteId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReturnRequestsApi->createReturnRequest: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getReturnRequest

Get the details of a return request.

Returns specific order return request details based on a specific return request code. The response contains detailed order return request information.


/{baseSiteId}/users/{userId}/orderReturns/{returnRequestCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json,application/xml"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orderReturns/{returnRequestCode}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReturnRequestsApi;

import java.io.File;
import java.util.*;

public class ReturnRequestsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ReturnRequestsApi apiInstance = new ReturnRequestsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String returnRequestCode = returnRequestCode_example; // String | Order return request code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            ReturnRequest result = apiInstance.getReturnRequest(baseSiteId, returnRequestCode, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnRequestsApi#getReturnRequest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReturnRequestsApi;

public class ReturnRequestsApiExample {

    public static void main(String[] args) {
        ReturnRequestsApi apiInstance = new ReturnRequestsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String returnRequestCode = returnRequestCode_example; // String | Order return request code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            ReturnRequest result = apiInstance.getReturnRequest(baseSiteId, returnRequestCode, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnRequestsApi#getReturnRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *returnRequestCode = returnRequestCode_example; // Order return request code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

ReturnRequestsApi *apiInstance = [[ReturnRequestsApi alloc] init];

// Get the details of a return request.
[apiInstance getReturnRequestWith:baseSiteId
    returnRequestCode:returnRequestCode
    userId:userId
    fields:fields
              completionHandler: ^(ReturnRequest output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ReturnRequestsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var returnRequestCode = returnRequestCode_example; // {{String}} Order return request code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnRequest(baseSiteId, returnRequestCode, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getReturnRequestExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReturnRequestsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var returnRequestCode = returnRequestCode_example;  // String | Order return request code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get the details of a return request.
                ReturnRequest result = apiInstance.getReturnRequest(baseSiteId, returnRequestCode, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReturnRequestsApi.getReturnRequest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReturnRequestsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$returnRequestCode = returnRequestCode_example; // String | Order return request code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getReturnRequest($baseSiteId, $returnRequestCode, $userId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnRequestsApi->getReturnRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReturnRequestsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReturnRequestsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $returnRequestCode = returnRequestCode_example; # String | Order return request code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getReturnRequest(baseSiteId => $baseSiteId, returnRequestCode => $returnRequestCode, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReturnRequestsApi->getReturnRequest: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReturnRequestsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
returnRequestCode = returnRequestCode_example # String | Order return request code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get the details of a return request.
    api_response = api_instance.get_return_request(baseSiteId, returnRequestCode, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReturnRequestsApi->getReturnRequest: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
returnRequestCode*
String
Order return request code
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getReturnRequests

Gets the user's return requests history

Returns order return request data associated with a specified user for a specified base store.


/{baseSiteId}/users/{userId}/orderReturns

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json,application/xml"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orderReturns?currentPage=&fields=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReturnRequestsApi;

import java.io.File;
import java.util.*;

public class ReturnRequestsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ReturnRequestsApi apiInstance = new ReturnRequestsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        Integer currentPage = 56; // Integer | The current result page requested.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | The number of results returned per page.
        String sort = sort_example; // String | Sorting method applied to the return results.
        try {
            ReturnRequestList result = apiInstance.getReturnRequests(baseSiteId, userId, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnRequestsApi#getReturnRequests");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReturnRequestsApi;

public class ReturnRequestsApiExample {

    public static void main(String[] args) {
        ReturnRequestsApi apiInstance = new ReturnRequestsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        Integer currentPage = 56; // Integer | The current result page requested.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | The number of results returned per page.
        String sort = sort_example; // String | Sorting method applied to the return results.
        try {
            ReturnRequestList result = apiInstance.getReturnRequests(baseSiteId, userId, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnRequestsApi#getReturnRequests");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Integer *currentPage = 56; // The current result page requested. (optional) (default to 0)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
Integer *pageSize = 56; // The number of results returned per page. (optional) (default to 20)
String *sort = sort_example; // Sorting method applied to the return results. (optional)

ReturnRequestsApi *apiInstance = [[ReturnRequestsApi alloc] init];

// Gets the user's return requests history
[apiInstance getReturnRequestsWith:baseSiteId
    userId:userId
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    sort:sort
              completionHandler: ^(ReturnRequestList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ReturnRequestsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'currentPage': 56, // {{Integer}} The current result page requested.
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'pageSize': 56, // {{Integer}} The number of results returned per page.
  'sort': sort_example // {{String}} Sorting method applied to the return results.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReturnRequests(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getReturnRequestsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReturnRequestsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var currentPage = 56;  // Integer | The current result page requested. (optional)  (default to 0)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | The number of results returned per page. (optional)  (default to 20)
            var sort = sort_example;  // String | Sorting method applied to the return results. (optional) 

            try
            {
                // Gets the user's return requests history
                ReturnRequestList result = apiInstance.getReturnRequests(baseSiteId, userId, currentPage, fields, pageSize, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReturnRequestsApi.getReturnRequests: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReturnRequestsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$currentPage = 56; // Integer | The current result page requested.
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$pageSize = 56; // Integer | The number of results returned per page.
$sort = sort_example; // String | Sorting method applied to the return results.

try {
    $result = $api_instance->getReturnRequests($baseSiteId, $userId, $currentPage, $fields, $pageSize, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReturnRequestsApi->getReturnRequests: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReturnRequestsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReturnRequestsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $currentPage = 56; # Integer | The current result page requested.
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $pageSize = 56; # Integer | The number of results returned per page.
my $sort = sort_example; # String | Sorting method applied to the return results.

eval { 
    my $result = $api_instance->getReturnRequests(baseSiteId => $baseSiteId, userId => $userId, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReturnRequestsApi->getReturnRequests: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReturnRequestsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
currentPage = 56 # Integer | The current result page requested. (optional) (default to 0)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
pageSize = 56 # Integer | The number of results returned per page. (optional) (default to 20)
sort = sort_example # String | Sorting method applied to the return results. (optional)

try: 
    # Gets the user's return requests history
    api_response = api_instance.get_return_requests(baseSiteId, userId, currentPage=currentPage, fields=fields, pageSize=pageSize, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReturnRequestsApi->getReturnRequests: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
currentPage
Integer (int32)
The current result page requested.
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
pageSize
Integer (int32)
The number of results returned per page.
sort
String
Sorting method applied to the return results.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


updateReturnRequest

Updates the order return request.

Updates the order return request. Only cancellation of the request is supported by setting the attribute status to CANCELLING. Cancellation of the return request cannot be reverted


/{baseSiteId}/users/{userId}/orderReturns/{returnRequestCode}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orderReturns/{returnRequestCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReturnRequestsApi;

import java.io.File;
import java.util.*;

public class ReturnRequestsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ReturnRequestsApi apiInstance = new ReturnRequestsApi();
        ReturnRequestModification body = ; // ReturnRequestModification | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String returnRequestCode = returnRequestCode_example; // String | Order return request code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.updateReturnRequest(body, baseSiteId, returnRequestCode, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnRequestsApi#updateReturnRequest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReturnRequestsApi;

public class ReturnRequestsApiExample {

    public static void main(String[] args) {
        ReturnRequestsApi apiInstance = new ReturnRequestsApi();
        ReturnRequestModification body = ; // ReturnRequestModification | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String returnRequestCode = returnRequestCode_example; // String | Order return request code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.updateReturnRequest(body, baseSiteId, returnRequestCode, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReturnRequestsApi#updateReturnRequest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ReturnRequestModification *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *returnRequestCode = returnRequestCode_example; // Order return request code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

ReturnRequestsApi *apiInstance = [[ReturnRequestsApi alloc] init];

// Updates the order return request.
[apiInstance updateReturnRequestWith:body
    baseSiteId:baseSiteId
    returnRequestCode:returnRequestCode
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.ReturnRequestsApi()
var body = ; // {{ReturnRequestModification}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var returnRequestCode = returnRequestCode_example; // {{String}} Order return request code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateReturnRequest(bodybaseSiteIdreturnRequestCodeuserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateReturnRequestExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReturnRequestsApi();
            var body = new ReturnRequestModification(); // ReturnRequestModification | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var returnRequestCode = returnRequestCode_example;  // String | Order return request code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Updates the order return request.
                apiInstance.updateReturnRequest(body, baseSiteId, returnRequestCode, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReturnRequestsApi.updateReturnRequest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReturnRequestsApi();
$body = ; // ReturnRequestModification | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$returnRequestCode = returnRequestCode_example; // String | Order return request code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->updateReturnRequest($body, $baseSiteId, $returnRequestCode, $userId);
} catch (Exception $e) {
    echo 'Exception when calling ReturnRequestsApi->updateReturnRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReturnRequestsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReturnRequestsApi->new();
my $body = WWW::SwaggerClient::Object::ReturnRequestModification->new(); # ReturnRequestModification | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $returnRequestCode = returnRequestCode_example; # String | Order return request code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->updateReturnRequest(body => $body, baseSiteId => $baseSiteId, returnRequestCode => $returnRequestCode, userId => $userId);
};
if ($@) {
    warn "Exception when calling ReturnRequestsApi->updateReturnRequest: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReturnRequestsApi()
body =  # ReturnRequestModification | 
baseSiteId = baseSiteId_example # String | Base site identifier
returnRequestCode = returnRequestCode_example # String | Order return request code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Updates the order return request.
    api_instance.update_return_request(body, baseSiteId, returnRequestCode, userId)
except ApiException as e:
    print("Exception when calling ReturnRequestsApi->updateReturnRequest: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
returnRequestCode*
String
Order return request code
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


SaveCart

doCartClone

Explicitly clones a cart.

Explicitly clones a cart and sets the name and description for the cloned cart if given.


/{baseSiteId}/users/{userId}/carts/{cartId}/clonesavedcart

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/clonesavedcart?description=&fields=&name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SaveCartApi;

import java.io.File;
import java.util.*;

public class SaveCartApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SaveCartApi apiInstance = new SaveCartApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String description = description_example; // String | The description that should be applied to the cloned cart.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        String name = name_example; // String | The name that should be applied to the cloned cart.
        try {
            SaveCartResult result = apiInstance.doCartClone(baseSiteId, cartId, userId, description, fields, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaveCartApi#doCartClone");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SaveCartApi;

public class SaveCartApiExample {

    public static void main(String[] args) {
        SaveCartApi apiInstance = new SaveCartApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String description = description_example; // String | The description that should be applied to the cloned cart.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        String name = name_example; // String | The name that should be applied to the cloned cart.
        try {
            SaveCartResult result = apiInstance.doCartClone(baseSiteId, cartId, userId, description, fields, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaveCartApi#doCartClone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *description = description_example; // The description that should be applied to the cloned cart. (optional)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
String *name = name_example; // The name that should be applied to the cloned cart. (optional)

SaveCartApi *apiInstance = [[SaveCartApi alloc] init];

// Explicitly clones a cart.
[apiInstance doCartCloneWith:baseSiteId
    cartId:cartId
    userId:userId
    description:description
    fields:fields
    name:name
              completionHandler: ^(SaveCartResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.SaveCartApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'description': description_example, // {{String}} The description that should be applied to the cloned cart.
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'name': name_example // {{String}} The name that should be applied to the cloned cart.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doCartClone(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class doCartCloneExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SaveCartApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var description = description_example;  // String | The description that should be applied to the cloned cart. (optional) 
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var name = name_example;  // String | The name that should be applied to the cloned cart. (optional) 

            try
            {
                // Explicitly clones a cart.
                SaveCartResult result = apiInstance.doCartClone(baseSiteId, cartId, userId, description, fields, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SaveCartApi.doCartClone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSaveCartApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$description = description_example; // String | The description that should be applied to the cloned cart.
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$name = name_example; // String | The name that should be applied to the cloned cart.

try {
    $result = $api_instance->doCartClone($baseSiteId, $cartId, $userId, $description, $fields, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SaveCartApi->doCartClone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SaveCartApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SaveCartApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $description = description_example; # String | The description that should be applied to the cloned cart.
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $name = name_example; # String | The name that should be applied to the cloned cart.

eval { 
    my $result = $api_instance->doCartClone(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, description => $description, fields => $fields, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SaveCartApi->doCartClone: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SaveCartApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
description = description_example # String | The description that should be applied to the cloned cart. (optional)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
name = name_example # String | The name that should be applied to the cloned cart. (optional)

try: 
    # Explicitly clones a cart.
    api_response = api_instance.do_cart_clone(baseSiteId, cartId, userId, description=description, fields=fields, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SaveCartApi->doCartClone: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
description
String
The description that should be applied to the cloned cart.
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
name
String
The name that should be applied to the cloned cart.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


doSaveCart

Explicitly saves a cart.

Explicitly saves a cart and sets the name and description for the saved cart if given.


/{baseSiteId}/users/{userId}/carts/{cartId}/save

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/save?fields=&saveCartDescription=&saveCartName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SaveCartApi;

import java.io.File;
import java.util.*;

public class SaveCartApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SaveCartApi apiInstance = new SaveCartApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        String saveCartDescription = saveCartDescription_example; // String | The description that should be applied to the saved cart.
        String saveCartName = saveCartName_example; // String | The name that should be applied to the saved cart.
        try {
            SaveCartResult result = apiInstance.doSaveCart(baseSiteId, cartId, userId, fields, saveCartDescription, saveCartName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaveCartApi#doSaveCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SaveCartApi;

public class SaveCartApiExample {

    public static void main(String[] args) {
        SaveCartApi apiInstance = new SaveCartApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        String saveCartDescription = saveCartDescription_example; // String | The description that should be applied to the saved cart.
        String saveCartName = saveCartName_example; // String | The name that should be applied to the saved cart.
        try {
            SaveCartResult result = apiInstance.doSaveCart(baseSiteId, cartId, userId, fields, saveCartDescription, saveCartName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaveCartApi#doSaveCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
String *saveCartDescription = saveCartDescription_example; // The description that should be applied to the saved cart. (optional)
String *saveCartName = saveCartName_example; // The name that should be applied to the saved cart. (optional)

SaveCartApi *apiInstance = [[SaveCartApi alloc] init];

// Explicitly saves a cart.
[apiInstance doSaveCartWith:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
    saveCartDescription:saveCartDescription
    saveCartName:saveCartName
              completionHandler: ^(SaveCartResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.SaveCartApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'saveCartDescription': saveCartDescription_example, // {{String}} The description that should be applied to the saved cart.
  'saveCartName': saveCartName_example // {{String}} The name that should be applied to the saved cart.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doSaveCart(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class doSaveCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SaveCartApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var saveCartDescription = saveCartDescription_example;  // String | The description that should be applied to the saved cart. (optional) 
            var saveCartName = saveCartName_example;  // String | The name that should be applied to the saved cart. (optional) 

            try
            {
                // Explicitly saves a cart.
                SaveCartResult result = apiInstance.doSaveCart(baseSiteId, cartId, userId, fields, saveCartDescription, saveCartName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SaveCartApi.doSaveCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSaveCartApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$saveCartDescription = saveCartDescription_example; // String | The description that should be applied to the saved cart.
$saveCartName = saveCartName_example; // String | The name that should be applied to the saved cart.

try {
    $result = $api_instance->doSaveCart($baseSiteId, $cartId, $userId, $fields, $saveCartDescription, $saveCartName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SaveCartApi->doSaveCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SaveCartApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SaveCartApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $saveCartDescription = saveCartDescription_example; # String | The description that should be applied to the saved cart.
my $saveCartName = saveCartName_example; # String | The name that should be applied to the saved cart.

eval { 
    my $result = $api_instance->doSaveCart(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields, saveCartDescription => $saveCartDescription, saveCartName => $saveCartName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SaveCartApi->doSaveCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SaveCartApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
saveCartDescription = saveCartDescription_example # String | The description that should be applied to the saved cart. (optional)
saveCartName = saveCartName_example # String | The name that should be applied to the saved cart. (optional)

try: 
    # Explicitly saves a cart.
    api_response = api_instance.do_save_cart(baseSiteId, cartId, userId, fields=fields, saveCartDescription=saveCartDescription, saveCartName=saveCartName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SaveCartApi->doSaveCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
saveCartDescription
String
The description that should be applied to the saved cart.
saveCartName
String
The name that should be applied to the saved cart.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


doUpdateFlagForDeletion

Flag a cart for deletion.

Flags a cart for deletion (the cart doesn't have corresponding save cart attributes anymore). The cart is not actually deleted from the database. But with the removal of the saved cart attributes, this cart will be taken care of by the cart removal job just like any other cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/flagForDeletion

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/flagForDeletion?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SaveCartApi;

import java.io.File;
import java.util.*;

public class SaveCartApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SaveCartApi apiInstance = new SaveCartApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            SaveCartResult result = apiInstance.doUpdateFlagForDeletion(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaveCartApi#doUpdateFlagForDeletion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SaveCartApi;

public class SaveCartApiExample {

    public static void main(String[] args) {
        SaveCartApi apiInstance = new SaveCartApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            SaveCartResult result = apiInstance.doUpdateFlagForDeletion(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaveCartApi#doUpdateFlagForDeletion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

SaveCartApi *apiInstance = [[SaveCartApi alloc] init];

// Flag a cart for deletion.
[apiInstance doUpdateFlagForDeletionWith:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
              completionHandler: ^(SaveCartResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.SaveCartApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doUpdateFlagForDeletion(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class doUpdateFlagForDeletionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SaveCartApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Flag a cart for deletion.
                SaveCartResult result = apiInstance.doUpdateFlagForDeletion(baseSiteId, cartId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SaveCartApi.doUpdateFlagForDeletion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSaveCartApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->doUpdateFlagForDeletion($baseSiteId, $cartId, $userId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SaveCartApi->doUpdateFlagForDeletion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SaveCartApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SaveCartApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->doUpdateFlagForDeletion(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SaveCartApi->doUpdateFlagForDeletion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SaveCartApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Flag a cart for deletion.
    api_response = api_instance.do_update_flag_for_deletion(baseSiteId, cartId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SaveCartApi->doUpdateFlagForDeletion: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


doUpdateSavedCart

Restore a saved cart.

Restore the data of a saved cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/restoresavedcart

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/restoresavedcart?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SaveCartApi;

import java.io.File;
import java.util.*;

public class SaveCartApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SaveCartApi apiInstance = new SaveCartApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            SaveCartResult result = apiInstance.doUpdateSavedCart(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaveCartApi#doUpdateSavedCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SaveCartApi;

public class SaveCartApiExample {

    public static void main(String[] args) {
        SaveCartApi apiInstance = new SaveCartApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            SaveCartResult result = apiInstance.doUpdateSavedCart(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaveCartApi#doUpdateSavedCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

SaveCartApi *apiInstance = [[SaveCartApi alloc] init];

// Restore a saved cart.
[apiInstance doUpdateSavedCartWith:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
              completionHandler: ^(SaveCartResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.SaveCartApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doUpdateSavedCart(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class doUpdateSavedCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SaveCartApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Restore a saved cart.
                SaveCartResult result = apiInstance.doUpdateSavedCart(baseSiteId, cartId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SaveCartApi.doUpdateSavedCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSaveCartApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->doUpdateSavedCart($baseSiteId, $cartId, $userId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SaveCartApi->doUpdateSavedCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SaveCartApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SaveCartApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->doUpdateSavedCart(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SaveCartApi->doUpdateSavedCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SaveCartApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Restore a saved cart.
    api_response = api_instance.do_update_saved_cart(baseSiteId, cartId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SaveCartApi->doUpdateSavedCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getSavedCart

Get a saved cart.

Returns a saved cart for an authenticated user. The cart is identified using the "cartId" parameter.


/{baseSiteId}/users/{userId}/carts/{cartId}/savedcart

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/savedcart?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SaveCartApi;

import java.io.File;
import java.util.*;

public class SaveCartApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SaveCartApi apiInstance = new SaveCartApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            SaveCartResult result = apiInstance.getSavedCart(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaveCartApi#getSavedCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SaveCartApi;

public class SaveCartApiExample {

    public static void main(String[] args) {
        SaveCartApi apiInstance = new SaveCartApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            SaveCartResult result = apiInstance.getSavedCart(baseSiteId, cartId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SaveCartApi#getSavedCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

SaveCartApi *apiInstance = [[SaveCartApi alloc] init];

// Get a saved cart.
[apiInstance getSavedCartWith:baseSiteId
    cartId:cartId
    userId:userId
    fields:fields
              completionHandler: ^(SaveCartResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.SaveCartApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSavedCart(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSavedCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SaveCartApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a saved cart.
                SaveCartResult result = apiInstance.getSavedCart(baseSiteId, cartId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SaveCartApi.getSavedCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSaveCartApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getSavedCart($baseSiteId, $cartId, $userId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SaveCartApi->getSavedCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SaveCartApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SaveCartApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getSavedCart(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SaveCartApi->getSavedCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SaveCartApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a saved cart.
    api_response = api_instance.get_saved_cart(baseSiteId, cartId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SaveCartApi->getSavedCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


SpecialServices

addSpecialServiceToPassenger

Adds the special service requests for the current cart and cart traveller.

Adds the special service requests for the current cart and cart traveller.


/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}/specialServiceRequests

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}/specialServiceRequests?specialServiceRequestId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SpecialServicesApi;

import java.io.File;
import java.util.*;

public class SpecialServicesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SpecialServicesApi apiInstance = new SpecialServicesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String specialServiceRequestId = specialServiceRequestId_example; // String | Special service request identifier (code)
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addSpecialServiceToPassenger(baseSiteId, cartId, sap.cxSalesApplication, specialServiceRequestId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SpecialServicesApi#addSpecialServiceToPassenger");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SpecialServicesApi;

public class SpecialServicesApiExample {

    public static void main(String[] args) {
        SpecialServicesApi apiInstance = new SpecialServicesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String specialServiceRequestId = specialServiceRequestId_example; // String | Special service request identifier (code)
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addSpecialServiceToPassenger(baseSiteId, cartId, sap.cxSalesApplication, specialServiceRequestId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SpecialServicesApi#addSpecialServiceToPassenger");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *specialServiceRequestId = specialServiceRequestId_example; // Special service request identifier (code)
String *travellerId = travellerId_example; // Traveller identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

SpecialServicesApi *apiInstance = [[SpecialServicesApi alloc] init];

// Adds the special service requests for the current cart and cart traveller.
[apiInstance addSpecialServiceToPassengerWith:baseSiteId
    cartId:cartId
    sap.cxSalesApplication:sap.cxSalesApplication
    specialServiceRequestId:specialServiceRequestId
    travellerId:travellerId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.SpecialServicesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var specialServiceRequestId = specialServiceRequestId_example; // {{String}} Special service request identifier (code)
var travellerId = travellerId_example; // {{String}} Traveller identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addSpecialServiceToPassenger(baseSiteId, cartId, sap.cxSalesApplication, specialServiceRequestId, travellerId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addSpecialServiceToPassengerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SpecialServicesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var specialServiceRequestId = specialServiceRequestId_example;  // String | Special service request identifier (code)
            var travellerId = travellerId_example;  // String | Traveller identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Adds the special service requests for the current cart and cart traveller.
                'String' result = apiInstance.addSpecialServiceToPassenger(baseSiteId, cartId, sap.cxSalesApplication, specialServiceRequestId, travellerId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SpecialServicesApi.addSpecialServiceToPassenger: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSpecialServicesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$specialServiceRequestId = specialServiceRequestId_example; // String | Special service request identifier (code)
$travellerId = travellerId_example; // String | Traveller identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->addSpecialServiceToPassenger($baseSiteId, $cartId, $sap.cxSalesApplication, $specialServiceRequestId, $travellerId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SpecialServicesApi->addSpecialServiceToPassenger: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SpecialServicesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SpecialServicesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $specialServiceRequestId = specialServiceRequestId_example; # String | Special service request identifier (code)
my $travellerId = travellerId_example; # String | Traveller identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->addSpecialServiceToPassenger(baseSiteId => $baseSiteId, cartId => $cartId, sap.cxSalesApplication => $sap.cxSalesApplication, specialServiceRequestId => $specialServiceRequestId, travellerId => $travellerId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SpecialServicesApi->addSpecialServiceToPassenger: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SpecialServicesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
specialServiceRequestId = specialServiceRequestId_example # String | Special service request identifier (code)
travellerId = travellerId_example # String | Traveller identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Adds the special service requests for the current cart and cart traveller.
    api_response = api_instance.add_special_service_to_passenger(baseSiteId, cartId, sap.cxSalesApplication, specialServiceRequestId, travellerId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SpecialServicesApi->addSpecialServiceToPassenger: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
travellerId*
String
Traveller identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Query parameters
Name Description
specialServiceRequestId*
String
Special service request identifier (code)
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


findAllSpecialServiceRequests

Get a list of available special services.

Lists all available special services that can be associated to a transport booking


/{baseSiteId}/specialServices

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/specialServices"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SpecialServicesApi;

import java.io.File;
import java.util.*;

public class SpecialServicesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SpecialServicesApi apiInstance = new SpecialServicesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            SpecialServiceRequestList result = apiInstance.findAllSpecialServiceRequests(baseSiteId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SpecialServicesApi#findAllSpecialServiceRequests");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SpecialServicesApi;

public class SpecialServicesApiExample {

    public static void main(String[] args) {
        SpecialServicesApi apiInstance = new SpecialServicesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            SpecialServiceRequestList result = apiInstance.findAllSpecialServiceRequests(baseSiteId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SpecialServicesApi#findAllSpecialServiceRequests");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

SpecialServicesApi *apiInstance = [[SpecialServicesApi alloc] init];

// Get a list of available special services.
[apiInstance findAllSpecialServiceRequestsWith:baseSiteId
    acceptLanguage:acceptLanguage
              completionHandler: ^(SpecialServiceRequestList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.SpecialServicesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAllSpecialServiceRequests(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findAllSpecialServiceRequestsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SpecialServicesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get a list of available special services.
                SpecialServiceRequestList result = apiInstance.findAllSpecialServiceRequests(baseSiteId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SpecialServicesApi.findAllSpecialServiceRequests: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSpecialServicesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->findAllSpecialServiceRequests($baseSiteId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SpecialServicesApi->findAllSpecialServiceRequests: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SpecialServicesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SpecialServicesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->findAllSpecialServiceRequests(baseSiteId => $baseSiteId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SpecialServicesApi->findAllSpecialServiceRequests: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SpecialServicesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get a list of available special services.
    api_response = api_instance.find_all_special_service_requests(baseSiteId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SpecialServicesApi->findAllSpecialServiceRequests: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


findSpecialServiceRequestFromOrderAndTraveller

Get all special service requests for the given orderId and traveller.

Returns all special service requests for the given order and traveller.


/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/specialServiceRequests

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/specialServiceRequests"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SpecialServicesApi;

import java.io.File;
import java.util.*;

public class SpecialServicesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SpecialServicesApi apiInstance = new SpecialServicesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order identifier
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            SpecialServiceRequestList result = apiInstance.findSpecialServiceRequestFromOrderAndTraveller(baseSiteId, orderId, travellerId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SpecialServicesApi#findSpecialServiceRequestFromOrderAndTraveller");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SpecialServicesApi;

public class SpecialServicesApiExample {

    public static void main(String[] args) {
        SpecialServicesApi apiInstance = new SpecialServicesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order identifier
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            SpecialServiceRequestList result = apiInstance.findSpecialServiceRequestFromOrderAndTraveller(baseSiteId, orderId, travellerId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SpecialServicesApi#findSpecialServiceRequestFromOrderAndTraveller");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order identifier
String *travellerId = travellerId_example; // Traveller identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

SpecialServicesApi *apiInstance = [[SpecialServicesApi alloc] init];

// Get all special service requests for the given orderId and traveller.
[apiInstance findSpecialServiceRequestFromOrderAndTravellerWith:baseSiteId
    orderId:orderId
    travellerId:travellerId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^(SpecialServiceRequestList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.SpecialServicesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order identifier
var travellerId = travellerId_example; // {{String}} Traveller identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findSpecialServiceRequestFromOrderAndTraveller(baseSiteId, orderId, travellerId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findSpecialServiceRequestFromOrderAndTravellerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SpecialServicesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order identifier
            var travellerId = travellerId_example;  // String | Traveller identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get all special service requests for the given orderId and traveller.
                SpecialServiceRequestList result = apiInstance.findSpecialServiceRequestFromOrderAndTraveller(baseSiteId, orderId, travellerId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SpecialServicesApi.findSpecialServiceRequestFromOrderAndTraveller: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSpecialServicesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order identifier
$travellerId = travellerId_example; // String | Traveller identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->findSpecialServiceRequestFromOrderAndTraveller($baseSiteId, $orderId, $travellerId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SpecialServicesApi->findSpecialServiceRequestFromOrderAndTraveller: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SpecialServicesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SpecialServicesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order identifier
my $travellerId = travellerId_example; # String | Traveller identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->findSpecialServiceRequestFromOrderAndTraveller(baseSiteId => $baseSiteId, orderId => $orderId, travellerId => $travellerId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SpecialServicesApi->findSpecialServiceRequestFromOrderAndTraveller: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SpecialServicesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order identifier
travellerId = travellerId_example # String | Traveller identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get all special service requests for the given orderId and traveller.
    api_response = api_instance.find_special_service_request_from_order_and_traveller(baseSiteId, orderId, travellerId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SpecialServicesApi->findSpecialServiceRequestFromOrderAndTraveller: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order identifier
Required
travellerId*
String
Traveller identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


findSpecialServiceRequestFromTraveller

Get all special service requests for the current cart and traveller.

Returns all special service requests for the current cart and cart traveller.


/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}/specialServiceRequests

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}/specialServiceRequests"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SpecialServicesApi;

import java.io.File;
import java.util.*;

public class SpecialServicesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SpecialServicesApi apiInstance = new SpecialServicesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            SpecialServiceRequestList result = apiInstance.findSpecialServiceRequestFromTraveller(baseSiteId, cartId, travellerId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SpecialServicesApi#findSpecialServiceRequestFromTraveller");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SpecialServicesApi;

public class SpecialServicesApiExample {

    public static void main(String[] args) {
        SpecialServicesApi apiInstance = new SpecialServicesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            SpecialServiceRequestList result = apiInstance.findSpecialServiceRequestFromTraveller(baseSiteId, cartId, travellerId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SpecialServicesApi#findSpecialServiceRequestFromTraveller");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *travellerId = travellerId_example; // Traveller identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

SpecialServicesApi *apiInstance = [[SpecialServicesApi alloc] init];

// Get all special service requests for the current cart and traveller.
[apiInstance findSpecialServiceRequestFromTravellerWith:baseSiteId
    cartId:cartId
    travellerId:travellerId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^(SpecialServiceRequestList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.SpecialServicesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var travellerId = travellerId_example; // {{String}} Traveller identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findSpecialServiceRequestFromTraveller(baseSiteId, cartId, travellerId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findSpecialServiceRequestFromTravellerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SpecialServicesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var travellerId = travellerId_example;  // String | Traveller identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get all special service requests for the current cart and traveller.
                SpecialServiceRequestList result = apiInstance.findSpecialServiceRequestFromTraveller(baseSiteId, cartId, travellerId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SpecialServicesApi.findSpecialServiceRequestFromTraveller: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSpecialServicesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$travellerId = travellerId_example; // String | Traveller identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->findSpecialServiceRequestFromTraveller($baseSiteId, $cartId, $travellerId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SpecialServicesApi->findSpecialServiceRequestFromTraveller: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SpecialServicesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SpecialServicesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $travellerId = travellerId_example; # String | Traveller identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->findSpecialServiceRequestFromTraveller(baseSiteId => $baseSiteId, cartId => $cartId, travellerId => $travellerId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SpecialServicesApi->findSpecialServiceRequestFromTraveller: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SpecialServicesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
travellerId = travellerId_example # String | Traveller identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get all special service requests for the current cart and traveller.
    api_response = api_instance.find_special_service_request_from_traveller(baseSiteId, cartId, travellerId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SpecialServicesApi->findSpecialServiceRequestFromTraveller: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
travellerId*
String
Traveller identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


removeSpecialServiceFromPassenger

Remove the special service requests for the current cart and traveller

Remove the special service requests for the current cart and traveller


/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}/specialServiceRequests/{specialServiceRequestId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}/specialServiceRequests/{specialServiceRequestId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SpecialServicesApi;

import java.io.File;
import java.util.*;

public class SpecialServicesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SpecialServicesApi apiInstance = new SpecialServicesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String specialServiceRequestId = specialServiceRequestId_example; // String | Special service request identifier (code)
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeSpecialServiceFromPassenger(baseSiteId, cartId, specialServiceRequestId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SpecialServicesApi#removeSpecialServiceFromPassenger");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SpecialServicesApi;

public class SpecialServicesApiExample {

    public static void main(String[] args) {
        SpecialServicesApi apiInstance = new SpecialServicesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String specialServiceRequestId = specialServiceRequestId_example; // String | Special service request identifier (code)
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeSpecialServiceFromPassenger(baseSiteId, cartId, specialServiceRequestId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SpecialServicesApi#removeSpecialServiceFromPassenger");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *specialServiceRequestId = specialServiceRequestId_example; // Special service request identifier (code)
String *travellerId = travellerId_example; // Traveller identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

SpecialServicesApi *apiInstance = [[SpecialServicesApi alloc] init];

// Remove the special service requests for the current cart and traveller
[apiInstance removeSpecialServiceFromPassengerWith:baseSiteId
    cartId:cartId
    specialServiceRequestId:specialServiceRequestId
    travellerId:travellerId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.SpecialServicesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var specialServiceRequestId = specialServiceRequestId_example; // {{String}} Special service request identifier (code)
var travellerId = travellerId_example; // {{String}} Traveller identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeSpecialServiceFromPassenger(baseSiteId, cartId, specialServiceRequestId, travellerId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeSpecialServiceFromPassengerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SpecialServicesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var specialServiceRequestId = specialServiceRequestId_example;  // String | Special service request identifier (code)
            var travellerId = travellerId_example;  // String | Traveller identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Remove the special service requests for the current cart and traveller
                'String' result = apiInstance.removeSpecialServiceFromPassenger(baseSiteId, cartId, specialServiceRequestId, travellerId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SpecialServicesApi.removeSpecialServiceFromPassenger: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSpecialServicesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$specialServiceRequestId = specialServiceRequestId_example; // String | Special service request identifier (code)
$travellerId = travellerId_example; // String | Traveller identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->removeSpecialServiceFromPassenger($baseSiteId, $cartId, $specialServiceRequestId, $travellerId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SpecialServicesApi->removeSpecialServiceFromPassenger: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SpecialServicesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SpecialServicesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $specialServiceRequestId = specialServiceRequestId_example; # String | Special service request identifier (code)
my $travellerId = travellerId_example; # String | Traveller identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->removeSpecialServiceFromPassenger(baseSiteId => $baseSiteId, cartId => $cartId, specialServiceRequestId => $specialServiceRequestId, travellerId => $travellerId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SpecialServicesApi->removeSpecialServiceFromPassenger: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SpecialServicesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
specialServiceRequestId = specialServiceRequestId_example # String | Special service request identifier (code)
travellerId = travellerId_example # String | Traveller identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Remove the special service requests for the current cart and traveller
    api_response = api_instance.remove_special_service_from_passenger(baseSiteId, cartId, specialServiceRequestId, travellerId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SpecialServicesApi->removeSpecialServiceFromPassenger: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
specialServiceRequestId*
String
Special service request identifier (code)
Required
travellerId*
String
Traveller identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


Stores

countStoreLocations

Get a header with total number of stores

In the response header, the "x-total-count" indicates the number of all stores that are near the location specified in the query or based on latitude and longitude.


/{baseSiteId}/stores

Usage and SDK Samples

curl -X HEAD\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/stores?accuracy=&latitude=&longitude=&query=&radius="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StoresApi;

import java.io.File;
import java.util.*;

public class StoresApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        Double accuracy = 1.2; // Double | Accuracy in meters.
        Double latitude = 1.2; // Double | Coordinate that specifies the north-south position of a point on the Earth's surface.
        Double longitude = 1.2; // Double | Coordinate that specifies the east-west position of a point on the Earth's surface.
        String query = query_example; // String | Location in natural language i.e. city or country.
        Double radius = 1.2; // Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter).
        try {
            apiInstance.countStoreLocations(baseSiteId, accuracy, latitude, longitude, query, radius);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#countStoreLocations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StoresApi;

public class StoresApiExample {

    public static void main(String[] args) {
        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        Double accuracy = 1.2; // Double | Accuracy in meters.
        Double latitude = 1.2; // Double | Coordinate that specifies the north-south position of a point on the Earth's surface.
        Double longitude = 1.2; // Double | Coordinate that specifies the east-west position of a point on the Earth's surface.
        String query = query_example; // String | Location in natural language i.e. city or country.
        Double radius = 1.2; // Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter).
        try {
            apiInstance.countStoreLocations(baseSiteId, accuracy, latitude, longitude, query, radius);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#countStoreLocations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
Double *accuracy = 1.2; // Accuracy in meters. (optional) (default to 0.0)
Double *latitude = 1.2; // Coordinate that specifies the north-south position of a point on the Earth's surface. (optional)
Double *longitude = 1.2; // Coordinate that specifies the east-west position of a point on the Earth's surface. (optional)
String *query = query_example; // Location in natural language i.e. city or country. (optional)
Double *radius = 1.2; // Radius in meters. Max value: 40075000.0 (Earth's perimeter). (optional) (default to 100000.0)

StoresApi *apiInstance = [[StoresApi alloc] init];

// Get a header with total number of stores
[apiInstance countStoreLocationsWith:baseSiteId
    accuracy:accuracy
    latitude:latitude
    longitude:longitude
    query:query
    radius:radius
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.StoresApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'accuracy': 1.2, // {{Double}} Accuracy in meters.
  'latitude': 1.2, // {{Double}} Coordinate that specifies the north-south position of a point on the Earth's surface.
  'longitude': 1.2, // {{Double}} Coordinate that specifies the east-west position of a point on the Earth's surface.
  'query': query_example, // {{String}} Location in natural language i.e. city or country.
  'radius': 1.2 // {{Double}} Radius in meters. Max value: 40075000.0 (Earth's perimeter).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.countStoreLocations(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class countStoreLocationsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var accuracy = 1.2;  // Double | Accuracy in meters. (optional)  (default to 0.0)
            var latitude = 1.2;  // Double | Coordinate that specifies the north-south position of a point on the Earth's surface. (optional) 
            var longitude = 1.2;  // Double | Coordinate that specifies the east-west position of a point on the Earth's surface. (optional) 
            var query = query_example;  // String | Location in natural language i.e. city or country. (optional) 
            var radius = 1.2;  // Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter). (optional)  (default to 100000.0)

            try
            {
                // Get a header with total number of stores
                apiInstance.countStoreLocations(baseSiteId, accuracy, latitude, longitude, query, radius);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.countStoreLocations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStoresApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$accuracy = 1.2; // Double | Accuracy in meters.
$latitude = 1.2; // Double | Coordinate that specifies the north-south position of a point on the Earth's surface.
$longitude = 1.2; // Double | Coordinate that specifies the east-west position of a point on the Earth's surface.
$query = query_example; // String | Location in natural language i.e. city or country.
$radius = 1.2; // Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter).

try {
    $api_instance->countStoreLocations($baseSiteId, $accuracy, $latitude, $longitude, $query, $radius);
} catch (Exception $e) {
    echo 'Exception when calling StoresApi->countStoreLocations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StoresApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StoresApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $accuracy = 1.2; # Double | Accuracy in meters.
my $latitude = 1.2; # Double | Coordinate that specifies the north-south position of a point on the Earth's surface.
my $longitude = 1.2; # Double | Coordinate that specifies the east-west position of a point on the Earth's surface.
my $query = query_example; # String | Location in natural language i.e. city or country.
my $radius = 1.2; # Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter).

eval { 
    $api_instance->countStoreLocations(baseSiteId => $baseSiteId, accuracy => $accuracy, latitude => $latitude, longitude => $longitude, query => $query, radius => $radius);
};
if ($@) {
    warn "Exception when calling StoresApi->countStoreLocations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StoresApi()
baseSiteId = baseSiteId_example # String | Base site identifier
accuracy = 1.2 # Double | Accuracy in meters. (optional) (default to 0.0)
latitude = 1.2 # Double | Coordinate that specifies the north-south position of a point on the Earth's surface. (optional)
longitude = 1.2 # Double | Coordinate that specifies the east-west position of a point on the Earth's surface. (optional)
query = query_example # String | Location in natural language i.e. city or country. (optional)
radius = 1.2 # Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter). (optional) (default to 100000.0)

try: 
    # Get a header with total number of stores
    api_instance.count_store_locations(baseSiteId, accuracy=accuracy, latitude=latitude, longitude=longitude, query=query, radius=radius)
except ApiException as e:
    print("Exception when calling StoresApi->countStoreLocations: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
accuracy
Double (double)
Accuracy in meters.
latitude
Double (double)
Coordinate that specifies the north-south position of a point on the Earth's surface.
longitude
Double (double)
Coordinate that specifies the east-west position of a point on the Earth's surface.
query
String
Location in natural language i.e. city or country.
radius
Double (double)
Radius in meters. Max value: 40075000.0 (Earth's perimeter).

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getLocationCounts

Get a list of store counts aggregated by countries and regions for a given base site

Lists all store counts that are aggregated by countries and regions for a given base site


/{baseSiteId}/stores/storescounts

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/stores/storescounts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StoresApi;

import java.io.File;
import java.util.*;

public class StoresApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            StoreCountList result = apiInstance.getLocationCounts(baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#getLocationCounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StoresApi;

public class StoresApiExample {

    public static void main(String[] args) {
        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            StoreCountList result = apiInstance.getLocationCounts(baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#getLocationCounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier

StoresApi *apiInstance = [[StoresApi alloc] init];

// Get a list of store counts aggregated by countries and regions for a given base site
[apiInstance getLocationCountsWith:baseSiteId
              completionHandler: ^(StoreCountList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.StoresApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLocationCounts(baseSiteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLocationCountsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier

            try
            {
                // Get a list of store counts aggregated by countries and regions for a given base site
                StoreCountList result = apiInstance.getLocationCounts(baseSiteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.getLocationCounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStoresApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier

try {
    $result = $api_instance->getLocationCounts($baseSiteId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoresApi->getLocationCounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StoresApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StoresApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier

eval { 
    my $result = $api_instance->getLocationCounts(baseSiteId => $baseSiteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoresApi->getLocationCounts: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StoresApi()
baseSiteId = baseSiteId_example # String | Base site identifier

try: 
    # Get a list of store counts aggregated by countries and regions for a given base site
    api_response = api_instance.get_location_counts(baseSiteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoresApi->getLocationCounts: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getStoreLocation

Get the details of a store

Returns the store details based on its unique name.


/{baseSiteId}/stores/{storeId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/stores/{storeId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StoresApi;

import java.io.File;
import java.util.*;

public class StoresApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String storeId = storeId_example; // String | Store identifier (currently store name)
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PointOfService result = apiInstance.getStoreLocation(baseSiteId, storeId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#getStoreLocation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StoresApi;

public class StoresApiExample {

    public static void main(String[] args) {
        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String storeId = storeId_example; // String | Store identifier (currently store name)
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PointOfService result = apiInstance.getStoreLocation(baseSiteId, storeId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#getStoreLocation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *storeId = storeId_example; // Store identifier (currently store name)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

StoresApi *apiInstance = [[StoresApi alloc] init];

// Get the details of a store
[apiInstance getStoreLocationWith:baseSiteId
    storeId:storeId
    fields:fields
              completionHandler: ^(PointOfService output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.StoresApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var storeId = storeId_example; // {{String}} Store identifier (currently store name)
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStoreLocation(baseSiteId, storeId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStoreLocationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var storeId = storeId_example;  // String | Store identifier (currently store name)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get the details of a store
                PointOfService result = apiInstance.getStoreLocation(baseSiteId, storeId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.getStoreLocation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStoresApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$storeId = storeId_example; // String | Store identifier (currently store name)
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getStoreLocation($baseSiteId, $storeId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoresApi->getStoreLocation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StoresApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StoresApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $storeId = storeId_example; # String | Store identifier (currently store name)
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getStoreLocation(baseSiteId => $baseSiteId, storeId => $storeId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoresApi->getStoreLocation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StoresApi()
baseSiteId = baseSiteId_example # String | Base site identifier
storeId = storeId_example # String | Store identifier (currently store name)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get the details of a store
    api_response = api_instance.get_store_location(baseSiteId, storeId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoresApi->getStoreLocation: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
storeId*
String
Store identifier (currently store name)
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getStoreLocations

Get a list of stores

Lists all stores that are near the location specified in the query or based on latitude and longitude.


/{baseSiteId}/stores

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/stores?accuracy=¤tPage=&fields=&latitude=&longitude=&pageSize=&query=&radius=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StoresApi;

import java.io.File;
import java.util.*;

public class StoresApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        Double accuracy = 1.2; // Double | Accuracy in meters.
        Integer currentPage = 56; // Integer | The current result page requested.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Double latitude = 1.2; // Double | Coordinate that specifies the north-south position of a point on the Earth's surface.
        Double longitude = 1.2; // Double | Coordinate that specifies the east-west position of a point on the Earth's surface.
        Integer pageSize = 56; // Integer | The number of results returned per page.
        String query = query_example; // String | Location in natural language i.e. city or country.
        Double radius = 1.2; // Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter).
        String sort = sort_example; // String | Sorting method applied to the return results.
        try {
            StoreFinderSearchPage result = apiInstance.getStoreLocations(baseSiteId, accuracy, currentPage, fields, latitude, longitude, pageSize, query, radius, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#getStoreLocations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StoresApi;

public class StoresApiExample {

    public static void main(String[] args) {
        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        Double accuracy = 1.2; // Double | Accuracy in meters.
        Integer currentPage = 56; // Integer | The current result page requested.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Double latitude = 1.2; // Double | Coordinate that specifies the north-south position of a point on the Earth's surface.
        Double longitude = 1.2; // Double | Coordinate that specifies the east-west position of a point on the Earth's surface.
        Integer pageSize = 56; // Integer | The number of results returned per page.
        String query = query_example; // String | Location in natural language i.e. city or country.
        Double radius = 1.2; // Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter).
        String sort = sort_example; // String | Sorting method applied to the return results.
        try {
            StoreFinderSearchPage result = apiInstance.getStoreLocations(baseSiteId, accuracy, currentPage, fields, latitude, longitude, pageSize, query, radius, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#getStoreLocations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
Double *accuracy = 1.2; // Accuracy in meters. (optional) (default to 0.0)
Integer *currentPage = 56; // The current result page requested. (optional) (default to 0)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
Double *latitude = 1.2; // Coordinate that specifies the north-south position of a point on the Earth's surface. (optional)
Double *longitude = 1.2; // Coordinate that specifies the east-west position of a point on the Earth's surface. (optional)
Integer *pageSize = 56; // The number of results returned per page. (optional) (default to 20)
String *query = query_example; // Location in natural language i.e. city or country. (optional)
Double *radius = 1.2; // Radius in meters. Max value: 40075000.0 (Earth's perimeter). (optional) (default to 100000.0)
String *sort = sort_example; // Sorting method applied to the return results. (optional) (default to asc)

StoresApi *apiInstance = [[StoresApi alloc] init];

// Get a list of stores
[apiInstance getStoreLocationsWith:baseSiteId
    accuracy:accuracy
    currentPage:currentPage
    fields:fields
    latitude:latitude
    longitude:longitude
    pageSize:pageSize
    query:query
    radius:radius
    sort:sort
              completionHandler: ^(StoreFinderSearchPage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.StoresApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'accuracy': 1.2, // {{Double}} Accuracy in meters.
  'currentPage': 56, // {{Integer}} The current result page requested.
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'latitude': 1.2, // {{Double}} Coordinate that specifies the north-south position of a point on the Earth's surface.
  'longitude': 1.2, // {{Double}} Coordinate that specifies the east-west position of a point on the Earth's surface.
  'pageSize': 56, // {{Integer}} The number of results returned per page.
  'query': query_example, // {{String}} Location in natural language i.e. city or country.
  'radius': 1.2, // {{Double}} Radius in meters. Max value: 40075000.0 (Earth's perimeter).
  'sort': sort_example // {{String}} Sorting method applied to the return results.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStoreLocations(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStoreLocationsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var accuracy = 1.2;  // Double | Accuracy in meters. (optional)  (default to 0.0)
            var currentPage = 56;  // Integer | The current result page requested. (optional)  (default to 0)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)
            var latitude = 1.2;  // Double | Coordinate that specifies the north-south position of a point on the Earth's surface. (optional) 
            var longitude = 1.2;  // Double | Coordinate that specifies the east-west position of a point on the Earth's surface. (optional) 
            var pageSize = 56;  // Integer | The number of results returned per page. (optional)  (default to 20)
            var query = query_example;  // String | Location in natural language i.e. city or country. (optional) 
            var radius = 1.2;  // Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter). (optional)  (default to 100000.0)
            var sort = sort_example;  // String | Sorting method applied to the return results. (optional)  (default to asc)

            try
            {
                // Get a list of stores
                StoreFinderSearchPage result = apiInstance.getStoreLocations(baseSiteId, accuracy, currentPage, fields, latitude, longitude, pageSize, query, radius, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.getStoreLocations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStoresApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$accuracy = 1.2; // Double | Accuracy in meters.
$currentPage = 56; // Integer | The current result page requested.
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$latitude = 1.2; // Double | Coordinate that specifies the north-south position of a point on the Earth's surface.
$longitude = 1.2; // Double | Coordinate that specifies the east-west position of a point on the Earth's surface.
$pageSize = 56; // Integer | The number of results returned per page.
$query = query_example; // String | Location in natural language i.e. city or country.
$radius = 1.2; // Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter).
$sort = sort_example; // String | Sorting method applied to the return results.

try {
    $result = $api_instance->getStoreLocations($baseSiteId, $accuracy, $currentPage, $fields, $latitude, $longitude, $pageSize, $query, $radius, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoresApi->getStoreLocations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StoresApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StoresApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $accuracy = 1.2; # Double | Accuracy in meters.
my $currentPage = 56; # Integer | The current result page requested.
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $latitude = 1.2; # Double | Coordinate that specifies the north-south position of a point on the Earth's surface.
my $longitude = 1.2; # Double | Coordinate that specifies the east-west position of a point on the Earth's surface.
my $pageSize = 56; # Integer | The number of results returned per page.
my $query = query_example; # String | Location in natural language i.e. city or country.
my $radius = 1.2; # Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter).
my $sort = sort_example; # String | Sorting method applied to the return results.

eval { 
    my $result = $api_instance->getStoreLocations(baseSiteId => $baseSiteId, accuracy => $accuracy, currentPage => $currentPage, fields => $fields, latitude => $latitude, longitude => $longitude, pageSize => $pageSize, query => $query, radius => $radius, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoresApi->getStoreLocations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StoresApi()
baseSiteId = baseSiteId_example # String | Base site identifier
accuracy = 1.2 # Double | Accuracy in meters. (optional) (default to 0.0)
currentPage = 56 # Integer | The current result page requested. (optional) (default to 0)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)
latitude = 1.2 # Double | Coordinate that specifies the north-south position of a point on the Earth's surface. (optional)
longitude = 1.2 # Double | Coordinate that specifies the east-west position of a point on the Earth's surface. (optional)
pageSize = 56 # Integer | The number of results returned per page. (optional) (default to 20)
query = query_example # String | Location in natural language i.e. city or country. (optional)
radius = 1.2 # Double | Radius in meters. Max value: 40075000.0 (Earth's perimeter). (optional) (default to 100000.0)
sort = sort_example # String | Sorting method applied to the return results. (optional) (default to asc)

try: 
    # Get a list of stores
    api_response = api_instance.get_store_locations(baseSiteId, accuracy=accuracy, currentPage=currentPage, fields=fields, latitude=latitude, longitude=longitude, pageSize=pageSize, query=query, radius=radius, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoresApi->getStoreLocations: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Query parameters
Name Description
accuracy
Double (double)
Accuracy in meters.
currentPage
Integer (int32)
The current result page requested.
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
latitude
Double (double)
Coordinate that specifies the north-south position of a point on the Earth's surface.
longitude
Double (double)
Coordinate that specifies the east-west position of a point on the Earth's surface.
pageSize
Integer (int32)
The number of results returned per page.
query
String
Location in natural language i.e. city or country.
radius
Double (double)
Radius in meters. Max value: 40075000.0 (Earth's perimeter).
sort
String
Sorting method applied to the return results.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getStoresByCountry

Get a list of stores for a given country

Lists all stores that are in the specified country.


/{baseSiteId}/stores/country/{countryIso}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/stores/country/{countryIso}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StoresApi;

import java.io.File;
import java.util.*;

public class StoresApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String countryIso = countryIso_example; // String | Country ISO code
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PointOfServiceList result = apiInstance.getStoresByCountry(baseSiteId, countryIso, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#getStoresByCountry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StoresApi;

public class StoresApiExample {

    public static void main(String[] args) {
        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String countryIso = countryIso_example; // String | Country ISO code
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PointOfServiceList result = apiInstance.getStoresByCountry(baseSiteId, countryIso, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#getStoresByCountry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *countryIso = countryIso_example; // Country ISO code
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

StoresApi *apiInstance = [[StoresApi alloc] init];

// Get a list of stores for a given country
[apiInstance getStoresByCountryWith:baseSiteId
    countryIso:countryIso
    fields:fields
              completionHandler: ^(PointOfServiceList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.StoresApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var countryIso = countryIso_example; // {{String}} Country ISO code
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStoresByCountry(baseSiteId, countryIso, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStoresByCountryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var countryIso = countryIso_example;  // String | Country ISO code
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a list of stores for a given country
                PointOfServiceList result = apiInstance.getStoresByCountry(baseSiteId, countryIso, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.getStoresByCountry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStoresApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$countryIso = countryIso_example; // String | Country ISO code
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getStoresByCountry($baseSiteId, $countryIso, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoresApi->getStoresByCountry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StoresApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StoresApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $countryIso = countryIso_example; # String | Country ISO code
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getStoresByCountry(baseSiteId => $baseSiteId, countryIso => $countryIso, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoresApi->getStoresByCountry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StoresApi()
baseSiteId = baseSiteId_example # String | Base site identifier
countryIso = countryIso_example # String | Country ISO code
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a list of stores for a given country
    api_response = api_instance.get_stores_by_country(baseSiteId, countryIso, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoresApi->getStoresByCountry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
countryIso*
String
Country ISO code
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getStoresByCountryAndRegion

Get a list of stores for a given country and region

Lists all stores that are in the specified country and its subdivision/region.


/{baseSiteId}/stores/country/{countryIso}/region/{regionIso}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/stores/country/{countryIso}/region/{regionIso}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StoresApi;

import java.io.File;
import java.util.*;

public class StoresApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String countryIso = countryIso_example; // String | Country ISO code
        String regionIso = regionIso_example; // String | Region ISO code
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PointOfServiceList result = apiInstance.getStoresByCountryAndRegion(baseSiteId, countryIso, regionIso, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#getStoresByCountryAndRegion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StoresApi;

public class StoresApiExample {

    public static void main(String[] args) {
        StoresApi apiInstance = new StoresApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String countryIso = countryIso_example; // String | Country ISO code
        String regionIso = regionIso_example; // String | Region ISO code
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            PointOfServiceList result = apiInstance.getStoresByCountryAndRegion(baseSiteId, countryIso, regionIso, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoresApi#getStoresByCountryAndRegion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *countryIso = countryIso_example; // Country ISO code
String *regionIso = regionIso_example; // Region ISO code
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

StoresApi *apiInstance = [[StoresApi alloc] init];

// Get a list of stores for a given country and region
[apiInstance getStoresByCountryAndRegionWith:baseSiteId
    countryIso:countryIso
    regionIso:regionIso
    fields:fields
              completionHandler: ^(PointOfServiceList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.StoresApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var countryIso = countryIso_example; // {{String}} Country ISO code
var regionIso = regionIso_example; // {{String}} Region ISO code
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStoresByCountryAndRegion(baseSiteId, countryIso, regionIso, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStoresByCountryAndRegionExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var countryIso = countryIso_example;  // String | Country ISO code
            var regionIso = regionIso_example;  // String | Region ISO code
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get a list of stores for a given country and region
                PointOfServiceList result = apiInstance.getStoresByCountryAndRegion(baseSiteId, countryIso, regionIso, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.getStoresByCountryAndRegion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiStoresApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$countryIso = countryIso_example; // String | Country ISO code
$regionIso = regionIso_example; // String | Region ISO code
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getStoresByCountryAndRegion($baseSiteId, $countryIso, $regionIso, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoresApi->getStoresByCountryAndRegion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StoresApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::StoresApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $countryIso = countryIso_example; # String | Country ISO code
my $regionIso = regionIso_example; # String | Region ISO code
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getStoresByCountryAndRegion(baseSiteId => $baseSiteId, countryIso => $countryIso, regionIso => $regionIso, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StoresApi->getStoresByCountryAndRegion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.StoresApi()
baseSiteId = baseSiteId_example # String | Base site identifier
countryIso = countryIso_example # String | Country ISO code
regionIso = regionIso_example # String | Region ISO code
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get a list of stores for a given country and region
    api_response = api_instance.get_stores_by_country_and_region(baseSiteId, countryIso, regionIso, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StoresApi->getStoresByCountryAndRegion: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
countryIso*
String
Country ISO code
Required
regionIso*
String
Region ISO code
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


TransportBundles

getTransportBundleById

Get the bundle template

Returns the information about the transport bundle template with the given id. The response will contain the structure of the bundle alongside with the products.


/{baseSiteId}/catalogs/{catalogId}/transportBundles/{bundleId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/catalogs/{catalogId}/transportBundles/{bundleId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportBundlesApi;

import java.io.File;
import java.util.*;

public class TransportBundlesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportBundlesApi apiInstance = new TransportBundlesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String bundleId = bundleId_example; // String | Bundle template identifier
        String catalogId = catalogId_example; // String | Catalog identifier
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            TravelBundleTemplate result = apiInstance.getTransportBundleById(baseSiteId, bundleId, catalogId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportBundlesApi#getTransportBundleById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportBundlesApi;

public class TransportBundlesApiExample {

    public static void main(String[] args) {
        TransportBundlesApi apiInstance = new TransportBundlesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String bundleId = bundleId_example; // String | Bundle template identifier
        String catalogId = catalogId_example; // String | Catalog identifier
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            TravelBundleTemplate result = apiInstance.getTransportBundleById(baseSiteId, bundleId, catalogId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportBundlesApi#getTransportBundleById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *bundleId = bundleId_example; // Bundle template identifier
String *catalogId = catalogId_example; // Catalog identifier
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TransportBundlesApi *apiInstance = [[TransportBundlesApi alloc] init];

// Get the bundle template
[apiInstance getTransportBundleByIdWith:baseSiteId
    bundleId:bundleId
    catalogId:catalogId
    acceptLanguage:acceptLanguage
              completionHandler: ^(TravelBundleTemplate output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportBundlesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var bundleId = bundleId_example; // {{String}} Bundle template identifier
var catalogId = catalogId_example; // {{String}} Catalog identifier
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransportBundleById(baseSiteId, bundleId, catalogId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTransportBundleByIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportBundlesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var bundleId = bundleId_example;  // String | Bundle template identifier
            var catalogId = catalogId_example;  // String | Catalog identifier
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get the bundle template
                TravelBundleTemplate result = apiInstance.getTransportBundleById(baseSiteId, bundleId, catalogId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportBundlesApi.getTransportBundleById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportBundlesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$bundleId = bundleId_example; // String | Bundle template identifier
$catalogId = catalogId_example; // String | Catalog identifier
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getTransportBundleById($baseSiteId, $bundleId, $catalogId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportBundlesApi->getTransportBundleById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportBundlesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportBundlesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $bundleId = bundleId_example; # String | Bundle template identifier
my $catalogId = catalogId_example; # String | Catalog identifier
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getTransportBundleById(baseSiteId => $baseSiteId, bundleId => $bundleId, catalogId => $catalogId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportBundlesApi->getTransportBundleById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportBundlesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
bundleId = bundleId_example # String | Bundle template identifier
catalogId = catalogId_example # String | Catalog identifier
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get the bundle template
    api_response = api_instance.get_transport_bundle_by_id(baseSiteId, bundleId, catalogId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportBundlesApi->getTransportBundleById: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
bundleId*
String
Bundle template identifier
Required
catalogId*
String
Catalog identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


TransportCarts

addAncillaryToCart

Add ancillary entry to cart

Perform the add ancilary entry to cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        AncillaryEntryRequest body = ; // AncillaryEntryRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addAncillaryToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#addAncillaryToCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        AncillaryEntryRequest body = ; // AncillaryEntryRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addAncillaryToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#addAncillaryToCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AncillaryEntryRequest *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Add ancillary entry to cart
[apiInstance addAncillaryToCartWith:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var body = ; // {{AncillaryEntryRequest}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAncillaryToCart(bodysap.cxSalesApplicationbaseSiteIdcartIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addAncillaryToCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var body = new AncillaryEntryRequest(); // AncillaryEntryRequest | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Add ancillary entry to cart
                'String' result = apiInstance.addAncillaryToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.addAncillaryToCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$body = ; // AncillaryEntryRequest | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->addAncillaryToCart($body, $sap.cxSalesApplication, $baseSiteId, $cartId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->addAncillaryToCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $body = WWW::SwaggerClient::Object::AncillaryEntryRequest->new(); # AncillaryEntryRequest | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->addAncillaryToCart(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->addAncillaryToCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
body =  # AncillaryEntryRequest | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Add ancillary entry to cart
    api_response = api_instance.add_ancillary_to_cart(body, sap.cxSalesApplication, baseSiteId, cartId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->addAncillaryToCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


addSeatsToCart

Add seat to cart

Performs the add seat to cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/seatEntries

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/seatEntries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        SeatEntryRequest body = ; // SeatEntryRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addSeatsToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#addSeatsToCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        SeatEntryRequest body = ; // SeatEntryRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addSeatsToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#addSeatsToCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
SeatEntryRequest *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Add seat to cart
[apiInstance addSeatsToCartWith:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var body = ; // {{SeatEntryRequest}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addSeatsToCart(bodysap.cxSalesApplicationbaseSiteIdcartIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addSeatsToCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var body = new SeatEntryRequest(); // SeatEntryRequest | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Add seat to cart
                'String' result = apiInstance.addSeatsToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.addSeatsToCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$body = ; // SeatEntryRequest | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->addSeatsToCart($body, $sap.cxSalesApplication, $baseSiteId, $cartId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->addSeatsToCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $body = WWW::SwaggerClient::Object::SeatEntryRequest->new(); # SeatEntryRequest | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->addSeatsToCart(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->addSeatsToCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
body =  # SeatEntryRequest | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Add seat to cart
    api_response = api_instance.add_seats_to_cart(body, sap.cxSalesApplication, baseSiteId, cartId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->addSeatsToCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


addTransportBundleToCart

Perform the add bundle to cart.

Add a fare bundle having the provided bundleTemplateId and the product with the same fareProductCode, for the bound specified by the originDestinationRefNumberand for each traveller already added in the cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/bounds

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/bounds"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        AddBoundToCartRequest body = ; // AddBoundToCartRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addTransportBundleToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#addTransportBundleToCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        AddBoundToCartRequest body = ; // AddBoundToCartRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addTransportBundleToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#addTransportBundleToCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AddBoundToCartRequest *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Perform the add bundle to cart.
[apiInstance addTransportBundleToCartWith:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var body = ; // {{AddBoundToCartRequest}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addTransportBundleToCart(bodysap.cxSalesApplicationbaseSiteIdcartIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addTransportBundleToCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var body = new AddBoundToCartRequest(); // AddBoundToCartRequest | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Perform the add bundle to cart.
                'String' result = apiInstance.addTransportBundleToCart(body, sap.cxSalesApplication, baseSiteId, cartId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.addTransportBundleToCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$body = ; // AddBoundToCartRequest | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->addTransportBundleToCart($body, $sap.cxSalesApplication, $baseSiteId, $cartId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->addTransportBundleToCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $body = WWW::SwaggerClient::Object::AddBoundToCartRequest->new(); # AddBoundToCartRequest | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->addTransportBundleToCart(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->addTransportBundleToCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
body =  # AddBoundToCartRequest | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Perform the add bundle to cart.
    api_response = api_instance.add_transport_bundle_to_cart(body, sap.cxSalesApplication, baseSiteId, cartId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->addTransportBundleToCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity)

Status: 500 - Server Error


addTravellersToCart

Add travellers to the given cart.

Add the travellers to the given cart to be used to perform add to cart operations. Those travellers can be considered as an abstraction of the physical people travelling and define the passenger type composition of the booking.


/{baseSiteId}/users/{userId}/carts/{cartId}/travellers

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/travellers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        TravellerQuantityList body = ; // TravellerQuantityList | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addTravellersToCart(body, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#addTravellersToCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        TravellerQuantityList body = ; // TravellerQuantityList | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addTravellersToCart(body, baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#addTravellersToCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
TravellerQuantityList *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Add travellers to the given cart.
[apiInstance addTravellersToCartWith:body
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var body = ; // {{TravellerQuantityList}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addTravellersToCart(bodybaseSiteIdcartIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addTravellersToCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var body = new TravellerQuantityList(); // TravellerQuantityList | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Add travellers to the given cart.
                'String' result = apiInstance.addTravellersToCart(body, baseSiteId, cartId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.addTravellersToCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$body = ; // TravellerQuantityList | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->addTravellersToCart($body, $baseSiteId, $cartId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->addTravellersToCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $body = WWW::SwaggerClient::Object::TravellerQuantityList->new(); # TravellerQuantityList | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->addTravellersToCart(body => $body, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->addTravellersToCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
body =  # TravellerQuantityList | 
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Add travellers to the given cart.
    api_response = api_instance.add_travellers_to_cart(body, baseSiteId, cartId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->addTravellersToCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity)

Status: 500 - Server Error


getAncillaryEntry

Get the details of an ancillary entry.

Retrieves the details relative to a ancillary entry such as the unique identifier, price information alongside with an indication about the passengers and transport offerings associated.


/{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries/{entryId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries/{entryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.getAncillaryEntry(baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getAncillaryEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.getAncillaryEntry(baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getAncillaryEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *entryId = 56; // The entry identifier. Each entry in a cart has an entry identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Get the details of an ancillary entry.
[apiInstance getAncillaryEntryWith:baseSiteId
    cartId:cartId
    entryId:entryId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryId = 56; // {{Integer}} The entry identifier. Each entry in a cart has an entry identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAncillaryEntry(baseSiteId, cartId, entryId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAncillaryEntryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryId = 56;  // Integer | The entry identifier. Each entry in a cart has an entry identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Get the details of an ancillary entry.
                'String' result = apiInstance.getAncillaryEntry(baseSiteId, cartId, entryId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.getAncillaryEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->getAncillaryEntry($baseSiteId, $cartId, $entryId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->getAncillaryEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryId = 56; # Integer | The entry identifier. Each entry in a cart has an entry identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->getAncillaryEntry(baseSiteId => $baseSiteId, cartId => $cartId, entryId => $entryId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->getAncillaryEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryId = 56 # Integer | The entry identifier. Each entry in a cart has an entry identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Get the details of an ancillary entry.
    api_response = api_instance.get_ancillary_entry(baseSiteId, cartId, entryId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->getAncillaryEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryId*
Integer (int32)
The entry identifier. Each entry in a cart has an entry identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getAvailableAncillaries

Searches for all available ancillaries

Searches for all available ancillaries for a given cart id.


/{baseSiteId}/users/{userId}/carts/{cartId}/ancillaries

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json,application/xml"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/ancillaries?transportOfferingCodes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        array[String] transportOfferingCodes = ; // array[String] | The transport offerings for which the ancillaries are returned
        try {
            AncillaryResponse result = apiInstance.getAvailableAncillaries(baseSiteId, cartId, sap.cxSalesApplication, userId, acceptLanguage, transportOfferingCodes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getAvailableAncillaries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        array[String] transportOfferingCodes = ; // array[String] | The transport offerings for which the ancillaries are returned
        try {
            AncillaryResponse result = apiInstance.getAvailableAncillaries(baseSiteId, cartId, sap.cxSalesApplication, userId, acceptLanguage, transportOfferingCodes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getAvailableAncillaries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
array[String] *transportOfferingCodes = ; // The transport offerings for which the ancillaries are returned (optional)

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Searches for all available ancillaries
[apiInstance getAvailableAncillariesWith:baseSiteId
    cartId:cartId
    sap.cxSalesApplication:sap.cxSalesApplication
    userId:userId
    acceptLanguage:acceptLanguage
    transportOfferingCodes:transportOfferingCodes
              completionHandler: ^(AncillaryResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'transportOfferingCodes':  // {{array[String]}} The transport offerings for which the ancillaries are returned
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvailableAncillaries(baseSiteId, cartId, sap.cxSalesApplication, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAvailableAncillariesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var transportOfferingCodes = new array[String](); // array[String] | The transport offerings for which the ancillaries are returned (optional) 

            try
            {
                // Searches for all available ancillaries
                AncillaryResponse result = apiInstance.getAvailableAncillaries(baseSiteId, cartId, sap.cxSalesApplication, userId, acceptLanguage, transportOfferingCodes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.getAvailableAncillaries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$transportOfferingCodes = ; // array[String] | The transport offerings for which the ancillaries are returned

try {
    $result = $api_instance->getAvailableAncillaries($baseSiteId, $cartId, $sap.cxSalesApplication, $userId, $acceptLanguage, $transportOfferingCodes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->getAvailableAncillaries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $transportOfferingCodes = []; # array[String] | The transport offerings for which the ancillaries are returned

eval { 
    my $result = $api_instance->getAvailableAncillaries(baseSiteId => $baseSiteId, cartId => $cartId, sap.cxSalesApplication => $sap.cxSalesApplication, userId => $userId, acceptLanguage => $acceptLanguage, transportOfferingCodes => $transportOfferingCodes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->getAvailableAncillaries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
transportOfferingCodes =  # array[String] | The transport offerings for which the ancillaries are returned (optional)

try: 
    # Searches for all available ancillaries
    api_response = api_instance.get_available_ancillaries(baseSiteId, cartId, sap.cxSalesApplication, userId, acceptLanguage=acceptLanguage, transportOfferingCodes=transportOfferingCodes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->getAvailableAncillaries: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-sales-application*
String
The sales application code
Required
Query parameters
Name Description
transportOfferingCodes
array[String]
The transport offerings for which the ancillaries are returned

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity)

Status: 500 - Server Error


getSeatEntry

Get the details of a seat entry.

Retrieves the details relative to a seat entry such as the unique identifier, price information alongside with an indication about the passengers and transport offerings associated.


/{baseSiteId}/users/{userId}/carts/{cartId}/seatEntries/{entryId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/seatEntries/{entryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.getSeatEntry(baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getSeatEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.getSeatEntry(baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getSeatEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *entryId = 56; // The entry identifier. Each entry in a cart has an entry identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Get the details of a seat entry.
[apiInstance getSeatEntryWith:baseSiteId
    cartId:cartId
    entryId:entryId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryId = 56; // {{Integer}} The entry identifier. Each entry in a cart has an entry identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSeatEntry(baseSiteId, cartId, entryId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSeatEntryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryId = 56;  // Integer | The entry identifier. Each entry in a cart has an entry identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Get the details of a seat entry.
                'String' result = apiInstance.getSeatEntry(baseSiteId, cartId, entryId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.getSeatEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->getSeatEntry($baseSiteId, $cartId, $entryId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->getSeatEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryId = 56; # Integer | The entry identifier. Each entry in a cart has an entry identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->getSeatEntry(baseSiteId => $baseSiteId, cartId => $cartId, entryId => $entryId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->getSeatEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryId = 56 # Integer | The entry identifier. Each entry in a cart has an entry identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Get the details of a seat entry.
    api_response = api_instance.get_seat_entry(baseSiteId, cartId, entryId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->getSeatEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryId*
Integer (int32)
The entry identifier. Each entry in a cart has an entry identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


getSeatMap

Gets the seat map

Retrieves the seat map for the current cart


/{baseSiteId}/users/{userId}/carts/{cartId}/seatmap

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/seatmap?transportOfferingCodes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        array[String] transportOfferingCodes = ; // array[String] | The codes of transport offerings the seatmap will be returned for orders
        try {
            SeatMapResponse result = apiInstance.getSeatMap(baseSiteId, cartId, sap.cxSalesApplication, userId, acceptLanguage, transportOfferingCodes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getSeatMap");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        array[String] transportOfferingCodes = ; // array[String] | The codes of transport offerings the seatmap will be returned for orders
        try {
            SeatMapResponse result = apiInstance.getSeatMap(baseSiteId, cartId, sap.cxSalesApplication, userId, acceptLanguage, transportOfferingCodes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getSeatMap");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
array[String] *transportOfferingCodes = ; // The codes of transport offerings the seatmap will be returned for orders (optional)

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Gets the seat map
[apiInstance getSeatMapWith:baseSiteId
    cartId:cartId
    sap.cxSalesApplication:sap.cxSalesApplication
    userId:userId
    acceptLanguage:acceptLanguage
    transportOfferingCodes:transportOfferingCodes
              completionHandler: ^(SeatMapResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'transportOfferingCodes':  // {{array[String]}} The codes of transport offerings the seatmap will be returned for orders
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSeatMap(baseSiteId, cartId, sap.cxSalesApplication, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSeatMapExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var transportOfferingCodes = new array[String](); // array[String] | The codes of transport offerings the seatmap will be returned for orders (optional) 

            try
            {
                // Gets the seat map
                SeatMapResponse result = apiInstance.getSeatMap(baseSiteId, cartId, sap.cxSalesApplication, userId, acceptLanguage, transportOfferingCodes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.getSeatMap: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$transportOfferingCodes = ; // array[String] | The codes of transport offerings the seatmap will be returned for orders

try {
    $result = $api_instance->getSeatMap($baseSiteId, $cartId, $sap.cxSalesApplication, $userId, $acceptLanguage, $transportOfferingCodes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->getSeatMap: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $transportOfferingCodes = []; # array[String] | The codes of transport offerings the seatmap will be returned for orders

eval { 
    my $result = $api_instance->getSeatMap(baseSiteId => $baseSiteId, cartId => $cartId, sap.cxSalesApplication => $sap.cxSalesApplication, userId => $userId, acceptLanguage => $acceptLanguage, transportOfferingCodes => $transportOfferingCodes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->getSeatMap: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
transportOfferingCodes =  # array[String] | The codes of transport offerings the seatmap will be returned for orders (optional)

try: 
    # Gets the seat map
    api_response = api_instance.get_seat_map(baseSiteId, cartId, sap.cxSalesApplication, userId, acceptLanguage=acceptLanguage, transportOfferingCodes=transportOfferingCodes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->getSeatMap: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
sap.cx-sales-application*
String
The sales application code
Required
Query parameters
Name Description
transportOfferingCodes
array[String]
The codes of transport offerings the seatmap will be returned for orders

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity


getTraveller

Retrieves the traveller information.

Retrieves the information for a specific traveller in the cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getTraveller(baseSiteId, cartId, travellerId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getTraveller");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getTraveller(baseSiteId, cartId, travellerId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getTraveller");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *travellerId = travellerId_example; // Traveller identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Retrieves the traveller information.
[apiInstance getTravellerWith:baseSiteId
    cartId:cartId
    travellerId:travellerId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var travellerId = travellerId_example; // {{String}} Traveller identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTraveller(baseSiteId, cartId, travellerId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTravellerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var travellerId = travellerId_example;  // String | Traveller identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Retrieves the traveller information.
                'String' result = apiInstance.getTraveller(baseSiteId, cartId, travellerId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.getTraveller: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$travellerId = travellerId_example; // String | Traveller identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getTraveller($baseSiteId, $cartId, $travellerId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->getTraveller: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $travellerId = travellerId_example; # String | Traveller identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getTraveller(baseSiteId => $baseSiteId, cartId => $cartId, travellerId => $travellerId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->getTraveller: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
travellerId = travellerId_example # String | Traveller identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Retrieves the traveller information.
    api_response = api_instance.get_traveller(baseSiteId, cartId, travellerId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->getTraveller: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
travellerId*
String
Traveller identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getTravellers

Get travellers from the given cart.

Get the travellers from the given cart alongside with the information already provided for all of them.


/{baseSiteId}/users/{userId}/carts/{cartId}/travellers

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/travellers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getTravellers(baseSiteId, cartId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getTravellers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getTravellers(baseSiteId, cartId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#getTravellers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Get travellers from the given cart.
[apiInstance getTravellersWith:baseSiteId
    cartId:cartId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTravellers(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTravellersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get travellers from the given cart.
                'String' result = apiInstance.getTravellers(baseSiteId, cartId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.getTravellers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getTravellers($baseSiteId, $cartId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->getTravellers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getTravellers(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->getTravellers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get travellers from the given cart.
    api_response = api_instance.get_travellers(baseSiteId, cartId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->getTravellers: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


removeAncillaryCartEntry

Deletes ancillary entry.

Performs the deletes ancillary entry.


/{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries/{entryId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries/{entryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeAncillaryCartEntry(baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#removeAncillaryCartEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeAncillaryCartEntry(baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#removeAncillaryCartEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *entryId = 56; // The entry identifier. Each entry in a cart has an entry identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Deletes ancillary entry.
[apiInstance removeAncillaryCartEntryWith:baseSiteId
    cartId:cartId
    entryId:entryId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryId = 56; // {{Integer}} The entry identifier. Each entry in a cart has an entry identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeAncillaryCartEntry(baseSiteId, cartId, entryId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeAncillaryCartEntryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryId = 56;  // Integer | The entry identifier. Each entry in a cart has an entry identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Deletes ancillary entry.
                'String' result = apiInstance.removeAncillaryCartEntry(baseSiteId, cartId, entryId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.removeAncillaryCartEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->removeAncillaryCartEntry($baseSiteId, $cartId, $entryId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->removeAncillaryCartEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryId = 56; # Integer | The entry identifier. Each entry in a cart has an entry identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->removeAncillaryCartEntry(baseSiteId => $baseSiteId, cartId => $cartId, entryId => $entryId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->removeAncillaryCartEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryId = 56 # Integer | The entry identifier. Each entry in a cart has an entry identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Deletes ancillary entry.
    api_response = api_instance.remove_ancillary_cart_entry(baseSiteId, cartId, entryId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->removeAncillaryCartEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryId*
Integer (int32)
The entry identifier. Each entry in a cart has an entry identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


removeBoundFromCart

Perform the remove bound from cart.

Each bundle or an ancillary added to a bound have abound id mapped to them. Removing a bound will remove all the associated bundles and ancillary for the bound


/{baseSiteId}/users/{userId}/carts/{cartId}/bounds/{boundId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/bounds/{boundId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String boundId = boundId_example; // String | The bound id. Each entry of a bound have a bound id mapped to it
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeBoundFromCart(baseSiteId, boundId, cartId, sap.cxSalesApplication, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#removeBoundFromCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String boundId = boundId_example; // String | The bound id. Each entry of a bound have a bound id mapped to it
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeBoundFromCart(baseSiteId, boundId, cartId, sap.cxSalesApplication, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#removeBoundFromCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *boundId = boundId_example; // The bound id. Each entry of a bound have a bound id mapped to it
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Perform the remove bound from cart.
[apiInstance removeBoundFromCartWith:baseSiteId
    boundId:boundId
    cartId:cartId
    sap.cxSalesApplication:sap.cxSalesApplication
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var boundId = boundId_example; // {{String}} The bound id. Each entry of a bound have a bound id mapped to it
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeBoundFromCart(baseSiteId, boundId, cartId, sap.cxSalesApplication, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeBoundFromCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var boundId = boundId_example;  // String | The bound id. Each entry of a bound have a bound id mapped to it
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Perform the remove bound from cart.
                'String' result = apiInstance.removeBoundFromCart(baseSiteId, boundId, cartId, sap.cxSalesApplication, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.removeBoundFromCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$boundId = boundId_example; // String | The bound id. Each entry of a bound have a bound id mapped to it
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->removeBoundFromCart($baseSiteId, $boundId, $cartId, $sap.cxSalesApplication, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->removeBoundFromCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $boundId = boundId_example; # String | The bound id. Each entry of a bound have a bound id mapped to it
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->removeBoundFromCart(baseSiteId => $baseSiteId, boundId => $boundId, cartId => $cartId, sap.cxSalesApplication => $sap.cxSalesApplication, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->removeBoundFromCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
boundId = boundId_example # String | The bound id. Each entry of a bound have a bound id mapped to it
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Perform the remove bound from cart.
    api_response = api_instance.remove_bound_from_cart(baseSiteId, boundId, cartId, sap.cxSalesApplication, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->removeBoundFromCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
boundId*
String
The bound id. Each entry of a bound have a bound id mapped to it
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


removeSeatEntry

Deletes seat entry.

Deletes seat entry.


/{baseSiteId}/users/{userId}/carts/{cartId}/seatEntries/{entryId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/seatEntries/{entryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeSeatEntry(baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#removeSeatEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeSeatEntry(baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#removeSeatEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *entryId = 56; // The entry identifier. Each entry in a cart has an entry identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Deletes seat entry.
[apiInstance removeSeatEntryWith:baseSiteId
    cartId:cartId
    entryId:entryId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryId = 56; // {{Integer}} The entry identifier. Each entry in a cart has an entry identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeSeatEntry(baseSiteId, cartId, entryId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeSeatEntryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryId = 56;  // Integer | The entry identifier. Each entry in a cart has an entry identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Deletes seat entry.
                'String' result = apiInstance.removeSeatEntry(baseSiteId, cartId, entryId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.removeSeatEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->removeSeatEntry($baseSiteId, $cartId, $entryId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->removeSeatEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryId = 56; # Integer | The entry identifier. Each entry in a cart has an entry identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->removeSeatEntry(baseSiteId => $baseSiteId, cartId => $cartId, entryId => $entryId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->removeSeatEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryId = 56 # Integer | The entry identifier. Each entry in a cart has an entry identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Deletes seat entry.
    api_response = api_instance.remove_seat_entry(baseSiteId, cartId, entryId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->removeSeatEntry: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryId*
Integer (int32)
The entry identifier. Each entry in a cart has an entry identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


removeTraveller

Remove a traveller from a cart.

Remove a traveller from a cart, together with all the associated reservation items.


/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String travellerId = travellerId_example; // String | Traveller unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeTraveller(baseSiteId, cartId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#removeTraveller");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String travellerId = travellerId_example; // String | Traveller unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeTraveller(baseSiteId, cartId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#removeTraveller");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *travellerId = travellerId_example; // Traveller unique identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Remove a traveller from a cart.
[apiInstance removeTravellerWith:baseSiteId
    cartId:cartId
    travellerId:travellerId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var travellerId = travellerId_example; // {{String}} Traveller unique identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeTraveller(baseSiteId, cartId, travellerId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeTravellerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var travellerId = travellerId_example;  // String | Traveller unique identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Remove a traveller from a cart.
                'String' result = apiInstance.removeTraveller(baseSiteId, cartId, travellerId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.removeTraveller: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$travellerId = travellerId_example; // String | Traveller unique identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->removeTraveller($baseSiteId, $cartId, $travellerId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->removeTraveller: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $travellerId = travellerId_example; # String | Traveller unique identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->removeTraveller(baseSiteId => $baseSiteId, cartId => $cartId, travellerId => $travellerId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->removeTraveller: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
travellerId = travellerId_example # String | Traveller unique identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Remove a traveller from a cart.
    api_response = api_instance.remove_traveller(baseSiteId, cartId, travellerId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->removeTraveller: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
travellerId*
String
Traveller unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


updateCartEntry1

Updates the specified fields of an ancillary entry in the cart.

Updates the specified fields of an ancillary entry in the cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries/{entryId}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/ancillaryEntries/{entryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        AncillaryEntryRequest body = ; // AncillaryEntryRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.updateCartEntry1(body, sap.cxSalesApplication, baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#updateCartEntry1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        AncillaryEntryRequest body = ; // AncillaryEntryRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        Integer entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.updateCartEntry1(body, sap.cxSalesApplication, baseSiteId, cartId, entryId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#updateCartEntry1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AncillaryEntryRequest *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *entryId = 56; // The entry identifier. Each entry in a cart has an entry identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Updates the specified fields of an ancillary entry in the cart.
[apiInstance updateCartEntry1With:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    cartId:cartId
    entryId:entryId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var body = ; // {{AncillaryEntryRequest}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var entryId = 56; // {{Integer}} The entry identifier. Each entry in a cart has an entry identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCartEntry1(bodysap.cxSalesApplicationbaseSiteIdcartIdentryIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCartEntry1Example
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var body = new AncillaryEntryRequest(); // AncillaryEntryRequest | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var entryId = 56;  // Integer | The entry identifier. Each entry in a cart has an entry identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Updates the specified fields of an ancillary entry in the cart.
                'String' result = apiInstance.updateCartEntry1(body, sap.cxSalesApplication, baseSiteId, cartId, entryId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.updateCartEntry1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$body = ; // AncillaryEntryRequest | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$entryId = 56; // Integer | The entry identifier. Each entry in a cart has an entry identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->updateCartEntry1($body, $sap.cxSalesApplication, $baseSiteId, $cartId, $entryId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->updateCartEntry1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $body = WWW::SwaggerClient::Object::AncillaryEntryRequest->new(); # AncillaryEntryRequest | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $entryId = 56; # Integer | The entry identifier. Each entry in a cart has an entry identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->updateCartEntry1(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, cartId => $cartId, entryId => $entryId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->updateCartEntry1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
body =  # AncillaryEntryRequest | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
entryId = 56 # Integer | The entry identifier. Each entry in a cart has an entry identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Updates the specified fields of an ancillary entry in the cart.
    api_response = api_instance.update_cart_entry1(body, sap.cxSalesApplication, baseSiteId, cartId, entryId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportCartsApi->updateCartEntry1: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
entryId*
Integer (int32)
The entry identifier. Each entry in a cart has an entry identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable entity: business rules validation errors, e.g., travel restrictions

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


updateTraveller

Updates the traveller information.

Updates the traveller information in the cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/travellers/{travellerId}?saveInProfile="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportCartsApi;

import java.io.File;
import java.util.*;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportCartsApi apiInstance = new TransportCartsApi();
        Traveller body = ; // Traveller | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String travellerId = travellerId_example; // String | The traveller identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        Boolean saveInProfile = true; // Boolean | Optional parameter. If the parameter is provided and its value is true, traveller details is saved in the profile.
        try {
            apiInstance.updateTraveller(body, baseSiteId, cartId, travellerId, userId, saveInProfile);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#updateTraveller");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportCartsApi;

public class TransportCartsApiExample {

    public static void main(String[] args) {
        TransportCartsApi apiInstance = new TransportCartsApi();
        Traveller body = ; // Traveller | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String travellerId = travellerId_example; // String | The traveller identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        Boolean saveInProfile = true; // Boolean | Optional parameter. If the parameter is provided and its value is true, traveller details is saved in the profile.
        try {
            apiInstance.updateTraveller(body, baseSiteId, cartId, travellerId, userId, saveInProfile);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportCartsApi#updateTraveller");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Traveller *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *travellerId = travellerId_example; // The traveller identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Boolean *saveInProfile = true; // Optional parameter. If the parameter is provided and its value is true, traveller details is saved in the profile. (optional)

TransportCartsApi *apiInstance = [[TransportCartsApi alloc] init];

// Updates the traveller information.
[apiInstance updateTravellerWith:body
    baseSiteId:baseSiteId
    cartId:cartId
    travellerId:travellerId
    userId:userId
    saveInProfile:saveInProfile
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportCartsApi()
var body = ; // {{Traveller}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var travellerId = travellerId_example; // {{String}} The traveller identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'saveInProfile': true // {{Boolean}} Optional parameter. If the parameter is provided and its value is true, traveller details is saved in the profile.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateTraveller(bodybaseSiteIdcartIdtravellerIduserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateTravellerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportCartsApi();
            var body = new Traveller(); // Traveller | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var travellerId = travellerId_example;  // String | The traveller identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var saveInProfile = true;  // Boolean | Optional parameter. If the parameter is provided and its value is true, traveller details is saved in the profile. (optional) 

            try
            {
                // Updates the traveller information.
                apiInstance.updateTraveller(body, baseSiteId, cartId, travellerId, userId, saveInProfile);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportCartsApi.updateTraveller: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportCartsApi();
$body = ; // Traveller | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$travellerId = travellerId_example; // String | The traveller identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$saveInProfile = true; // Boolean | Optional parameter. If the parameter is provided and its value is true, traveller details is saved in the profile.

try {
    $api_instance->updateTraveller($body, $baseSiteId, $cartId, $travellerId, $userId, $saveInProfile);
} catch (Exception $e) {
    echo 'Exception when calling TransportCartsApi->updateTraveller: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportCartsApi->new();
my $body = WWW::SwaggerClient::Object::Traveller->new(); # Traveller | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $travellerId = travellerId_example; # String | The traveller identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $saveInProfile = true; # Boolean | Optional parameter. If the parameter is provided and its value is true, traveller details is saved in the profile.

eval { 
    $api_instance->updateTraveller(body => $body, baseSiteId => $baseSiteId, cartId => $cartId, travellerId => $travellerId, userId => $userId, saveInProfile => $saveInProfile);
};
if ($@) {
    warn "Exception when calling TransportCartsApi->updateTraveller: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportCartsApi()
body =  # Traveller | 
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
travellerId = travellerId_example # String | The traveller identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
saveInProfile = true # Boolean | Optional parameter. If the parameter is provided and its value is true, traveller details is saved in the profile. (optional)

try: 
    # Updates the traveller information.
    api_instance.update_traveller(body, baseSiteId, cartId, travellerId, userId, saveInProfile=saveInProfile)
except ApiException as e:
    print("Exception when calling TransportCartsApi->updateTraveller: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
travellerId*
String
The traveller identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *
Query parameters
Name Description
saveInProfile
Boolean
Optional parameter. If the parameter is provided and its value is true, traveller details is saved in the profile.

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


TransportLocations

getDestinationSuggestions

Get location suggestions for destination

Get location suggestions for destination. If the origin is specified, it returns all the destinations that have a route for that origin.


/{baseSiteId}/destinationSuggestions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/destinationSuggestions?origin=&searchText="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportLocationsApi;

import java.io.File;
import java.util.*;

public class TransportLocationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportLocationsApi apiInstance = new TransportLocationsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String searchText = searchText_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String origin = origin_example; // String | 
        try {
            TransportLocationSuggestionResponse result = apiInstance.getDestinationSuggestions(baseSiteId, searchText, acceptLanguage, origin);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportLocationsApi#getDestinationSuggestions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportLocationsApi;

public class TransportLocationsApiExample {

    public static void main(String[] args) {
        TransportLocationsApi apiInstance = new TransportLocationsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String searchText = searchText_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String origin = origin_example; // String | 
        try {
            TransportLocationSuggestionResponse result = apiInstance.getDestinationSuggestions(baseSiteId, searchText, acceptLanguage, origin);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportLocationsApi#getDestinationSuggestions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *searchText = searchText_example; // 
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
String *origin = origin_example; //  (optional)

TransportLocationsApi *apiInstance = [[TransportLocationsApi alloc] init];

// Get location suggestions for destination
[apiInstance getDestinationSuggestionsWith:baseSiteId
    searchText:searchText
    acceptLanguage:acceptLanguage
    origin:origin
              completionHandler: ^(TransportLocationSuggestionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportLocationsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var searchText = searchText_example; // {{String}} 
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'origin': origin_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDestinationSuggestions(baseSiteId, searchText, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDestinationSuggestionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportLocationsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var searchText = searchText_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var origin = origin_example;  // String |  (optional) 

            try
            {
                // Get location suggestions for destination
                TransportLocationSuggestionResponse result = apiInstance.getDestinationSuggestions(baseSiteId, searchText, acceptLanguage, origin);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportLocationsApi.getDestinationSuggestions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportLocationsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$searchText = searchText_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$origin = origin_example; // String | 

try {
    $result = $api_instance->getDestinationSuggestions($baseSiteId, $searchText, $acceptLanguage, $origin);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportLocationsApi->getDestinationSuggestions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportLocationsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportLocationsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $searchText = searchText_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $origin = origin_example; # String | 

eval { 
    my $result = $api_instance->getDestinationSuggestions(baseSiteId => $baseSiteId, searchText => $searchText, acceptLanguage => $acceptLanguage, origin => $origin);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportLocationsApi->getDestinationSuggestions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportLocationsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
searchText = searchText_example # String | 
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
origin = origin_example # String |  (optional)

try: 
    # Get location suggestions for destination
    api_response = api_instance.get_destination_suggestions(baseSiteId, searchText, acceptLanguage=acceptLanguage, origin=origin)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportLocationsApi->getDestinationSuggestions: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
Query parameters
Name Description
origin
String
searchText*
String
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Unprocessable Entity


getOriginSuggestions

Get location suggestions for origin

Get location suggestions for origin. If the destination is specified, it returns all the origins that have a route for that destination.


/{baseSiteId}/originSuggestions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/originSuggestions?destination=&searchText="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportLocationsApi;

import java.io.File;
import java.util.*;

public class TransportLocationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportLocationsApi apiInstance = new TransportLocationsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String searchText = searchText_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String destination = destination_example; // String | 
        try {
            TransportLocationSuggestionResponse result = apiInstance.getOriginSuggestions(baseSiteId, searchText, acceptLanguage, destination);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportLocationsApi#getOriginSuggestions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportLocationsApi;

public class TransportLocationsApiExample {

    public static void main(String[] args) {
        TransportLocationsApi apiInstance = new TransportLocationsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String searchText = searchText_example; // String | 
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String destination = destination_example; // String | 
        try {
            TransportLocationSuggestionResponse result = apiInstance.getOriginSuggestions(baseSiteId, searchText, acceptLanguage, destination);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportLocationsApi#getOriginSuggestions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *searchText = searchText_example; // 
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
String *destination = destination_example; //  (optional)

TransportLocationsApi *apiInstance = [[TransportLocationsApi alloc] init];

// Get location suggestions for origin
[apiInstance getOriginSuggestionsWith:baseSiteId
    searchText:searchText
    acceptLanguage:acceptLanguage
    destination:destination
              completionHandler: ^(TransportLocationSuggestionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportLocationsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var searchText = searchText_example; // {{String}} 
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'destination': destination_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOriginSuggestions(baseSiteId, searchText, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOriginSuggestionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportLocationsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var searchText = searchText_example;  // String | 
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var destination = destination_example;  // String |  (optional) 

            try
            {
                // Get location suggestions for origin
                TransportLocationSuggestionResponse result = apiInstance.getOriginSuggestions(baseSiteId, searchText, acceptLanguage, destination);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportLocationsApi.getOriginSuggestions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportLocationsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$searchText = searchText_example; // String | 
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$destination = destination_example; // String | 

try {
    $result = $api_instance->getOriginSuggestions($baseSiteId, $searchText, $acceptLanguage, $destination);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportLocationsApi->getOriginSuggestions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportLocationsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportLocationsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $searchText = searchText_example; # String | 
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $destination = destination_example; # String | 

eval { 
    my $result = $api_instance->getOriginSuggestions(baseSiteId => $baseSiteId, searchText => $searchText, acceptLanguage => $acceptLanguage, destination => $destination);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportLocationsApi->getOriginSuggestions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportLocationsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
searchText = searchText_example # String | 
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
destination = destination_example # String |  (optional)

try: 
    # Get location suggestions for origin
    api_response = api_instance.get_origin_suggestions(baseSiteId, searchText, acceptLanguage=acceptLanguage, destination=destination)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportLocationsApi->getOriginSuggestions: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
Query parameters
Name Description
destination
String
searchText*
String
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Unprocessable Entity


TransportOfferings

getTransportOfferingByCode

Get a transport offering

Returns the information about the transport offering having the given code.


/{baseSiteId}/transportOfferings/{transportOfferingCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/transportOfferings/{transportOfferingCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportOfferingsApi;

import java.io.File;
import java.util.*;

public class TransportOfferingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportOfferingsApi apiInstance = new TransportOfferingsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String transportOfferingCode = transportOfferingCode_example; // String | The transport offering code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            TransportOfferingDetails result = apiInstance.getTransportOfferingByCode(baseSiteId, transportOfferingCode, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOfferingsApi#getTransportOfferingByCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportOfferingsApi;

public class TransportOfferingsApiExample {

    public static void main(String[] args) {
        TransportOfferingsApi apiInstance = new TransportOfferingsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String transportOfferingCode = transportOfferingCode_example; // String | The transport offering code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            TransportOfferingDetails result = apiInstance.getTransportOfferingByCode(baseSiteId, transportOfferingCode, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOfferingsApi#getTransportOfferingByCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *transportOfferingCode = transportOfferingCode_example; // The transport offering code
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TransportOfferingsApi *apiInstance = [[TransportOfferingsApi alloc] init];

// Get a transport offering
[apiInstance getTransportOfferingByCodeWith:baseSiteId
    transportOfferingCode:transportOfferingCode
    acceptLanguage:acceptLanguage
              completionHandler: ^(TransportOfferingDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportOfferingsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var transportOfferingCode = transportOfferingCode_example; // {{String}} The transport offering code
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransportOfferingByCode(baseSiteId, transportOfferingCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTransportOfferingByCodeExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportOfferingsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var transportOfferingCode = transportOfferingCode_example;  // String | The transport offering code
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get a transport offering
                TransportOfferingDetails result = apiInstance.getTransportOfferingByCode(baseSiteId, transportOfferingCode, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportOfferingsApi.getTransportOfferingByCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportOfferingsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$transportOfferingCode = transportOfferingCode_example; // String | The transport offering code
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getTransportOfferingByCode($baseSiteId, $transportOfferingCode, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportOfferingsApi->getTransportOfferingByCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportOfferingsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportOfferingsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $transportOfferingCode = transportOfferingCode_example; # String | The transport offering code
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getTransportOfferingByCode(baseSiteId => $baseSiteId, transportOfferingCode => $transportOfferingCode, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportOfferingsApi->getTransportOfferingByCode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportOfferingsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
transportOfferingCode = transportOfferingCode_example # String | The transport offering code
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get a transport offering
    api_response = api_instance.get_transport_offering_by_code(baseSiteId, transportOfferingCode, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportOfferingsApi->getTransportOfferingByCode: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
transportOfferingCode*
String
The transport offering code
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getTransportOfferings

Get transport offerings

Returns the information about the transport offerings having the given number, departure date and travel provider


/{baseSiteId}/transportOfferings

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/transportOfferings?departureDate=&transportOfferingNumber=&travelProviderCode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportOfferingsApi;

import java.io.File;
import java.util.*;

public class TransportOfferingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportOfferingsApi apiInstance = new TransportOfferingsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String departureDate = departureDate_example; // String | The departure date
        String transportOfferingNumber = transportOfferingNumber_example; // String | The transport offering number
        String travelProviderCode = travelProviderCode_example; // String | The travel provider code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            TransportOfferingList result = apiInstance.getTransportOfferings(baseSiteId, departureDate, transportOfferingNumber, travelProviderCode, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOfferingsApi#getTransportOfferings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportOfferingsApi;

public class TransportOfferingsApiExample {

    public static void main(String[] args) {
        TransportOfferingsApi apiInstance = new TransportOfferingsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String departureDate = departureDate_example; // String | The departure date
        String transportOfferingNumber = transportOfferingNumber_example; // String | The transport offering number
        String travelProviderCode = travelProviderCode_example; // String | The travel provider code
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            TransportOfferingList result = apiInstance.getTransportOfferings(baseSiteId, departureDate, transportOfferingNumber, travelProviderCode, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOfferingsApi#getTransportOfferings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *departureDate = departureDate_example; // The departure date
String *transportOfferingNumber = transportOfferingNumber_example; // The transport offering number
String *travelProviderCode = travelProviderCode_example; // The travel provider code
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TransportOfferingsApi *apiInstance = [[TransportOfferingsApi alloc] init];

// Get transport offerings
[apiInstance getTransportOfferingsWith:baseSiteId
    departureDate:departureDate
    transportOfferingNumber:transportOfferingNumber
    travelProviderCode:travelProviderCode
    acceptLanguage:acceptLanguage
              completionHandler: ^(TransportOfferingList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportOfferingsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var departureDate = departureDate_example; // {{String}} The departure date
var transportOfferingNumber = transportOfferingNumber_example; // {{String}} The transport offering number
var travelProviderCode = travelProviderCode_example; // {{String}} The travel provider code
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransportOfferings(baseSiteId, departureDate, transportOfferingNumber, travelProviderCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTransportOfferingsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportOfferingsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var departureDate = departureDate_example;  // String | The departure date
            var transportOfferingNumber = transportOfferingNumber_example;  // String | The transport offering number
            var travelProviderCode = travelProviderCode_example;  // String | The travel provider code
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get transport offerings
                TransportOfferingList result = apiInstance.getTransportOfferings(baseSiteId, departureDate, transportOfferingNumber, travelProviderCode, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportOfferingsApi.getTransportOfferings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportOfferingsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$departureDate = departureDate_example; // String | The departure date
$transportOfferingNumber = transportOfferingNumber_example; // String | The transport offering number
$travelProviderCode = travelProviderCode_example; // String | The travel provider code
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getTransportOfferings($baseSiteId, $departureDate, $transportOfferingNumber, $travelProviderCode, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportOfferingsApi->getTransportOfferings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportOfferingsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportOfferingsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $departureDate = departureDate_example; # String | The departure date
my $transportOfferingNumber = transportOfferingNumber_example; # String | The transport offering number
my $travelProviderCode = travelProviderCode_example; # String | The travel provider code
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getTransportOfferings(baseSiteId => $baseSiteId, departureDate => $departureDate, transportOfferingNumber => $transportOfferingNumber, travelProviderCode => $travelProviderCode, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportOfferingsApi->getTransportOfferings: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportOfferingsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
departureDate = departureDate_example # String | The departure date
transportOfferingNumber = transportOfferingNumber_example # String | The transport offering number
travelProviderCode = travelProviderCode_example # String | The travel provider code
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get transport offerings
    api_response = api_instance.get_transport_offerings(baseSiteId, departureDate, transportOfferingNumber, travelProviderCode, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportOfferingsApi->getTransportOfferings: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
Query parameters
Name Description
departureDate*
String
The departure date
Required
transportOfferingNumber*
String
The transport offering number
Required
travelProviderCode*
String
The travel provider code
Required

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


TransportOrders

addAdvancePassengerInformation

Add advance passenger information

Add advance passenger information to the specified traveller associated to the booking


/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/advancePassengerInformation

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/advancePassengerInformation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportOrdersApi;

import java.io.File;
import java.util.*;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportOrdersApi apiInstance = new TransportOrdersApi();
        AdvancePassengerInformation body = ; // AdvancePassengerInformation | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String travellerId = travellerId_example; // String | Traveller unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addAdvancePassengerInformation(body, baseSiteId, orderId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#addAdvancePassengerInformation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportOrdersApi;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        TransportOrdersApi apiInstance = new TransportOrdersApi();
        AdvancePassengerInformation body = ; // AdvancePassengerInformation | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String travellerId = travellerId_example; // String | Traveller unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.addAdvancePassengerInformation(body, baseSiteId, orderId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#addAdvancePassengerInformation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AdvancePassengerInformation *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
String *travellerId = travellerId_example; // Traveller unique identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportOrdersApi *apiInstance = [[TransportOrdersApi alloc] init];

// Add advance passenger information
[apiInstance addAdvancePassengerInformationWith:body
    baseSiteId:baseSiteId
    orderId:orderId
    travellerId:travellerId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportOrdersApi()
var body = ; // {{AdvancePassengerInformation}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var travellerId = travellerId_example; // {{String}} Traveller unique identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAdvancePassengerInformation(bodybaseSiteIdorderIdtravellerIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addAdvancePassengerInformationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportOrdersApi();
            var body = new AdvancePassengerInformation(); // AdvancePassengerInformation | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var travellerId = travellerId_example;  // String | Traveller unique identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Add advance passenger information
                'String' result = apiInstance.addAdvancePassengerInformation(body, baseSiteId, orderId, travellerId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportOrdersApi.addAdvancePassengerInformation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportOrdersApi();
$body = ; // AdvancePassengerInformation | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$travellerId = travellerId_example; // String | Traveller unique identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->addAdvancePassengerInformation($body, $baseSiteId, $orderId, $travellerId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportOrdersApi->addAdvancePassengerInformation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportOrdersApi->new();
my $body = WWW::SwaggerClient::Object::AdvancePassengerInformation->new(); # AdvancePassengerInformation | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $travellerId = travellerId_example; # String | Traveller unique identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->addAdvancePassengerInformation(body => $body, baseSiteId => $baseSiteId, orderId => $orderId, travellerId => $travellerId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportOrdersApi->addAdvancePassengerInformation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportOrdersApi()
body =  # AdvancePassengerInformation | 
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
travellerId = travellerId_example # String | Traveller unique identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Add advance passenger information
    api_response = api_instance.add_advance_passenger_information(body, baseSiteId, orderId, travellerId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportOrdersApi->addAdvancePassengerInformation: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
travellerId*
String
Traveller unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found)

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


cancelTransportReservation

Cancels the transport reservation from the given order

Cancel the transport reservation, releasing stocks and triggering refund procedure when applicable


/{baseSiteId}/users/{userId}/orders/{orderId}/reservations/transportReservation/cancel

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/reservations/transportReservation/cancel"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportOrdersApi;

import java.io.File;
import java.util.*;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.cancelTransportReservation(baseSiteId, orderId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#cancelTransportReservation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportOrdersApi;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.cancelTransportReservation(baseSiteId, orderId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#cancelTransportReservation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportOrdersApi *apiInstance = [[TransportOrdersApi alloc] init];

// Cancels the transport reservation from the given order
[apiInstance cancelTransportReservationWith:baseSiteId
    orderId:orderId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.cancelTransportReservation(baseSiteId, orderId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cancelTransportReservationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Cancels the transport reservation from the given order
                apiInstance.cancelTransportReservation(baseSiteId, orderId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportOrdersApi.cancelTransportReservation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->cancelTransportReservation($baseSiteId, $orderId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling TransportOrdersApi->cancelTransportReservation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->cancelTransportReservation(baseSiteId => $baseSiteId, orderId => $orderId, userId => $userId);
};
if ($@) {
    warn "Exception when calling TransportOrdersApi->cancelTransportReservation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Cancels the transport reservation from the given order
    api_instance.cancel_transport_reservation(baseSiteId, orderId, userId)
except ApiException as e:
    print("Exception when calling TransportOrdersApi->cancelTransportReservation: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found)

Status: 422 - Unprocessable Entity

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


checkinTraveller

Checks in a traveller

Performs the check in for the given traveller


/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/checkin

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/checkin?boundIdentifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportOrdersApi;

import java.io.File;
import java.util.*;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String boundIdentifier = boundIdentifier_example; // String | Specifies the bound the check in will be performed for.
        String orderId = orderId_example; // String | Order unique identifier
        String travellerId = travellerId_example; // String | Traveller unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.checkinTraveller(baseSiteId, boundIdentifier, orderId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#checkinTraveller");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportOrdersApi;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String boundIdentifier = boundIdentifier_example; // String | Specifies the bound the check in will be performed for.
        String orderId = orderId_example; // String | Order unique identifier
        String travellerId = travellerId_example; // String | Traveller unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.checkinTraveller(baseSiteId, boundIdentifier, orderId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#checkinTraveller");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *boundIdentifier = boundIdentifier_example; // Specifies the bound the check in will be performed for.
String *orderId = orderId_example; // Order unique identifier
String *travellerId = travellerId_example; // Traveller unique identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportOrdersApi *apiInstance = [[TransportOrdersApi alloc] init];

// Checks in a traveller
[apiInstance checkinTravellerWith:baseSiteId
    boundIdentifier:boundIdentifier
    orderId:orderId
    travellerId:travellerId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var boundIdentifier = boundIdentifier_example; // {{String}} Specifies the bound the check in will be performed for.
var orderId = orderId_example; // {{String}} Order unique identifier
var travellerId = travellerId_example; // {{String}} Traveller unique identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkinTraveller(baseSiteId, boundIdentifier, orderId, travellerId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkinTravellerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var boundIdentifier = boundIdentifier_example;  // String | Specifies the bound the check in will be performed for.
            var orderId = orderId_example;  // String | Order unique identifier
            var travellerId = travellerId_example;  // String | Traveller unique identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Checks in a traveller
                'String' result = apiInstance.checkinTraveller(baseSiteId, boundIdentifier, orderId, travellerId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportOrdersApi.checkinTraveller: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$boundIdentifier = boundIdentifier_example; // String | Specifies the bound the check in will be performed for.
$orderId = orderId_example; // String | Order unique identifier
$travellerId = travellerId_example; // String | Traveller unique identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->checkinTraveller($baseSiteId, $boundIdentifier, $orderId, $travellerId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportOrdersApi->checkinTraveller: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $boundIdentifier = boundIdentifier_example; # String | Specifies the bound the check in will be performed for.
my $orderId = orderId_example; # String | Order unique identifier
my $travellerId = travellerId_example; # String | Traveller unique identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->checkinTraveller(baseSiteId => $baseSiteId, boundIdentifier => $boundIdentifier, orderId => $orderId, travellerId => $travellerId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportOrdersApi->checkinTraveller: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
boundIdentifier = boundIdentifier_example # String | Specifies the bound the check in will be performed for.
orderId = orderId_example # String | Order unique identifier
travellerId = travellerId_example # String | Traveller unique identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Checks in a traveller
    api_response = api_instance.checkin_traveller(baseSiteId, boundIdentifier, orderId, travellerId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportOrdersApi->checkinTraveller: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
travellerId*
String
Traveller unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
boundIdentifier*
String
Specifies the bound the check in will be performed for.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found)

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


evaluateCancelTraveller

Evaluates if a traveller can be removed from the order

Evaluates if a traveller can be removed from the order returning information about the total refund if applicable


/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/evaluateCancel

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/evaluateCancel"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportOrdersApi;

import java.io.File;
import java.util.*;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String travellerId = travellerId_example; // String | Traveller unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            EvaluateCancelPriceInfoResponse result = apiInstance.evaluateCancelTraveller(baseSiteId, orderId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#evaluateCancelTraveller");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportOrdersApi;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String travellerId = travellerId_example; // String | Traveller unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            EvaluateCancelPriceInfoResponse result = apiInstance.evaluateCancelTraveller(baseSiteId, orderId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#evaluateCancelTraveller");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
String *travellerId = travellerId_example; // Traveller unique identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportOrdersApi *apiInstance = [[TransportOrdersApi alloc] init];

// Evaluates if a traveller can be removed from the order
[apiInstance evaluateCancelTravellerWith:baseSiteId
    orderId:orderId
    travellerId:travellerId
    userId:userId
              completionHandler: ^(EvaluateCancelPriceInfoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var travellerId = travellerId_example; // {{String}} Traveller unique identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.evaluateCancelTraveller(baseSiteId, orderId, travellerId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class evaluateCancelTravellerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var travellerId = travellerId_example;  // String | Traveller unique identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Evaluates if a traveller can be removed from the order
                EvaluateCancelPriceInfoResponse result = apiInstance.evaluateCancelTraveller(baseSiteId, orderId, travellerId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportOrdersApi.evaluateCancelTraveller: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$travellerId = travellerId_example; // String | Traveller unique identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->evaluateCancelTraveller($baseSiteId, $orderId, $travellerId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportOrdersApi->evaluateCancelTraveller: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $travellerId = travellerId_example; # String | Traveller unique identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->evaluateCancelTraveller(baseSiteId => $baseSiteId, orderId => $orderId, travellerId => $travellerId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportOrdersApi->evaluateCancelTraveller: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
travellerId = travellerId_example # String | Traveller unique identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Evaluates if a traveller can be removed from the order
    api_response = api_instance.evaluate_cancel_traveller(baseSiteId, orderId, travellerId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportOrdersApi->evaluateCancelTraveller: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
travellerId*
String
Traveller unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found)

Status: 422 - Unprocessable Entity

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getAdvancePassengerInformation

Get advance passenger information.

Get advance passenger information to the specified traveller associated to the booking.


/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/advancePassengerInformation

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}/advancePassengerInformation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportOrdersApi;

import java.io.File;
import java.util.*;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String travellerId = travellerId_example; // String | Traveller unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getAdvancePassengerInformation(baseSiteId, orderId, travellerId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#getAdvancePassengerInformation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportOrdersApi;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String travellerId = travellerId_example; // String | Traveller unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getAdvancePassengerInformation(baseSiteId, orderId, travellerId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#getAdvancePassengerInformation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
String *travellerId = travellerId_example; // Traveller unique identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TransportOrdersApi *apiInstance = [[TransportOrdersApi alloc] init];

// Get advance passenger information.
[apiInstance getAdvancePassengerInformationWith:baseSiteId
    orderId:orderId
    travellerId:travellerId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var travellerId = travellerId_example; // {{String}} Traveller unique identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAdvancePassengerInformation(baseSiteId, orderId, travellerId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAdvancePassengerInformationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var travellerId = travellerId_example;  // String | Traveller unique identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get advance passenger information.
                'String' result = apiInstance.getAdvancePassengerInformation(baseSiteId, orderId, travellerId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportOrdersApi.getAdvancePassengerInformation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$travellerId = travellerId_example; // String | Traveller unique identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getAdvancePassengerInformation($baseSiteId, $orderId, $travellerId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportOrdersApi->getAdvancePassengerInformation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $travellerId = travellerId_example; # String | Traveller unique identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getAdvancePassengerInformation(baseSiteId => $baseSiteId, orderId => $orderId, travellerId => $travellerId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportOrdersApi->getAdvancePassengerInformation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
travellerId = travellerId_example # String | Traveller unique identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get advance passenger information.
    api_response = api_instance.get_advance_passenger_information(baseSiteId, orderId, travellerId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportOrdersApi->getAdvancePassengerInformation: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
travellerId*
String
Traveller unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getOrderTraveller

Retrieves the traveller information.

Retrieves the information for a specific traveller in the order.


/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/travellers/{travellerId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportOrdersApi;

import java.io.File;
import java.util.*;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getOrderTraveller(baseSiteId, orderId, travellerId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#getOrderTraveller");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportOrdersApi;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String travellerId = travellerId_example; // String | Traveller identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getOrderTraveller(baseSiteId, orderId, travellerId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#getOrderTraveller");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
String *travellerId = travellerId_example; // Traveller identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TransportOrdersApi *apiInstance = [[TransportOrdersApi alloc] init];

// Retrieves the traveller information.
[apiInstance getOrderTravellerWith:baseSiteId
    orderId:orderId
    travellerId:travellerId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var travellerId = travellerId_example; // {{String}} Traveller identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderTraveller(baseSiteId, orderId, travellerId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrderTravellerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var travellerId = travellerId_example;  // String | Traveller identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Retrieves the traveller information.
                'String' result = apiInstance.getOrderTraveller(baseSiteId, orderId, travellerId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportOrdersApi.getOrderTraveller: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$travellerId = travellerId_example; // String | Traveller identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getOrderTraveller($baseSiteId, $orderId, $travellerId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportOrdersApi->getOrderTraveller: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $travellerId = travellerId_example; # String | Traveller identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getOrderTraveller(baseSiteId => $baseSiteId, orderId => $orderId, travellerId => $travellerId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportOrdersApi->getOrderTraveller: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
travellerId = travellerId_example # String | Traveller identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Retrieves the traveller information.
    api_response = api_instance.get_order_traveller(baseSiteId, orderId, travellerId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportOrdersApi->getOrderTraveller: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
travellerId*
String
Traveller identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getOrderTravellers

Get travellers from the given order.

Get the travellers from the given order alongside with the information already provided for all of them.


/{baseSiteId}/users/{userId}/orders/{orderId}/travellers

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/travellers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportOrdersApi;

import java.io.File;
import java.util.*;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getOrderTravellers(baseSiteId, orderId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#getOrderTravellers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportOrdersApi;

public class TransportOrdersApiExample {

    public static void main(String[] args) {
        TransportOrdersApi apiInstance = new TransportOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getOrderTravellers(baseSiteId, orderId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportOrdersApi#getOrderTravellers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TransportOrdersApi *apiInstance = [[TransportOrdersApi alloc] init];

// Get travellers from the given order.
[apiInstance getOrderTravellersWith:baseSiteId
    orderId:orderId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderTravellers(baseSiteId, orderId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrderTravellersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get travellers from the given order.
                'String' result = apiInstance.getOrderTravellers(baseSiteId, orderId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportOrdersApi.getOrderTravellers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getOrderTravellers($baseSiteId, $orderId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportOrdersApi->getOrderTravellers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getOrderTravellers(baseSiteId => $baseSiteId, orderId => $orderId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportOrdersApi->getOrderTravellers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get travellers from the given order.
    api_response = api_instance.get_order_travellers(baseSiteId, orderId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportOrdersApi->getOrderTravellers: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


TransportUsers

closeAccount

Delete customer profile.

Removes customer profile, allowing to close the account


/{baseSiteId}/users/{userId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportUsersApi;

import java.io.File;
import java.util.*;

public class TransportUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportUsersApi apiInstance = new TransportUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | The user id
        try {
            'String' result = apiInstance.closeAccount(baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportUsersApi#closeAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportUsersApi;

public class TransportUsersApiExample {

    public static void main(String[] args) {
        TransportUsersApi apiInstance = new TransportUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | The user id
        try {
            'String' result = apiInstance.closeAccount(baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportUsersApi#closeAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // The user id

TransportUsersApi *apiInstance = [[TransportUsersApi alloc] init];

// Delete customer profile.
[apiInstance closeAccountWith:baseSiteId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportUsersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} The user id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.closeAccount(baseSiteId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class closeAccountExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportUsersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | The user id

            try
            {
                // Delete customer profile.
                'String' result = apiInstance.closeAccount(baseSiteId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportUsersApi.closeAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportUsersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | The user id

try {
    $result = $api_instance->closeAccount($baseSiteId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportUsersApi->closeAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportUsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportUsersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | The user id

eval { 
    my $result = $api_instance->closeAccount(baseSiteId => $baseSiteId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportUsersApi->closeAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportUsersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | The user id

try: 
    # Delete customer profile.
    api_response = api_instance.close_account(baseSiteId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportUsersApi->closeAccount: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
The user id
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getSavedSearchesForUser

Get saved travellers

Retrieves all the saved searches.


/{baseSiteId}/users/{userId}/savedSearches

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/savedSearches"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportUsersApi;

import java.io.File;
import java.util.*;

public class TransportUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportUsersApi apiInstance = new TransportUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | The user id
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getSavedSearchesForUser(baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportUsersApi#getSavedSearchesForUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportUsersApi;

public class TransportUsersApiExample {

    public static void main(String[] args) {
        TransportUsersApi apiInstance = new TransportUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | The user id
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getSavedSearchesForUser(baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportUsersApi#getSavedSearchesForUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // The user id
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TransportUsersApi *apiInstance = [[TransportUsersApi alloc] init];

// Get saved travellers
[apiInstance getSavedSearchesForUserWith:baseSiteId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportUsersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} The user id
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSavedSearchesForUser(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSavedSearchesForUserExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportUsersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | The user id
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get saved travellers
                'String' result = apiInstance.getSavedSearchesForUser(baseSiteId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportUsersApi.getSavedSearchesForUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportUsersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | The user id
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getSavedSearchesForUser($baseSiteId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportUsersApi->getSavedSearchesForUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportUsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportUsersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | The user id
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getSavedSearchesForUser(baseSiteId => $baseSiteId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportUsersApi->getSavedSearchesForUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportUsersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | The user id
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get saved travellers
    api_response = api_instance.get_saved_searches_for_user(baseSiteId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportUsersApi->getSavedSearchesForUser: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
The user id
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


getSavedTravellers

Get saved travellers

Retrieves all the saved travellers for specific user. The response contains detailed traveller information.


/{baseSiteId}/users/{userId}/savedTravellers

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/savedTravellers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportUsersApi;

import java.io.File;
import java.util.*;

public class TransportUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportUsersApi apiInstance = new TransportUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getSavedTravellers(baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportUsersApi#getSavedTravellers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportUsersApi;

public class TransportUsersApiExample {

    public static void main(String[] args) {
        TransportUsersApi apiInstance = new TransportUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getSavedTravellers(baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportUsersApi#getSavedTravellers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TransportUsersApi *apiInstance = [[TransportUsersApi alloc] init];

// Get saved travellers
[apiInstance getSavedTravellersWith:baseSiteId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportUsersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSavedTravellers(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSavedTravellersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportUsersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get saved travellers
                'String' result = apiInstance.getSavedTravellers(baseSiteId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportUsersApi.getSavedTravellers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportUsersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getSavedTravellers($baseSiteId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportUsersApi->getSavedTravellers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportUsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportUsersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getSavedTravellers(baseSiteId => $baseSiteId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportUsersApi->getSavedTravellers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportUsersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get saved travellers
    api_response = api_instance.get_saved_travellers(baseSiteId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportUsersApi->getSavedTravellers: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


removeSavedSearch

Removes a saved search.

Removes the saved search identified by Id from the list of saved searches


/{baseSiteId}/users/{userId}/savedSearches/{savedSearchId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/savedSearches/{savedSearchId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportUsersApi;

import java.io.File;
import java.util.*;

public class TransportUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportUsersApi apiInstance = new TransportUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String savedSearchId = savedSearchId_example; // String | Saved Search Identifier
        String userId = userId_example; // String | The user id
        try {
            'String' result = apiInstance.removeSavedSearch(baseSiteId, savedSearchId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportUsersApi#removeSavedSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportUsersApi;

public class TransportUsersApiExample {

    public static void main(String[] args) {
        TransportUsersApi apiInstance = new TransportUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String savedSearchId = savedSearchId_example; // String | Saved Search Identifier
        String userId = userId_example; // String | The user id
        try {
            'String' result = apiInstance.removeSavedSearch(baseSiteId, savedSearchId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportUsersApi#removeSavedSearch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *savedSearchId = savedSearchId_example; // Saved Search Identifier
String *userId = userId_example; // The user id

TransportUsersApi *apiInstance = [[TransportUsersApi alloc] init];

// Removes a saved search.
[apiInstance removeSavedSearchWith:baseSiteId
    savedSearchId:savedSearchId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportUsersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var savedSearchId = savedSearchId_example; // {{String}} Saved Search Identifier
var userId = userId_example; // {{String}} The user id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeSavedSearch(baseSiteId, savedSearchId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeSavedSearchExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportUsersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var savedSearchId = savedSearchId_example;  // String | Saved Search Identifier
            var userId = userId_example;  // String | The user id

            try
            {
                // Removes a saved search.
                'String' result = apiInstance.removeSavedSearch(baseSiteId, savedSearchId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportUsersApi.removeSavedSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportUsersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$savedSearchId = savedSearchId_example; // String | Saved Search Identifier
$userId = userId_example; // String | The user id

try {
    $result = $api_instance->removeSavedSearch($baseSiteId, $savedSearchId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportUsersApi->removeSavedSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportUsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportUsersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $savedSearchId = savedSearchId_example; # String | Saved Search Identifier
my $userId = userId_example; # String | The user id

eval { 
    my $result = $api_instance->removeSavedSearch(baseSiteId => $baseSiteId, savedSearchId => $savedSearchId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportUsersApi->removeSavedSearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportUsersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
savedSearchId = savedSearchId_example # String | Saved Search Identifier
userId = userId_example # String | The user id

try: 
    # Removes a saved search.
    api_response = api_instance.remove_saved_search(baseSiteId, savedSearchId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportUsersApi->removeSavedSearch: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
savedSearchId*
String
Saved Search Identifier
Required
userId*
String
The user id
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


removeSavedtraveller

Delete a saved traveller

Deletes a traveller identified by id from the list of saved travellers for the given user.


/{baseSiteId}/users/{userId}/savedTravellers/{travellerId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/savedTravellers/{travellerId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransportUsersApi;

import java.io.File;
import java.util.*;

public class TransportUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TransportUsersApi apiInstance = new TransportUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String travellerId = travellerId_example; // String | Traveller identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeSavedtraveller(baseSiteId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportUsersApi#removeSavedtraveller");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransportUsersApi;

public class TransportUsersApiExample {

    public static void main(String[] args) {
        TransportUsersApi apiInstance = new TransportUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String travellerId = travellerId_example; // String | Traveller identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeSavedtraveller(baseSiteId, travellerId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransportUsersApi#removeSavedtraveller");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *travellerId = travellerId_example; // Traveller identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TransportUsersApi *apiInstance = [[TransportUsersApi alloc] init];

// Delete a saved traveller
[apiInstance removeSavedtravellerWith:baseSiteId
    travellerId:travellerId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TransportUsersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var travellerId = travellerId_example; // {{String}} Traveller identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeSavedtraveller(baseSiteId, travellerId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeSavedtravellerExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TransportUsersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var travellerId = travellerId_example;  // String | Traveller identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Delete a saved traveller
                'String' result = apiInstance.removeSavedtraveller(baseSiteId, travellerId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransportUsersApi.removeSavedtraveller: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTransportUsersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$travellerId = travellerId_example; // String | Traveller identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->removeSavedtraveller($baseSiteId, $travellerId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransportUsersApi->removeSavedtraveller: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransportUsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TransportUsersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $travellerId = travellerId_example; # String | Traveller identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->removeSavedtraveller(baseSiteId => $baseSiteId, travellerId => $travellerId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransportUsersApi->removeSavedtraveller: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TransportUsersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
travellerId = travellerId_example # String | Traveller identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Delete a saved traveller
    api_response = api_instance.remove_savedtraveller(baseSiteId, travellerId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransportUsersApi->removeSavedtraveller: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
travellerId*
String
Traveller identifier.
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


TravelBaseSites

getCurrencies

Get a list of available currencies.

Lists all available currencies (all usable currencies for the current store). If the list of currencies for a base store is empty, a list of all currencies available in the system is returned.


/{baseSiteId}/currencies

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/currencies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelBaseSitesApi;

import java.io.File;
import java.util.*;

public class TravelBaseSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelBaseSitesApi apiInstance = new TravelBaseSitesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            CurrencyList result = apiInstance.getCurrencies(baseSiteId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelBaseSitesApi#getCurrencies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelBaseSitesApi;

public class TravelBaseSitesApiExample {

    public static void main(String[] args) {
        TravelBaseSitesApi apiInstance = new TravelBaseSitesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            CurrencyList result = apiInstance.getCurrencies(baseSiteId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelBaseSitesApi#getCurrencies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TravelBaseSitesApi *apiInstance = [[TravelBaseSitesApi alloc] init];

// Get a list of available currencies.
[apiInstance getCurrenciesWith:baseSiteId
    acceptLanguage:acceptLanguage
              completionHandler: ^(CurrencyList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelBaseSitesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCurrencies(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCurrenciesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelBaseSitesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get a list of available currencies.
                CurrencyList result = apiInstance.getCurrencies(baseSiteId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelBaseSitesApi.getCurrencies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelBaseSitesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getCurrencies($baseSiteId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelBaseSitesApi->getCurrencies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelBaseSitesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelBaseSitesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getCurrencies(baseSiteId => $baseSiteId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelBaseSitesApi->getCurrencies: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelBaseSitesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get a list of available currencies.
    api_response = api_instance.get_currencies(baseSiteId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelBaseSitesApi->getCurrencies: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


getLanguages

Get a list of available languages.

Lists all available languages (all languages used for a particular store). If the list of languages for a base store is empty, a list of all languages available in the system will be returned.


/{baseSiteId}/languages

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/languages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelBaseSitesApi;

import java.io.File;
import java.util.*;

public class TravelBaseSitesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelBaseSitesApi apiInstance = new TravelBaseSitesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getLanguages(baseSiteId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelBaseSitesApi#getLanguages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelBaseSitesApi;

public class TravelBaseSitesApiExample {

    public static void main(String[] args) {
        TravelBaseSitesApi apiInstance = new TravelBaseSitesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getLanguages(baseSiteId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelBaseSitesApi#getLanguages");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TravelBaseSitesApi *apiInstance = [[TravelBaseSitesApi alloc] init];

// Get a list of available languages.
[apiInstance getLanguagesWith:baseSiteId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelBaseSitesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLanguages(baseSiteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLanguagesExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelBaseSitesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get a list of available languages.
                'String' result = apiInstance.getLanguages(baseSiteId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelBaseSitesApi.getLanguages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelBaseSitesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getLanguages($baseSiteId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelBaseSitesApi->getLanguages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelBaseSitesApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelBaseSitesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getLanguages(baseSiteId => $baseSiteId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelBaseSitesApi->getLanguages: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelBaseSitesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get a list of available languages.
    api_response = api_instance.get_languages(baseSiteId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelBaseSitesApi->getLanguages: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


TravelCarts

assignEmail

Assigns an email to the cart.

Assigns an email to the cart. This step is required to make a guest checkout.


/{baseSiteId}/users/{userId}/carts/{cartId}/email

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/email?email="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelCartsApi;

import java.io.File;
import java.util.*;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String email = email_example; // String | Email of the guest user. It will be used during the checkout process.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.assignEmail(baseSiteId, cartId, email, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#assignEmail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelCartsApi;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String email = email_example; // String | Email of the guest user. It will be used during the checkout process.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.assignEmail(baseSiteId, cartId, email, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#assignEmail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *email = email_example; // Email of the guest user. It will be used during the checkout process.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelCartsApi *apiInstance = [[TravelCartsApi alloc] init];

// Assigns an email to the cart.
[apiInstance assignEmailWith:baseSiteId
    cartId:cartId
    email:email
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var email = email_example; // {{String}} Email of the guest user. It will be used during the checkout process.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.assignEmail(baseSiteId, cartId, email, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assignEmailExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var email = email_example;  // String | Email of the guest user. It will be used during the checkout process.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Assigns an email to the cart.
                apiInstance.assignEmail(baseSiteId, cartId, email, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelCartsApi.assignEmail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$email = email_example; // String | Email of the guest user. It will be used during the checkout process.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->assignEmail($baseSiteId, $cartId, $email, $userId);
} catch (Exception $e) {
    echo 'Exception when calling TravelCartsApi->assignEmail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $email = email_example; # String | Email of the guest user. It will be used during the checkout process.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->assignEmail(baseSiteId => $baseSiteId, cartId => $cartId, email => $email, userId => $userId);
};
if ($@) {
    warn "Exception when calling TravelCartsApi->assignEmail: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
email = email_example # String | Email of the guest user. It will be used during the checkout process.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Assigns an email to the cart.
    api_instance.assign_email(baseSiteId, cartId, email, userId)
except ApiException as e:
    print("Exception when calling TravelCartsApi->assignEmail: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
email*
String
Email of the guest user. It will be used during the checkout process.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


changeCurrency

Changes currency against the given cart.

Sets the currency specified in the request parameter if allowed and recalculates the cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/currency

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/currency?currencyISO="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelCartsApi;

import java.io.File;
import java.util.*;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String currencyISO = currencyISO_example; // String | The ISO code if the currency to be set
        try {
            apiInstance.changeCurrency(baseSiteId, cartId, userId, currencyISO);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#changeCurrency");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelCartsApi;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String currencyISO = currencyISO_example; // String | The ISO code if the currency to be set
        try {
            apiInstance.changeCurrency(baseSiteId, cartId, userId, currencyISO);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#changeCurrency");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *currencyISO = currencyISO_example; // The ISO code if the currency to be set (optional)

TravelCartsApi *apiInstance = [[TravelCartsApi alloc] init];

// Changes currency against the given cart.
[apiInstance changeCurrencyWith:baseSiteId
    cartId:cartId
    userId:userId
    currencyISO:currencyISO
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'currencyISO': currencyISO_example // {{String}} The ISO code if the currency to be set
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.changeCurrency(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class changeCurrencyExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var currencyISO = currencyISO_example;  // String | The ISO code if the currency to be set (optional) 

            try
            {
                // Changes currency against the given cart.
                apiInstance.changeCurrency(baseSiteId, cartId, userId, currencyISO);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelCartsApi.changeCurrency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$currencyISO = currencyISO_example; // String | The ISO code if the currency to be set

try {
    $api_instance->changeCurrency($baseSiteId, $cartId, $userId, $currencyISO);
} catch (Exception $e) {
    echo 'Exception when calling TravelCartsApi->changeCurrency: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $currencyISO = currencyISO_example; # String | The ISO code if the currency to be set

eval { 
    $api_instance->changeCurrency(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, currencyISO => $currencyISO);
};
if ($@) {
    warn "Exception when calling TravelCartsApi->changeCurrency: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
currencyISO = currencyISO_example # String | The ISO code if the currency to be set (optional)

try: 
    # Changes currency against the given cart.
    api_instance.change_currency(baseSiteId, cartId, userId, currencyISO=currencyISO)
except ApiException as e:
    print("Exception when calling TravelCartsApi->changeCurrency: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
currencyISO
String
The ISO code if the currency to be set

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


createCart

Creates or restore a cart for a user

Creates a new cart or restores an anonymous cart as a user's cart (if an old Cart Id is given in the request). In case an order identifier is provided a cart will be created from the given order acting as an amendment cart.


/{baseSiteId}/users/{userId}/carts

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts?fromOrderGuid=&fromOrderId=&oldCartId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelCartsApi;

import java.io.File;
import java.util.*;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fromOrderGuid = fromOrderGuid_example; // String | Guest existing order unique identifier
        String fromOrderId = fromOrderId_example; // String | Existing order unique identifier
        String oldCartId = oldCartId_example; // String | Anonymous cart GUID that will replace the user cart.
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        try {
            'String' result = apiInstance.createCart(baseSiteId, userId, fromOrderGuid, fromOrderId, oldCartId, sap.cxAcceptCurrency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#createCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelCartsApi;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String fromOrderGuid = fromOrderGuid_example; // String | Guest existing order unique identifier
        String fromOrderId = fromOrderId_example; // String | Existing order unique identifier
        String oldCartId = oldCartId_example; // String | Anonymous cart GUID that will replace the user cart.
        String sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client
        try {
            'String' result = apiInstance.createCart(baseSiteId, userId, fromOrderGuid, fromOrderId, oldCartId, sap.cxAcceptCurrency);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#createCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *fromOrderGuid = fromOrderGuid_example; // Guest existing order unique identifier (optional)
String *fromOrderId = fromOrderId_example; // Existing order unique identifier (optional)
String *oldCartId = oldCartId_example; // Anonymous cart GUID that will replace the user cart. (optional)
String *sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // Requested Currency for the client (optional)

TravelCartsApi *apiInstance = [[TravelCartsApi alloc] init];

// Creates or restore a cart for a user
[apiInstance createCartWith:baseSiteId
    userId:userId
    fromOrderGuid:fromOrderGuid
    fromOrderId:fromOrderId
    oldCartId:oldCartId
    sap.cxAcceptCurrency:sap.cxAcceptCurrency
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'fromOrderGuid': fromOrderGuid_example, // {{String}} Guest existing order unique identifier
  'fromOrderId': fromOrderId_example, // {{String}} Existing order unique identifier
  'oldCartId': oldCartId_example, // {{String}} Anonymous cart GUID that will replace the user cart.
  'sap.cxAcceptCurrency': sap.cxAcceptCurrency_example // {{String}} Requested Currency for the client
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCart(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var fromOrderGuid = fromOrderGuid_example;  // String | Guest existing order unique identifier (optional) 
            var fromOrderId = fromOrderId_example;  // String | Existing order unique identifier (optional) 
            var oldCartId = oldCartId_example;  // String | Anonymous cart GUID that will replace the user cart. (optional) 
            var sap.cxAcceptCurrency = sap.cxAcceptCurrency_example;  // String | Requested Currency for the client (optional) 

            try
            {
                // Creates or restore a cart for a user
                'String' result = apiInstance.createCart(baseSiteId, userId, fromOrderGuid, fromOrderId, oldCartId, sap.cxAcceptCurrency);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelCartsApi.createCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$fromOrderGuid = fromOrderGuid_example; // String | Guest existing order unique identifier
$fromOrderId = fromOrderId_example; // String | Existing order unique identifier
$oldCartId = oldCartId_example; // String | Anonymous cart GUID that will replace the user cart.
$sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; // String | Requested Currency for the client

try {
    $result = $api_instance->createCart($baseSiteId, $userId, $fromOrderGuid, $fromOrderId, $oldCartId, $sap.cxAcceptCurrency);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelCartsApi->createCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $fromOrderGuid = fromOrderGuid_example; # String | Guest existing order unique identifier
my $fromOrderId = fromOrderId_example; # String | Existing order unique identifier
my $oldCartId = oldCartId_example; # String | Anonymous cart GUID that will replace the user cart.
my $sap.cxAcceptCurrency = sap.cxAcceptCurrency_example; # String | Requested Currency for the client

eval { 
    my $result = $api_instance->createCart(baseSiteId => $baseSiteId, userId => $userId, fromOrderGuid => $fromOrderGuid, fromOrderId => $fromOrderId, oldCartId => $oldCartId, sap.cxAcceptCurrency => $sap.cxAcceptCurrency);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelCartsApi->createCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fromOrderGuid = fromOrderGuid_example # String | Guest existing order unique identifier (optional)
fromOrderId = fromOrderId_example # String | Existing order unique identifier (optional)
oldCartId = oldCartId_example # String | Anonymous cart GUID that will replace the user cart. (optional)
sap.cxAcceptCurrency = sap.cxAcceptCurrency_example # String | Requested Currency for the client (optional)

try: 
    # Creates or restore a cart for a user
    api_response = api_instance.create_cart(baseSiteId, userId, fromOrderGuid=fromOrderGuid, fromOrderId=fromOrderId, oldCartId=oldCartId, sap.cxAcceptCurrency=sap.cxAcceptCurrency)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelCartsApi->createCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-accept-currency
String
Requested Currency for the client
Query parameters
Name Description
fromOrderGuid
String
Guest existing order unique identifier
fromOrderId
String
Existing order unique identifier
oldCartId
String
Anonymous cart GUID that will replace the user cart.

Responses

Status: 201 - Created

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


createCartPaymentDetails

Defines and assigns details of a new credit card payment to the cart.

Defines the details of a new credit card, and assigns this payment option to the cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelCartsApi;

import java.io.File;
import java.util.*;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelCartsApi apiInstance = new TravelCartsApi();
        PaymentDetails body = ; // PaymentDetails | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.createCartPaymentDetails(body, baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#createCartPaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelCartsApi;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        TravelCartsApi apiInstance = new TravelCartsApi();
        PaymentDetails body = ; // PaymentDetails | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.createCartPaymentDetails(body, baseSiteId, cartId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#createCartPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PaymentDetails *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelCartsApi *apiInstance = [[TravelCartsApi alloc] init];

// Defines and assigns details of a new credit card payment to the cart.
[apiInstance createCartPaymentDetailsWith:body
    baseSiteId:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelCartsApi()
var body = ; // {{PaymentDetails}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createCartPaymentDetails(bodybaseSiteIdcartIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCartPaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelCartsApi();
            var body = new PaymentDetails(); // PaymentDetails | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Defines and assigns details of a new credit card payment to the cart.
                apiInstance.createCartPaymentDetails(body, baseSiteId, cartId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelCartsApi.createCartPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelCartsApi();
$body = ; // PaymentDetails | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->createCartPaymentDetails($body, $baseSiteId, $cartId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling TravelCartsApi->createCartPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelCartsApi->new();
my $body = WWW::SwaggerClient::Object::PaymentDetails->new(); # PaymentDetails | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->createCartPaymentDetails(body => $body, baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
};
if ($@) {
    warn "Exception when calling TravelCartsApi->createCartPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelCartsApi()
body =  # PaymentDetails | 
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Defines and assigns details of a new credit card payment to the cart.
    api_instance.create_cart_payment_details(body, baseSiteId, cartId, userId)
except ApiException as e:
    print("Exception when calling TravelCartsApi->createCartPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable entity: business rules validation errors, e.g., travel restrictions

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getCartReservationDetails

Get the reservation details

Returns the reservation details.


/{baseSiteId}/users/{userId}/carts/{cartId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelCartsApi;

import java.io.File;
import java.util.*;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getCartReservationDetails(baseSiteId, cartId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#getCartReservationDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelCartsApi;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getCartReservationDetails(baseSiteId, cartId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#getCartReservationDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TravelCartsApi *apiInstance = [[TravelCartsApi alloc] init];

// Get the reservation details
[apiInstance getCartReservationDetailsWith:baseSiteId
    cartId:cartId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCartReservationDetails(baseSiteId, cartId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCartReservationDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get the reservation details
                'String' result = apiInstance.getCartReservationDetails(baseSiteId, cartId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelCartsApi.getCartReservationDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getCartReservationDetails($baseSiteId, $cartId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelCartsApi->getCartReservationDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getCartReservationDetails(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelCartsApi->getCartReservationDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get the reservation details
    api_response = api_instance.get_cart_reservation_details(baseSiteId, cartId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelCartsApi->getCartReservationDetails: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


getPaymentOptions

Get payment options

Retrieves all the available payment options.


/{baseSiteId}/users/{userId}/carts/{cartId}/paymentOptions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/paymentOptions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelCartsApi;

import java.io.File;
import java.util.*;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.getPaymentOptions(baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#getPaymentOptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelCartsApi;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.getPaymentOptions(baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#getPaymentOptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelCartsApi *apiInstance = [[TravelCartsApi alloc] init];

// Get payment options
[apiInstance getPaymentOptionsWith:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPaymentOptions(baseSiteId, cartId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPaymentOptionsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Get payment options
                'String' result = apiInstance.getPaymentOptions(baseSiteId, cartId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelCartsApi.getPaymentOptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->getPaymentOptions($baseSiteId, $cartId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelCartsApi->getPaymentOptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->getPaymentOptions(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelCartsApi->getPaymentOptions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Get payment options
    api_response = api_instance.get_payment_options(baseSiteId, cartId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelCartsApi->getPaymentOptions: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


removeCart

Deletes a cart with a given cart id.

Deletes a cart with a given cart id.


/{baseSiteId}/users/{userId}/carts/{cartId}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelCartsApi;

import java.io.File;
import java.util.*;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeCart(baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#removeCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelCartsApi;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.removeCart(baseSiteId, cartId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#removeCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelCartsApi *apiInstance = [[TravelCartsApi alloc] init];

// Deletes a cart with a given cart id.
[apiInstance removeCartWith:baseSiteId
    cartId:cartId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.removeCart(baseSiteId, cartId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Deletes a cart with a given cart id.
                'String' result = apiInstance.removeCart(baseSiteId, cartId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelCartsApi.removeCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->removeCart($baseSiteId, $cartId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelCartsApi->removeCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->removeCart(baseSiteId => $baseSiteId, cartId => $cartId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelCartsApi->removeCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Deletes a cart with a given cart id.
    api_response = api_instance.remove_cart(baseSiteId, cartId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelCartsApi->removeCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Unprocessable Entity

Status: 500 - Server Error


replaceCartPaymentDetails

Sets credit card payment details for the cart.

Sets credit card payment details for the cart.


/{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails?paymentDetailsId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelCartsApi;

import java.io.File;
import java.util.*;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.replaceCartPaymentDetails(baseSiteId, cartId, paymentDetailsId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#replaceCartPaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelCartsApi;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.replaceCartPaymentDetails(baseSiteId, cartId, paymentDetailsId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#replaceCartPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *paymentDetailsId = paymentDetailsId_example; // Payment details identifier.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelCartsApi *apiInstance = [[TravelCartsApi alloc] init];

// Sets credit card payment details for the cart.
[apiInstance replaceCartPaymentDetailsWith:baseSiteId
    cartId:cartId
    paymentDetailsId:paymentDetailsId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var paymentDetailsId = paymentDetailsId_example; // {{String}} Payment details identifier.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.replaceCartPaymentDetails(baseSiteId, cartId, paymentDetailsId, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class replaceCartPaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var paymentDetailsId = paymentDetailsId_example;  // String | Payment details identifier.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Sets credit card payment details for the cart.
                'String' result = apiInstance.replaceCartPaymentDetails(baseSiteId, cartId, paymentDetailsId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelCartsApi.replaceCartPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$paymentDetailsId = paymentDetailsId_example; // String | Payment details identifier.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->replaceCartPaymentDetails($baseSiteId, $cartId, $paymentDetailsId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelCartsApi->replaceCartPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $paymentDetailsId = paymentDetailsId_example; # String | Payment details identifier.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->replaceCartPaymentDetails(baseSiteId => $baseSiteId, cartId => $cartId, paymentDetailsId => $paymentDetailsId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelCartsApi->replaceCartPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
paymentDetailsId = paymentDetailsId_example # String | Payment details identifier.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Sets credit card payment details for the cart.
    api_response = api_instance.replace_cart_payment_details(baseSiteId, cartId, paymentDetailsId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelCartsApi->replaceCartPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
paymentDetailsId*
String
Payment details identifier.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


validateCart

Validate the cart having all the necessary information to place the order

Validate the cart having all the necessary information to place the order: Cart is not empty, all the passenger have provided their basic profile details, a payment method is associated with the cart


/{baseSiteId}/users/{userId}/carts/{cartId}/validate

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/validate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelCartsApi;

import java.io.File;
import java.util.*;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.validateCart(baseSiteId, cartId, sap.cxSalesApplication, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#validateCart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelCartsApi;

public class TravelCartsApiExample {

    public static void main(String[] args) {
        TravelCartsApi apiInstance = new TravelCartsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.validateCart(baseSiteId, cartId, sap.cxSalesApplication, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelCartsApi#validateCart");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelCartsApi *apiInstance = [[TravelCartsApi alloc] init];

// Validate the cart having all the necessary information to place the order
[apiInstance validateCartWith:baseSiteId
    cartId:cartId
    sap.cxSalesApplication:sap.cxSalesApplication
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelCartsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateCart(baseSiteId, cartId, sap.cxSalesApplication, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class validateCartExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelCartsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var cartId = cartId_example;  // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Validate the cart having all the necessary information to place the order
                'String' result = apiInstance.validateCart(baseSiteId, cartId, sap.cxSalesApplication, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelCartsApi.validateCart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelCartsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->validateCart($baseSiteId, $cartId, $sap.cxSalesApplication, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelCartsApi->validateCart: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelCartsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelCartsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->validateCart(baseSiteId => $baseSiteId, cartId => $cartId, sap.cxSalesApplication => $sap.cxSalesApplication, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelCartsApi->validateCart: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelCartsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Validate the cart having all the necessary information to place the order
    api_response = api_instance.validate_cart(baseSiteId, cartId, sap.cxSalesApplication, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelCartsApi->validateCart: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
cartId*
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


TravelOrderSearch

getOrderByIdAndLastName

Get the details of a specific booking for a specific owner

Returns the details of the booking having the code passed as a parameter with a specific section for each part of the journey. The booking must be associated to the customer having the specified last name. In case additional security has been activated the traveller reference must be passed to retrieve a specific subset of information for the specific traveller.


/{baseSiteId}/orders

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/orders?lastName=&orderId=&travellerReference="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelOrderSearchApi;

import java.io.File;
import java.util.*;

public class TravelOrderSearchApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelOrderSearchApi apiInstance = new TravelOrderSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String lastName = lastName_example; // String | The customer last name
        String orderId = orderId_example; // String | The booking reference
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String travellerReference = travellerReference_example; // String | The traveller reference
        try {
            'String' result = apiInstance.getOrderByIdAndLastName(baseSiteId, lastName, orderId, acceptLanguage, travellerReference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrderSearchApi#getOrderByIdAndLastName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelOrderSearchApi;

public class TravelOrderSearchApiExample {

    public static void main(String[] args) {
        TravelOrderSearchApi apiInstance = new TravelOrderSearchApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String lastName = lastName_example; // String | The customer last name
        String orderId = orderId_example; // String | The booking reference
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        String travellerReference = travellerReference_example; // String | The traveller reference
        try {
            'String' result = apiInstance.getOrderByIdAndLastName(baseSiteId, lastName, orderId, acceptLanguage, travellerReference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrderSearchApi#getOrderByIdAndLastName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *lastName = lastName_example; // The customer last name
String *orderId = orderId_example; // The booking reference
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
String *travellerReference = travellerReference_example; // The traveller reference (optional)

TravelOrderSearchApi *apiInstance = [[TravelOrderSearchApi alloc] init];

// Get the details of a specific booking for a specific owner
[apiInstance getOrderByIdAndLastNameWith:baseSiteId
    lastName:lastName
    orderId:orderId
    acceptLanguage:acceptLanguage
    travellerReference:travellerReference
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelOrderSearchApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var lastName = lastName_example; // {{String}} The customer last name
var orderId = orderId_example; // {{String}} The booking reference
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'travellerReference': travellerReference_example // {{String}} The traveller reference
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderByIdAndLastName(baseSiteId, lastName, orderId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrderByIdAndLastNameExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelOrderSearchApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var lastName = lastName_example;  // String | The customer last name
            var orderId = orderId_example;  // String | The booking reference
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var travellerReference = travellerReference_example;  // String | The traveller reference (optional) 

            try
            {
                // Get the details of a specific booking for a specific owner
                'String' result = apiInstance.getOrderByIdAndLastName(baseSiteId, lastName, orderId, acceptLanguage, travellerReference);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelOrderSearchApi.getOrderByIdAndLastName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelOrderSearchApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$lastName = lastName_example; // String | The customer last name
$orderId = orderId_example; // String | The booking reference
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$travellerReference = travellerReference_example; // String | The traveller reference

try {
    $result = $api_instance->getOrderByIdAndLastName($baseSiteId, $lastName, $orderId, $acceptLanguage, $travellerReference);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelOrderSearchApi->getOrderByIdAndLastName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelOrderSearchApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelOrderSearchApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $lastName = lastName_example; # String | The customer last name
my $orderId = orderId_example; # String | The booking reference
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $travellerReference = travellerReference_example; # String | The traveller reference

eval { 
    my $result = $api_instance->getOrderByIdAndLastName(baseSiteId => $baseSiteId, lastName => $lastName, orderId => $orderId, acceptLanguage => $acceptLanguage, travellerReference => $travellerReference);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelOrderSearchApi->getOrderByIdAndLastName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelOrderSearchApi()
baseSiteId = baseSiteId_example # String | Base site identifier
lastName = lastName_example # String | The customer last name
orderId = orderId_example # String | The booking reference
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
travellerReference = travellerReference_example # String | The traveller reference (optional)

try: 
    # Get the details of a specific booking for a specific owner
    api_response = api_instance.get_order_by_id_and_last_name(baseSiteId, lastName, orderId, acceptLanguage=acceptLanguage, travellerReference=travellerReference)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelOrderSearchApi->getOrderByIdAndLastName: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
Query parameters
Name Description
lastName*
String
The customer last name
Required
orderId*
String
The booking reference
Required
travellerReference
String
The traveller reference

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found


TravelOrders

cancelOrder

Cancels the entire order

Cancel the entire order, releasing stocks and triggering refund procedure when applicable


/{baseSiteId}/users/{userId}/orders/{orderId}/cancel

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/cancel"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelOrdersApi;

import java.io.File;
import java.util.*;

public class TravelOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelOrdersApi apiInstance = new TravelOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.cancelOrder(baseSiteId, orderId, sap.cxSalesApplication, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrdersApi#cancelOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelOrdersApi;

public class TravelOrdersApiExample {

    public static void main(String[] args) {
        TravelOrdersApi apiInstance = new TravelOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.cancelOrder(baseSiteId, orderId, sap.cxSalesApplication, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrdersApi#cancelOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelOrdersApi *apiInstance = [[TravelOrdersApi alloc] init];

// Cancels the entire order
[apiInstance cancelOrderWith:baseSiteId
    orderId:orderId
    sap.cxSalesApplication:sap.cxSalesApplication
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.cancelOrder(baseSiteId, orderId, sap.cxSalesApplication, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cancelOrderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Cancels the entire order
                apiInstance.cancelOrder(baseSiteId, orderId, sap.cxSalesApplication, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelOrdersApi.cancelOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->cancelOrder($baseSiteId, $orderId, $sap.cxSalesApplication, $userId);
} catch (Exception $e) {
    echo 'Exception when calling TravelOrdersApi->cancelOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->cancelOrder(baseSiteId => $baseSiteId, orderId => $orderId, sap.cxSalesApplication => $sap.cxSalesApplication, userId => $userId);
};
if ($@) {
    warn "Exception when calling TravelOrdersApi->cancelOrder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Cancels the entire order
    api_instance.cancel_order(baseSiteId, orderId, sap.cxSalesApplication, userId)
except ApiException as e:
    print("Exception when calling TravelOrdersApi->cancelOrder: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


evaluateCancelOrder

Evaluates the cancellation of the entire order

Evaluates if the entire booking can be cancelled, returning information about total refunded amount


/{baseSiteId}/users/{userId}/orders/{orderId}/evaluateCancel

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{orderId}/evaluateCancel"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelOrdersApi;

import java.io.File;
import java.util.*;

public class TravelOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelOrdersApi apiInstance = new TravelOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            EvaluateCancelBookingResponse result = apiInstance.evaluateCancelOrder(baseSiteId, orderId, sap.cxSalesApplication, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrdersApi#evaluateCancelOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelOrdersApi;

public class TravelOrdersApiExample {

    public static void main(String[] args) {
        TravelOrdersApi apiInstance = new TravelOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String orderId = orderId_example; // String | Order unique identifier
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            EvaluateCancelBookingResponse result = apiInstance.evaluateCancelOrder(baseSiteId, orderId, sap.cxSalesApplication, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrdersApi#evaluateCancelOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *orderId = orderId_example; // Order unique identifier
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelOrdersApi *apiInstance = [[TravelOrdersApi alloc] init];

// Evaluates the cancellation of the entire order
[apiInstance evaluateCancelOrderWith:baseSiteId
    orderId:orderId
    sap.cxSalesApplication:sap.cxSalesApplication
    userId:userId
              completionHandler: ^(EvaluateCancelBookingResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var orderId = orderId_example; // {{String}} Order unique identifier
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.evaluateCancelOrder(baseSiteId, orderId, sap.cxSalesApplication, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class evaluateCancelOrderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var orderId = orderId_example;  // String | Order unique identifier
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Evaluates the cancellation of the entire order
                EvaluateCancelBookingResponse result = apiInstance.evaluateCancelOrder(baseSiteId, orderId, sap.cxSalesApplication, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelOrdersApi.evaluateCancelOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$orderId = orderId_example; // String | Order unique identifier
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->evaluateCancelOrder($baseSiteId, $orderId, $sap.cxSalesApplication, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelOrdersApi->evaluateCancelOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $orderId = orderId_example; # String | Order unique identifier
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->evaluateCancelOrder(baseSiteId => $baseSiteId, orderId => $orderId, sap.cxSalesApplication => $sap.cxSalesApplication, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelOrdersApi->evaluateCancelOrder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
orderId = orderId_example # String | Order unique identifier
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Evaluates the cancellation of the entire order
    api_response = api_instance.evaluate_cancel_order(baseSiteId, orderId, sap.cxSalesApplication, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelOrdersApi->evaluateCancelOrder: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
orderId*
String
Order unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error: unexpected condition that prevented it from fulfilling the request


getOrder

Get the booking details

Returns the details of a booking with a specific section for each part of the journey.


/{baseSiteId}/users/{userId}/orders/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelOrdersApi;

import java.io.File;
import java.util.*;

public class TravelOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelOrdersApi apiInstance = new TravelOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Order unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            GlobalTravelReservation result = apiInstance.getOrder(baseSiteId, code, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrdersApi#getOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelOrdersApi;

public class TravelOrdersApiExample {

    public static void main(String[] args) {
        TravelOrdersApi apiInstance = new TravelOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Order unique identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            GlobalTravelReservation result = apiInstance.getOrder(baseSiteId, code, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrdersApi#getOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *code = code_example; // Order unique identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TravelOrdersApi *apiInstance = [[TravelOrdersApi alloc] init];

// Get the booking details
[apiInstance getOrderWith:baseSiteId
    code:code
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^(GlobalTravelReservation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var code = code_example; // {{String}} Order unique identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrder(baseSiteId, code, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var code = code_example;  // String | Order unique identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get the booking details
                GlobalTravelReservation result = apiInstance.getOrder(baseSiteId, code, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelOrdersApi.getOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$code = code_example; // String | Order unique identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getOrder($baseSiteId, $code, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelOrdersApi->getOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $code = code_example; # String | Order unique identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getOrder(baseSiteId => $baseSiteId, code => $code, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelOrdersApi->getOrder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
code = code_example # String | Order unique identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get the booking details
    api_response = api_instance.get_order(baseSiteId, code, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelOrdersApi->getOrder: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
code*
String
Order unique identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


getOrders

Get the booking list for user

Returns a list with the details of bookings for the given user. The level of information returned is configured via field attribute. The list can be also paginated.


/{baseSiteId}/users/{userId}/orders

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders?activeOnly=¤tPage=&fields=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelOrdersApi;

import java.io.File;
import java.util.*;

public class TravelOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelOrdersApi apiInstance = new TravelOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        Boolean activeOnly = true; // Boolean | When true only the active booking will be returned
        Integer currentPage = 56; // Integer | Assuming the response arranged in pages, it represents the number of the page to be returned
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | Assuming the response arranged in pages, it represents the number of results to be returned for every page
        try {
            'String' result = apiInstance.getOrders(baseSiteId, userId, acceptLanguage, activeOnly, currentPage, fields, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrdersApi#getOrders");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelOrdersApi;

public class TravelOrdersApiExample {

    public static void main(String[] args) {
        TravelOrdersApi apiInstance = new TravelOrdersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        Boolean activeOnly = true; // Boolean | When true only the active booking will be returned
        Integer currentPage = 56; // Integer | Assuming the response arranged in pages, it represents the number of the page to be returned
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        Integer pageSize = 56; // Integer | Assuming the response arranged in pages, it represents the number of results to be returned for every page
        try {
            'String' result = apiInstance.getOrders(baseSiteId, userId, acceptLanguage, activeOnly, currentPage, fields, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrdersApi#getOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)
Boolean *activeOnly = true; // When true only the active booking will be returned (optional)
Integer *currentPage = 56; // Assuming the response arranged in pages, it represents the number of the page to be returned (optional) (default to 0)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)
Integer *pageSize = 56; // Assuming the response arranged in pages, it represents the number of results to be returned for every page (optional) (default to 20)

TravelOrdersApi *apiInstance = [[TravelOrdersApi alloc] init];

// Get the booking list for user
[apiInstance getOrdersWith:baseSiteId
    userId:userId
    acceptLanguage:acceptLanguage
    activeOnly:activeOnly
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelOrdersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example, // {{String}} Languages the client is able to understand, and which locale variant is preferred
  'activeOnly': true, // {{Boolean}} When true only the active booking will be returned
  'currentPage': 56, // {{Integer}} Assuming the response arranged in pages, it represents the number of the page to be returned
  'fields': fields_example, // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
  'pageSize': 56 // {{Integer}} Assuming the response arranged in pages, it represents the number of results to be returned for every page
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrders(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrdersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelOrdersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 
            var activeOnly = true;  // Boolean | When true only the active booking will be returned (optional) 
            var currentPage = 56;  // Integer | Assuming the response arranged in pages, it represents the number of the page to be returned (optional)  (default to 0)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to BASIC)
            var pageSize = 56;  // Integer | Assuming the response arranged in pages, it represents the number of results to be returned for every page (optional)  (default to 20)

            try
            {
                // Get the booking list for user
                'String' result = apiInstance.getOrders(baseSiteId, userId, acceptLanguage, activeOnly, currentPage, fields, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelOrdersApi.getOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelOrdersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
$activeOnly = true; // Boolean | When true only the active booking will be returned
$currentPage = 56; // Integer | Assuming the response arranged in pages, it represents the number of the page to be returned
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
$pageSize = 56; // Integer | Assuming the response arranged in pages, it represents the number of results to be returned for every page

try {
    $result = $api_instance->getOrders($baseSiteId, $userId, $acceptLanguage, $activeOnly, $currentPage, $fields, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelOrdersApi->getOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelOrdersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred
my $activeOnly = true; # Boolean | When true only the active booking will be returned
my $currentPage = 56; # Integer | Assuming the response arranged in pages, it represents the number of the page to be returned
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
my $pageSize = 56; # Integer | Assuming the response arranged in pages, it represents the number of results to be returned for every page

eval { 
    my $result = $api_instance->getOrders(baseSiteId => $baseSiteId, userId => $userId, acceptLanguage => $acceptLanguage, activeOnly => $activeOnly, currentPage => $currentPage, fields => $fields, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelOrdersApi->getOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelOrdersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)
activeOnly = true # Boolean | When true only the active booking will be returned (optional)
currentPage = 56 # Integer | Assuming the response arranged in pages, it represents the number of the page to be returned (optional) (default to 0)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)
pageSize = 56 # Integer | Assuming the response arranged in pages, it represents the number of results to be returned for every page (optional) (default to 20)

try: 
    # Get the booking list for user
    api_response = api_instance.get_orders(baseSiteId, userId, acceptLanguage=acceptLanguage, activeOnly=activeOnly, currentPage=currentPage, fields=fields, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelOrdersApi->getOrders: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred
Query parameters
Name Description
activeOnly
Boolean
When true only the active booking will be returned
currentPage
Integer (int32)
Assuming the response arranged in pages, it represents the number of the page to be returned
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
pageSize
Integer (int32)
Assuming the response arranged in pages, it represents the number of results to be returned for every page

Responses

Status: 200 - Success

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


placeOrder

Place a travel order

Validates the consistency of the cart and when successful persist the booking into the system.


/{baseSiteId}/users/{userId}/orders

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/orders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelOrdersApi;

import java.io.File;
import java.util.*;

public class TravelOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelOrdersApi apiInstance = new TravelOrdersApi();
        PlaceOrderRequest body = ; // PlaceOrderRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.placeOrder(body, sap.cxSalesApplication, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrdersApi#placeOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelOrdersApi;

public class TravelOrdersApiExample {

    public static void main(String[] args) {
        TravelOrdersApi apiInstance = new TravelOrdersApi();
        PlaceOrderRequest body = ; // PlaceOrderRequest | 
        String sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.placeOrder(body, sap.cxSalesApplication, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelOrdersApi#placeOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PlaceOrderRequest *body = ; // 
String *sap.cxSalesApplication = sap.cxSalesApplication_example; // The sales application code
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelOrdersApi *apiInstance = [[TravelOrdersApi alloc] init];

// Place a travel order
[apiInstance placeOrderWith:body
    sap.cxSalesApplication:sap.cxSalesApplication
    baseSiteId:baseSiteId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelOrdersApi()
var body = ; // {{PlaceOrderRequest}} 
var sap.cxSalesApplication = sap.cxSalesApplication_example; // {{String}} The sales application code
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.placeOrder(bodysap.cxSalesApplicationbaseSiteIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class placeOrderExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelOrdersApi();
            var body = new PlaceOrderRequest(); // PlaceOrderRequest | 
            var sap.cxSalesApplication = sap.cxSalesApplication_example;  // String | The sales application code
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Place a travel order
                'String' result = apiInstance.placeOrder(body, sap.cxSalesApplication, baseSiteId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelOrdersApi.placeOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelOrdersApi();
$body = ; // PlaceOrderRequest | 
$sap.cxSalesApplication = sap.cxSalesApplication_example; // String | The sales application code
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->placeOrder($body, $sap.cxSalesApplication, $baseSiteId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelOrdersApi->placeOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelOrdersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelOrdersApi->new();
my $body = WWW::SwaggerClient::Object::PlaceOrderRequest->new(); # PlaceOrderRequest | 
my $sap.cxSalesApplication = sap.cxSalesApplication_example; # String | The sales application code
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->placeOrder(body => $body, sap.cxSalesApplication => $sap.cxSalesApplication, baseSiteId => $baseSiteId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelOrdersApi->placeOrder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelOrdersApi()
body =  # PlaceOrderRequest | 
sap.cxSalesApplication = sap.cxSalesApplication_example # String | The sales application code
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Place a travel order
    api_response = api_instance.place_order(body, sap.cxSalesApplication, baseSiteId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelOrdersApi->placeOrder: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
sap.cx-sales-application*
String
The sales application code
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Name Type Format Description

Status: 400 - Not Found

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


TravelUsers

createUser

Registers a customer

Registers a customer. Requires the following parameters: login, password, firstName, lastName, titleCode.


/{baseSiteId}/users

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelUsersApi;

import java.io.File;
import java.util.*;

public class TravelUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelUsersApi apiInstance = new TravelUsersApi();
        UserSignUp body = ; // UserSignUp | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            'String' result = apiInstance.createUser(body, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelUsersApi#createUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelUsersApi;

public class TravelUsersApiExample {

    public static void main(String[] args) {
        TravelUsersApi apiInstance = new TravelUsersApi();
        UserSignUp body = ; // UserSignUp | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        try {
            'String' result = apiInstance.createUser(body, baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelUsersApi#createUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UserSignUp *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier

TravelUsersApi *apiInstance = [[TravelUsersApi alloc] init];

//  Registers a customer
[apiInstance createUserWith:body
    baseSiteId:baseSiteId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelUsersApi()
var body = ; // {{UserSignUp}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUser(bodybaseSiteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createUserExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelUsersApi();
            var body = new UserSignUp(); // UserSignUp | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier

            try
            {
                //  Registers a customer
                'String' result = apiInstance.createUser(body, baseSiteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelUsersApi.createUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelUsersApi();
$body = ; // UserSignUp | 
$baseSiteId = baseSiteId_example; // String | Base site identifier

try {
    $result = $api_instance->createUser($body, $baseSiteId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelUsersApi->createUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelUsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelUsersApi->new();
my $body = WWW::SwaggerClient::Object::UserSignUp->new(); # UserSignUp | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier

eval { 
    my $result = $api_instance->createUser(body => $body, baseSiteId => $baseSiteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelUsersApi->createUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelUsersApi()
body =  # UserSignUp | 
baseSiteId = baseSiteId_example # String | Base site identifier

try: 
    #  Registers a customer
    api_response = api_instance.create_user(body, baseSiteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelUsersApi->createUser: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Name Type Format Description

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


getUser

Get customer profile

Returns customer profile.


/{baseSiteId}/users/{userId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelUsersApi;

import java.io.File;
import java.util.*;

public class TravelUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelUsersApi apiInstance = new TravelUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getUser(baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelUsersApi#getUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelUsersApi;

public class TravelUsersApiExample {

    public static void main(String[] args) {
        TravelUsersApi apiInstance = new TravelUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        String acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred
        try {
            'String' result = apiInstance.getUser(baseSiteId, userId, acceptLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelUsersApi#getUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
String *acceptLanguage = acceptLanguage_example; // Languages the client is able to understand, and which locale variant is preferred (optional)

TravelUsersApi *apiInstance = [[TravelUsersApi alloc] init];

// Get customer profile
[apiInstance getUserWith:baseSiteId
    userId:userId
    acceptLanguage:acceptLanguage
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelUsersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var opts = { 
  'acceptLanguage': acceptLanguage_example // {{String}} Languages the client is able to understand, and which locale variant is preferred
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUser(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelUsersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
            var acceptLanguage = acceptLanguage_example;  // String | Languages the client is able to understand, and which locale variant is preferred (optional) 

            try
            {
                // Get customer profile
                'String' result = apiInstance.getUser(baseSiteId, userId, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelUsersApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelUsersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
$acceptLanguage = acceptLanguage_example; // String | Languages the client is able to understand, and which locale variant is preferred

try {
    $result = $api_instance->getUser($baseSiteId, $userId, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelUsersApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelUsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelUsersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
my $acceptLanguage = acceptLanguage_example; # String | Languages the client is able to understand, and which locale variant is preferred

eval { 
    my $result = $api_instance->getUser(baseSiteId => $baseSiteId, userId => $userId, acceptLanguage => $acceptLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelUsersApi->getUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelUsersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
acceptLanguage = acceptLanguage_example # String | Languages the client is able to understand, and which locale variant is preferred (optional)

try: 
    # Get customer profile
    api_response = api_instance.get_user(baseSiteId, userId, acceptLanguage=acceptLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelUsersApi->getUser: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Header parameters
Name Description
Accept-Language
String
Languages the client is able to understand, and which locale variant is preferred

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not found

Status: 500 - Server Error


replaceUserLogin

Changes customer's login name.

Changes a customer's login name, the email by default. Requires the customer's current password.


/{baseSiteId}/users/{userId}/login

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/login?newLogin=&password="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelUsersApi;

import java.io.File;
import java.util.*;

public class TravelUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelUsersApi apiInstance = new TravelUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String newLogin = newLogin_example; // String | Customer's new login name. Customer login is case insensitive.
        String password = password_example; // String | Customer's current password.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.replaceUserLogin(baseSiteId, newLogin, password, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelUsersApi#replaceUserLogin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelUsersApi;

public class TravelUsersApiExample {

    public static void main(String[] args) {
        TravelUsersApi apiInstance = new TravelUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String newLogin = newLogin_example; // String | Customer's new login name. Customer login is case insensitive.
        String password = password_example; // String | Customer's current password.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.replaceUserLogin(baseSiteId, newLogin, password, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelUsersApi#replaceUserLogin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *newLogin = newLogin_example; // Customer's new login name. Customer login is case insensitive.
String *password = password_example; // Customer's current password.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelUsersApi *apiInstance = [[TravelUsersApi alloc] init];

// Changes customer's login name.
[apiInstance replaceUserLoginWith:baseSiteId
    newLogin:newLogin
    password:password
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelUsersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var newLogin = newLogin_example; // {{String}} Customer's new login name. Customer login is case insensitive.
var password = password_example; // {{String}} Customer's current password.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.replaceUserLogin(baseSiteId, newLogin, password, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class replaceUserLoginExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelUsersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var newLogin = newLogin_example;  // String | Customer's new login name. Customer login is case insensitive.
            var password = password_example;  // String | Customer's current password.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Changes customer's login name.
                'String' result = apiInstance.replaceUserLogin(baseSiteId, newLogin, password, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelUsersApi.replaceUserLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelUsersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$newLogin = newLogin_example; // String | Customer's new login name. Customer login is case insensitive.
$password = password_example; // String | Customer's current password.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->replaceUserLogin($baseSiteId, $newLogin, $password, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelUsersApi->replaceUserLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelUsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelUsersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $newLogin = newLogin_example; # String | Customer's new login name. Customer login is case insensitive.
my $password = password_example; # String | Customer's current password.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->replaceUserLogin(baseSiteId => $baseSiteId, newLogin => $newLogin, password => $password, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelUsersApi->replaceUserLogin: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelUsersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
newLogin = newLogin_example # String | Customer's new login name. Customer login is case insensitive.
password = password_example # String | Customer's current password.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Changes customer's login name.
    api_response = api_instance.replace_user_login(baseSiteId, newLogin, password, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelUsersApi->replaceUserLogin: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
newLogin*
String
Customer's new login name. Customer login is case insensitive.
Required
password*
String
Customer's current password.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


replaceUserPassword

Changes user's password

Changes user's password. The old password is required.


/{baseSiteId}/users/{userId}/password

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/password?newPassword=&oldPassword="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelUsersApi;

import java.io.File;
import java.util.*;

public class TravelUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelUsersApi apiInstance = new TravelUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String newPassword = newPassword_example; // String | New password.
        String oldPassword = oldPassword_example; // String | Old password.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.replaceUserPassword(baseSiteId, newPassword, oldPassword, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelUsersApi#replaceUserPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelUsersApi;

public class TravelUsersApiExample {

    public static void main(String[] args) {
        TravelUsersApi apiInstance = new TravelUsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String newPassword = newPassword_example; // String | New password.
        String oldPassword = oldPassword_example; // String | Old password.
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.replaceUserPassword(baseSiteId, newPassword, oldPassword, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelUsersApi#replaceUserPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *newPassword = newPassword_example; // New password.
String *oldPassword = oldPassword_example; // Old password.
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelUsersApi *apiInstance = [[TravelUsersApi alloc] init];

// Changes user's password
[apiInstance replaceUserPasswordWith:baseSiteId
    newPassword:newPassword
    oldPassword:oldPassword
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelUsersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var newPassword = newPassword_example; // {{String}} New password.
var oldPassword = oldPassword_example; // {{String}} Old password.
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.replaceUserPassword(baseSiteId, newPassword, oldPassword, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class replaceUserPasswordExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelUsersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var newPassword = newPassword_example;  // String | New password.
            var oldPassword = oldPassword_example;  // String | Old password.
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Changes user's password
                'String' result = apiInstance.replaceUserPassword(baseSiteId, newPassword, oldPassword, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelUsersApi.replaceUserPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelUsersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$newPassword = newPassword_example; // String | New password.
$oldPassword = oldPassword_example; // String | Old password.
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->replaceUserPassword($baseSiteId, $newPassword, $oldPassword, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelUsersApi->replaceUserPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelUsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelUsersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $newPassword = newPassword_example; # String | New password.
my $oldPassword = oldPassword_example; # String | Old password.
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->replaceUserPassword(baseSiteId => $baseSiteId, newPassword => $newPassword, oldPassword => $oldPassword, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelUsersApi->replaceUserPassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelUsersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
newPassword = newPassword_example # String | New password.
oldPassword = oldPassword_example # String | Old password.
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Changes user's password
    api_response = api_instance.replace_user_password(baseSiteId, newPassword, oldPassword, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelUsersApi->replaceUserPassword: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Query parameters
Name Description
newPassword*
String
New password.
Required
oldPassword*
String
Old password.
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 500 - Server Error


updateUser

Updates customer profile

Updates customer profile. Only attributes provided in the request body will be changed.


/{baseSiteId}/users/{userId}

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TravelUsersApi;

import java.io.File;
import java.util.*;

public class TravelUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TravelUsersApi apiInstance = new TravelUsersApi();
        User body = ; // User | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.updateUser(body, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelUsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TravelUsersApi;

public class TravelUsersApiExample {

    public static void main(String[] args) {
        TravelUsersApi apiInstance = new TravelUsersApi();
        User body = ; // User | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            'String' result = apiInstance.updateUser(body, baseSiteId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TravelUsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
User *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

TravelUsersApi *apiInstance = [[TravelUsersApi alloc] init];

// Updates customer profile
[apiInstance updateUserWith:body
    baseSiteId:baseSiteId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.TravelUsersApi()
var body = ; // {{User}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUser(bodybaseSiteIduserId, 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 OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TravelUsersApi();
            var body = new User(); // User | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Updates customer profile
                'String' result = apiInstance.updateUser(body, baseSiteId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TravelUsersApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTravelUsersApi();
$body = ; // User | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $result = $api_instance->updateUser($body, $baseSiteId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TravelUsersApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TravelUsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TravelUsersApi->new();
my $body = WWW::SwaggerClient::Object::User->new(); # User | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    my $result = $api_instance->updateUser(body => $body, baseSiteId => $baseSiteId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TravelUsersApi->updateUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TravelUsersApi()
body =  # User | 
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Updates customer profile
    api_response = api_instance.update_user(body, baseSiteId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TravelUsersApi->updateUser: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Unprocessable Entity

Status: 500 - Server Error


Users

getUserCustomerGroups

Get all customer groups of a customer.

Returns all customer groups of a customer.


/{baseSiteId}/users/{userId}/customergroups

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/customergroups?fields="
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 OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        UsersApi apiInstance = new UsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            UserGroupList result = apiInstance.getUserCustomerGroups(baseSiteId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUserCustomerGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier.
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            UserGroupList result = apiInstance.getUserCustomerGroups(baseSiteId, userId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUserCustomerGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier.
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

UsersApi *apiInstance = [[UsersApi alloc] init];

// Get all customer groups of a customer.
[apiInstance getUserCustomerGroupsWith:baseSiteId
    userId:userId
    fields:fields
              completionHandler: ^(UserGroupList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.UsersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier.
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserCustomerGroups(baseSiteId, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserCustomerGroupsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UsersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier.
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to DEFAULT)

            try
            {
                // Get all customer groups of a customer.
                UserGroupList result = apiInstance.getUserCustomerGroups(baseSiteId, userId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getUserCustomerGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUsersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier.
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getUserCustomerGroups($baseSiteId, $userId, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->getUserCustomerGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier.
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getUserCustomerGroups(baseSiteId => $baseSiteId, userId => $userId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getUserCustomerGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier.
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to DEFAULT)

try: 
    # Get all customer groups of a customer.
    api_response = api_instance.get_user_customer_groups(baseSiteId, userId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUserCustomerGroups: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier.
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replaceUser

Updates customer profile

Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default).


/{baseSiteId}/users/{userId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}"
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 OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        UsersApi apiInstance = new UsersApi();
        User body = ; // User | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.replaceUser(body, baseSiteId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#replaceUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        User body = ; // User | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
        try {
            apiInstance.replaceUser(body, baseSiteId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#replaceUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
User *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

UsersApi *apiInstance = [[UsersApi alloc] init];

// Updates customer profile
[apiInstance replaceUserWith:body
    baseSiteId:baseSiteId
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.UsersApi()
var body = ; // {{User}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.replaceUser(bodybaseSiteIduserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class replaceUserExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UsersApi();
            var body = new User(); // User | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var userId = userId_example;  // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

            try
            {
                // Updates customer profile
                apiInstance.replaceUser(body, baseSiteId, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.replaceUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiUsersApi();
$body = ; // User | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try {
    $api_instance->replaceUser($body, $baseSiteId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->replaceUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $body = WWW::SwaggerClient::Object::User->new(); # User | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

eval { 
    $api_instance->replaceUser(body => $body, baseSiteId => $baseSiteId, userId => $userId);
};
if ($@) {
    warn "Exception when calling UsersApi->replaceUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
body =  # User | 
baseSiteId = baseSiteId_example # String | Base site identifier
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

try: 
    # Updates customer profile
    api_instance.replace_user(body, baseSiteId, userId)
except ApiException as e:
    print("Exception when calling UsersApi->replaceUser: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
userId*
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Vouchers

getVoucher

Get a voucher based on code.

Returns details of a single voucher that is specified by its voucher identification code.


/{baseSiteId}/vouchers/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/vouchers/{code}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VouchersApi;

import java.io.File;
import java.util.*;

public class VouchersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        VouchersApi apiInstance = new VouchersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Voucher identifier (code)
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Voucher result = apiInstance.getVoucher(baseSiteId, code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VouchersApi#getVoucher");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VouchersApi;

public class VouchersApiExample {

    public static void main(String[] args) {
        VouchersApi apiInstance = new VouchersApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Voucher identifier (code)
        String fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
        try {
            Voucher result = apiInstance.getVoucher(baseSiteId, code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VouchersApi#getVoucher");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // Base site identifier
String *code = code_example; // Voucher identifier (code)
String *fields = fields_example; // Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)

VouchersApi *apiInstance = [[VouchersApi alloc] init];

// Get a voucher based on code.
[apiInstance getVoucherWith:baseSiteId
    code:code
    fields:fields
              completionHandler: ^(Voucher output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new CommerceWebservices.VouchersApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var code = code_example; // {{String}} Voucher identifier (code)
var opts = { 
  'fields': fields_example // {{String}} Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVoucher(baseSiteId, code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVoucherExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new VouchersApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var code = code_example;  // String | Voucher identifier (code)
            var fields = fields_example;  // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional)  (default to BASIC)

            try
            {
                // Get a voucher based on code.
                Voucher result = apiInstance.getVoucher(baseSiteId, code, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VouchersApi.getVoucher: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiVouchersApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$code = code_example; // String | Voucher identifier (code)
$fields = fields_example; // String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

try {
    $result = $api_instance->getVoucher($baseSiteId, $code, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VouchersApi->getVoucher: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VouchersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::VouchersApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $code = code_example; # String | Voucher identifier (code)
my $fields = fields_example; # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

eval { 
    my $result = $api_instance->getVoucher(baseSiteId => $baseSiteId, code => $code, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VouchersApi->getVoucher: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.VouchersApi()
baseSiteId = baseSiteId_example # String | Base site identifier
code = code_example # String | Voucher identifier (code)
fields = fields_example # String | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL (optional) (default to BASIC)

try: 
    # Get a voucher based on code.
    api_response = api_instance.get_voucher(baseSiteId, code, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VouchersApi->getVoucher: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
code*
String
Voucher identifier (code)
Required
Query parameters
Name Description
fields
String
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found