Warehousing Webservices

WarehousingAsnsController

cancelAsn

Cancels an advanced shipping notice

Cancels an advanced shipping notice.


/asns/{internalId}/cancel

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/asns/{internalId}/cancel?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingAsnsControllerApi;

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

public class WarehousingAsnsControllerApiExample {

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

        // 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");

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

        WarehousingAsnsControllerApi apiInstance = new WarehousingAsnsControllerApi();
        String internalId = internalId_example; // String | Internal Id for the advanced shipping notice to be cancelled
        String fields = fields_example; // String | Fields mapping level
        try {
            apiInstance.cancelAsn(internalId, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingAsnsControllerApi#cancelAsn");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingAsnsControllerApi;

public class WarehousingAsnsControllerApiExample {

    public static void main(String[] args) {
        WarehousingAsnsControllerApi apiInstance = new WarehousingAsnsControllerApi();
        String internalId = internalId_example; // String | Internal Id for the advanced shipping notice to be cancelled
        String fields = fields_example; // String | Fields mapping level
        try {
            apiInstance.cancelAsn(internalId, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingAsnsControllerApi#cancelAsn");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *internalId = internalId_example; // Internal Id for the advanced shipping notice to be cancelled
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Cancels an advanced shipping notice
[apiInstance cancelAsnWith:internalId
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingAsnsControllerApi()
var internalId = internalId_example; // {{String}} Internal Id for the advanced shipping notice to be cancelled
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.cancelAsn(internalId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingAsnsControllerApi();
            var internalId = internalId_example;  // String | Internal Id for the advanced shipping notice to be cancelled
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Cancels an advanced shipping notice
                apiInstance.cancelAsn(internalId, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingAsnsControllerApi.cancelAsn: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingAsnsControllerApi();
$internalId = internalId_example; // String | Internal Id for the advanced shipping notice to be cancelled
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingAsnsControllerApi->new();
my $internalId = internalId_example; # String | Internal Id for the advanced shipping notice to be cancelled
my $fields = fields_example; # String | Fields mapping level

eval { 
    $api_instance->cancelAsn(internalId => $internalId, fields => $fields);
};
if ($@) {
    warn "Exception when calling WarehousingAsnsControllerApi->cancelAsn: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingAsnsControllerApi()
internalId = internalId_example # String | Internal Id for the advanced shipping notice to be cancelled
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Cancels an advanced shipping notice
    api_instance.cancel_asn(internalId, fields=fields)
except ApiException as e:
    print("Exception when calling WarehousingAsnsControllerApi->cancelAsn: %s\n" % e)

Parameters

Path parameters
Name Description
internalId*
String
Internal Id for the advanced shipping notice to be cancelled
Required
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 201 - Created

Status: 202 - Accepted

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


confirmAsnReceipt

Confirms the receipt of an advanced shipping notice

Confirms the receipt of an advanced shipping notice.


/asns/{internalId}/confirm-receipt

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/asns/{internalId}/confirm-receipt?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingAsnsControllerApi;

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

public class WarehousingAsnsControllerApiExample {

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

        // 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");

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

        WarehousingAsnsControllerApi apiInstance = new WarehousingAsnsControllerApi();
        String internalId = internalId_example; // String | Internal Id for the advanced shipping notice to be confirmed
        String fields = fields_example; // String | Fields mapping level
        try {
            AsnWsDTO result = apiInstance.confirmAsnReceipt(internalId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingAsnsControllerApi#confirmAsnReceipt");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingAsnsControllerApi;

public class WarehousingAsnsControllerApiExample {

    public static void main(String[] args) {
        WarehousingAsnsControllerApi apiInstance = new WarehousingAsnsControllerApi();
        String internalId = internalId_example; // String | Internal Id for the advanced shipping notice to be confirmed
        String fields = fields_example; // String | Fields mapping level
        try {
            AsnWsDTO result = apiInstance.confirmAsnReceipt(internalId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingAsnsControllerApi#confirmAsnReceipt");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *internalId = internalId_example; // Internal Id for the advanced shipping notice to be confirmed
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Confirms the receipt of an advanced shipping notice
[apiInstance confirmAsnReceiptWith:internalId
    fields:fields
              completionHandler: ^(AsnWsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingAsnsControllerApi()
var internalId = internalId_example; // {{String}} Internal Id for the advanced shipping notice to be confirmed
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmAsnReceipt(internalId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingAsnsControllerApi();
            var internalId = internalId_example;  // String | Internal Id for the advanced shipping notice to be confirmed
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Confirms the receipt of an advanced shipping notice
                AsnWsDTO result = apiInstance.confirmAsnReceipt(internalId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingAsnsControllerApi.confirmAsnReceipt: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingAsnsControllerApi();
$internalId = internalId_example; // String | Internal Id for the advanced shipping notice to be confirmed
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingAsnsControllerApi->new();
my $internalId = internalId_example; # String | Internal Id for the advanced shipping notice to be confirmed
my $fields = fields_example; # String | Fields mapping level

eval { 
    my $result = $api_instance->confirmAsnReceipt(internalId => $internalId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingAsnsControllerApi->confirmAsnReceipt: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingAsnsControllerApi()
internalId = internalId_example # String | Internal Id for the advanced shipping notice to be confirmed
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Confirms the receipt of an advanced shipping notice
    api_response = api_instance.confirm_asn_receipt(internalId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingAsnsControllerApi->confirmAsnReceipt: %s\n" % e)

Parameters

Path parameters
Name Description
internalId*
String
Internal Id for the advanced shipping notice to be confirmed
Required
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


createAsn

Creates an advanced shipping notice

Creates a new advanced shipping notice as given in the request.


/asns

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"//hostname/warehousingwebservices/asns?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingAsnsControllerApi;

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

public class WarehousingAsnsControllerApiExample {

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

        // 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");

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

        WarehousingAsnsControllerApi apiInstance = new WarehousingAsnsControllerApi();
        AsnWsDTO body = ; // AsnWsDTO | AsnWsDTO containing information about the asn to be created
        String fields = fields_example; // String | Fields mapping level
        try {
            AsnWsDTO result = apiInstance.createAsn(body, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingAsnsControllerApi#createAsn");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingAsnsControllerApi;

public class WarehousingAsnsControllerApiExample {

    public static void main(String[] args) {
        WarehousingAsnsControllerApi apiInstance = new WarehousingAsnsControllerApi();
        AsnWsDTO body = ; // AsnWsDTO | AsnWsDTO containing information about the asn to be created
        String fields = fields_example; // String | Fields mapping level
        try {
            AsnWsDTO result = apiInstance.createAsn(body, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingAsnsControllerApi#createAsn");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
AsnWsDTO *body = ; // AsnWsDTO containing information about the asn to be created
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Creates an advanced shipping notice
[apiInstance createAsnWith:body
    fields:fields
              completionHandler: ^(AsnWsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingAsnsControllerApi()
var body = ; // {{AsnWsDTO}} AsnWsDTO containing information about the asn to be created
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAsn(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingAsnsControllerApi();
            var body = new AsnWsDTO(); // AsnWsDTO | AsnWsDTO containing information about the asn to be created
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Creates an advanced shipping notice
                AsnWsDTO result = apiInstance.createAsn(body, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingAsnsControllerApi.createAsn: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingAsnsControllerApi();
$body = ; // AsnWsDTO | AsnWsDTO containing information about the asn to be created
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingAsnsControllerApi->new();
my $body = WWW::SwaggerClient::Object::AsnWsDTO->new(); # AsnWsDTO | AsnWsDTO containing information about the asn to be created
my $fields = fields_example; # String | Fields mapping level

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

# create an instance of the API class
api_instance = swagger_client.WarehousingAsnsControllerApi()
body =  # AsnWsDTO | AsnWsDTO containing information about the asn to be created
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Creates an advanced shipping notice
    api_response = api_instance.create_asn(body, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingAsnsControllerApi->createAsn: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


WarehousingBaseStoresController

getPointsOfServiceForBaseStoreId

Finds a paginated list of point of services per a given base store

Finds a paginated list of point of services per a given base store.


/basestores/{uid}/pointofservices

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/basestores/{uid}/pointofservices?currentPage=&fields=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingBaseStoresControllerApi;

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

public class WarehousingBaseStoresControllerApiExample {

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

        // 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");

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

        WarehousingBaseStoresControllerApi apiInstance = new WarehousingBaseStoresControllerApi();
        String uid = uid_example; // String | The id of the base store
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            PointOfServiceSearchPageWsDTO result = apiInstance.getPointsOfServiceForBaseStoreId(uid, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingBaseStoresControllerApi#getPointsOfServiceForBaseStoreId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingBaseStoresControllerApi;

public class WarehousingBaseStoresControllerApiExample {

    public static void main(String[] args) {
        WarehousingBaseStoresControllerApi apiInstance = new WarehousingBaseStoresControllerApi();
        String uid = uid_example; // String | The id of the base store
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            PointOfServiceSearchPageWsDTO result = apiInstance.getPointsOfServiceForBaseStoreId(uid, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingBaseStoresControllerApi#getPointsOfServiceForBaseStoreId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *uid = uid_example; // The id of the base store
Integer *currentPage = 56; // Current page (optional) (default to 0)
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)
Integer *pageSize = 56; // Page size (optional) (default to 10)
String *sort = sort_example; // Sort parameter (optional) (default to asc)

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

// Finds a paginated list of point of services per a given base store
[apiInstance getPointsOfServiceForBaseStoreIdWith:uid
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    sort:sort
              completionHandler: ^(PointOfServiceSearchPageWsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingBaseStoresControllerApi()
var uid = uid_example; // {{String}} The id of the base store
var opts = { 
  'currentPage': 56, // {{Integer}} Current page
  'fields': fields_example, // {{String}} Fields mapping level
  'pageSize': 56, // {{Integer}} Page size
  'sort': sort_example // {{String}} Sort parameter
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPointsOfServiceForBaseStoreId(uid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingBaseStoresControllerApi();
            var uid = uid_example;  // String | The id of the base store
            var currentPage = 56;  // Integer | Current page (optional)  (default to 0)
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | Page size (optional)  (default to 10)
            var sort = sort_example;  // String | Sort parameter (optional)  (default to asc)

            try
            {
                // Finds a paginated list of point of services per a given base store
                PointOfServiceSearchPageWsDTO result = apiInstance.getPointsOfServiceForBaseStoreId(uid, currentPage, fields, pageSize, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingBaseStoresControllerApi.getPointsOfServiceForBaseStoreId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingBaseStoresControllerApi();
$uid = uid_example; // String | The id of the base store
$currentPage = 56; // Integer | Current page
$fields = fields_example; // String | Fields mapping level
$pageSize = 56; // Integer | Page size
$sort = sort_example; // String | Sort parameter

try {
    $result = $api_instance->getPointsOfServiceForBaseStoreId($uid, $currentPage, $fields, $pageSize, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehousingBaseStoresControllerApi->getPointsOfServiceForBaseStoreId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WarehousingBaseStoresControllerApi;

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

my $api_instance = WWW::SwaggerClient::WarehousingBaseStoresControllerApi->new();
my $uid = uid_example; # String | The id of the base store
my $currentPage = 56; # Integer | Current page
my $fields = fields_example; # String | Fields mapping level
my $pageSize = 56; # Integer | Page size
my $sort = sort_example; # String | Sort parameter

eval { 
    my $result = $api_instance->getPointsOfServiceForBaseStoreId(uid => $uid, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingBaseStoresControllerApi->getPointsOfServiceForBaseStoreId: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingBaseStoresControllerApi()
uid = uid_example # String | The id of the base store
currentPage = 56 # Integer | Current page (optional) (default to 0)
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)
pageSize = 56 # Integer | Page size (optional) (default to 10)
sort = sort_example # String | Sort parameter (optional) (default to asc)

try: 
    # Finds a paginated list of point of services per a given base store
    api_response = api_instance.get_points_of_service_for_base_store_id(uid, currentPage=currentPage, fields=fields, pageSize=pageSize, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingBaseStoresControllerApi->getPointsOfServiceForBaseStoreId: %s\n" % e)

Parameters

Path parameters
Name Description
uid*
String
The id of the base store
Required
Query parameters
Name Description
currentPage
Integer (int32)
Current page
fields
String
Fields mapping level
pageSize
Integer (int32)
Page size
sort
String
Sort parameter

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getWarehousesForBaseStoreId

Finds a paginated list of warehouses per a given base store

Finds a paginated list of warehouses per a given base store.


/basestores/{uid}/warehouses

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/basestores/{uid}/warehouses?currentPage=&fields=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingBaseStoresControllerApi;

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

public class WarehousingBaseStoresControllerApiExample {

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

        // 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");

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

        WarehousingBaseStoresControllerApi apiInstance = new WarehousingBaseStoresControllerApi();
        String uid = uid_example; // String | The id of the base store
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            WarehouseSearchPageWsDto result = apiInstance.getWarehousesForBaseStoreId(uid, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingBaseStoresControllerApi#getWarehousesForBaseStoreId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingBaseStoresControllerApi;

public class WarehousingBaseStoresControllerApiExample {

    public static void main(String[] args) {
        WarehousingBaseStoresControllerApi apiInstance = new WarehousingBaseStoresControllerApi();
        String uid = uid_example; // String | The id of the base store
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            WarehouseSearchPageWsDto result = apiInstance.getWarehousesForBaseStoreId(uid, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingBaseStoresControllerApi#getWarehousesForBaseStoreId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *uid = uid_example; // The id of the base store
Integer *currentPage = 56; // Current page (optional) (default to 0)
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)
Integer *pageSize = 56; // Page size (optional) (default to 10)
String *sort = sort_example; // Sort parameter (optional) (default to asc)

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

// Finds a paginated list of warehouses per a given base store
[apiInstance getWarehousesForBaseStoreIdWith:uid
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    sort:sort
              completionHandler: ^(WarehouseSearchPageWsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingBaseStoresControllerApi()
var uid = uid_example; // {{String}} The id of the base store
var opts = { 
  'currentPage': 56, // {{Integer}} Current page
  'fields': fields_example, // {{String}} Fields mapping level
  'pageSize': 56, // {{Integer}} Page size
  'sort': sort_example // {{String}} Sort parameter
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWarehousesForBaseStoreId(uid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingBaseStoresControllerApi();
            var uid = uid_example;  // String | The id of the base store
            var currentPage = 56;  // Integer | Current page (optional)  (default to 0)
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | Page size (optional)  (default to 10)
            var sort = sort_example;  // String | Sort parameter (optional)  (default to asc)

            try
            {
                // Finds a paginated list of warehouses per a given base store
                WarehouseSearchPageWsDto result = apiInstance.getWarehousesForBaseStoreId(uid, currentPage, fields, pageSize, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingBaseStoresControllerApi.getWarehousesForBaseStoreId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingBaseStoresControllerApi();
$uid = uid_example; // String | The id of the base store
$currentPage = 56; // Integer | Current page
$fields = fields_example; // String | Fields mapping level
$pageSize = 56; // Integer | Page size
$sort = sort_example; // String | Sort parameter

try {
    $result = $api_instance->getWarehousesForBaseStoreId($uid, $currentPage, $fields, $pageSize, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehousingBaseStoresControllerApi->getWarehousesForBaseStoreId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WarehousingBaseStoresControllerApi;

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

my $api_instance = WWW::SwaggerClient::WarehousingBaseStoresControllerApi->new();
my $uid = uid_example; # String | The id of the base store
my $currentPage = 56; # Integer | Current page
my $fields = fields_example; # String | Fields mapping level
my $pageSize = 56; # Integer | Page size
my $sort = sort_example; # String | Sort parameter

eval { 
    my $result = $api_instance->getWarehousesForBaseStoreId(uid => $uid, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingBaseStoresControllerApi->getWarehousesForBaseStoreId: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingBaseStoresControllerApi()
uid = uid_example # String | The id of the base store
currentPage = 56 # Integer | Current page (optional) (default to 0)
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)
pageSize = 56 # Integer | Page size (optional) (default to 10)
sort = sort_example # String | Sort parameter (optional) (default to asc)

try: 
    # Finds a paginated list of warehouses per a given base store
    api_response = api_instance.get_warehouses_for_base_store_id(uid, currentPage=currentPage, fields=fields, pageSize=pageSize, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingBaseStoresControllerApi->getWarehousesForBaseStoreId: %s\n" % e)

Parameters

Path parameters
Name Description
uid*
String
The id of the base store
Required
Query parameters
Name Description
currentPage
Integer (int32)
Current page
fields
String
Fields mapping level
pageSize
Integer (int32)
Page size
sort
String
Sort parameter

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


WarehousingConsignmentsController

confirmPickupConsignment

Confirms a consignment's pickup for a given consignment code

Confirms a consignment's pickup for a given consignment code.


/consignments/{code}/confirm-pickup

Usage and SDK Samples

curl -X POST\
\
\
"//hostname/warehousingwebservices/consignments/{code}/confirm-pickup"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        try {
            apiInstance.confirmPickupConsignment(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#confirmPickupConsignment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        try {
            apiInstance.confirmPickupConsignment(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#confirmPickupConsignment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // The consignment code

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

// Confirms a consignment's pickup for a given consignment code
[apiInstance confirmPickupConsignmentWith:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} The consignment code

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | The consignment code

            try
            {
                // Confirms a consignment's pickup for a given consignment code
                apiInstance.confirmPickupConsignment(code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.confirmPickupConsignment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | The consignment code

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | The consignment code

eval { 
    $api_instance->confirmPickupConsignment(code => $code);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->confirmPickupConsignment: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | The consignment code

try: 
    # Confirms a consignment's pickup for a given consignment code
    api_instance.confirm_pickup_consignment(code)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->confirmPickupConsignment: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The consignment code
Required

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


confirmShipConsignment

Confirms a consignment's shipping for a given consignment code

Confirms a consignment's shipping for a given consignment code.


/consignments/{code}/confirm-shipping

Usage and SDK Samples

curl -X POST\
\
\
"//hostname/warehousingwebservices/consignments/{code}/confirm-shipping"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        try {
            apiInstance.confirmShipConsignment(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#confirmShipConsignment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        try {
            apiInstance.confirmShipConsignment(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#confirmShipConsignment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // The consignment code

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

// Confirms a consignment's shipping for a given consignment code
[apiInstance confirmShipConsignmentWith:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} The consignment code

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | The consignment code

            try
            {
                // Confirms a consignment's shipping for a given consignment code
                apiInstance.confirmShipConsignment(code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.confirmShipConsignment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | The consignment code

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | The consignment code

eval { 
    $api_instance->confirmShipConsignment(code => $code);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->confirmShipConsignment: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | The consignment code

try: 
    # Confirms a consignment's shipping for a given consignment code
    api_instance.confirm_ship_consignment(code)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->confirmShipConsignment: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The consignment code
Required

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


consolidatedPickConsignments

Request to pick multiple Consignments and generate a consolidated Pick Slip

Request to pick multiple Consignments and generate a consolidated Pick Slip.


/consignments/consolidated-pick

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: */*"\
-H "Content-Type: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/consolidated-pick"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        ConsignmentCodesWsDTO body = ; // ConsignmentCodesWsDTO | The ConsignmentsCodesWsDTO which contains the Consignment codes
        try {
            'String' result = apiInstance.consolidatedPickConsignments(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#consolidatedPickConsignments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        ConsignmentCodesWsDTO body = ; // ConsignmentCodesWsDTO | The ConsignmentsCodesWsDTO which contains the Consignment codes
        try {
            'String' result = apiInstance.consolidatedPickConsignments(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#consolidatedPickConsignments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ConsignmentCodesWsDTO *body = ; // The ConsignmentsCodesWsDTO which contains the Consignment codes

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

// Request to pick multiple Consignments and generate a consolidated Pick Slip
[apiInstance consolidatedPickConsignmentsWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var body = ; // {{ConsignmentCodesWsDTO}} The ConsignmentsCodesWsDTO which contains the Consignment codes

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var body = new ConsignmentCodesWsDTO(); // ConsignmentCodesWsDTO | The ConsignmentsCodesWsDTO which contains the Consignment codes

            try
            {
                // Request to pick multiple Consignments and generate a consolidated Pick Slip
                'String' result = apiInstance.consolidatedPickConsignments(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.consolidatedPickConsignments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$body = ; // ConsignmentCodesWsDTO | The ConsignmentsCodesWsDTO which contains the Consignment codes

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $body = WWW::SwaggerClient::Object::ConsignmentCodesWsDTO->new(); # ConsignmentCodesWsDTO | The ConsignmentsCodesWsDTO which contains the Consignment codes

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

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
body =  # ConsignmentCodesWsDTO | The ConsignmentsCodesWsDTO which contains the Consignment codes

try: 
    # Request to pick multiple Consignments and generate a consolidated Pick Slip
    api_response = api_instance.consolidated_pick_consignments(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->consolidatedPickConsignments: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getConsignmentEntriesForConsignmentCode

Finds a paginated list of consignment entries for a given consignment code

Finds a paginated list of consignment entries for a given consignment code.


/consignments/{code}/entries

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/{code}/entries?currentPage=&fields=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            ConsignmentEntrySearchPageWsDto result = apiInstance.getConsignmentEntriesForConsignmentCode(code, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getConsignmentEntriesForConsignmentCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            ConsignmentEntrySearchPageWsDto result = apiInstance.getConsignmentEntriesForConsignmentCode(code, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getConsignmentEntriesForConsignmentCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // The consignment code
Integer *currentPage = 56; // Current page (optional) (default to 0)
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)
Integer *pageSize = 56; // Page size (optional) (default to 10)
String *sort = sort_example; // Sort parameter (optional) (default to asc)

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

// Finds a paginated list of consignment entries for a given consignment code
[apiInstance getConsignmentEntriesForConsignmentCodeWith:code
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    sort:sort
              completionHandler: ^(ConsignmentEntrySearchPageWsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} The consignment code
var opts = { 
  'currentPage': 56, // {{Integer}} Current page
  'fields': fields_example, // {{String}} Fields mapping level
  'pageSize': 56, // {{Integer}} Page size
  'sort': sort_example // {{String}} Sort parameter
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsignmentEntriesForConsignmentCode(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | The consignment code
            var currentPage = 56;  // Integer | Current page (optional)  (default to 0)
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | Page size (optional)  (default to 10)
            var sort = sort_example;  // String | Sort parameter (optional)  (default to asc)

            try
            {
                // Finds a paginated list of consignment entries for a given consignment code
                ConsignmentEntrySearchPageWsDto result = apiInstance.getConsignmentEntriesForConsignmentCode(code, currentPage, fields, pageSize, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getConsignmentEntriesForConsignmentCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | The consignment code
$currentPage = 56; // Integer | Current page
$fields = fields_example; // String | Fields mapping level
$pageSize = 56; // Integer | Page size
$sort = sort_example; // String | Sort parameter

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | The consignment code
my $currentPage = 56; # Integer | Current page
my $fields = fields_example; # String | Fields mapping level
my $pageSize = 56; # Integer | Page size
my $sort = sort_example; # String | Sort parameter

eval { 
    my $result = $api_instance->getConsignmentEntriesForConsignmentCode(code => $code, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->getConsignmentEntriesForConsignmentCode: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | The consignment code
currentPage = 56 # Integer | Current page (optional) (default to 0)
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)
pageSize = 56 # Integer | Page size (optional) (default to 10)
sort = sort_example # String | Sort parameter (optional) (default to asc)

try: 
    # Finds a paginated list of consignment entries for a given consignment code
    api_response = api_instance.get_consignment_entries_for_consignment_code(code, currentPage=currentPage, fields=fields, pageSize=pageSize, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getConsignmentEntriesForConsignmentCode: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The consignment code
Required
Query parameters
Name Description
currentPage
Integer (int32)
Current page
fields
String
Fields mapping level
pageSize
Integer (int32)
Page size
sort
String
Sort parameter

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getConsignmentForCode

Finds a consignment by a given consignment code

Finds a consignment by a given consignment code.


/consignments/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/{code}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        String fields = fields_example; // String | Fields mapping level
        try {
            Consignment result = apiInstance.getConsignmentForCode(code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getConsignmentForCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        String fields = fields_example; // String | Fields mapping level
        try {
            Consignment result = apiInstance.getConsignmentForCode(code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getConsignmentForCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // The consignment code
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Finds a consignment by a given consignment code
[apiInstance getConsignmentForCodeWith:code
    fields:fields
              completionHandler: ^(Consignment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} The consignment code
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsignmentForCode(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | The consignment code
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Finds a consignment by a given consignment code
                Consignment result = apiInstance.getConsignmentForCode(code, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getConsignmentForCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | The consignment code
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | The consignment code
my $fields = fields_example; # String | Fields mapping level

eval { 
    my $result = $api_instance->getConsignmentForCode(code => $code, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->getConsignmentForCode: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | The consignment code
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Finds a consignment by a given consignment code
    api_response = api_instance.get_consignment_for_code(code, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getConsignmentForCode: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The consignment code
Required
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getConsignmentStatuses

Finds a list of all consignment's statuses

Finds a list of all consignment's statuses.


/consignments/statuses

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/statuses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

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

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        try {
            ConsignmentStatusListWsDTO result = apiInstance.getConsignmentStatuses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getConsignmentStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Finds a list of all consignment's statuses
[apiInstance getConsignmentStatusesWithCompletionHandler: 
              ^(ConsignmentStatusListWsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();

            try
            {
                // Finds a list of all consignment's statuses
                ConsignmentStatusListWsDTO result = apiInstance.getConsignmentStatuses();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getConsignmentStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();

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

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

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

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

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

try: 
    # Finds a list of all consignment's statuses
    api_response = api_instance.get_consignment_statuses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getConsignmentStatuses: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getConsignments

Finds a paginated list of consignments

Finds a paginated list of consignments.


/consignments

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments?currentPage=&fields=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            ConsignmentSearchPageWsDto result = apiInstance.getConsignments(currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getConsignments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            ConsignmentSearchPageWsDto result = apiInstance.getConsignments(currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getConsignments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *currentPage = 56; // Current page (optional) (default to 0)
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)
Integer *pageSize = 56; // Page size (optional) (default to 10)
String *sort = sort_example; // Sort parameter (optional) (default to asc)

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

// Finds a paginated list of consignments
[apiInstance getConsignmentsWith:currentPage
    fields:fields
    pageSize:pageSize
    sort:sort
              completionHandler: ^(ConsignmentSearchPageWsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var opts = { 
  'currentPage': 56, // {{Integer}} Current page
  'fields': fields_example, // {{String}} Fields mapping level
  'pageSize': 56, // {{Integer}} Page size
  'sort': sort_example // {{String}} Sort parameter
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsignments(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var currentPage = 56;  // Integer | Current page (optional)  (default to 0)
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | Page size (optional)  (default to 10)
            var sort = sort_example;  // String | Sort parameter (optional)  (default to asc)

            try
            {
                // Finds a paginated list of consignments
                ConsignmentSearchPageWsDto result = apiInstance.getConsignments(currentPage, fields, pageSize, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getConsignments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$currentPage = 56; // Integer | Current page
$fields = fields_example; // String | Fields mapping level
$pageSize = 56; // Integer | Page size
$sort = sort_example; // String | Sort parameter

try {
    $result = $api_instance->getConsignments($currentPage, $fields, $pageSize, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehousingConsignmentsControllerApi->getConsignments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WarehousingConsignmentsControllerApi;

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $currentPage = 56; # Integer | Current page
my $fields = fields_example; # String | Fields mapping level
my $pageSize = 56; # Integer | Page size
my $sort = sort_example; # String | Sort parameter

eval { 
    my $result = $api_instance->getConsignments(currentPage => $currentPage, fields => $fields, pageSize => $pageSize, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->getConsignments: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
currentPage = 56 # Integer | Current page (optional) (default to 0)
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)
pageSize = 56 # Integer | Page size (optional) (default to 10)
sort = sort_example # String | Sort parameter (optional) (default to asc)

try: 
    # Finds a paginated list of consignments
    api_response = api_instance.get_consignments(currentPage=currentPage, fields=fields, pageSize=pageSize, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getConsignments: %s\n" % e)

Parameters

Query parameters
Name Description
currentPage
Integer (int32)
Current page
fields
String
Fields mapping level
pageSize
Integer (int32)
Page size
sort
String
Sort parameter

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getConsignmentsByStatus

Finds a paginated list of consignments for a given consignment status

Finds a paginated list of consignments for a given consignment status


/consignments/status/{consignmentStatuses}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/status/{consignmentStatuses}?currentPage=&fields=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String consignmentStatuses = consignmentStatuses_example; // String | Consignment status
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            ConsignmentSearchPageWsDto result = apiInstance.getConsignmentsByStatus(consignmentStatuses, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getConsignmentsByStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String consignmentStatuses = consignmentStatuses_example; // String | Consignment status
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            ConsignmentSearchPageWsDto result = apiInstance.getConsignmentsByStatus(consignmentStatuses, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getConsignmentsByStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consignmentStatuses = consignmentStatuses_example; // Consignment status
Integer *currentPage = 56; // Current page (optional) (default to 0)
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)
Integer *pageSize = 56; // Page size (optional) (default to 10)
String *sort = sort_example; // Sort parameter (optional) (default to asc)

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

// Finds a paginated list of consignments for a given consignment status
[apiInstance getConsignmentsByStatusWith:consignmentStatuses
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    sort:sort
              completionHandler: ^(ConsignmentSearchPageWsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var consignmentStatuses = consignmentStatuses_example; // {{String}} Consignment status
var opts = { 
  'currentPage': 56, // {{Integer}} Current page
  'fields': fields_example, // {{String}} Fields mapping level
  'pageSize': 56, // {{Integer}} Page size
  'sort': sort_example // {{String}} Sort parameter
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsignmentsByStatus(consignmentStatuses, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var consignmentStatuses = consignmentStatuses_example;  // String | Consignment status
            var currentPage = 56;  // Integer | Current page (optional)  (default to 0)
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | Page size (optional)  (default to 10)
            var sort = sort_example;  // String | Sort parameter (optional)  (default to asc)

            try
            {
                // Finds a paginated list of consignments for a given consignment status
                ConsignmentSearchPageWsDto result = apiInstance.getConsignmentsByStatus(consignmentStatuses, currentPage, fields, pageSize, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getConsignmentsByStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$consignmentStatuses = consignmentStatuses_example; // String | Consignment status
$currentPage = 56; // Integer | Current page
$fields = fields_example; // String | Fields mapping level
$pageSize = 56; // Integer | Page size
$sort = sort_example; // String | Sort parameter

try {
    $result = $api_instance->getConsignmentsByStatus($consignmentStatuses, $currentPage, $fields, $pageSize, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehousingConsignmentsControllerApi->getConsignmentsByStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WarehousingConsignmentsControllerApi;

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $consignmentStatuses = consignmentStatuses_example; # String | Consignment status
my $currentPage = 56; # Integer | Current page
my $fields = fields_example; # String | Fields mapping level
my $pageSize = 56; # Integer | Page size
my $sort = sort_example; # String | Sort parameter

eval { 
    my $result = $api_instance->getConsignmentsByStatus(consignmentStatuses => $consignmentStatuses, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->getConsignmentsByStatus: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
consignmentStatuses = consignmentStatuses_example # String | Consignment status
currentPage = 56 # Integer | Current page (optional) (default to 0)
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)
pageSize = 56 # Integer | Page size (optional) (default to 10)
sort = sort_example # String | Sort parameter (optional) (default to asc)

try: 
    # Finds a paginated list of consignments for a given consignment status
    api_response = api_instance.get_consignments_by_status(consignmentStatuses, currentPage=currentPage, fields=fields, pageSize=pageSize, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getConsignmentsByStatus: %s\n" % e)

Parameters

Path parameters
Name Description
consignmentStatuses*
String
Consignment status
Required
Query parameters
Name Description
currentPage
Integer (int32)
Current page
fields
String
Fields mapping level
pageSize
Integer (int32)
Page size
sort
String
Sort parameter

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getDeclineReasons

Finds a list of all decline reasons

Finds a list of all decline reasons.


/consignments/decline-reasons

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/decline-reasons"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

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

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        try {
            DeclineReasonListWsDTO result = apiInstance.getDeclineReasons();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getDeclineReasons");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Finds a list of all decline reasons
[apiInstance getDeclineReasonsWithCompletionHandler: 
              ^(DeclineReasonListWsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();

            try
            {
                // Finds a list of all decline reasons
                DeclineReasonListWsDTO result = apiInstance.getDeclineReasons();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getDeclineReasons: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();

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

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

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

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

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

try: 
    # Finds a list of all decline reasons
    api_response = api_instance.get_decline_reasons()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getDeclineReasons: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getExportForm

Request to ge the Export Form for a given Consignment

Request to ge the Export Form for a given Consignment.


/consignments/{code}/export-form

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: */*"\
"//hostname/warehousingwebservices/consignments/{code}/export-form"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.getExportForm(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getExportForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.getExportForm(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getExportForm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Code corresponding to the desired consignment

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

// Request to ge the Export Form for a given Consignment
[apiInstance getExportFormWith:code
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} Code corresponding to the desired consignment

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | Code corresponding to the desired consignment

            try
            {
                // Request to ge the Export Form for a given Consignment
                'String' result = apiInstance.getExportForm(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getExportForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | Code corresponding to the desired consignment

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | Code corresponding to the desired consignment

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

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | Code corresponding to the desired consignment

try: 
    # Request to ge the Export Form for a given Consignment
    api_response = api_instance.get_export_form(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getExportForm: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code corresponding to the desired consignment
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getPackagingInfo

Finds the packaging information for the given consignment code

Finds the packaging information for the given consignment code.


/consignments/{code}/packaging-info

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/{code}/packaging-info"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        try {
            PackagingInfo result = apiInstance.getPackagingInfo(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getPackagingInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        try {
            PackagingInfo result = apiInstance.getPackagingInfo(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getPackagingInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // The consignment code

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

// Finds the packaging information for the given consignment code
[apiInstance getPackagingInfoWith:code
              completionHandler: ^(PackagingInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} The consignment code

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | The consignment code

            try
            {
                // Finds the packaging information for the given consignment code
                PackagingInfo result = apiInstance.getPackagingInfo(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getPackagingInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | The consignment code

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | The consignment code

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

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | The consignment code

try: 
    # Finds the packaging information for the given consignment code
    api_response = api_instance.get_packaging_info(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getPackagingInfo: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The consignment code
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getReturnForm

Request to get the Return form for a given Consignment

Request to get the Return form for a given Consignment.


/consignments/{code}/return-form

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: */*"\
"//hostname/warehousingwebservices/consignments/{code}/return-form"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.getReturnForm(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getReturnForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.getReturnForm(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getReturnForm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Code corresponding to the desired consignment

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

// Request to get the Return form for a given Consignment
[apiInstance getReturnFormWith:code
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} Code corresponding to the desired consignment

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | Code corresponding to the desired consignment

            try
            {
                // Request to get the Return form for a given Consignment
                'String' result = apiInstance.getReturnForm(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getReturnForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | Code corresponding to the desired consignment

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | Code corresponding to the desired consignment

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

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | Code corresponding to the desired consignment

try: 
    # Request to get the Return form for a given Consignment
    api_response = api_instance.get_return_form(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getReturnForm: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code corresponding to the desired consignment
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getReturnShippingLabel

Request to get the Return Shipping Label for a given Consignment

Request to get the Return Shipping Label for a given Consignment.


/consignments/{code}/return-shipping-label

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: */*"\
"//hostname/warehousingwebservices/consignments/{code}/return-shipping-label"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.getReturnShippingLabel(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getReturnShippingLabel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.getReturnShippingLabel(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getReturnShippingLabel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Code corresponding to the desired consignment

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

// Request to get the Return Shipping Label for a given Consignment
[apiInstance getReturnShippingLabelWith:code
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} Code corresponding to the desired consignment

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | Code corresponding to the desired consignment

            try
            {
                // Request to get the Return Shipping Label for a given Consignment
                'String' result = apiInstance.getReturnShippingLabel(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getReturnShippingLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | Code corresponding to the desired consignment

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | Code corresponding to the desired consignment

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

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | Code corresponding to the desired consignment

try: 
    # Request to get the Return Shipping Label for a given Consignment
    api_response = api_instance.get_return_shipping_label(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getReturnShippingLabel: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code corresponding to the desired consignment
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getShippingLabel

Request to get the Shipping Label for a given Consignment

Request to get the Shipping Label for a given Consignment.


/consignments/{code}/shipping-label

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: */*"\
"//hostname/warehousingwebservices/consignments/{code}/shipping-label"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.getShippingLabel(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getShippingLabel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.getShippingLabel(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getShippingLabel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Code corresponding to the desired consignment

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

// Request to get the Shipping Label for a given Consignment
[apiInstance getShippingLabelWith:code
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} Code corresponding to the desired consignment

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | Code corresponding to the desired consignment

            try
            {
                // Request to get the Shipping Label for a given Consignment
                'String' result = apiInstance.getShippingLabel(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getShippingLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | Code corresponding to the desired consignment

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | Code corresponding to the desired consignment

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

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | Code corresponding to the desired consignment

try: 
    # Request to get the Shipping Label for a given Consignment
    api_response = api_instance.get_shipping_label(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getShippingLabel: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code corresponding to the desired consignment
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getSourcingLocationsForConsignmentCode

Finds a paginated list of sourcing locations for a given consignment code

Finds a paginated list of sourcing locations for a given consignment code.


/consignments/{code}/sourcing-locations

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/{code}/sourcing-locations?currentPage=&fields=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            WarehouseSearchPageWsDto result = apiInstance.getSourcingLocationsForConsignmentCode(code, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getSourcingLocationsForConsignmentCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            WarehouseSearchPageWsDto result = apiInstance.getSourcingLocationsForConsignmentCode(code, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#getSourcingLocationsForConsignmentCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // The consignment code
Integer *currentPage = 56; // Current page (optional) (default to 0)
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)
Integer *pageSize = 56; // Page size (optional) (default to 10)
String *sort = sort_example; // Sort parameter (optional) (default to asc)

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

// Finds a paginated list of sourcing locations for a given consignment code
[apiInstance getSourcingLocationsForConsignmentCodeWith:code
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    sort:sort
              completionHandler: ^(WarehouseSearchPageWsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} The consignment code
var opts = { 
  'currentPage': 56, // {{Integer}} Current page
  'fields': fields_example, // {{String}} Fields mapping level
  'pageSize': 56, // {{Integer}} Page size
  'sort': sort_example // {{String}} Sort parameter
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSourcingLocationsForConsignmentCode(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | The consignment code
            var currentPage = 56;  // Integer | Current page (optional)  (default to 0)
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | Page size (optional)  (default to 10)
            var sort = sort_example;  // String | Sort parameter (optional)  (default to asc)

            try
            {
                // Finds a paginated list of sourcing locations for a given consignment code
                WarehouseSearchPageWsDto result = apiInstance.getSourcingLocationsForConsignmentCode(code, currentPage, fields, pageSize, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.getSourcingLocationsForConsignmentCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | The consignment code
$currentPage = 56; // Integer | Current page
$fields = fields_example; // String | Fields mapping level
$pageSize = 56; // Integer | Page size
$sort = sort_example; // String | Sort parameter

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | The consignment code
my $currentPage = 56; # Integer | Current page
my $fields = fields_example; # String | Fields mapping level
my $pageSize = 56; # Integer | Page size
my $sort = sort_example; # String | Sort parameter

eval { 
    my $result = $api_instance->getSourcingLocationsForConsignmentCode(code => $code, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->getSourcingLocationsForConsignmentCode: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | The consignment code
currentPage = 56 # Integer | Current page (optional) (default to 0)
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)
pageSize = 56 # Integer | Page size (optional) (default to 10)
sort = sort_example # String | Sort parameter (optional) (default to asc)

try: 
    # Finds a paginated list of sourcing locations for a given consignment code
    api_response = api_instance.get_sourcing_locations_for_consignment_code(code, currentPage=currentPage, fields=fields, pageSize=pageSize, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->getSourcingLocationsForConsignmentCode: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The consignment code
Required
Query parameters
Name Description
currentPage
Integer (int32)
Current page
fields
String
Fields mapping level
pageSize
Integer (int32)
Page size
sort
String
Sort parameter

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


isConsignmentConfirmable

Checks if a consignment can be confirmed

Checks if a consignment can be confirmed.


/consignments/{code}/is-confirmable

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/{code}/is-confirmable"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        try {
            'Boolean' result = apiInstance.isConsignmentConfirmable(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#isConsignmentConfirmable");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | The consignment code
        try {
            'Boolean' result = apiInstance.isConsignmentConfirmable(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#isConsignmentConfirmable");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // The consignment code

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

// Checks if a consignment can be confirmed
[apiInstance isConsignmentConfirmableWith:code
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} The consignment code

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | The consignment code

            try
            {
                // Checks if a consignment can be confirmed
                'Boolean' result = apiInstance.isConsignmentConfirmable(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.isConsignmentConfirmable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | The consignment code

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | The consignment code

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

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | The consignment code

try: 
    # Checks if a consignment can be confirmed
    api_response = api_instance.is_consignment_confirmable(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->isConsignmentConfirmable: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The consignment code
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


manuallyReleasePaymentCapture

Moves a consignment out of the waiting step after the payment capture has failed.

Moves a consignment out of the waiting step after the payment capture has failed.


/consignments/{code}/manual/capture-payment

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/{code}/manual/capture-payment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.manuallyReleasePaymentCapture(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#manuallyReleasePaymentCapture");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.manuallyReleasePaymentCapture(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#manuallyReleasePaymentCapture");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Code corresponding to the desired consignment

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

// Moves a consignment out of the waiting step after the payment capture has failed.
[apiInstance manuallyReleasePaymentCaptureWith:code
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} Code corresponding to the desired consignment

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | Code corresponding to the desired consignment

            try
            {
                // Moves a consignment out of the waiting step after the payment capture has failed.
                'String' result = apiInstance.manuallyReleasePaymentCapture(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.manuallyReleasePaymentCapture: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | Code corresponding to the desired consignment

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | Code corresponding to the desired consignment

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

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | Code corresponding to the desired consignment

try: 
    # Moves a consignment out of the waiting step after the payment capture has failed.
    api_response = api_instance.manually_release_payment_capture(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->manuallyReleasePaymentCapture: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code corresponding to the desired consignment
Required

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


manuallyReleaseTaxCommit

Moves a consignment out of the waiting step after a tax commit has failed

Moves a consignment out of the waiting step after a tax commit has failed.


/consignments/{code}/manual/commit-tax

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/{code}/manual/commit-tax"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.manuallyReleaseTaxCommit(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#manuallyReleaseTaxCommit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        try {
            'String' result = apiInstance.manuallyReleaseTaxCommit(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#manuallyReleaseTaxCommit");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Code corresponding to the desired consignment

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

// Moves a consignment out of the waiting step after a tax commit has failed
[apiInstance manuallyReleaseTaxCommitWith:code
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} Code corresponding to the desired consignment

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | Code corresponding to the desired consignment

            try
            {
                // Moves a consignment out of the waiting step after a tax commit has failed
                'String' result = apiInstance.manuallyReleaseTaxCommit(code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.manuallyReleaseTaxCommit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | Code corresponding to the desired consignment

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | Code corresponding to the desired consignment

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

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | Code corresponding to the desired consignment

try: 
    # Moves a consignment out of the waiting step after a tax commit has failed
    api_response = api_instance.manually_release_tax_commit(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->manuallyReleaseTaxCommit: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code corresponding to the desired consignment
Required

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


packConsignment

Request to pack a given Consignment and optionally generate its Pack Label

Request to pack a given Consignment and optionally generate its Pack Label.


/consignments/{code}/pack

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: */*"\
"//hostname/warehousingwebservices/consignments/{code}/pack?printSlip="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        Boolean printSlip = true; // Boolean | Flag for backwards compatibility. Used to check if the pack label will be generated
        try {
            'String' result = apiInstance.packConsignment(code, printSlip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#packConsignment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        Boolean printSlip = true; // Boolean | Flag for backwards compatibility. Used to check if the pack label will be generated
        try {
            'String' result = apiInstance.packConsignment(code, printSlip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#packConsignment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Code corresponding to the desired consignment
Boolean *printSlip = true; // Flag for backwards compatibility. Used to check if the pack label will be generated (optional) (default to true)

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

// Request to pack a given Consignment and optionally generate its Pack Label
[apiInstance packConsignmentWith:code
    printSlip:printSlip
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} Code corresponding to the desired consignment
var opts = { 
  'printSlip': true // {{Boolean}} Flag for backwards compatibility. Used to check if the pack label will be generated
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.packConsignment(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | Code corresponding to the desired consignment
            var printSlip = true;  // Boolean | Flag for backwards compatibility. Used to check if the pack label will be generated (optional)  (default to true)

            try
            {
                // Request to pack a given Consignment and optionally generate its Pack Label
                'String' result = apiInstance.packConsignment(code, printSlip);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.packConsignment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | Code corresponding to the desired consignment
$printSlip = true; // Boolean | Flag for backwards compatibility. Used to check if the pack label will be generated

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | Code corresponding to the desired consignment
my $printSlip = true; # Boolean | Flag for backwards compatibility. Used to check if the pack label will be generated

eval { 
    my $result = $api_instance->packConsignment(code => $code, printSlip => $printSlip);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->packConsignment: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | Code corresponding to the desired consignment
printSlip = true # Boolean | Flag for backwards compatibility. Used to check if the pack label will be generated (optional) (default to true)

try: 
    # Request to pack a given Consignment and optionally generate its Pack Label
    api_response = api_instance.pack_consignment(code, printSlip=printSlip)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->packConsignment: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code corresponding to the desired consignment
Required
Query parameters
Name Description
printSlip
Boolean
Flag for backwards compatibility. Used to check if the pack label will be generated

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


pickConsignment

Request to pick a given Consignment and optionally generate its Pick Slip

Request to pick a given Consignment and optionally generate its Pick Slip.


/consignments/{code}/pick

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: */*"\
"//hostname/warehousingwebservices/consignments/{code}/pick?printSlip="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        Boolean printSlip = true; // Boolean | Flag for backwards compatibility. Used to check if the pick slip will be generated 
        try {
            'String' result = apiInstance.pickConsignment(code, printSlip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#pickConsignment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        Boolean printSlip = true; // Boolean | Flag for backwards compatibility. Used to check if the pick slip will be generated 
        try {
            'String' result = apiInstance.pickConsignment(code, printSlip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#pickConsignment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Code corresponding to the desired consignment
Boolean *printSlip = true; // Flag for backwards compatibility. Used to check if the pick slip will be generated  (optional) (default to true)

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

// Request to pick a given Consignment and optionally generate its Pick Slip
[apiInstance pickConsignmentWith:code
    printSlip:printSlip
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} Code corresponding to the desired consignment
var opts = { 
  'printSlip': true // {{Boolean}} Flag for backwards compatibility. Used to check if the pick slip will be generated 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pickConsignment(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | Code corresponding to the desired consignment
            var printSlip = true;  // Boolean | Flag for backwards compatibility. Used to check if the pick slip will be generated  (optional)  (default to true)

            try
            {
                // Request to pick a given Consignment and optionally generate its Pick Slip
                'String' result = apiInstance.pickConsignment(code, printSlip);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.pickConsignment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | Code corresponding to the desired consignment
$printSlip = true; // Boolean | Flag for backwards compatibility. Used to check if the pick slip will be generated 

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | Code corresponding to the desired consignment
my $printSlip = true; # Boolean | Flag for backwards compatibility. Used to check if the pick slip will be generated 

eval { 
    my $result = $api_instance->pickConsignment(code => $code, printSlip => $printSlip);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->pickConsignment: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | Code corresponding to the desired consignment
printSlip = true # Boolean | Flag for backwards compatibility. Used to check if the pick slip will be generated  (optional) (default to true)

try: 
    # Request to pick a given Consignment and optionally generate its Pick Slip
    api_response = api_instance.pick_consignment(code, printSlip=printSlip)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->pickConsignment: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code corresponding to the desired consignment
Required
Query parameters
Name Description
printSlip
Boolean
Flag for backwards compatibility. Used to check if the pick slip will be generated

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


reallocateConsignment

Reallocates a given consignment

Reallocates a given consignment.


/consignments/{code}/reallocate

Usage and SDK Samples

curl -X POST\
\
\
-H "Content-Type: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/{code}/reallocate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        ConsignmentReallocationWsDTO body = ; // ConsignmentReallocationWsDTO | The ConsignmentReallocationWsDTO containing entries to be reallocated
        String code = code_example; // String | The consignment code
        try {
            apiInstance.reallocateConsignment(body, code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#reallocateConsignment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        ConsignmentReallocationWsDTO body = ; // ConsignmentReallocationWsDTO | The ConsignmentReallocationWsDTO containing entries to be reallocated
        String code = code_example; // String | The consignment code
        try {
            apiInstance.reallocateConsignment(body, code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#reallocateConsignment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ConsignmentReallocationWsDTO *body = ; // The ConsignmentReallocationWsDTO containing entries to be reallocated
String *code = code_example; // The consignment code

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

// Reallocates a given consignment
[apiInstance reallocateConsignmentWith:body
    code:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var body = ; // {{ConsignmentReallocationWsDTO}} The ConsignmentReallocationWsDTO containing entries to be reallocated
var code = code_example; // {{String}} The consignment code

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

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var body = new ConsignmentReallocationWsDTO(); // ConsignmentReallocationWsDTO | The ConsignmentReallocationWsDTO containing entries to be reallocated
            var code = code_example;  // String | The consignment code

            try
            {
                // Reallocates a given consignment
                apiInstance.reallocateConsignment(body, code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.reallocateConsignment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$body = ; // ConsignmentReallocationWsDTO | The ConsignmentReallocationWsDTO containing entries to be reallocated
$code = code_example; // String | The consignment code

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $body = WWW::SwaggerClient::Object::ConsignmentReallocationWsDTO->new(); # ConsignmentReallocationWsDTO | The ConsignmentReallocationWsDTO containing entries to be reallocated
my $code = code_example; # String | The consignment code

eval { 
    $api_instance->reallocateConsignment(body => $body, code => $code);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->reallocateConsignment: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
body =  # ConsignmentReallocationWsDTO | The ConsignmentReallocationWsDTO containing entries to be reallocated
code = code_example # String | The consignment code

try: 
    # Reallocates a given consignment
    api_instance.reallocate_consignment(body, code)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->reallocateConsignment: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The consignment code
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


takePayment

Request to take a payment for a given Consignment

Request to take a payment for a given Consignment.


/consignments/{code}/take-payment

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/{code}/take-payment?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        String fields = fields_example; // String | Fields mapping level
        try {
            PaymentTransactionEntryWsDTO result = apiInstance.takePayment(code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#takePayment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        String code = code_example; // String | Code corresponding to the desired consignment
        String fields = fields_example; // String | Fields mapping level
        try {
            PaymentTransactionEntryWsDTO result = apiInstance.takePayment(code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#takePayment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Code corresponding to the desired consignment
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Request to take a payment for a given Consignment
[apiInstance takePaymentWith:code
    fields:fields
              completionHandler: ^(PaymentTransactionEntryWsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var code = code_example; // {{String}} Code corresponding to the desired consignment
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.takePayment(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var code = code_example;  // String | Code corresponding to the desired consignment
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Request to take a payment for a given Consignment
                PaymentTransactionEntryWsDTO result = apiInstance.takePayment(code, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.takePayment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$code = code_example; // String | Code corresponding to the desired consignment
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $code = code_example; # String | Code corresponding to the desired consignment
my $fields = fields_example; # String | Fields mapping level

eval { 
    my $result = $api_instance->takePayment(code => $code, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->takePayment: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
code = code_example # String | Code corresponding to the desired consignment
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Request to take a payment for a given Consignment
    api_response = api_instance.take_payment(code, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->takePayment: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Code corresponding to the desired consignment
Required
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


updatePackagingInfo

Updates a consignment's packaging information

Updates a consignment's packaging information.


/consignments/{code}/packaging-info

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"//hostname/warehousingwebservices/consignments/{code}/packaging-info?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

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

public class WarehousingConsignmentsControllerApiExample {

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

        // 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");

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

        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        PackagingInfo body = ; // PackagingInfo | The PackagingInfoWsDTO to update the consignment with
        String code = code_example; // String | The consignment code
        String fields = fields_example; // String | Fields mapping level
        try {
            Consignment result = apiInstance.updatePackagingInfo(body, code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#updatePackagingInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingConsignmentsControllerApi;

public class WarehousingConsignmentsControllerApiExample {

    public static void main(String[] args) {
        WarehousingConsignmentsControllerApi apiInstance = new WarehousingConsignmentsControllerApi();
        PackagingInfo body = ; // PackagingInfo | The PackagingInfoWsDTO to update the consignment with
        String code = code_example; // String | The consignment code
        String fields = fields_example; // String | Fields mapping level
        try {
            Consignment result = apiInstance.updatePackagingInfo(body, code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingConsignmentsControllerApi#updatePackagingInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PackagingInfo *body = ; // The PackagingInfoWsDTO to update the consignment with
String *code = code_example; // The consignment code
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Updates a consignment's packaging information
[apiInstance updatePackagingInfoWith:body
    code:code
    fields:fields
              completionHandler: ^(Consignment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingConsignmentsControllerApi()
var body = ; // {{PackagingInfo}} The PackagingInfoWsDTO to update the consignment with
var code = code_example; // {{String}} The consignment code
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePackagingInfo(bodycode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingConsignmentsControllerApi();
            var body = new PackagingInfo(); // PackagingInfo | The PackagingInfoWsDTO to update the consignment with
            var code = code_example;  // String | The consignment code
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Updates a consignment's packaging information
                Consignment result = apiInstance.updatePackagingInfo(body, code, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingConsignmentsControllerApi.updatePackagingInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingConsignmentsControllerApi();
$body = ; // PackagingInfo | The PackagingInfoWsDTO to update the consignment with
$code = code_example; // String | The consignment code
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingConsignmentsControllerApi->new();
my $body = WWW::SwaggerClient::Object::PackagingInfo->new(); # PackagingInfo | The PackagingInfoWsDTO to update the consignment with
my $code = code_example; # String | The consignment code
my $fields = fields_example; # String | Fields mapping level

eval { 
    my $result = $api_instance->updatePackagingInfo(body => $body, code => $code, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingConsignmentsControllerApi->updatePackagingInfo: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingConsignmentsControllerApi()
body =  # PackagingInfo | The PackagingInfoWsDTO to update the consignment with
code = code_example # String | The consignment code
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Updates a consignment's packaging information
    api_response = api_instance.update_packaging_info(body, code, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingConsignmentsControllerApi->updatePackagingInfo: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The consignment code
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


WarehousingOrdersController

putOrderOnHold

Puts an order on hold

Puts an order on hold.


/orders/{code}/on-hold

Usage and SDK Samples

curl -X POST\
\
\
"//hostname/warehousingwebservices/orders/{code}/on-hold"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingOrdersControllerApi;

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

public class WarehousingOrdersControllerApiExample {

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

        // 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");

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

        WarehousingOrdersControllerApi apiInstance = new WarehousingOrdersControllerApi();
        String code = code_example; // String | Order code
        try {
            apiInstance.putOrderOnHold(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingOrdersControllerApi#putOrderOnHold");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingOrdersControllerApi;

public class WarehousingOrdersControllerApiExample {

    public static void main(String[] args) {
        WarehousingOrdersControllerApi apiInstance = new WarehousingOrdersControllerApi();
        String code = code_example; // String | Order code
        try {
            apiInstance.putOrderOnHold(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingOrdersControllerApi#putOrderOnHold");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Order code

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

// Puts an order on hold
[apiInstance putOrderOnHoldWith:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingOrdersControllerApi()
var code = code_example; // {{String}} Order code

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

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

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

            var apiInstance = new WarehousingOrdersControllerApi();
            var code = code_example;  // String | Order code

            try
            {
                // Puts an order on hold
                apiInstance.putOrderOnHold(code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingOrdersControllerApi.putOrderOnHold: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingOrdersControllerApi();
$code = code_example; // String | Order code

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

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

my $api_instance = WWW::SwaggerClient::WarehousingOrdersControllerApi->new();
my $code = code_example; # String | Order code

eval { 
    $api_instance->putOrderOnHold(code => $code);
};
if ($@) {
    warn "Exception when calling WarehousingOrdersControllerApi->putOrderOnHold: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingOrdersControllerApi()
code = code_example # String | Order code

try: 
    # Puts an order on hold
    api_instance.put_order_on_hold(code)
except ApiException as e:
    print("Exception when calling WarehousingOrdersControllerApi->putOrderOnHold: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Order code
Required

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


reSourceOrder

Resources an order

Resources an order.


/orders/{code}/re-source

Usage and SDK Samples

curl -X POST\
\
\
"//hostname/warehousingwebservices/orders/{code}/re-source"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingOrdersControllerApi;

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

public class WarehousingOrdersControllerApiExample {

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

        // 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");

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

        WarehousingOrdersControllerApi apiInstance = new WarehousingOrdersControllerApi();
        String code = code_example; // String | Order code
        try {
            apiInstance.reSourceOrder(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingOrdersControllerApi#reSourceOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingOrdersControllerApi;

public class WarehousingOrdersControllerApiExample {

    public static void main(String[] args) {
        WarehousingOrdersControllerApi apiInstance = new WarehousingOrdersControllerApi();
        String code = code_example; // String | Order code
        try {
            apiInstance.reSourceOrder(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingOrdersControllerApi#reSourceOrder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Order code

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

// Resources an order
[apiInstance reSourceOrderWith:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingOrdersControllerApi()
var code = code_example; // {{String}} Order code

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

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

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

            var apiInstance = new WarehousingOrdersControllerApi();
            var code = code_example;  // String | Order code

            try
            {
                // Resources an order
                apiInstance.reSourceOrder(code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingOrdersControllerApi.reSourceOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingOrdersControllerApi();
$code = code_example; // String | Order code

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

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

my $api_instance = WWW::SwaggerClient::WarehousingOrdersControllerApi->new();
my $code = code_example; # String | Order code

eval { 
    $api_instance->reSourceOrder(code => $code);
};
if ($@) {
    warn "Exception when calling WarehousingOrdersControllerApi->reSourceOrder: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingOrdersControllerApi()
code = code_example # String | Order code

try: 
    # Resources an order
    api_instance.re_source_order(code)
except ApiException as e:
    print("Exception when calling WarehousingOrdersControllerApi->reSourceOrder: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Order code
Required

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


WarehousingPointOfServicesController

deleteWarehousesFromPointOfService

Request to delete a warehouse from point of service

Request to delete a warehouse from point of service.


/pointofservices/{pointOfServiceName}/warehouses/{warehouseCode}

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/pointofservices/{pointOfServiceName}/warehouses/{warehouseCode}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingPointOfServicesControllerApi;

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

public class WarehousingPointOfServicesControllerApiExample {

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

        // 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");

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

        WarehousingPointOfServicesControllerApi apiInstance = new WarehousingPointOfServicesControllerApi();
        String pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
        String warehouseCode = warehouseCode_example; // String | The code of the warehouse to be deleted from the point of service
        String fields = fields_example; // String | Fields mapping level
        try {
            PointOfService result = apiInstance.deleteWarehousesFromPointOfService(pointOfServiceName, warehouseCode, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingPointOfServicesControllerApi#deleteWarehousesFromPointOfService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingPointOfServicesControllerApi;

public class WarehousingPointOfServicesControllerApiExample {

    public static void main(String[] args) {
        WarehousingPointOfServicesControllerApi apiInstance = new WarehousingPointOfServicesControllerApi();
        String pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
        String warehouseCode = warehouseCode_example; // String | The code of the warehouse to be deleted from the point of service
        String fields = fields_example; // String | Fields mapping level
        try {
            PointOfService result = apiInstance.deleteWarehousesFromPointOfService(pointOfServiceName, warehouseCode, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingPointOfServicesControllerApi#deleteWarehousesFromPointOfService");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *pointOfServiceName = pointOfServiceName_example; // The name of the point of service
String *warehouseCode = warehouseCode_example; // The code of the warehouse to be deleted from the point of service
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Request to delete a warehouse from point of service
[apiInstance deleteWarehousesFromPointOfServiceWith:pointOfServiceName
    warehouseCode:warehouseCode
    fields:fields
              completionHandler: ^(PointOfService output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingPointOfServicesControllerApi()
var pointOfServiceName = pointOfServiceName_example; // {{String}} The name of the point of service
var warehouseCode = warehouseCode_example; // {{String}} The code of the warehouse to be deleted from the point of service
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteWarehousesFromPointOfService(pointOfServiceName, warehouseCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingPointOfServicesControllerApi();
            var pointOfServiceName = pointOfServiceName_example;  // String | The name of the point of service
            var warehouseCode = warehouseCode_example;  // String | The code of the warehouse to be deleted from the point of service
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Request to delete a warehouse from point of service
                PointOfService result = apiInstance.deleteWarehousesFromPointOfService(pointOfServiceName, warehouseCode, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingPointOfServicesControllerApi.deleteWarehousesFromPointOfService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingPointOfServicesControllerApi();
$pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
$warehouseCode = warehouseCode_example; // String | The code of the warehouse to be deleted from the point of service
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingPointOfServicesControllerApi->new();
my $pointOfServiceName = pointOfServiceName_example; # String | The name of the point of service
my $warehouseCode = warehouseCode_example; # String | The code of the warehouse to be deleted from the point of service
my $fields = fields_example; # String | Fields mapping level

eval { 
    my $result = $api_instance->deleteWarehousesFromPointOfService(pointOfServiceName => $pointOfServiceName, warehouseCode => $warehouseCode, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingPointOfServicesControllerApi->deleteWarehousesFromPointOfService: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingPointOfServicesControllerApi()
pointOfServiceName = pointOfServiceName_example # String | The name of the point of service
warehouseCode = warehouseCode_example # String | The code of the warehouse to be deleted from the point of service
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Request to delete a warehouse from point of service
    api_response = api_instance.delete_warehouses_from_point_of_service(pointOfServiceName, warehouseCode, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingPointOfServicesControllerApi->deleteWarehousesFromPointOfService: %s\n" % e)

Parameters

Path parameters
Name Description
pointOfServiceName*
String
The name of the point of service
Required
warehouseCode*
String
The code of the warehouse to be deleted from the point of service
Required
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden


getPointOfServiceByName

Finds one point of service by name

Finds one point of service by name.


/pointofservices/{name}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/pointofservices/{name}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingPointOfServicesControllerApi;

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

public class WarehousingPointOfServicesControllerApiExample {

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

        // 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");

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

        WarehousingPointOfServicesControllerApi apiInstance = new WarehousingPointOfServicesControllerApi();
        String name = name_example; // String | The name of the point of service to be fetched
        String fields = fields_example; // String | Fields mapping level
        try {
            PointOfService result = apiInstance.getPointOfServiceByName(name, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingPointOfServicesControllerApi#getPointOfServiceByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingPointOfServicesControllerApi;

public class WarehousingPointOfServicesControllerApiExample {

    public static void main(String[] args) {
        WarehousingPointOfServicesControllerApi apiInstance = new WarehousingPointOfServicesControllerApi();
        String name = name_example; // String | The name of the point of service to be fetched
        String fields = fields_example; // String | Fields mapping level
        try {
            PointOfService result = apiInstance.getPointOfServiceByName(name, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingPointOfServicesControllerApi#getPointOfServiceByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *name = name_example; // The name of the point of service to be fetched
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Finds one point of service by name
[apiInstance getPointOfServiceByNameWith:name
    fields:fields
              completionHandler: ^(PointOfService output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingPointOfServicesControllerApi()
var name = name_example; // {{String}} The name of the point of service to be fetched
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPointOfServiceByName(name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingPointOfServicesControllerApi();
            var name = name_example;  // String | The name of the point of service to be fetched
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Finds one point of service by name
                PointOfService result = apiInstance.getPointOfServiceByName(name, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingPointOfServicesControllerApi.getPointOfServiceByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingPointOfServicesControllerApi();
$name = name_example; // String | The name of the point of service to be fetched
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingPointOfServicesControllerApi->new();
my $name = name_example; # String | The name of the point of service to be fetched
my $fields = fields_example; # String | Fields mapping level

eval { 
    my $result = $api_instance->getPointOfServiceByName(name => $name, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingPointOfServicesControllerApi->getPointOfServiceByName: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingPointOfServicesControllerApi()
name = name_example # String | The name of the point of service to be fetched
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Finds one point of service by name
    api_response = api_instance.get_point_of_service_by_name(name, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingPointOfServicesControllerApi->getPointOfServiceByName: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
The name of the point of service to be fetched
Required
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getWarehousesForPointOfService

Finds a paginated list of warehouses per given point of service

Finds a paginated list of warehouses per given point of service.


/pointofservices/{pointOfServiceName}/warehouses

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/pointofservices/{pointOfServiceName}/warehouses?currentPage=&fields=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingPointOfServicesControllerApi;

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

public class WarehousingPointOfServicesControllerApiExample {

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

        // 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");

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

        WarehousingPointOfServicesControllerApi apiInstance = new WarehousingPointOfServicesControllerApi();
        String pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            WarehouseSearchPageWsDto result = apiInstance.getWarehousesForPointOfService(pointOfServiceName, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingPointOfServicesControllerApi#getWarehousesForPointOfService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingPointOfServicesControllerApi;

public class WarehousingPointOfServicesControllerApiExample {

    public static void main(String[] args) {
        WarehousingPointOfServicesControllerApi apiInstance = new WarehousingPointOfServicesControllerApi();
        String pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            WarehouseSearchPageWsDto result = apiInstance.getWarehousesForPointOfService(pointOfServiceName, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingPointOfServicesControllerApi#getWarehousesForPointOfService");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *pointOfServiceName = pointOfServiceName_example; // The name of the point of service
Integer *currentPage = 56; // Current page (optional) (default to 0)
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)
Integer *pageSize = 56; // Page size (optional) (default to 10)
String *sort = sort_example; // Sort parameter (optional) (default to asc)

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

// Finds a paginated list of warehouses per given point of service
[apiInstance getWarehousesForPointOfServiceWith:pointOfServiceName
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    sort:sort
              completionHandler: ^(WarehouseSearchPageWsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingPointOfServicesControllerApi()
var pointOfServiceName = pointOfServiceName_example; // {{String}} The name of the point of service
var opts = { 
  'currentPage': 56, // {{Integer}} Current page
  'fields': fields_example, // {{String}} Fields mapping level
  'pageSize': 56, // {{Integer}} Page size
  'sort': sort_example // {{String}} Sort parameter
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWarehousesForPointOfService(pointOfServiceName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingPointOfServicesControllerApi();
            var pointOfServiceName = pointOfServiceName_example;  // String | The name of the point of service
            var currentPage = 56;  // Integer | Current page (optional)  (default to 0)
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | Page size (optional)  (default to 10)
            var sort = sort_example;  // String | Sort parameter (optional)  (default to asc)

            try
            {
                // Finds a paginated list of warehouses per given point of service
                WarehouseSearchPageWsDto result = apiInstance.getWarehousesForPointOfService(pointOfServiceName, currentPage, fields, pageSize, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingPointOfServicesControllerApi.getWarehousesForPointOfService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingPointOfServicesControllerApi();
$pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
$currentPage = 56; // Integer | Current page
$fields = fields_example; // String | Fields mapping level
$pageSize = 56; // Integer | Page size
$sort = sort_example; // String | Sort parameter

try {
    $result = $api_instance->getWarehousesForPointOfService($pointOfServiceName, $currentPage, $fields, $pageSize, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehousingPointOfServicesControllerApi->getWarehousesForPointOfService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WarehousingPointOfServicesControllerApi;

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

my $api_instance = WWW::SwaggerClient::WarehousingPointOfServicesControllerApi->new();
my $pointOfServiceName = pointOfServiceName_example; # String | The name of the point of service
my $currentPage = 56; # Integer | Current page
my $fields = fields_example; # String | Fields mapping level
my $pageSize = 56; # Integer | Page size
my $sort = sort_example; # String | Sort parameter

eval { 
    my $result = $api_instance->getWarehousesForPointOfService(pointOfServiceName => $pointOfServiceName, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingPointOfServicesControllerApi->getWarehousesForPointOfService: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingPointOfServicesControllerApi()
pointOfServiceName = pointOfServiceName_example # String | The name of the point of service
currentPage = 56 # Integer | Current page (optional) (default to 0)
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)
pageSize = 56 # Integer | Page size (optional) (default to 10)
sort = sort_example # String | Sort parameter (optional) (default to asc)

try: 
    # Finds a paginated list of warehouses per given point of service
    api_response = api_instance.get_warehouses_for_point_of_service(pointOfServiceName, currentPage=currentPage, fields=fields, pageSize=pageSize, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingPointOfServicesControllerApi->getWarehousesForPointOfService: %s\n" % e)

Parameters

Path parameters
Name Description
pointOfServiceName*
String
The name of the point of service
Required
Query parameters
Name Description
currentPage
Integer (int32)
Current page
fields
String
Fields mapping level
pageSize
Integer (int32)
Page size
sort
String
Sort parameter

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


updatePointOfServiceWithAddress

Updates point of service with an address

Updates point of service with an address.


/pointofservices/{pointOfServiceName}/address

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"//hostname/warehousingwebservices/pointofservices/{pointOfServiceName}/address?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingPointOfServicesControllerApi;

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

public class WarehousingPointOfServicesControllerApiExample {

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

        // 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");

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

        WarehousingPointOfServicesControllerApi apiInstance = new WarehousingPointOfServicesControllerApi();
        Address body = ; // Address | The AddressWsDTO object to update the point of service with
        String pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
        String fields = fields_example; // String | Fields mapping level
        try {
            PointOfService result = apiInstance.updatePointOfServiceWithAddress(body, pointOfServiceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingPointOfServicesControllerApi#updatePointOfServiceWithAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingPointOfServicesControllerApi;

public class WarehousingPointOfServicesControllerApiExample {

    public static void main(String[] args) {
        WarehousingPointOfServicesControllerApi apiInstance = new WarehousingPointOfServicesControllerApi();
        Address body = ; // Address | The AddressWsDTO object to update the point of service with
        String pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
        String fields = fields_example; // String | Fields mapping level
        try {
            PointOfService result = apiInstance.updatePointOfServiceWithAddress(body, pointOfServiceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingPointOfServicesControllerApi#updatePointOfServiceWithAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Address *body = ; // The AddressWsDTO object to update the point of service with
String *pointOfServiceName = pointOfServiceName_example; // The name of the point of service
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Updates point of service with an address
[apiInstance updatePointOfServiceWithAddressWith:body
    pointOfServiceName:pointOfServiceName
    fields:fields
              completionHandler: ^(PointOfService output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingPointOfServicesControllerApi()
var body = ; // {{Address}} The AddressWsDTO object to update the point of service with
var pointOfServiceName = pointOfServiceName_example; // {{String}} The name of the point of service
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePointOfServiceWithAddress(bodypointOfServiceName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingPointOfServicesControllerApi();
            var body = new Address(); // Address | The AddressWsDTO object to update the point of service with
            var pointOfServiceName = pointOfServiceName_example;  // String | The name of the point of service
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Updates point of service with an address
                PointOfService result = apiInstance.updatePointOfServiceWithAddress(body, pointOfServiceName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingPointOfServicesControllerApi.updatePointOfServiceWithAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingPointOfServicesControllerApi();
$body = ; // Address | The AddressWsDTO object to update the point of service with
$pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingPointOfServicesControllerApi->new();
my $body = WWW::SwaggerClient::Object::Address->new(); # Address | The AddressWsDTO object to update the point of service with
my $pointOfServiceName = pointOfServiceName_example; # String | The name of the point of service
my $fields = fields_example; # String | Fields mapping level

eval { 
    my $result = $api_instance->updatePointOfServiceWithAddress(body => $body, pointOfServiceName => $pointOfServiceName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingPointOfServicesControllerApi->updatePointOfServiceWithAddress: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingPointOfServicesControllerApi()
body =  # Address | The AddressWsDTO object to update the point of service with
pointOfServiceName = pointOfServiceName_example # String | The name of the point of service
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Updates point of service with an address
    api_response = api_instance.update_point_of_service_with_address(body, pointOfServiceName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingPointOfServicesControllerApi->updatePointOfServiceWithAddress: %s\n" % e)

Parameters

Path parameters
Name Description
pointOfServiceName*
String
The name of the point of service
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


updatePointOfServiceWithWarehouses

Updates a point of service with a list of warehouse codes

Updates a point of service with a list of warehouse codes


/pointofservices/{pointOfServiceName}/warehouses

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"//hostname/warehousingwebservices/pointofservices/{pointOfServiceName}/warehouses?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingPointOfServicesControllerApi;

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

public class WarehousingPointOfServicesControllerApiExample {

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

        // 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");

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

        WarehousingPointOfServicesControllerApi apiInstance = new WarehousingPointOfServicesControllerApi();
        WarehouseCodesWsDto body = ; // WarehouseCodesWsDto | The WarehouseCodesWsDto that contains a list of valid warehouse codes
        String pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
        String fields = fields_example; // String | Fields mapping level
        try {
            PointOfService result = apiInstance.updatePointOfServiceWithWarehouses(body, pointOfServiceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingPointOfServicesControllerApi#updatePointOfServiceWithWarehouses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingPointOfServicesControllerApi;

public class WarehousingPointOfServicesControllerApiExample {

    public static void main(String[] args) {
        WarehousingPointOfServicesControllerApi apiInstance = new WarehousingPointOfServicesControllerApi();
        WarehouseCodesWsDto body = ; // WarehouseCodesWsDto | The WarehouseCodesWsDto that contains a list of valid warehouse codes
        String pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
        String fields = fields_example; // String | Fields mapping level
        try {
            PointOfService result = apiInstance.updatePointOfServiceWithWarehouses(body, pointOfServiceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingPointOfServicesControllerApi#updatePointOfServiceWithWarehouses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
WarehouseCodesWsDto *body = ; // The WarehouseCodesWsDto that contains a list of valid warehouse codes
String *pointOfServiceName = pointOfServiceName_example; // The name of the point of service
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Updates a point of service with a list of warehouse codes
[apiInstance updatePointOfServiceWithWarehousesWith:body
    pointOfServiceName:pointOfServiceName
    fields:fields
              completionHandler: ^(PointOfService output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingPointOfServicesControllerApi()
var body = ; // {{WarehouseCodesWsDto}} The WarehouseCodesWsDto that contains a list of valid warehouse codes
var pointOfServiceName = pointOfServiceName_example; // {{String}} The name of the point of service
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePointOfServiceWithWarehouses(bodypointOfServiceName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingPointOfServicesControllerApi();
            var body = new WarehouseCodesWsDto(); // WarehouseCodesWsDto | The WarehouseCodesWsDto that contains a list of valid warehouse codes
            var pointOfServiceName = pointOfServiceName_example;  // String | The name of the point of service
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Updates a point of service with a list of warehouse codes
                PointOfService result = apiInstance.updatePointOfServiceWithWarehouses(body, pointOfServiceName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingPointOfServicesControllerApi.updatePointOfServiceWithWarehouses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingPointOfServicesControllerApi();
$body = ; // WarehouseCodesWsDto | The WarehouseCodesWsDto that contains a list of valid warehouse codes
$pointOfServiceName = pointOfServiceName_example; // String | The name of the point of service
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingPointOfServicesControllerApi->new();
my $body = WWW::SwaggerClient::Object::WarehouseCodesWsDto->new(); # WarehouseCodesWsDto | The WarehouseCodesWsDto that contains a list of valid warehouse codes
my $pointOfServiceName = pointOfServiceName_example; # String | The name of the point of service
my $fields = fields_example; # String | Fields mapping level

eval { 
    my $result = $api_instance->updatePointOfServiceWithWarehouses(body => $body, pointOfServiceName => $pointOfServiceName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingPointOfServicesControllerApi->updatePointOfServiceWithWarehouses: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingPointOfServicesControllerApi()
body =  # WarehouseCodesWsDto | The WarehouseCodesWsDto that contains a list of valid warehouse codes
pointOfServiceName = pointOfServiceName_example # String | The name of the point of service
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Updates a point of service with a list of warehouse codes
    api_response = api_instance.update_point_of_service_with_warehouses(body, pointOfServiceName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingPointOfServicesControllerApi->updatePointOfServiceWithWarehouses: %s\n" % e)

Parameters

Path parameters
Name Description
pointOfServiceName*
String
The name of the point of service
Required
Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


WarehousingReturnsController

acceptReturnedGoods

Request to accept returned goods

Request to accept returned goods.


/returns/{code}/accept-goods

Usage and SDK Samples

curl -X POST\
\
\
"//hostname/warehousingwebservices/returns/{code}/accept-goods"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingReturnsControllerApi;

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

public class WarehousingReturnsControllerApiExample {

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

        // 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");

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

        WarehousingReturnsControllerApi apiInstance = new WarehousingReturnsControllerApi();
        String code = code_example; // String | Return code to be accepted
        try {
            apiInstance.acceptReturnedGoods(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingReturnsControllerApi#acceptReturnedGoods");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingReturnsControllerApi;

public class WarehousingReturnsControllerApiExample {

    public static void main(String[] args) {
        WarehousingReturnsControllerApi apiInstance = new WarehousingReturnsControllerApi();
        String code = code_example; // String | Return code to be accepted
        try {
            apiInstance.acceptReturnedGoods(code);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingReturnsControllerApi#acceptReturnedGoods");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Return code to be accepted

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

// Request to accept returned goods
[apiInstance acceptReturnedGoodsWith:code
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingReturnsControllerApi()
var code = code_example; // {{String}} Return code to be accepted

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

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

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

            var apiInstance = new WarehousingReturnsControllerApi();
            var code = code_example;  // String | Return code to be accepted

            try
            {
                // Request to accept returned goods
                apiInstance.acceptReturnedGoods(code);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingReturnsControllerApi.acceptReturnedGoods: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingReturnsControllerApi();
$code = code_example; // String | Return code to be accepted

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

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

my $api_instance = WWW::SwaggerClient::WarehousingReturnsControllerApi->new();
my $code = code_example; # String | Return code to be accepted

eval { 
    $api_instance->acceptReturnedGoods(code => $code);
};
if ($@) {
    warn "Exception when calling WarehousingReturnsControllerApi->acceptReturnedGoods: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingReturnsControllerApi()
code = code_example # String | Return code to be accepted

try: 
    # Request to accept returned goods
    api_instance.accept_returned_goods(code)
except ApiException as e:
    print("Exception when calling WarehousingReturnsControllerApi->acceptReturnedGoods: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Return code to be accepted
Required

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


WarehousingStockLevelsController

createStockLevel

Creates a stocklevel

Creates a stocklevel.


/stocklevels

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"//hostname/warehousingwebservices/stocklevels?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingStockLevelsControllerApi;

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

public class WarehousingStockLevelsControllerApiExample {

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

        // 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");

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

        WarehousingStockLevelsControllerApi apiInstance = new WarehousingStockLevelsControllerApi();
        StockLevelWsDto body = ; // StockLevelWsDto | The stocklevel object to be created
        String fields = fields_example; // String | Fields mapping level
        try {
            StockLevelWsDto result = apiInstance.createStockLevel(body, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingStockLevelsControllerApi#createStockLevel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingStockLevelsControllerApi;

public class WarehousingStockLevelsControllerApiExample {

    public static void main(String[] args) {
        WarehousingStockLevelsControllerApi apiInstance = new WarehousingStockLevelsControllerApi();
        StockLevelWsDto body = ; // StockLevelWsDto | The stocklevel object to be created
        String fields = fields_example; // String | Fields mapping level
        try {
            StockLevelWsDto result = apiInstance.createStockLevel(body, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingStockLevelsControllerApi#createStockLevel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
StockLevelWsDto *body = ; // The stocklevel object to be created
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)

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

// Creates a stocklevel
[apiInstance createStockLevelWith:body
    fields:fields
              completionHandler: ^(StockLevelWsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingStockLevelsControllerApi()
var body = ; // {{StockLevelWsDto}} The stocklevel object to be created
var opts = { 
  'fields': fields_example // {{String}} Fields mapping level
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createStockLevel(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingStockLevelsControllerApi();
            var body = new StockLevelWsDto(); // StockLevelWsDto | The stocklevel object to be created
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)

            try
            {
                // Creates a stocklevel
                StockLevelWsDto result = apiInstance.createStockLevel(body, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingStockLevelsControllerApi.createStockLevel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingStockLevelsControllerApi();
$body = ; // StockLevelWsDto | The stocklevel object to be created
$fields = fields_example; // String | Fields mapping level

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

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

my $api_instance = WWW::SwaggerClient::WarehousingStockLevelsControllerApi->new();
my $body = WWW::SwaggerClient::Object::StockLevelWsDto->new(); # StockLevelWsDto | The stocklevel object to be created
my $fields = fields_example; # String | Fields mapping level

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

# create an instance of the API class
api_instance = swagger_client.WarehousingStockLevelsControllerApi()
body =  # StockLevelWsDto | The stocklevel object to be created
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)

try: 
    # Creates a stocklevel
    api_response = api_instance.create_stock_level(body, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingStockLevelsControllerApi->createStockLevel: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Fields mapping level

Responses

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


createStockLevelAdjustment

Creates an inventoryEvent to adjust a specific stocklevel

Creates an inventoryEvent to adjust a specific stocklevel.


/stocklevels/product/{productCode}/warehouse/{warehouseCode}/adjustment

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"//hostname/warehousingwebservices/stocklevels/product/{productCode}/warehouse/{warehouseCode}/adjustment?binCode=&releaseDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingStockLevelsControllerApi;

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

public class WarehousingStockLevelsControllerApiExample {

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

        // 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");

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

        WarehousingStockLevelsControllerApi apiInstance = new WarehousingStockLevelsControllerApi();
        StockLevelAdjustmentsWsDTO body = ; // StockLevelAdjustmentsWsDTO | List of stockLevel Adjustments
        String productCode = productCode_example; // String | Product Code
        String warehouseCode = warehouseCode_example; // String | Warehouse Code
        String binCode = binCode_example; // String | Bin Code
        String releaseDate = releaseDate_example; // String | Release Date
        try {
            StockLevelAdjustmentsWsDTO result = apiInstance.createStockLevelAdjustment(body, productCode, warehouseCode, binCode, releaseDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingStockLevelsControllerApi#createStockLevelAdjustment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingStockLevelsControllerApi;

public class WarehousingStockLevelsControllerApiExample {

    public static void main(String[] args) {
        WarehousingStockLevelsControllerApi apiInstance = new WarehousingStockLevelsControllerApi();
        StockLevelAdjustmentsWsDTO body = ; // StockLevelAdjustmentsWsDTO | List of stockLevel Adjustments
        String productCode = productCode_example; // String | Product Code
        String warehouseCode = warehouseCode_example; // String | Warehouse Code
        String binCode = binCode_example; // String | Bin Code
        String releaseDate = releaseDate_example; // String | Release Date
        try {
            StockLevelAdjustmentsWsDTO result = apiInstance.createStockLevelAdjustment(body, productCode, warehouseCode, binCode, releaseDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingStockLevelsControllerApi#createStockLevelAdjustment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
StockLevelAdjustmentsWsDTO *body = ; // List of stockLevel Adjustments
String *productCode = productCode_example; // Product Code
String *warehouseCode = warehouseCode_example; // Warehouse Code
String *binCode = binCode_example; // Bin Code (optional)
String *releaseDate = releaseDate_example; // Release Date (optional)

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

// Creates an inventoryEvent to adjust a specific stocklevel
[apiInstance createStockLevelAdjustmentWith:body
    productCode:productCode
    warehouseCode:warehouseCode
    binCode:binCode
    releaseDate:releaseDate
              completionHandler: ^(StockLevelAdjustmentsWsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingStockLevelsControllerApi()
var body = ; // {{StockLevelAdjustmentsWsDTO}} List of stockLevel Adjustments
var productCode = productCode_example; // {{String}} Product Code
var warehouseCode = warehouseCode_example; // {{String}} Warehouse Code
var opts = { 
  'binCode': binCode_example // {{String}} Bin Code
  'releaseDate': releaseDate_example // {{String}} Release Date
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createStockLevelAdjustment(bodyproductCodewarehouseCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingStockLevelsControllerApi();
            var body = new StockLevelAdjustmentsWsDTO(); // StockLevelAdjustmentsWsDTO | List of stockLevel Adjustments
            var productCode = productCode_example;  // String | Product Code
            var warehouseCode = warehouseCode_example;  // String | Warehouse Code
            var binCode = binCode_example;  // String | Bin Code (optional) 
            var releaseDate = releaseDate_example;  // String | Release Date (optional) 

            try
            {
                // Creates an inventoryEvent to adjust a specific stocklevel
                StockLevelAdjustmentsWsDTO result = apiInstance.createStockLevelAdjustment(body, productCode, warehouseCode, binCode, releaseDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingStockLevelsControllerApi.createStockLevelAdjustment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingStockLevelsControllerApi();
$body = ; // StockLevelAdjustmentsWsDTO | List of stockLevel Adjustments
$productCode = productCode_example; // String | Product Code
$warehouseCode = warehouseCode_example; // String | Warehouse Code
$binCode = binCode_example; // String | Bin Code
$releaseDate = releaseDate_example; // String | Release Date

try {
    $result = $api_instance->createStockLevelAdjustment($body, $productCode, $warehouseCode, $binCode, $releaseDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehousingStockLevelsControllerApi->createStockLevelAdjustment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WarehousingStockLevelsControllerApi;

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

my $api_instance = WWW::SwaggerClient::WarehousingStockLevelsControllerApi->new();
my $body = WWW::SwaggerClient::Object::StockLevelAdjustmentsWsDTO->new(); # StockLevelAdjustmentsWsDTO | List of stockLevel Adjustments
my $productCode = productCode_example; # String | Product Code
my $warehouseCode = warehouseCode_example; # String | Warehouse Code
my $binCode = binCode_example; # String | Bin Code
my $releaseDate = releaseDate_example; # String | Release Date

eval { 
    my $result = $api_instance->createStockLevelAdjustment(body => $body, productCode => $productCode, warehouseCode => $warehouseCode, binCode => $binCode, releaseDate => $releaseDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingStockLevelsControllerApi->createStockLevelAdjustment: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingStockLevelsControllerApi()
body =  # StockLevelAdjustmentsWsDTO | List of stockLevel Adjustments
productCode = productCode_example # String | Product Code
warehouseCode = warehouseCode_example # String | Warehouse Code
binCode = binCode_example # String | Bin Code (optional)
releaseDate = releaseDate_example # String | Release Date (optional)

try: 
    # Creates an inventoryEvent to adjust a specific stocklevel
    api_response = api_instance.create_stock_level_adjustment(body, productCode, warehouseCode, binCode=binCode, releaseDate=releaseDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingStockLevelsControllerApi->createStockLevelAdjustment: %s\n" % e)

Parameters

Path parameters
Name Description
productCode*
String
Product Code
Required
warehouseCode*
String
Warehouse Code
Required
Body parameters
Name Description
body *
Query parameters
Name Description
binCode
String
Bin Code
releaseDate
String
Release Date

Responses

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getStockLevelAdjustmentReasons

Finds all adjustment reasons

Finds all adjustment reasons.


/stocklevels/adjustment-reasons

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/stocklevels/adjustment-reasons"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingStockLevelsControllerApi;

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

public class WarehousingStockLevelsControllerApiExample {

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

        // 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");

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

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

public class WarehousingStockLevelsControllerApiExample {

    public static void main(String[] args) {
        WarehousingStockLevelsControllerApi apiInstance = new WarehousingStockLevelsControllerApi();
        try {
            StockLevelAdjustmentReasonsWsDTO result = apiInstance.getStockLevelAdjustmentReasons();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingStockLevelsControllerApi#getStockLevelAdjustmentReasons");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Finds all adjustment reasons
[apiInstance getStockLevelAdjustmentReasonsWithCompletionHandler: 
              ^(StockLevelAdjustmentReasonsWsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

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

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

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

            var apiInstance = new WarehousingStockLevelsControllerApi();

            try
            {
                // Finds all adjustment reasons
                StockLevelAdjustmentReasonsWsDTO result = apiInstance.getStockLevelAdjustmentReasons();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingStockLevelsControllerApi.getStockLevelAdjustmentReasons: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingStockLevelsControllerApi();

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

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

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

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

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

try: 
    # Finds all adjustment reasons
    api_response = api_instance.get_stock_level_adjustment_reasons()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingStockLevelsControllerApi->getStockLevelAdjustmentReasons: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getStockLevelsForWarehouseCode

Finds a paginated list of stock levels by a given warehouse code

Finds a paginated list of stock levels by a given warehouse code.


/stocklevels/warehouses/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/stocklevels/warehouses/{code}?currentPage=&fields=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingStockLevelsControllerApi;

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

public class WarehousingStockLevelsControllerApiExample {

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

        // 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");

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

        WarehousingStockLevelsControllerApi apiInstance = new WarehousingStockLevelsControllerApi();
        String code = code_example; // String | The code for the warehouse
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            StockLevelSearchPageWsDto result = apiInstance.getStockLevelsForWarehouseCode(code, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingStockLevelsControllerApi#getStockLevelsForWarehouseCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingStockLevelsControllerApi;

public class WarehousingStockLevelsControllerApiExample {

    public static void main(String[] args) {
        WarehousingStockLevelsControllerApi apiInstance = new WarehousingStockLevelsControllerApi();
        String code = code_example; // String | The code for the warehouse
        Integer currentPage = 56; // Integer | Current page
        String fields = fields_example; // String | Fields mapping level
        Integer pageSize = 56; // Integer | Page size
        String sort = sort_example; // String | Sort parameter
        try {
            StockLevelSearchPageWsDto result = apiInstance.getStockLevelsForWarehouseCode(code, currentPage, fields, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingStockLevelsControllerApi#getStockLevelsForWarehouseCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // The code for the warehouse
Integer *currentPage = 56; // Current page (optional) (default to 0)
String *fields = fields_example; // Fields mapping level (optional) (default to DEFAULT)
Integer *pageSize = 56; // Page size (optional) (default to 10)
String *sort = sort_example; // Sort parameter (optional) (default to asc)

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

// Finds a paginated list of stock levels by a given warehouse code
[apiInstance getStockLevelsForWarehouseCodeWith:code
    currentPage:currentPage
    fields:fields
    pageSize:pageSize
    sort:sort
              completionHandler: ^(StockLevelSearchPageWsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingStockLevelsControllerApi()
var code = code_example; // {{String}} The code for the warehouse
var opts = { 
  'currentPage': 56, // {{Integer}} Current page
  'fields': fields_example, // {{String}} Fields mapping level
  'pageSize': 56, // {{Integer}} Page size
  'sort': sort_example // {{String}} Sort parameter
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStockLevelsForWarehouseCode(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingStockLevelsControllerApi();
            var code = code_example;  // String | The code for the warehouse
            var currentPage = 56;  // Integer | Current page (optional)  (default to 0)
            var fields = fields_example;  // String | Fields mapping level (optional)  (default to DEFAULT)
            var pageSize = 56;  // Integer | Page size (optional)  (default to 10)
            var sort = sort_example;  // String | Sort parameter (optional)  (default to asc)

            try
            {
                // Finds a paginated list of stock levels by a given warehouse code
                StockLevelSearchPageWsDto result = apiInstance.getStockLevelsForWarehouseCode(code, currentPage, fields, pageSize, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingStockLevelsControllerApi.getStockLevelsForWarehouseCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingStockLevelsControllerApi();
$code = code_example; // String | The code for the warehouse
$currentPage = 56; // Integer | Current page
$fields = fields_example; // String | Fields mapping level
$pageSize = 56; // Integer | Page size
$sort = sort_example; // String | Sort parameter

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

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

my $api_instance = WWW::SwaggerClient::WarehousingStockLevelsControllerApi->new();
my $code = code_example; # String | The code for the warehouse
my $currentPage = 56; # Integer | Current page
my $fields = fields_example; # String | Fields mapping level
my $pageSize = 56; # Integer | Page size
my $sort = sort_example; # String | Sort parameter

eval { 
    my $result = $api_instance->getStockLevelsForWarehouseCode(code => $code, currentPage => $currentPage, fields => $fields, pageSize => $pageSize, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingStockLevelsControllerApi->getStockLevelsForWarehouseCode: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingStockLevelsControllerApi()
code = code_example # String | The code for the warehouse
currentPage = 56 # Integer | Current page (optional) (default to 0)
fields = fields_example # String | Fields mapping level (optional) (default to DEFAULT)
pageSize = 56 # Integer | Page size (optional) (default to 10)
sort = sort_example # String | Sort parameter (optional) (default to asc)

try: 
    # Finds a paginated list of stock levels by a given warehouse code
    api_response = api_instance.get_stock_levels_for_warehouse_code(code, currentPage=currentPage, fields=fields, pageSize=pageSize, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingStockLevelsControllerApi->getStockLevelsForWarehouseCode: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
The code for the warehouse
Required
Query parameters
Name Description
currentPage
Integer (int32)
Current page
fields
String
Fields mapping level
pageSize
Integer (int32)
Page size
sort
String
Sort parameter

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


WarehousingWarehousesController

getWarehouseForCode

Finds a warehouse by the given code

It returns a warehouse for the given code, the given warehouse code should be valid


/warehouses/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"//hostname/warehousingwebservices/warehouses/{code}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WarehousingWarehousesControllerApi;

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

public class WarehousingWarehousesControllerApiExample {

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

        // 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");

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

        WarehousingWarehousesControllerApi apiInstance = new WarehousingWarehousesControllerApi();
        String code = code_example; // String | code
        String fields = fields_example; // String | The code of the requested warehouse
        try {
            WarehouseWsDto result = apiInstance.getWarehouseForCode(code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingWarehousesControllerApi#getWarehouseForCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WarehousingWarehousesControllerApi;

public class WarehousingWarehousesControllerApiExample {

    public static void main(String[] args) {
        WarehousingWarehousesControllerApi apiInstance = new WarehousingWarehousesControllerApi();
        String code = code_example; // String | code
        String fields = fields_example; // String | The code of the requested warehouse
        try {
            WarehouseWsDto result = apiInstance.getWarehouseForCode(code, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousingWarehousesControllerApi#getWarehouseForCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // code
String *fields = fields_example; // The code of the requested warehouse (optional) (default to DEFAULT)

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

// Finds a warehouse by the given code
[apiInstance getWarehouseForCodeWith:code
    fields:fields
              completionHandler: ^(WarehouseWsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WarehousingWebservices = require('warehousing_webservices');
var defaultClient = WarehousingWebservices.ApiClient.instance;

// 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"

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

var api = new WarehousingWebservices.WarehousingWarehousesControllerApi()
var code = code_example; // {{String}} code
var opts = { 
  'fields': fields_example // {{String}} The code of the requested warehouse
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWarehouseForCode(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new WarehousingWarehousesControllerApi();
            var code = code_example;  // String | code
            var fields = fields_example;  // String | The code of the requested warehouse (optional)  (default to DEFAULT)

            try
            {
                // Finds a warehouse by the given code
                WarehouseWsDto result = apiInstance.getWarehouseForCode(code, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WarehousingWarehousesControllerApi.getWarehouseForCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiWarehousingWarehousesControllerApi();
$code = code_example; // String | code
$fields = fields_example; // String | The code of the requested warehouse

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

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

my $api_instance = WWW::SwaggerClient::WarehousingWarehousesControllerApi->new();
my $code = code_example; # String | code
my $fields = fields_example; # String | The code of the requested warehouse

eval { 
    my $result = $api_instance->getWarehouseForCode(code => $code, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WarehousingWarehousesControllerApi->getWarehouseForCode: $@\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_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WarehousingWarehousesControllerApi()
code = code_example # String | code
fields = fields_example # String | The code of the requested warehouse (optional) (default to DEFAULT)

try: 
    # Finds a warehouse by the given code
    api_response = api_instance.get_warehouse_for_code(code, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WarehousingWarehousesControllerApi->getWarehouseForCode: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
code
Required
Query parameters
Name Description
fields
String
The code of the requested warehouse

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found