API Docs - How it works

GETOperations

addresslistGet

Returns address information.

The AddressList request returns information about the specified address.


/addresslist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/addresslist?AddressID=&AddressListID=&CardRecordID=&ContactName=&Location=&City=&Country=&Email=&Fax=&Phone1=&Phone2=&Phone3=&postcode=&street=&streetline1=&streetline2=&streetline3="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer addressID = 56; // Integer | the primary key value of the address record.
        Integer addressListID = 56; // Integer | The primary key value of the address list record.
        Integer cardRecordID = 56; // Integer | The primary key value of the card record.
        String contactName = contactName_example; // String | The name on the contact card
        String location = location_example; // String | The location details of the address record.
        String city = city_example; // String | The city or ship to city of a customer card.
        String country = country_example; // String | Country of the location address.
        String email = email_example; // String | Email address of a card record.
        String fax = fax_example; // String | The fax number of a card record.
        String phone1 = phone1_example; // String | Phone number 1 of a card record.
        String phone2 = phone2_example; // String | Phone number 2 of a card record.
        String phone3 = phone3_example; // String | Phone number 3 of a card record.
        String postcode = postcode_example; // String | State of a card record.
        String street = street_example; // String | Full contents of the ship to address field.
        String streetline1 = streetline1_example; // String | First line of cards Address or Ship To address.
        String streetline2 = streetline2_example; // String | Second line of cards Address or Ship To address.
        String streetline3 = streetline3_example; // String | Third line of cards Address or Ship To address.
        try {
            addresslist result = apiInstance.addresslistGet(addressID, addressListID, cardRecordID, contactName, location, city, country, email, fax, phone1, phone2, phone3, postcode, street, streetline1, streetline2, streetline3);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#addresslistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer addressID = 56; // Integer | the primary key value of the address record.
        Integer addressListID = 56; // Integer | The primary key value of the address list record.
        Integer cardRecordID = 56; // Integer | The primary key value of the card record.
        String contactName = contactName_example; // String | The name on the contact card
        String location = location_example; // String | The location details of the address record.
        String city = city_example; // String | The city or ship to city of a customer card.
        String country = country_example; // String | Country of the location address.
        String email = email_example; // String | Email address of a card record.
        String fax = fax_example; // String | The fax number of a card record.
        String phone1 = phone1_example; // String | Phone number 1 of a card record.
        String phone2 = phone2_example; // String | Phone number 2 of a card record.
        String phone3 = phone3_example; // String | Phone number 3 of a card record.
        String postcode = postcode_example; // String | State of a card record.
        String street = street_example; // String | Full contents of the ship to address field.
        String streetline1 = streetline1_example; // String | First line of cards Address or Ship To address.
        String streetline2 = streetline2_example; // String | Second line of cards Address or Ship To address.
        String streetline3 = streetline3_example; // String | Third line of cards Address or Ship To address.
        try {
            addresslist result = apiInstance.addresslistGet(addressID, addressListID, cardRecordID, contactName, location, city, country, email, fax, phone1, phone2, phone3, postcode, street, streetline1, streetline2, streetline3);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#addresslistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *addressID = 56; // the primary key value of the address record. (optional)
Integer *addressListID = 56; // The primary key value of the address list record. (optional)
Integer *cardRecordID = 56; // The primary key value of the card record. (optional)
String *contactName = contactName_example; // The name on the contact card (optional)
String *location = location_example; // The location details of the address record. (optional)
String *city = city_example; // The city or ship to city of a customer card. (optional)
String *country = country_example; // Country of the location address. (optional)
String *email = email_example; // Email address of a card record. (optional)
String *fax = fax_example; // The fax number of a card record. (optional)
String *phone1 = phone1_example; // Phone number 1 of a card record. (optional)
String *phone2 = phone2_example; // Phone number 2 of a card record. (optional)
String *phone3 = phone3_example; // Phone number 3 of a card record. (optional)
String *postcode = postcode_example; // State of a card record. (optional)
String *street = street_example; // Full contents of the ship to address field. (optional)
String *streetline1 = streetline1_example; // First line of cards Address or Ship To address. (optional)
String *streetline2 = streetline2_example; // Second line of cards Address or Ship To address. (optional)
String *streetline3 = streetline3_example; // Third line of cards Address or Ship To address. (optional)

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

// Returns address information.
[apiInstance addresslistGetWith:addressID
    addressListID:addressListID
    cardRecordID:cardRecordID
    contactName:contactName
    location:location
    city:city
    country:country
    email:email
    fax:fax
    phone1:phone1
    phone2:phone2
    phone3:phone3
    postcode:postcode
    street:street
    streetline1:streetline1
    streetline2:streetline2
    streetline3:streetline3
              completionHandler: ^(addresslist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'addressID': 56, // {{Integer}} the primary key value of the address record.
  'addressListID': 56, // {{Integer}} The primary key value of the address list record.
  'cardRecordID': 56, // {{Integer}} The primary key value of the card record.
  'contactName': contactName_example, // {{String}} The name on the contact card
  'location': location_example, // {{String}} The location details of the address record.
  'city': city_example, // {{String}} The city or ship to city of a customer card.
  'country': country_example, // {{String}} Country of the location address.
  'email': email_example, // {{String}} Email address of a card record.
  'fax': fax_example, // {{String}} The fax number of a card record.
  'phone1': phone1_example, // {{String}} Phone number 1 of a card record.
  'phone2': phone2_example, // {{String}} Phone number 2 of a card record.
  'phone3': phone3_example, // {{String}} Phone number 3 of a card record.
  'postcode': postcode_example, // {{String}} State of a card record.
  'street': street_example, // {{String}} Full contents of the ship to address field.
  'streetline1': streetline1_example, // {{String}} First line of cards Address or Ship To address.
  'streetline2': streetline2_example, // {{String}} Second line of cards Address or Ship To address.
  'streetline3': streetline3_example // {{String}} Third line of cards Address or Ship To address.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addresslistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addresslistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var addressID = 56;  // Integer | the primary key value of the address record. (optional) 
            var addressListID = 56;  // Integer | The primary key value of the address list record. (optional) 
            var cardRecordID = 56;  // Integer | The primary key value of the card record. (optional) 
            var contactName = contactName_example;  // String | The name on the contact card (optional) 
            var location = location_example;  // String | The location details of the address record. (optional) 
            var city = city_example;  // String | The city or ship to city of a customer card. (optional) 
            var country = country_example;  // String | Country of the location address. (optional) 
            var email = email_example;  // String | Email address of a card record. (optional) 
            var fax = fax_example;  // String | The fax number of a card record. (optional) 
            var phone1 = phone1_example;  // String | Phone number 1 of a card record. (optional) 
            var phone2 = phone2_example;  // String | Phone number 2 of a card record. (optional) 
            var phone3 = phone3_example;  // String | Phone number 3 of a card record. (optional) 
            var postcode = postcode_example;  // String | State of a card record. (optional) 
            var street = street_example;  // String | Full contents of the ship to address field. (optional) 
            var streetline1 = streetline1_example;  // String | First line of cards Address or Ship To address. (optional) 
            var streetline2 = streetline2_example;  // String | Second line of cards Address or Ship To address. (optional) 
            var streetline3 = streetline3_example;  // String | Third line of cards Address or Ship To address. (optional) 

            try
            {
                // Returns address information.
                addresslist result = apiInstance.addresslistGet(addressID, addressListID, cardRecordID, contactName, location, city, country, email, fax, phone1, phone2, phone3, postcode, street, streetline1, streetline2, streetline3);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.addresslistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$addressID = 56; // Integer | the primary key value of the address record.
$addressListID = 56; // Integer | The primary key value of the address list record.
$cardRecordID = 56; // Integer | The primary key value of the card record.
$contactName = contactName_example; // String | The name on the contact card
$location = location_example; // String | The location details of the address record.
$city = city_example; // String | The city or ship to city of a customer card.
$country = country_example; // String | Country of the location address.
$email = email_example; // String | Email address of a card record.
$fax = fax_example; // String | The fax number of a card record.
$phone1 = phone1_example; // String | Phone number 1 of a card record.
$phone2 = phone2_example; // String | Phone number 2 of a card record.
$phone3 = phone3_example; // String | Phone number 3 of a card record.
$postcode = postcode_example; // String | State of a card record.
$street = street_example; // String | Full contents of the ship to address field.
$streetline1 = streetline1_example; // String | First line of cards Address or Ship To address.
$streetline2 = streetline2_example; // String | Second line of cards Address or Ship To address.
$streetline3 = streetline3_example; // String | Third line of cards Address or Ship To address.

try {
    $result = $api_instance->addresslistGet($addressID, $addressListID, $cardRecordID, $contactName, $location, $city, $country, $email, $fax, $phone1, $phone2, $phone3, $postcode, $street, $streetline1, $streetline2, $streetline3);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->addresslistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $addressID = 56; # Integer | the primary key value of the address record.
my $addressListID = 56; # Integer | The primary key value of the address list record.
my $cardRecordID = 56; # Integer | The primary key value of the card record.
my $contactName = contactName_example; # String | The name on the contact card
my $location = location_example; # String | The location details of the address record.
my $city = city_example; # String | The city or ship to city of a customer card.
my $country = country_example; # String | Country of the location address.
my $email = email_example; # String | Email address of a card record.
my $fax = fax_example; # String | The fax number of a card record.
my $phone1 = phone1_example; # String | Phone number 1 of a card record.
my $phone2 = phone2_example; # String | Phone number 2 of a card record.
my $phone3 = phone3_example; # String | Phone number 3 of a card record.
my $postcode = postcode_example; # String | State of a card record.
my $street = street_example; # String | Full contents of the ship to address field.
my $streetline1 = streetline1_example; # String | First line of cards Address or Ship To address.
my $streetline2 = streetline2_example; # String | Second line of cards Address or Ship To address.
my $streetline3 = streetline3_example; # String | Third line of cards Address or Ship To address.

eval { 
    my $result = $api_instance->addresslistGet(addressID => $addressID, addressListID => $addressListID, cardRecordID => $cardRecordID, contactName => $contactName, location => $location, city => $city, country => $country, email => $email, fax => $fax, phone1 => $phone1, phone2 => $phone2, phone3 => $phone3, postcode => $postcode, street => $street, streetline1 => $streetline1, streetline2 => $streetline2, streetline3 => $streetline3);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->addresslistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
addressID = 56 # Integer | the primary key value of the address record. (optional)
addressListID = 56 # Integer | The primary key value of the address list record. (optional)
cardRecordID = 56 # Integer | The primary key value of the card record. (optional)
contactName = contactName_example # String | The name on the contact card (optional)
location = location_example # String | The location details of the address record. (optional)
city = city_example # String | The city or ship to city of a customer card. (optional)
country = country_example # String | Country of the location address. (optional)
email = email_example # String | Email address of a card record. (optional)
fax = fax_example # String | The fax number of a card record. (optional)
phone1 = phone1_example # String | Phone number 1 of a card record. (optional)
phone2 = phone2_example # String | Phone number 2 of a card record. (optional)
phone3 = phone3_example # String | Phone number 3 of a card record. (optional)
postcode = postcode_example # String | State of a card record. (optional)
street = street_example # String | Full contents of the ship to address field. (optional)
streetline1 = streetline1_example # String | First line of cards Address or Ship To address. (optional)
streetline2 = streetline2_example # String | Second line of cards Address or Ship To address. (optional)
streetline3 = streetline3_example # String | Third line of cards Address or Ship To address. (optional)

try: 
    # Returns address information.
    api_response = api_instance.addresslist_get(addressID=addressID, addressListID=addressListID, cardRecordID=cardRecordID, contactName=contactName, location=location, city=city, country=country, email=email, fax=fax, phone1=phone1, phone2=phone2, phone3=phone3, postcode=postcode, street=street, streetline1=streetline1, streetline2=streetline2, streetline3=streetline3)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->addresslistGet: %s\n" % e)

Parameters

Query parameters
Name Description
AddressID
Integer
the primary key value of the address record.
AddressListID
Integer
The primary key value of the address list record.
CardRecordID
Integer
The primary key value of the card record.
ContactName
String
The name on the contact card
Location
String
The location details of the address record.
City
String
The city or ship to city of a customer card.
Country
String
Country of the location address.
Email
String
Email address of a card record.
Fax
String
The fax number of a card record.
Phone1
String
Phone number 1 of a card record.
Phone2
String
Phone number 2 of a card record.
Phone3
String
Phone number 3 of a card record.
postcode
String
State of a card record.
street
String
Full contents of the ship to address field.
streetline1
String
First line of cards Address or Ship To address.
streetline2
String
Second line of cards Address or Ship To address.
streetline3
String
Third line of cards Address or Ship To address.

Responses

Status: 200 - OK


attachmentsAttachmentGet

Returns attachment.

Returns information about the specified attachment.


/attachments/attachment

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/attachments/attachment?BaseStockID=&filename="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String filename = filename_example; // String | a valid filename
        try {
            byte[] result = apiInstance.attachmentsAttachmentGet(baseStockID, filename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#attachmentsAttachmentGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String filename = filename_example; // String | a valid filename
        try {
            byte[] result = apiInstance.attachmentsAttachmentGet(baseStockID, filename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#attachmentsAttachmentGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
String *filename = filename_example; // a valid filename (optional)

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

// Returns attachment.
[apiInstance attachmentsAttachmentGetWith:baseStockID
    filename:filename
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'filename': filename_example // {{String}} a valid filename
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.attachmentsAttachmentGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class attachmentsAttachmentGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var filename = filename_example;  // String | a valid filename (optional) 

            try
            {
                // Returns attachment.
                byte[] result = apiInstance.attachmentsAttachmentGet(baseStockID, filename);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.attachmentsAttachmentGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$filename = filename_example; // String | a valid filename

try {
    $result = $api_instance->attachmentsAttachmentGet($baseStockID, $filename);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->attachmentsAttachmentGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $filename = filename_example; # String | a valid filename

eval { 
    my $result = $api_instance->attachmentsAttachmentGet(baseStockID => $baseStockID, filename => $filename);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->attachmentsAttachmentGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
filename = filename_example # String | a valid filename (optional)

try: 
    # Returns attachment.
    api_response = api_instance.attachments_attachment_get(baseStockID=baseStockID, filename=filename)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->attachmentsAttachmentGet: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
filename
String
a valid filename

Responses

Status: 200 - get the attached image


barcodelistGet

Returns information about the specified barcode

The barcodelist request returns information about the specified barcode.


/barcodelist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/barcodelist?ItemNumber=&Barcode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer barcode = 56; // Integer | Pass query by barcode.
        try {
            barcodeList result = apiInstance.barcodelistGet(itemNumber, barcode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#barcodelistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer barcode = 56; // Integer | Pass query by barcode.
        try {
            barcodeList result = apiInstance.barcodelistGet(itemNumber, barcode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#barcodelistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *itemNumber = itemNumber_example; // Pass by an item number. (optional)
Integer *barcode = 56; // Pass query by barcode. (optional)

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

// Returns information about the specified barcode
[apiInstance barcodelistGetWith:itemNumber
    barcode:barcode
              completionHandler: ^(barcodeList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'itemNumber': itemNumber_example, // {{String}} Pass by an item number.
  'barcode': 56 // {{Integer}} Pass query by barcode.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.barcodelistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class barcodelistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var itemNumber = itemNumber_example;  // String | Pass by an item number. (optional) 
            var barcode = 56;  // Integer | Pass query by barcode. (optional) 

            try
            {
                // Returns information about the specified barcode
                barcodeList result = apiInstance.barcodelistGet(itemNumber, barcode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.barcodelistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$itemNumber = itemNumber_example; // String | Pass by an item number.
$barcode = 56; // Integer | Pass query by barcode.

try {
    $result = $api_instance->barcodelistGet($itemNumber, $barcode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->barcodelistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $itemNumber = itemNumber_example; # String | Pass by an item number.
my $barcode = 56; # Integer | Pass query by barcode.

eval { 
    my $result = $api_instance->barcodelistGet(itemNumber => $itemNumber, barcode => $barcode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->barcodelistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
itemNumber = itemNumber_example # String | Pass by an item number. (optional)
barcode = 56 # Integer | Pass query by barcode. (optional)

try: 
    # Returns information about the specified barcode
    api_response = api_instance.barcodelist_get(itemNumber=itemNumber, barcode=barcode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->barcodelistGet: %s\n" % e)

Parameters

Query parameters
Name Description
ItemNumber
String
Pass by an item number.
Barcode
Integer
Pass query by barcode.

Responses

Status: 200 - OK


billofmaterialsGet

Returns information about the specified bill of materials.

The billofmaterials request returns information about the specified bill of materials.


/billofmaterials

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/billofmaterials?BaseStockID=&BaseStockLineID=&ItemNumber="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | The primary key of the item master record.
        Integer baseStockLineID = 56; // Integer | The primary key of the item master record for a stock line item.
        String itemNumber = itemNumber_example; // String | The item number.
        try {
            array[billofmaterials] result = apiInstance.billofmaterialsGet(baseStockID, baseStockLineID, itemNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#billofmaterialsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | The primary key of the item master record.
        Integer baseStockLineID = 56; // Integer | The primary key of the item master record for a stock line item.
        String itemNumber = itemNumber_example; // String | The item number.
        try {
            array[billofmaterials] result = apiInstance.billofmaterialsGet(baseStockID, baseStockLineID, itemNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#billofmaterialsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // The primary key of the item master record. (optional)
Integer *baseStockLineID = 56; // The primary key of the item master record for a stock line item. (optional)
String *itemNumber = itemNumber_example; // The item number. (optional)

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

// Returns information about the specified bill of materials.
[apiInstance billofmaterialsGetWith:baseStockID
    baseStockLineID:baseStockLineID
    itemNumber:itemNumber
              completionHandler: ^(array[billofmaterials] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} The primary key of the item master record.
  'baseStockLineID': 56, // {{Integer}} The primary key of the item master record for a stock line item.
  'itemNumber': itemNumber_example // {{String}} The item number.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.billofmaterialsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class billofmaterialsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | The primary key of the item master record. (optional) 
            var baseStockLineID = 56;  // Integer | The primary key of the item master record for a stock line item. (optional) 
            var itemNumber = itemNumber_example;  // String | The item number. (optional) 

            try
            {
                // Returns information about the specified bill of materials.
                array[billofmaterials] result = apiInstance.billofmaterialsGet(baseStockID, baseStockLineID, itemNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.billofmaterialsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | The primary key of the item master record.
$baseStockLineID = 56; // Integer | The primary key of the item master record for a stock line item.
$itemNumber = itemNumber_example; // String | The item number.

try {
    $result = $api_instance->billofmaterialsGet($baseStockID, $baseStockLineID, $itemNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->billofmaterialsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | The primary key of the item master record.
my $baseStockLineID = 56; # Integer | The primary key of the item master record for a stock line item.
my $itemNumber = itemNumber_example; # String | The item number.

eval { 
    my $result = $api_instance->billofmaterialsGet(baseStockID => $baseStockID, baseStockLineID => $baseStockLineID, itemNumber => $itemNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->billofmaterialsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | The primary key of the item master record. (optional)
baseStockLineID = 56 # Integer | The primary key of the item master record for a stock line item. (optional)
itemNumber = itemNumber_example # String | The item number. (optional)

try: 
    # Returns information about the specified bill of materials.
    api_response = api_instance.billofmaterials_get(baseStockID=baseStockID, baseStockLineID=baseStockLineID, itemNumber=itemNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->billofmaterialsGet: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
The primary key of the item master record.
BaseStockLineID
Integer
The primary key of the item master record for a stock line item.
ItemNumber
String
The item number.

Responses

Status: 200 - OK


binlistGet

Returns binlist information.

The binlist request returns information about the specified bin.


/binlist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/binlist?bBin=&BinID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String bBin = bBin_example; // String | The assigned bin name.
        Integer binID = 56; // Integer | A valid value is the valid BinID, that you used for the REST call.
        try {
            binlist result = apiInstance.binlistGet(bBin, binID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#binlistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String bBin = bBin_example; // String | The assigned bin name.
        Integer binID = 56; // Integer | A valid value is the valid BinID, that you used for the REST call.
        try {
            binlist result = apiInstance.binlistGet(bBin, binID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#binlistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *bBin = bBin_example; // The assigned bin name. (optional)
Integer *binID = 56; // A valid value is the valid BinID, that you used for the REST call. (optional)

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

// Returns binlist information.
[apiInstance binlistGetWith:bBin
    binID:binID
              completionHandler: ^(binlist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'bBin': bBin_example, // {{String}} The assigned bin name.
  'binID': 56 // {{Integer}} A valid value is the valid BinID, that you used for the REST call.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.binlistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class binlistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var bBin = bBin_example;  // String | The assigned bin name. (optional) 
            var binID = 56;  // Integer | A valid value is the valid BinID, that you used for the REST call. (optional) 

            try
            {
                // Returns binlist information.
                binlist result = apiInstance.binlistGet(bBin, binID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.binlistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$bBin = bBin_example; // String | The assigned bin name.
$binID = 56; // Integer | A valid value is the valid BinID, that you used for the REST call.

try {
    $result = $api_instance->binlistGet($bBin, $binID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->binlistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $bBin = bBin_example; # String | The assigned bin name.
my $binID = 56; # Integer | A valid value is the valid BinID, that you used for the REST call.

eval { 
    my $result = $api_instance->binlistGet(bBin => $bBin, binID => $binID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->binlistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
bBin = bBin_example # String | The assigned bin name. (optional)
binID = 56 # Integer | A valid value is the valid BinID, that you used for the REST call. (optional)

try: 
    # Returns binlist information.
    api_response = api_instance.binlist_get(bBin=bBin, binID=binID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->binlistGet: %s\n" % e)

Parameters

Query parameters
Name Description
bBin
String
The assigned bin name.
BinID
Integer
A valid value is the valid BinID, that you used for the REST call.

Responses

Status: 200 - OK


contactlistGet

Returns a list of contact information

The contactlist request returns a list of contact records.


/contactlist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/contactlist?LinkCardRecordID=&CardsTypeID=&CreateDate=&FirstName=&LastName=&Name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer linkCardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
        String cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
        String createDate = createDate_example; // String | The creation date of the contact record.
        String firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
        String name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
        try {
            contactslist result = apiInstance.contactlistGet(linkCardRecordID, cardsTypeID, createDate, firstName, lastName, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#contactlistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer linkCardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
        String cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
        String createDate = createDate_example; // String | The creation date of the contact record.
        String firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
        String name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
        try {
            contactslist result = apiInstance.contactlistGet(linkCardRecordID, cardsTypeID, createDate, firstName, lastName, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#contactlistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *linkCardRecordID = 56; // The card ID number of the record within the Card table containing contact details. (optional)
String *cardsTypeID = cardsTypeID_example; // CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional)
String *createDate = createDate_example; // The creation date of the contact record. (optional)
String *firstName = firstName_example; // Blank if the card record represents a company, otherwise the first name of the individual. (optional)
String *lastName = lastName_example; // The company name if the card record represents a company, otherwise the individual's last name. (optional)
String *name = name_example; // If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional)

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

// Returns a list of contact information
[apiInstance contactlistGetWith:linkCardRecordID
    cardsTypeID:cardsTypeID
    createDate:createDate
    firstName:firstName
    lastName:lastName
    name:name
              completionHandler: ^(contactslist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'linkCardRecordID': 56, // {{Integer}} The card ID number of the record within the Card table containing contact details.
  'cardsTypeID': cardsTypeID_example, // {{String}} CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
  'createDate': createDate_example, // {{String}} The creation date of the contact record.
  'firstName': firstName_example, // {{String}} Blank if the card record represents a company, otherwise the first name of the individual.
  'lastName': lastName_example, // {{String}} The company name if the card record represents a company, otherwise the individual's last name.
  'name': name_example // {{String}} If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactlistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactlistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var linkCardRecordID = 56;  // Integer | The card ID number of the record within the Card table containing contact details. (optional) 
            var cardsTypeID = cardsTypeID_example;  // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional) 
            var createDate = createDate_example;  // String | The creation date of the contact record. (optional) 
            var firstName = firstName_example;  // String | Blank if the card record represents a company, otherwise the first name of the individual. (optional) 
            var lastName = lastName_example;  // String | The company name if the card record represents a company, otherwise the individual's last name. (optional) 
            var name = name_example;  // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional) 

            try
            {
                // Returns a list of contact information
                contactslist result = apiInstance.contactlistGet(linkCardRecordID, cardsTypeID, createDate, firstName, lastName, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.contactlistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$linkCardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
$cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
$createDate = createDate_example; // String | The creation date of the contact record.
$firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
$lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
$name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

try {
    $result = $api_instance->contactlistGet($linkCardRecordID, $cardsTypeID, $createDate, $firstName, $lastName, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->contactlistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $linkCardRecordID = 56; # Integer | The card ID number of the record within the Card table containing contact details.
my $cardsTypeID = cardsTypeID_example; # String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
my $createDate = createDate_example; # String | The creation date of the contact record.
my $firstName = firstName_example; # String | Blank if the card record represents a company, otherwise the first name of the individual.
my $lastName = lastName_example; # String | The company name if the card record represents a company, otherwise the individual's last name.
my $name = name_example; # String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

eval { 
    my $result = $api_instance->contactlistGet(linkCardRecordID => $linkCardRecordID, cardsTypeID => $cardsTypeID, createDate => $createDate, firstName => $firstName, lastName => $lastName, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->contactlistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
linkCardRecordID = 56 # Integer | The card ID number of the record within the Card table containing contact details. (optional)
cardsTypeID = cardsTypeID_example # String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional)
createDate = createDate_example # String | The creation date of the contact record. (optional)
firstName = firstName_example # String | Blank if the card record represents a company, otherwise the first name of the individual. (optional)
lastName = lastName_example # String | The company name if the card record represents a company, otherwise the individual's last name. (optional)
name = name_example # String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional)

try: 
    # Returns a list of contact information
    api_response = api_instance.contactlist_get(linkCardRecordID=linkCardRecordID, cardsTypeID=cardsTypeID, createDate=createDate, firstName=firstName, lastName=lastName, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->contactlistGet: %s\n" % e)

Parameters

Query parameters
Name Description
LinkCardRecordID
Integer
The card ID number of the record within the Card table containing contact details.
CardsTypeID
String
CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
CreateDate
String
The creation date of the contact record.
FirstName
String
Blank if the card record represents a company, otherwise the first name of the individual.
LastName
String
The company name if the card record represents a company, otherwise the individual's last name.
Name
String
If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

Responses

Status: 200 - OK


contactsGet

Returns Contact information.

The contact request returns information about the specified contact.


/contacts

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/contacts?CardIdentification=&CardRecordID=&CardsTypeID=&CreateDate=&FirstName=&LastName=&Name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer cardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
        String cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
        String createDate = createDate_example; // String | The creation date of the contact record.
        String firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
        String name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
        try {
            contactsget result = apiInstance.contactsGet(cardIdentification, cardRecordID, cardsTypeID, createDate, firstName, lastName, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#contactsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer cardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
        String cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
        String createDate = createDate_example; // String | The creation date of the contact record.
        String firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
        String name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
        try {
            contactsget result = apiInstance.contactsGet(cardIdentification, cardRecordID, cardsTypeID, createDate, firstName, lastName, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#contactsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *cardIdentification = cardIdentification_example; // User defined unique card ID. (optional)
Integer *cardRecordID = 56; // The card ID number of the record within the Card table containing contact details. (optional)
String *cardsTypeID = cardsTypeID_example; // CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional)
String *createDate = createDate_example; // The creation date of the contact record. (optional)
String *firstName = firstName_example; // Blank if the card record represents a company, otherwise the first name of the individual. (optional)
String *lastName = lastName_example; // The company name if the card record represents a company, otherwise the individual's last name. (optional)
String *name = name_example; // If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional)

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

// Returns Contact information.
[apiInstance contactsGetWith:cardIdentification
    cardRecordID:cardRecordID
    cardsTypeID:cardsTypeID
    createDate:createDate
    firstName:firstName
    lastName:lastName
    name:name
              completionHandler: ^(contactsget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'cardIdentification': cardIdentification_example, // {{String}} User defined unique card ID.
  'cardRecordID': 56, // {{Integer}} The card ID number of the record within the Card table containing contact details.
  'cardsTypeID': cardsTypeID_example, // {{String}} CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
  'createDate': createDate_example, // {{String}} The creation date of the contact record.
  'firstName': firstName_example, // {{String}} Blank if the card record represents a company, otherwise the first name of the individual.
  'lastName': lastName_example, // {{String}} The company name if the card record represents a company, otherwise the individual's last name.
  'name': name_example // {{String}} If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var cardIdentification = cardIdentification_example;  // String | User defined unique card ID. (optional) 
            var cardRecordID = 56;  // Integer | The card ID number of the record within the Card table containing contact details. (optional) 
            var cardsTypeID = cardsTypeID_example;  // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional) 
            var createDate = createDate_example;  // String | The creation date of the contact record. (optional) 
            var firstName = firstName_example;  // String | Blank if the card record represents a company, otherwise the first name of the individual. (optional) 
            var lastName = lastName_example;  // String | The company name if the card record represents a company, otherwise the individual's last name. (optional) 
            var name = name_example;  // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional) 

            try
            {
                // Returns Contact information.
                contactsget result = apiInstance.contactsGet(cardIdentification, cardRecordID, cardsTypeID, createDate, firstName, lastName, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.contactsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$cardIdentification = cardIdentification_example; // String | User defined unique card ID.
$cardRecordID = 56; // Integer | The card ID number of the record within the Card table containing contact details.
$cardsTypeID = cardsTypeID_example; // String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
$createDate = createDate_example; // String | The creation date of the contact record.
$firstName = firstName_example; // String | Blank if the card record represents a company, otherwise the first name of the individual.
$lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the individual's last name.
$name = name_example; // String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

try {
    $result = $api_instance->contactsGet($cardIdentification, $cardRecordID, $cardsTypeID, $createDate, $firstName, $lastName, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->contactsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $cardIdentification = cardIdentification_example; # String | User defined unique card ID.
my $cardRecordID = 56; # Integer | The card ID number of the record within the Card table containing contact details.
my $cardsTypeID = cardsTypeID_example; # String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
my $createDate = createDate_example; # String | The creation date of the contact record.
my $firstName = firstName_example; # String | Blank if the card record represents a company, otherwise the first name of the individual.
my $lastName = lastName_example; # String | The company name if the card record represents a company, otherwise the individual's last name.
my $name = name_example; # String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

eval { 
    my $result = $api_instance->contactsGet(cardIdentification => $cardIdentification, cardRecordID => $cardRecordID, cardsTypeID => $cardsTypeID, createDate => $createDate, firstName => $firstName, lastName => $lastName, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->contactsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
cardIdentification = cardIdentification_example # String | User defined unique card ID. (optional)
cardRecordID = 56 # Integer | The card ID number of the record within the Card table containing contact details. (optional)
cardsTypeID = cardsTypeID_example # String | CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee (optional)
createDate = createDate_example # String | The creation date of the contact record. (optional)
firstName = firstName_example # String | Blank if the card record represents a company, otherwise the first name of the individual. (optional)
lastName = lastName_example # String | The company name if the card record represents a company, otherwise the individual's last name. (optional)
name = name_example # String | If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name. (optional)

try: 
    # Returns Contact information.
    api_response = api_instance.contacts_get(cardIdentification=cardIdentification, cardRecordID=cardRecordID, cardsTypeID=cardsTypeID, createDate=createDate, firstName=firstName, lastName=lastName, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->contactsGet: %s\n" % e)

Parameters

Query parameters
Name Description
CardIdentification
String
User defined unique card ID.
CardRecordID
Integer
The card ID number of the record within the Card table containing contact details.
CardsTypeID
String
CardTypeID (CardTypes) of the record containing the full card type definition. S = Supplier,E = Employee
CreateDate
String
The creation date of the contact record.
FirstName
String
Blank if the card record represents a company, otherwise the first name of the individual.
LastName
String
The company name if the card record represents a company, otherwise the individual's last name.
Name
String
If the card is a company: company name. If the card is an individual: last name followed by a comma, a space and the first name.

Responses

Status: 200 - OK


customerpaymentsGet

Returns payment information.

The payment customer request returns information about the specified payment.


/customerpayments

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/customerpayments?Account=&ChequeNumber=&Comments=&CustomerID=&CustomerName=&CustomerPO=&InvoiceNumber=&Memo=&PaymentID=&ReceiptNumber=&SaleID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String account = account_example; // String | The account name.
        Integer chequeNumber = 56; // Integer | The payment cheque number
        String comments = comments_example; // String | Comment of the payments
        Integer customerID = 56; // Integer | The primary key value of the Customer record.
        String customerName = customerName_example; // String | The name of the customer
        Integer customerPO = 56; // Integer | The customer purchase order number
        Integer invoiceNumber = 56; // Integer | The invoice number of the sale
        String memo = memo_example; // String | Any reminding notes attached to the payment.
        String paymentID = paymentID_example; // String | The primary key value of the customer payment.
        Integer receiptNumber = 56; // Integer | The receipt number of the payment
        Integer saleID = 56; // Integer | The primary key value of the sale record.
        try {
            customerpaymentsget result = apiInstance.customerpaymentsGet(account, chequeNumber, comments, customerID, customerName, customerPO, invoiceNumber, memo, paymentID, receiptNumber, saleID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#customerpaymentsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String account = account_example; // String | The account name.
        Integer chequeNumber = 56; // Integer | The payment cheque number
        String comments = comments_example; // String | Comment of the payments
        Integer customerID = 56; // Integer | The primary key value of the Customer record.
        String customerName = customerName_example; // String | The name of the customer
        Integer customerPO = 56; // Integer | The customer purchase order number
        Integer invoiceNumber = 56; // Integer | The invoice number of the sale
        String memo = memo_example; // String | Any reminding notes attached to the payment.
        String paymentID = paymentID_example; // String | The primary key value of the customer payment.
        Integer receiptNumber = 56; // Integer | The receipt number of the payment
        Integer saleID = 56; // Integer | The primary key value of the sale record.
        try {
            customerpaymentsget result = apiInstance.customerpaymentsGet(account, chequeNumber, comments, customerID, customerName, customerPO, invoiceNumber, memo, paymentID, receiptNumber, saleID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#customerpaymentsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *account = account_example; // The account name. (optional)
Integer *chequeNumber = 56; // The payment cheque number (optional)
String *comments = comments_example; // Comment of the payments (optional)
Integer *customerID = 56; // The primary key value of the Customer record. (optional)
String *customerName = customerName_example; // The name of the customer (optional)
Integer *customerPO = 56; // The customer purchase order number (optional)
Integer *invoiceNumber = 56; // The invoice number of the sale (optional)
String *memo = memo_example; // Any reminding notes attached to the payment. (optional)
String *paymentID = paymentID_example; // The primary key value of the customer payment. (optional)
Integer *receiptNumber = 56; // The receipt number of the payment (optional)
Integer *saleID = 56; // The primary key value of the sale record. (optional)

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

// Returns payment information.
[apiInstance customerpaymentsGetWith:account
    chequeNumber:chequeNumber
    comments:comments
    customerID:customerID
    customerName:customerName
    customerPO:customerPO
    invoiceNumber:invoiceNumber
    memo:memo
    paymentID:paymentID
    receiptNumber:receiptNumber
    saleID:saleID
              completionHandler: ^(customerpaymentsget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'account': account_example, // {{String}} The account name.
  'chequeNumber': 56, // {{Integer}} The payment cheque number
  'comments': comments_example, // {{String}} Comment of the payments
  'customerID': 56, // {{Integer}} The primary key value of the Customer record.
  'customerName': customerName_example, // {{String}} The name of the customer
  'customerPO': 56, // {{Integer}} The customer purchase order number
  'invoiceNumber': 56, // {{Integer}} The invoice number of the sale
  'memo': memo_example, // {{String}} Any reminding notes attached to the payment.
  'paymentID': paymentID_example, // {{String}} The primary key value of the customer payment.
  'receiptNumber': 56, // {{Integer}} The receipt number of the payment
  'saleID': 56 // {{Integer}} The primary key value of the sale record.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customerpaymentsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class customerpaymentsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var account = account_example;  // String | The account name. (optional) 
            var chequeNumber = 56;  // Integer | The payment cheque number (optional) 
            var comments = comments_example;  // String | Comment of the payments (optional) 
            var customerID = 56;  // Integer | The primary key value of the Customer record. (optional) 
            var customerName = customerName_example;  // String | The name of the customer (optional) 
            var customerPO = 56;  // Integer | The customer purchase order number (optional) 
            var invoiceNumber = 56;  // Integer | The invoice number of the sale (optional) 
            var memo = memo_example;  // String | Any reminding notes attached to the payment. (optional) 
            var paymentID = paymentID_example;  // String | The primary key value of the customer payment. (optional) 
            var receiptNumber = 56;  // Integer | The receipt number of the payment (optional) 
            var saleID = 56;  // Integer | The primary key value of the sale record. (optional) 

            try
            {
                // Returns payment information.
                customerpaymentsget result = apiInstance.customerpaymentsGet(account, chequeNumber, comments, customerID, customerName, customerPO, invoiceNumber, memo, paymentID, receiptNumber, saleID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.customerpaymentsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$account = account_example; // String | The account name.
$chequeNumber = 56; // Integer | The payment cheque number
$comments = comments_example; // String | Comment of the payments
$customerID = 56; // Integer | The primary key value of the Customer record.
$customerName = customerName_example; // String | The name of the customer
$customerPO = 56; // Integer | The customer purchase order number
$invoiceNumber = 56; // Integer | The invoice number of the sale
$memo = memo_example; // String | Any reminding notes attached to the payment.
$paymentID = paymentID_example; // String | The primary key value of the customer payment.
$receiptNumber = 56; // Integer | The receipt number of the payment
$saleID = 56; // Integer | The primary key value of the sale record.

try {
    $result = $api_instance->customerpaymentsGet($account, $chequeNumber, $comments, $customerID, $customerName, $customerPO, $invoiceNumber, $memo, $paymentID, $receiptNumber, $saleID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->customerpaymentsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $account = account_example; # String | The account name.
my $chequeNumber = 56; # Integer | The payment cheque number
my $comments = comments_example; # String | Comment of the payments
my $customerID = 56; # Integer | The primary key value of the Customer record.
my $customerName = customerName_example; # String | The name of the customer
my $customerPO = 56; # Integer | The customer purchase order number
my $invoiceNumber = 56; # Integer | The invoice number of the sale
my $memo = memo_example; # String | Any reminding notes attached to the payment.
my $paymentID = paymentID_example; # String | The primary key value of the customer payment.
my $receiptNumber = 56; # Integer | The receipt number of the payment
my $saleID = 56; # Integer | The primary key value of the sale record.

eval { 
    my $result = $api_instance->customerpaymentsGet(account => $account, chequeNumber => $chequeNumber, comments => $comments, customerID => $customerID, customerName => $customerName, customerPO => $customerPO, invoiceNumber => $invoiceNumber, memo => $memo, paymentID => $paymentID, receiptNumber => $receiptNumber, saleID => $saleID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->customerpaymentsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
account = account_example # String | The account name. (optional)
chequeNumber = 56 # Integer | The payment cheque number (optional)
comments = comments_example # String | Comment of the payments (optional)
customerID = 56 # Integer | The primary key value of the Customer record. (optional)
customerName = customerName_example # String | The name of the customer (optional)
customerPO = 56 # Integer | The customer purchase order number (optional)
invoiceNumber = 56 # Integer | The invoice number of the sale (optional)
memo = memo_example # String | Any reminding notes attached to the payment. (optional)
paymentID = paymentID_example # String | The primary key value of the customer payment. (optional)
receiptNumber = 56 # Integer | The receipt number of the payment (optional)
saleID = 56 # Integer | The primary key value of the sale record. (optional)

try: 
    # Returns payment information.
    api_response = api_instance.customerpayments_get(account=account, chequeNumber=chequeNumber, comments=comments, customerID=customerID, customerName=customerName, customerPO=customerPO, invoiceNumber=invoiceNumber, memo=memo, paymentID=paymentID, receiptNumber=receiptNumber, saleID=saleID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->customerpaymentsGet: %s\n" % e)

Parameters

Query parameters
Name Description
Account
String
The account name.
ChequeNumber
Integer
The payment cheque number
Comments
String
Comment of the payments
CustomerID
Integer
The primary key value of the Customer record.
CustomerName
String
The name of the customer
CustomerPO
Integer
The customer purchase order number
InvoiceNumber
Integer
The invoice number of the sale
Memo
String
Any reminding notes attached to the payment.
PaymentID
String
The primary key value of the customer payment.
ReceiptNumber
Integer
The receipt number of the payment
SaleID
Integer
The primary key value of the sale record.

Responses

Status: 200 - OK


formGet

Generates the report and return the url to get the report.

The form generates the report with the given params and return the url to get generated report


/form

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/form?Filename=&ID=&SaveAsExcel=&SaveAsHtml=&Type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String filename = filename_example; // String | A valid filename.
        Integer iD = 56; // Integer | The primary key value of the form record.
        Boolean saveAsExcel = true; // Boolean | Save as excel.
        Boolean saveAsHtml = true; // Boolean | Save as HTML.
        String type = type_example; // String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel
        try {
            form result = apiInstance.formGet(filename, iD, saveAsExcel, saveAsHtml, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#formGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String filename = filename_example; // String | A valid filename.
        Integer iD = 56; // Integer | The primary key value of the form record.
        Boolean saveAsExcel = true; // Boolean | Save as excel.
        Boolean saveAsHtml = true; // Boolean | Save as HTML.
        String type = type_example; // String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel
        try {
            form result = apiInstance.formGet(filename, iD, saveAsExcel, saveAsHtml, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#formGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *filename = filename_example; // A valid filename. (optional)
Integer *iD = 56; // The primary key value of the form record. (optional)
Boolean *saveAsExcel = true; // Save as excel. (optional)
Boolean *saveAsHtml = true; // Save as HTML. (optional)
String *type = type_example; // Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel (optional)

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

// Generates the report and return the url to get the report.
[apiInstance formGetWith:filename
    iD:iD
    saveAsExcel:saveAsExcel
    saveAsHtml:saveAsHtml
    type:type
              completionHandler: ^(form output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'filename': filename_example, // {{String}} A valid filename.
  'iD': 56, // {{Integer}} The primary key value of the form record.
  'saveAsExcel': true, // {{Boolean}} Save as excel.
  'saveAsHtml': true, // {{Boolean}} Save as HTML.
  'type': type_example // {{String}} Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.formGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class formGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var filename = filename_example;  // String | A valid filename. (optional) 
            var iD = 56;  // Integer | The primary key value of the form record. (optional) 
            var saveAsExcel = true;  // Boolean | Save as excel. (optional) 
            var saveAsHtml = true;  // Boolean | Save as HTML. (optional) 
            var type = type_example;  // String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel (optional) 

            try
            {
                // Generates the report and return the url to get the report.
                form result = apiInstance.formGet(filename, iD, saveAsExcel, saveAsHtml, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.formGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$filename = filename_example; // String | A valid filename.
$iD = 56; // Integer | The primary key value of the form record.
$saveAsExcel = true; // Boolean | Save as excel.
$saveAsHtml = true; // Boolean | Save as HTML.
$type = type_example; // String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel

try {
    $result = $api_instance->formGet($filename, $iD, $saveAsExcel, $saveAsHtml, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->formGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $filename = filename_example; # String | A valid filename.
my $iD = 56; # Integer | The primary key value of the form record.
my $saveAsExcel = true; # Boolean | Save as excel.
my $saveAsHtml = true; # Boolean | Save as HTML.
my $type = type_example; # String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel

eval { 
    my $result = $api_instance->formGet(filename => $filename, iD => $iD, saveAsExcel => $saveAsExcel, saveAsHtml => $saveAsHtml, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->formGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
filename = filename_example # String | A valid filename. (optional)
iD = 56 # Integer | The primary key value of the form record. (optional)
saveAsExcel = true # Boolean | Save as excel. (optional)
saveAsHtml = true # Boolean | Save as HTML. (optional)
type = type_example # String | Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel (optional)

try: 
    # Generates the report and return the url to get the report.
    api_response = api_instance.form_get(filename=filename, iD=iD, saveAsExcel=saveAsExcel, saveAsHtml=saveAsHtml, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->formGet: %s\n" % e)

Parameters

Query parameters
Name Description
Filename
String
A valid filename.
ID
Integer
The primary key value of the form record.
SaveAsExcel
Boolean
Save as excel.
SaveAsHtml
Boolean
Save as HTML.
Type
String
Type of form palletlabel, order, cartonlabel,pickslip,shiplabel,packingslip or itemlabel

Responses

Status: 200 - OK


getInventory

The inventory request returns information about the specified inventory.

By passing in the appropriate options, you can search for available inventory in the system


/inventory

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/inventory?BaseStockID=&BatchListID=&BinID=&ItemName=&ItemNumber=&LocationID=&BRN="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        Integer batchListID = 56; // Integer | Pass a primary key of a batch list item.
        Integer binID = 56; // Integer | Pass by primary key of the item's assigned Bin.
        String itemName = itemName_example; // String | Pass by an item name.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer locationID = 56; // Integer | Pass by primary key of an items location.
        String bRN = bRN_example; // String | Pass by the Batch Registration Number of an item.
        try {
            inventory result = apiInstance.getInventory(baseStockID, batchListID, binID, itemName, itemNumber, locationID, bRN);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getInventory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        Integer batchListID = 56; // Integer | Pass a primary key of a batch list item.
        Integer binID = 56; // Integer | Pass by primary key of the item's assigned Bin.
        String itemName = itemName_example; // String | Pass by an item name.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer locationID = 56; // Integer | Pass by primary key of an items location.
        String bRN = bRN_example; // String | Pass by the Batch Registration Number of an item.
        try {
            inventory result = apiInstance.getInventory(baseStockID, batchListID, binID, itemName, itemNumber, locationID, bRN);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getInventory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
Integer *batchListID = 56; // Pass a primary key of a batch list item. (optional)
Integer *binID = 56; // Pass by primary key of the item's assigned Bin. (optional)
String *itemName = itemName_example; // Pass by an item name. (optional)
String *itemNumber = itemNumber_example; // Pass by an item number. (optional)
Integer *locationID = 56; // Pass by primary key of an items location. (optional)
String *bRN = bRN_example; // Pass by the Batch Registration Number of an item. (optional)

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

// The inventory request returns information about the specified inventory.
[apiInstance getInventoryWith:baseStockID
    batchListID:batchListID
    binID:binID
    itemName:itemName
    itemNumber:itemNumber
    locationID:locationID
    bRN:bRN
              completionHandler: ^(inventory output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'batchListID': 56, // {{Integer}} Pass a primary key of a batch list item.
  'binID': 56, // {{Integer}} Pass by primary key of the item's assigned Bin.
  'itemName': itemName_example, // {{String}} Pass by an item name.
  'itemNumber': itemNumber_example, // {{String}} Pass by an item number.
  'locationID': 56, // {{Integer}} Pass by primary key of an items location.
  'bRN': bRN_example // {{String}} Pass by the Batch Registration Number of an item.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInventory(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInventoryExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var batchListID = 56;  // Integer | Pass a primary key of a batch list item. (optional) 
            var binID = 56;  // Integer | Pass by primary key of the item's assigned Bin. (optional) 
            var itemName = itemName_example;  // String | Pass by an item name. (optional) 
            var itemNumber = itemNumber_example;  // String | Pass by an item number. (optional) 
            var locationID = 56;  // Integer | Pass by primary key of an items location. (optional) 
            var bRN = bRN_example;  // String | Pass by the Batch Registration Number of an item. (optional) 

            try
            {
                // The inventory request returns information about the specified inventory.
                inventory result = apiInstance.getInventory(baseStockID, batchListID, binID, itemName, itemNumber, locationID, bRN);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.getInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$batchListID = 56; // Integer | Pass a primary key of a batch list item.
$binID = 56; // Integer | Pass by primary key of the item's assigned Bin.
$itemName = itemName_example; // String | Pass by an item name.
$itemNumber = itemNumber_example; // String | Pass by an item number.
$locationID = 56; // Integer | Pass by primary key of an items location.
$bRN = bRN_example; // String | Pass by the Batch Registration Number of an item.

try {
    $result = $api_instance->getInventory($baseStockID, $batchListID, $binID, $itemName, $itemNumber, $locationID, $bRN);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->getInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $batchListID = 56; # Integer | Pass a primary key of a batch list item.
my $binID = 56; # Integer | Pass by primary key of the item's assigned Bin.
my $itemName = itemName_example; # String | Pass by an item name.
my $itemNumber = itemNumber_example; # String | Pass by an item number.
my $locationID = 56; # Integer | Pass by primary key of an items location.
my $bRN = bRN_example; # String | Pass by the Batch Registration Number of an item.

eval { 
    my $result = $api_instance->getInventory(baseStockID => $baseStockID, batchListID => $batchListID, binID => $binID, itemName => $itemName, itemNumber => $itemNumber, locationID => $locationID, bRN => $bRN);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->getInventory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
batchListID = 56 # Integer | Pass a primary key of a batch list item. (optional)
binID = 56 # Integer | Pass by primary key of the item's assigned Bin. (optional)
itemName = itemName_example # String | Pass by an item name. (optional)
itemNumber = itemNumber_example # String | Pass by an item number. (optional)
locationID = 56 # Integer | Pass by primary key of an items location. (optional)
bRN = bRN_example # String | Pass by the Batch Registration Number of an item. (optional)

try: 
    # The inventory request returns information about the specified inventory.
    api_response = api_instance.get_inventory(baseStockID=baseStockID, batchListID=batchListID, binID=binID, itemName=itemName, itemNumber=itemNumber, locationID=locationID, bRN=bRN)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->getInventory: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
BatchListID
Integer
Pass a primary key of a batch list item.
BinID
Integer
Pass by primary key of the item's assigned Bin.
ItemName
String
Pass by an item name.
ItemNumber
String
Pass by an item number.
LocationID
Integer
Pass by primary key of an items location.
BRN
String
Pass by the Batch Registration Number of an item.

Responses

Status: 200 - OK


getItem

Returns information about a specified item.

The items endpoint returns one record per SKU (stock keeping unit) or sometimes called the Item Master List. Each record provides information regarding the generic item properties and specific article location details. This endpoint is typically used to generate lists of available inventory available for sale or consumption.


/items

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/items?BaseStockID=&CustomField1=&CustomField2=&CustomField3=&ItemName=&ItemNumber=&ItemNotes=&MYOBItemID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String customField1 = customField1_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String customField2 = customField2_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String customField3 = customField3_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String itemName = itemName_example; // String | The item name.
        String itemNumber = itemNumber_example; // String | The allocated item number.
        String itemNotes = itemNotes_example; // String | The notes for an item.
        Integer mYOBItemID = 56; // Integer | The primary key of the item in the MYOB database
        try {
            array[itemsGet] result = apiInstance.getItem(baseStockID, customField1, customField2, customField3, itemName, itemNumber, itemNotes, mYOBItemID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String customField1 = customField1_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String customField2 = customField2_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String customField3 = customField3_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
        String itemName = itemName_example; // String | The item name.
        String itemNumber = itemNumber_example; // String | The allocated item number.
        String itemNotes = itemNotes_example; // String | The notes for an item.
        Integer mYOBItemID = 56; // Integer | The primary key of the item in the MYOB database
        try {
            array[itemsGet] result = apiInstance.getItem(baseStockID, customField1, customField2, customField3, itemName, itemNumber, itemNotes, mYOBItemID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
String *customField1 = customField1_example; // Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
String *customField2 = customField2_example; // Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
String *customField3 = customField3_example; // Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
String *itemName = itemName_example; // The item name. (optional)
String *itemNumber = itemNumber_example; // The allocated item number. (optional)
String *itemNotes = itemNotes_example; // The notes for an item. (optional)
Integer *mYOBItemID = 56; // The primary key of the item in the MYOB database (optional)

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

// Returns information about a specified item.
[apiInstance getItemWith:baseStockID
    customField1:customField1
    customField2:customField2
    customField3:customField3
    itemName:itemName
    itemNumber:itemNumber
    itemNotes:itemNotes
    mYOBItemID:mYOBItemID
              completionHandler: ^(array[itemsGet] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'customField1': customField1_example, // {{String}} Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
  'customField2': customField2_example, // {{String}} Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
  'customField3': customField3_example, // {{String}} Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
  'itemName': itemName_example, // {{String}} The item name.
  'itemNumber': itemNumber_example, // {{String}} The allocated item number.
  'itemNotes': itemNotes_example, // {{String}} The notes for an item.
  'mYOBItemID': 56 // {{Integer}} The primary key of the item in the MYOB database
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getItem(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getItemExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var customField1 = customField1_example;  // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional) 
            var customField2 = customField2_example;  // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional) 
            var customField3 = customField3_example;  // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional) 
            var itemName = itemName_example;  // String | The item name. (optional) 
            var itemNumber = itemNumber_example;  // String | The allocated item number. (optional) 
            var itemNotes = itemNotes_example;  // String | The notes for an item. (optional) 
            var mYOBItemID = 56;  // Integer | The primary key of the item in the MYOB database (optional) 

            try
            {
                // Returns information about a specified item.
                array[itemsGet] result = apiInstance.getItem(baseStockID, customField1, customField2, customField3, itemName, itemNumber, itemNotes, mYOBItemID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.getItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$customField1 = customField1_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
$customField2 = customField2_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
$customField3 = customField3_example; // String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
$itemName = itemName_example; // String | The item name.
$itemNumber = itemNumber_example; // String | The allocated item number.
$itemNotes = itemNotes_example; // String | The notes for an item.
$mYOBItemID = 56; // Integer | The primary key of the item in the MYOB database

try {
    $result = $api_instance->getItem($baseStockID, $customField1, $customField2, $customField3, $itemName, $itemNumber, $itemNotes, $mYOBItemID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->getItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $customField1 = customField1_example; # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
my $customField2 = customField2_example; # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
my $customField3 = customField3_example; # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
my $itemName = itemName_example; # String | The item name.
my $itemNumber = itemNumber_example; # String | The allocated item number.
my $itemNotes = itemNotes_example; # String | The notes for an item.
my $mYOBItemID = 56; # Integer | The primary key of the item in the MYOB database

eval { 
    my $result = $api_instance->getItem(baseStockID => $baseStockID, customField1 => $customField1, customField2 => $customField2, customField3 => $customField3, itemName => $itemName, itemNumber => $itemNumber, itemNotes => $itemNotes, mYOBItemID => $mYOBItemID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->getItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
customField1 = customField1_example # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
customField2 = customField2_example # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
customField3 = customField3_example # String | Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release. (optional)
itemName = itemName_example # String | The item name. (optional)
itemNumber = itemNumber_example # String | The allocated item number. (optional)
itemNotes = itemNotes_example # String | The notes for an item. (optional)
mYOBItemID = 56 # Integer | The primary key of the item in the MYOB database (optional)

try: 
    # Returns information about a specified item.
    api_response = api_instance.get_item(baseStockID=baseStockID, customField1=customField1, customField2=customField2, customField3=customField3, itemName=itemName, itemNumber=itemNumber, itemNotes=itemNotes, mYOBItemID=mYOBItemID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->getItem: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
CustomField1
String
Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
CustomField2
String
Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
CustomField3
String
Custom Field 1 Text attached to this item. Custom Field 1 is only used within the Premier release.
ItemName
String
The item name.
ItemNumber
String
The allocated item number.
ItemNotes
String
The notes for an item.
MYOBItemID
Integer
The primary key of the item in the MYOB database

Responses

Status: 200 - OK


getItemFeature

Returns item feature information.

Returns information about the specified feature.


/itemFeature

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/itemFeature?BaseStockID=&ItemNumber=&Name=&Type=&Value="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        String name = name_example; // String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
        String type = type_example; // String | Type of feature.
        String value = value_example; // String | Value of the feature.
        try {
            itemFeature result = apiInstance.getItemFeature(baseStockID, itemNumber, name, type, value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItemFeature");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        String name = name_example; // String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
        String type = type_example; // String | Type of feature.
        String value = value_example; // String | Value of the feature.
        try {
            itemFeature result = apiInstance.getItemFeature(baseStockID, itemNumber, name, type, value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItemFeature");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
String *itemNumber = itemNumber_example; // Pass by an item number. (optional)
String *name = name_example; // If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name. (optional)
String *type = type_example; // Type of feature. (optional)
String *value = value_example; // Value of the feature. (optional)

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

// Returns item feature information.
[apiInstance getItemFeatureWith:baseStockID
    itemNumber:itemNumber
    name:name
    type:type
    value:value
              completionHandler: ^(itemFeature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'itemNumber': itemNumber_example, // {{String}} Pass by an item number.
  'name': name_example, // {{String}} If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
  'type': type_example, // {{String}} Type of feature.
  'value': value_example // {{String}} Value of the feature.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getItemFeature(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getItemFeatureExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var itemNumber = itemNumber_example;  // String | Pass by an item number. (optional) 
            var name = name_example;  // String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name. (optional) 
            var type = type_example;  // String | Type of feature. (optional) 
            var value = value_example;  // String | Value of the feature. (optional) 

            try
            {
                // Returns item feature information.
                itemFeature result = apiInstance.getItemFeature(baseStockID, itemNumber, name, type, value);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.getItemFeature: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$itemNumber = itemNumber_example; // String | Pass by an item number.
$name = name_example; // String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
$type = type_example; // String | Type of feature.
$value = value_example; // String | Value of the feature.

try {
    $result = $api_instance->getItemFeature($baseStockID, $itemNumber, $name, $type, $value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->getItemFeature: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $itemNumber = itemNumber_example; # String | Pass by an item number.
my $name = name_example; # String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
my $type = type_example; # String | Type of feature.
my $value = value_example; # String | Value of the feature.

eval { 
    my $result = $api_instance->getItemFeature(baseStockID => $baseStockID, itemNumber => $itemNumber, name => $name, type => $type, value => $value);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->getItemFeature: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
itemNumber = itemNumber_example # String | Pass by an item number. (optional)
name = name_example # String | If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name. (optional)
type = type_example # String | Type of feature. (optional)
value = value_example # String | Value of the feature. (optional)

try: 
    # Returns item feature information.
    api_response = api_instance.get_item_feature(baseStockID=baseStockID, itemNumber=itemNumber, name=name, type=type, value=value)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->getItemFeature: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
ItemNumber
String
Pass by an item number.
Name
String
If the card is a company - company name. If the card is an individual - last name followed by a comma, a space and the first name.
Type
String
Type of feature.
Value
String
Value of the feature.

Responses

Status: 200 - OK


getItemList

Returns a list of item attributes

The itemslist endpoint enables queries on the master item list returning item attributes per basestockid. This endpoint is related to the item endpoint but will not return stock levels only item properties. This endpoint should be used to read general item attributes - for inventory levels see the inventorylist endpoint.


/itemsList

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/itemsList?BaseStockID=&ItemNumber="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        try {
            inline_response_200_1 result = apiInstance.getItemList(baseStockID, itemNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItemList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        try {
            inline_response_200_1 result = apiInstance.getItemList(baseStockID, itemNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#getItemList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
String *itemNumber = itemNumber_example; // Pass by an item number. (optional)

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

// Returns a list of item attributes
[apiInstance getItemListWith:baseStockID
    itemNumber:itemNumber
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'itemNumber': itemNumber_example // {{String}} Pass by an item number.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getItemList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getItemListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var itemNumber = itemNumber_example;  // String | Pass by an item number. (optional) 

            try
            {
                // Returns a list of item attributes
                inline_response_200_1 result = apiInstance.getItemList(baseStockID, itemNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.getItemList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$itemNumber = itemNumber_example; // String | Pass by an item number.

try {
    $result = $api_instance->getItemList($baseStockID, $itemNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->getItemList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $itemNumber = itemNumber_example; # String | Pass by an item number.

eval { 
    my $result = $api_instance->getItemList(baseStockID => $baseStockID, itemNumber => $itemNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->getItemList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
itemNumber = itemNumber_example # String | Pass by an item number. (optional)

try: 
    # Returns a list of item attributes
    api_response = api_instance.get_item_list(baseStockID=baseStockID, itemNumber=itemNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->getItemList: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
ItemNumber
String
Pass by an item number.

Responses

Status: 200 - OK


locationbinGet

Returns locationbin information.

The locationbin request returns information about the specified location.


/locationbin

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/locationbin?BinName=&Location="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String binName = binName_example; // String | The Bin Name.
        String location = location_example; // String | The name of the location.
        try {
            locationbin result = apiInstance.locationbinGet(binName, location);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#locationbinGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String binName = binName_example; // String | The Bin Name.
        String location = location_example; // String | The name of the location.
        try {
            locationbin result = apiInstance.locationbinGet(binName, location);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#locationbinGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *binName = binName_example; // The Bin Name. (optional)
String *location = location_example; // The name of the location. (optional)

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

// Returns locationbin information.
[apiInstance locationbinGetWith:binName
    location:location
              completionHandler: ^(locationbin output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'binName': binName_example, // {{String}} The Bin Name.
  'location': location_example // {{String}} The name of the location.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locationbinGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class locationbinGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var binName = binName_example;  // String | The Bin Name. (optional) 
            var location = location_example;  // String | The name of the location. (optional) 

            try
            {
                // Returns locationbin information.
                locationbin result = apiInstance.locationbinGet(binName, location);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.locationbinGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$binName = binName_example; // String | The Bin Name.
$location = location_example; // String | The name of the location.

try {
    $result = $api_instance->locationbinGet($binName, $location);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->locationbinGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $binName = binName_example; # String | The Bin Name.
my $location = location_example; # String | The name of the location.

eval { 
    my $result = $api_instance->locationbinGet(binName => $binName, location => $location);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->locationbinGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
binName = binName_example # String | The Bin Name. (optional)
location = location_example # String | The name of the location. (optional)

try: 
    # Returns locationbin information.
    api_response = api_instance.locationbin_get(binName=binName, location=location)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->locationbinGet: %s\n" % e)

Parameters

Query parameters
Name Description
BinName
String
The Bin Name.
Location
String
The name of the location.

Responses

Status: 200 - OK


locationsGet

Returns information about the specified location.

The locations request returns information about the specified locations.


/locations

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/locations?cardIdentification=&locationsID=&contactID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer locationsID = 56; // Integer | The primary key of the location record.
        Integer contactID = 56; // Integer | Unique identifier for a stored Contact's details.
        try {
            array[locations] result = apiInstance.locationsGet(cardIdentification, locationsID, contactID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#locationsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer locationsID = 56; // Integer | The primary key of the location record.
        Integer contactID = 56; // Integer | Unique identifier for a stored Contact's details.
        try {
            array[locations] result = apiInstance.locationsGet(cardIdentification, locationsID, contactID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#locationsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *cardIdentification = cardIdentification_example; // User defined unique card ID. (optional)
Integer *locationsID = 56; // The primary key of the location record. (optional)
Integer *contactID = 56; // Unique identifier for a stored Contact's details. (optional)

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

// Returns information about the specified location.
[apiInstance locationsGetWith:cardIdentification
    locationsID:locationsID
    contactID:contactID
              completionHandler: ^(array[locations] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'cardIdentification': cardIdentification_example, // {{String}} User defined unique card ID.
  'locationsID': 56, // {{Integer}} The primary key of the location record.
  'contactID': 56 // {{Integer}} Unique identifier for a stored Contact's details.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locationsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class locationsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var cardIdentification = cardIdentification_example;  // String | User defined unique card ID. (optional) 
            var locationsID = 56;  // Integer | The primary key of the location record. (optional) 
            var contactID = 56;  // Integer | Unique identifier for a stored Contact's details. (optional) 

            try
            {
                // Returns information about the specified location.
                array[locations] result = apiInstance.locationsGet(cardIdentification, locationsID, contactID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.locationsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$cardIdentification = cardIdentification_example; // String | User defined unique card ID.
$locationsID = 56; // Integer | The primary key of the location record.
$contactID = 56; // Integer | Unique identifier for a stored Contact's details.

try {
    $result = $api_instance->locationsGet($cardIdentification, $locationsID, $contactID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->locationsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $cardIdentification = cardIdentification_example; # String | User defined unique card ID.
my $locationsID = 56; # Integer | The primary key of the location record.
my $contactID = 56; # Integer | Unique identifier for a stored Contact's details.

eval { 
    my $result = $api_instance->locationsGet(cardIdentification => $cardIdentification, locationsID => $locationsID, contactID => $contactID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->locationsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
cardIdentification = cardIdentification_example # String | User defined unique card ID. (optional)
locationsID = 56 # Integer | The primary key of the location record. (optional)
contactID = 56 # Integer | Unique identifier for a stored Contact's details. (optional)

try: 
    # Returns information about the specified location.
    api_response = api_instance.locations_get(cardIdentification=cardIdentification, locationsID=locationsID, contactID=contactID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->locationsGet: %s\n" % e)

Parameters

Query parameters
Name Description
cardIdentification
String
User defined unique card ID.
locationsID
Integer
The primary key of the location record.
contactID
Integer
Unique identifier for a stored Contact's details.

Responses

Status: 200 - OK


paymentsupplierGet

Returns supplier payment information.


/paymentsupplier

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/paymentsupplier?Account=&ChequeNumber=&DateClosed=&InvoiceNumber=&PaymentDate=&PaymentID=&PurchaseID=&ReceiptNumber=&SupplierID=&SupplierName=&SupplierPO="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String account = account_example; // String | The supplier account number.
        Integer chequeNumber = 56; // Integer | The number on the cheque related to a specified payment
        String dateClosed = dateClosed_example; // String | The date in which a payment record was closed.
        String invoiceNumber = invoiceNumber_example; // String | The invoice number related to a payment.
        String paymentDate = paymentDate_example; // String | The date of a supplier payment
        Integer paymentID = 56; // Integer | The primary key value of the payment record.
        Integer purchaseID = 56; // Integer | The primary key value of the purchase record.
        String receiptNumber = receiptNumber_example; // String | The receipt number of a payment.
        Integer supplierID = 56; // Integer | The primary key value of the supplier record.
        String supplierName = supplierName_example; // String | The name of the supplier.
        Integer supplierPO = 56; // Integer | The supplier purchase order number.
        try {
            paymentsupplierget result = apiInstance.paymentsupplierGet(account, chequeNumber, dateClosed, invoiceNumber, paymentDate, paymentID, purchaseID, receiptNumber, supplierID, supplierName, supplierPO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#paymentsupplierGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String account = account_example; // String | The supplier account number.
        Integer chequeNumber = 56; // Integer | The number on the cheque related to a specified payment
        String dateClosed = dateClosed_example; // String | The date in which a payment record was closed.
        String invoiceNumber = invoiceNumber_example; // String | The invoice number related to a payment.
        String paymentDate = paymentDate_example; // String | The date of a supplier payment
        Integer paymentID = 56; // Integer | The primary key value of the payment record.
        Integer purchaseID = 56; // Integer | The primary key value of the purchase record.
        String receiptNumber = receiptNumber_example; // String | The receipt number of a payment.
        Integer supplierID = 56; // Integer | The primary key value of the supplier record.
        String supplierName = supplierName_example; // String | The name of the supplier.
        Integer supplierPO = 56; // Integer | The supplier purchase order number.
        try {
            paymentsupplierget result = apiInstance.paymentsupplierGet(account, chequeNumber, dateClosed, invoiceNumber, paymentDate, paymentID, purchaseID, receiptNumber, supplierID, supplierName, supplierPO);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#paymentsupplierGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *account = account_example; // The supplier account number. (optional)
Integer *chequeNumber = 56; // The number on the cheque related to a specified payment (optional)
String *dateClosed = dateClosed_example; // The date in which a payment record was closed. (optional)
String *invoiceNumber = invoiceNumber_example; // The invoice number related to a payment. (optional)
String *paymentDate = paymentDate_example; // The date of a supplier payment (optional)
Integer *paymentID = 56; // The primary key value of the payment record. (optional)
Integer *purchaseID = 56; // The primary key value of the purchase record. (optional)
String *receiptNumber = receiptNumber_example; // The receipt number of a payment. (optional)
Integer *supplierID = 56; // The primary key value of the supplier record. (optional)
String *supplierName = supplierName_example; // The name of the supplier. (optional)
Integer *supplierPO = 56; // The supplier purchase order number. (optional)

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

// Returns supplier payment information.
[apiInstance paymentsupplierGetWith:account
    chequeNumber:chequeNumber
    dateClosed:dateClosed
    invoiceNumber:invoiceNumber
    paymentDate:paymentDate
    paymentID:paymentID
    purchaseID:purchaseID
    receiptNumber:receiptNumber
    supplierID:supplierID
    supplierName:supplierName
    supplierPO:supplierPO
              completionHandler: ^(paymentsupplierget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'account': account_example, // {{String}} The supplier account number.
  'chequeNumber': 56, // {{Integer}} The number on the cheque related to a specified payment
  'dateClosed': dateClosed_example, // {{String}} The date in which a payment record was closed.
  'invoiceNumber': invoiceNumber_example, // {{String}} The invoice number related to a payment.
  'paymentDate': paymentDate_example, // {{String}} The date of a supplier payment
  'paymentID': 56, // {{Integer}} The primary key value of the payment record.
  'purchaseID': 56, // {{Integer}} The primary key value of the purchase record.
  'receiptNumber': receiptNumber_example, // {{String}} The receipt number of a payment.
  'supplierID': 56, // {{Integer}} The primary key value of the supplier record.
  'supplierName': supplierName_example, // {{String}} The name of the supplier.
  'supplierPO': 56 // {{Integer}} The supplier purchase order number.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.paymentsupplierGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class paymentsupplierGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var account = account_example;  // String | The supplier account number. (optional) 
            var chequeNumber = 56;  // Integer | The number on the cheque related to a specified payment (optional) 
            var dateClosed = dateClosed_example;  // String | The date in which a payment record was closed. (optional) 
            var invoiceNumber = invoiceNumber_example;  // String | The invoice number related to a payment. (optional) 
            var paymentDate = paymentDate_example;  // String | The date of a supplier payment (optional) 
            var paymentID = 56;  // Integer | The primary key value of the payment record. (optional) 
            var purchaseID = 56;  // Integer | The primary key value of the purchase record. (optional) 
            var receiptNumber = receiptNumber_example;  // String | The receipt number of a payment. (optional) 
            var supplierID = 56;  // Integer | The primary key value of the supplier record. (optional) 
            var supplierName = supplierName_example;  // String | The name of the supplier. (optional) 
            var supplierPO = 56;  // Integer | The supplier purchase order number. (optional) 

            try
            {
                // Returns supplier payment information.
                paymentsupplierget result = apiInstance.paymentsupplierGet(account, chequeNumber, dateClosed, invoiceNumber, paymentDate, paymentID, purchaseID, receiptNumber, supplierID, supplierName, supplierPO);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.paymentsupplierGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$account = account_example; // String | The supplier account number.
$chequeNumber = 56; // Integer | The number on the cheque related to a specified payment
$dateClosed = dateClosed_example; // String | The date in which a payment record was closed.
$invoiceNumber = invoiceNumber_example; // String | The invoice number related to a payment.
$paymentDate = paymentDate_example; // String | The date of a supplier payment
$paymentID = 56; // Integer | The primary key value of the payment record.
$purchaseID = 56; // Integer | The primary key value of the purchase record.
$receiptNumber = receiptNumber_example; // String | The receipt number of a payment.
$supplierID = 56; // Integer | The primary key value of the supplier record.
$supplierName = supplierName_example; // String | The name of the supplier.
$supplierPO = 56; // Integer | The supplier purchase order number.

try {
    $result = $api_instance->paymentsupplierGet($account, $chequeNumber, $dateClosed, $invoiceNumber, $paymentDate, $paymentID, $purchaseID, $receiptNumber, $supplierID, $supplierName, $supplierPO);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->paymentsupplierGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $account = account_example; # String | The supplier account number.
my $chequeNumber = 56; # Integer | The number on the cheque related to a specified payment
my $dateClosed = dateClosed_example; # String | The date in which a payment record was closed.
my $invoiceNumber = invoiceNumber_example; # String | The invoice number related to a payment.
my $paymentDate = paymentDate_example; # String | The date of a supplier payment
my $paymentID = 56; # Integer | The primary key value of the payment record.
my $purchaseID = 56; # Integer | The primary key value of the purchase record.
my $receiptNumber = receiptNumber_example; # String | The receipt number of a payment.
my $supplierID = 56; # Integer | The primary key value of the supplier record.
my $supplierName = supplierName_example; # String | The name of the supplier.
my $supplierPO = 56; # Integer | The supplier purchase order number.

eval { 
    my $result = $api_instance->paymentsupplierGet(account => $account, chequeNumber => $chequeNumber, dateClosed => $dateClosed, invoiceNumber => $invoiceNumber, paymentDate => $paymentDate, paymentID => $paymentID, purchaseID => $purchaseID, receiptNumber => $receiptNumber, supplierID => $supplierID, supplierName => $supplierName, supplierPO => $supplierPO);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->paymentsupplierGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
account = account_example # String | The supplier account number. (optional)
chequeNumber = 56 # Integer | The number on the cheque related to a specified payment (optional)
dateClosed = dateClosed_example # String | The date in which a payment record was closed. (optional)
invoiceNumber = invoiceNumber_example # String | The invoice number related to a payment. (optional)
paymentDate = paymentDate_example # String | The date of a supplier payment (optional)
paymentID = 56 # Integer | The primary key value of the payment record. (optional)
purchaseID = 56 # Integer | The primary key value of the purchase record. (optional)
receiptNumber = receiptNumber_example # String | The receipt number of a payment. (optional)
supplierID = 56 # Integer | The primary key value of the supplier record. (optional)
supplierName = supplierName_example # String | The name of the supplier. (optional)
supplierPO = 56 # Integer | The supplier purchase order number. (optional)

try: 
    # Returns supplier payment information.
    api_response = api_instance.paymentsupplier_get(account=account, chequeNumber=chequeNumber, dateClosed=dateClosed, invoiceNumber=invoiceNumber, paymentDate=paymentDate, paymentID=paymentID, purchaseID=purchaseID, receiptNumber=receiptNumber, supplierID=supplierID, supplierName=supplierName, supplierPO=supplierPO)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->paymentsupplierGet: %s\n" % e)

Parameters

Query parameters
Name Description
Account
String
The supplier account number.
ChequeNumber
Integer
The number on the cheque related to a specified payment
DateClosed
String
The date in which a payment record was closed.
InvoiceNumber
String
The invoice number related to a payment.
PaymentDate
String
The date of a supplier payment
PaymentID
Integer
The primary key value of the payment record.
PurchaseID
Integer
The primary key value of the purchase record.
ReceiptNumber
String
The receipt number of a payment.
SupplierID
Integer
The primary key value of the supplier record.
SupplierName
String
The name of the supplier.
SupplierPO
Integer
The supplier purchase order number.

Responses

Status: 200 - OK


pricelistGet

Return pricing of a specific item for a specific customer.

The Pricelistreturn pricing of a specific item for a specific customer.


/pricelist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/pricelist?BaseStockID=&CardIdentification=&CardsID=&ItemNumber=&LastName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | The primary key of the item master record.'
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer cardsID = 56; // Integer | The primary key of the card record
        String itemNumber = itemNumber_example; // String | The item number.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the Individual's last name.
        try {
            array[pricelistitem] result = apiInstance.pricelistGet(baseStockID, cardIdentification, cardsID, itemNumber, lastName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#pricelistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | The primary key of the item master record.'
        String cardIdentification = cardIdentification_example; // String | User defined unique card ID.
        Integer cardsID = 56; // Integer | The primary key of the card record
        String itemNumber = itemNumber_example; // String | The item number.
        String lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the Individual's last name.
        try {
            array[pricelistitem] result = apiInstance.pricelistGet(baseStockID, cardIdentification, cardsID, itemNumber, lastName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#pricelistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // The primary key of the item master record.' (optional)
String *cardIdentification = cardIdentification_example; // User defined unique card ID. (optional)
Integer *cardsID = 56; // The primary key of the card record (optional)
String *itemNumber = itemNumber_example; // The item number. (optional)
String *lastName = lastName_example; // The company name if the card record represents a company, otherwise the Individual's last name. (optional)

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

// Return pricing of a specific item for a specific customer.
[apiInstance pricelistGetWith:baseStockID
    cardIdentification:cardIdentification
    cardsID:cardsID
    itemNumber:itemNumber
    lastName:lastName
              completionHandler: ^(array[pricelistitem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} The primary key of the item master record.'
  'cardIdentification': cardIdentification_example, // {{String}} User defined unique card ID.
  'cardsID': 56, // {{Integer}} The primary key of the card record
  'itemNumber': itemNumber_example, // {{String}} The item number.
  'lastName': lastName_example // {{String}} The company name if the card record represents a company, otherwise the Individual's last name.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pricelistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pricelistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | The primary key of the item master record.' (optional) 
            var cardIdentification = cardIdentification_example;  // String | User defined unique card ID. (optional) 
            var cardsID = 56;  // Integer | The primary key of the card record (optional) 
            var itemNumber = itemNumber_example;  // String | The item number. (optional) 
            var lastName = lastName_example;  // String | The company name if the card record represents a company, otherwise the Individual's last name. (optional) 

            try
            {
                // Return pricing of a specific item for a specific customer.
                array[pricelistitem] result = apiInstance.pricelistGet(baseStockID, cardIdentification, cardsID, itemNumber, lastName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.pricelistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | The primary key of the item master record.'
$cardIdentification = cardIdentification_example; // String | User defined unique card ID.
$cardsID = 56; // Integer | The primary key of the card record
$itemNumber = itemNumber_example; // String | The item number.
$lastName = lastName_example; // String | The company name if the card record represents a company, otherwise the Individual's last name.

try {
    $result = $api_instance->pricelistGet($baseStockID, $cardIdentification, $cardsID, $itemNumber, $lastName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->pricelistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | The primary key of the item master record.'
my $cardIdentification = cardIdentification_example; # String | User defined unique card ID.
my $cardsID = 56; # Integer | The primary key of the card record
my $itemNumber = itemNumber_example; # String | The item number.
my $lastName = lastName_example; # String | The company name if the card record represents a company, otherwise the Individual's last name.

eval { 
    my $result = $api_instance->pricelistGet(baseStockID => $baseStockID, cardIdentification => $cardIdentification, cardsID => $cardsID, itemNumber => $itemNumber, lastName => $lastName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->pricelistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | The primary key of the item master record.' (optional)
cardIdentification = cardIdentification_example # String | User defined unique card ID. (optional)
cardsID = 56 # Integer | The primary key of the card record (optional)
itemNumber = itemNumber_example # String | The item number. (optional)
lastName = lastName_example # String | The company name if the card record represents a company, otherwise the Individual's last name. (optional)

try: 
    # Return pricing of a specific item for a specific customer.
    api_response = api_instance.pricelist_get(baseStockID=baseStockID, cardIdentification=cardIdentification, cardsID=cardsID, itemNumber=itemNumber, lastName=lastName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->pricelistGet: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
The primary key of the item master record.'
CardIdentification
String
User defined unique card ID.
CardsID
Integer
The primary key of the card record
ItemNumber
String
The item number.
LastName
String
The company name if the card record represents a company, otherwise the Individual's last name.

Responses

Status: 200 - OK


salelistGet

Returns a list of sales

The salelist returns list of sales.


/salelist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/salelist?EntryDate=&InvoiceNumber=&MYOBSalesID=&MYOBShipMethodID=&MYOBTermsID=&PromiseDate=&PurchaseOrder=&SRN=&SaleDate=&SalesID=&TypeID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String entryDate = entryDate_example; // String | An date of entry for a specified sale
        String invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
        Integer mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
        Integer mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
        Integer mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
        String promiseDate = promiseDate_example; // String | The promise date on the sale invoice
        String purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
        String sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
        String saleDate = saleDate_example; // String | The date the sale was filed for a customer.
        Integer salesID = 56; // Integer | The primary key value for a sale record.
        Integer typeID = 56; // Integer | The primary key value for a sale's type record.
        try {
            salelist result = apiInstance.salelistGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salelistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String entryDate = entryDate_example; // String | An date of entry for a specified sale
        String invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
        Integer mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
        Integer mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
        Integer mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
        String promiseDate = promiseDate_example; // String | The promise date on the sale invoice
        String purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
        String sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
        String saleDate = saleDate_example; // String | The date the sale was filed for a customer.
        Integer salesID = 56; // Integer | The primary key value for a sale record.
        Integer typeID = 56; // Integer | The primary key value for a sale's type record.
        try {
            salelist result = apiInstance.salelistGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salelistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *entryDate = entryDate_example; // An date of entry for a specified sale (optional)
String *invoiceNumber = invoiceNumber_example; // The sale invoice number. (optional)
Integer *mYOBSalesID = 56; // The primary key value for the MYOB sale record. (optional)
Integer *mYOBShipMethodID = 56; // the primary key value for the MYOB shipping method record. (optional)
Integer *mYOBTermsID = 56; // The primary key value for the MYOB sale terms record. (optional)
String *promiseDate = promiseDate_example; // The promise date on the sale invoice (optional)
String *purchaseOrder = purchaseOrder_example; // The purchase order number attached to a sale. (optional)
String *sRN = sRN_example; // The serial number of an item attached to a specific sale. (optional)
String *saleDate = saleDate_example; // The date the sale was filed for a customer. (optional)
Integer *salesID = 56; // The primary key value for a sale record. (optional)
Integer *typeID = 56; // The primary key value for a sale's type record. (optional)

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

// Returns a list of sales
[apiInstance salelistGetWith:entryDate
    invoiceNumber:invoiceNumber
    mYOBSalesID:mYOBSalesID
    mYOBShipMethodID:mYOBShipMethodID
    mYOBTermsID:mYOBTermsID
    promiseDate:promiseDate
    purchaseOrder:purchaseOrder
    sRN:sRN
    saleDate:saleDate
    salesID:salesID
    typeID:typeID
              completionHandler: ^(salelist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'entryDate': entryDate_example, // {{String}} An date of entry for a specified sale
  'invoiceNumber': invoiceNumber_example, // {{String}} The sale invoice number.
  'mYOBSalesID': 56, // {{Integer}} The primary key value for the MYOB sale record.
  'mYOBShipMethodID': 56, // {{Integer}} the primary key value for the MYOB shipping method record.
  'mYOBTermsID': 56, // {{Integer}} The primary key value for the MYOB sale terms record.
  'promiseDate': promiseDate_example, // {{String}} The promise date on the sale invoice
  'purchaseOrder': purchaseOrder_example, // {{String}} The purchase order number attached to a sale.
  'sRN': sRN_example, // {{String}} The serial number of an item attached to a specific sale.
  'saleDate': saleDate_example, // {{String}} The date the sale was filed for a customer.
  'salesID': 56, // {{Integer}} The primary key value for a sale record.
  'typeID': 56 // {{Integer}} The primary key value for a sale's type record.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.salelistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class salelistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var entryDate = entryDate_example;  // String | An date of entry for a specified sale (optional) 
            var invoiceNumber = invoiceNumber_example;  // String | The sale invoice number. (optional) 
            var mYOBSalesID = 56;  // Integer | The primary key value for the MYOB sale record. (optional) 
            var mYOBShipMethodID = 56;  // Integer | the primary key value for the MYOB shipping method record. (optional) 
            var mYOBTermsID = 56;  // Integer | The primary key value for the MYOB sale terms record. (optional) 
            var promiseDate = promiseDate_example;  // String | The promise date on the sale invoice (optional) 
            var purchaseOrder = purchaseOrder_example;  // String | The purchase order number attached to a sale. (optional) 
            var sRN = sRN_example;  // String | The serial number of an item attached to a specific sale. (optional) 
            var saleDate = saleDate_example;  // String | The date the sale was filed for a customer. (optional) 
            var salesID = 56;  // Integer | The primary key value for a sale record. (optional) 
            var typeID = 56;  // Integer | The primary key value for a sale's type record. (optional) 

            try
            {
                // Returns a list of sales
                salelist result = apiInstance.salelistGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.salelistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$entryDate = entryDate_example; // String | An date of entry for a specified sale
$invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
$mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
$mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
$mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
$promiseDate = promiseDate_example; // String | The promise date on the sale invoice
$purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
$sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
$saleDate = saleDate_example; // String | The date the sale was filed for a customer.
$salesID = 56; // Integer | The primary key value for a sale record.
$typeID = 56; // Integer | The primary key value for a sale's type record.

try {
    $result = $api_instance->salelistGet($entryDate, $invoiceNumber, $mYOBSalesID, $mYOBShipMethodID, $mYOBTermsID, $promiseDate, $purchaseOrder, $sRN, $saleDate, $salesID, $typeID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->salelistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $entryDate = entryDate_example; # String | An date of entry for a specified sale
my $invoiceNumber = invoiceNumber_example; # String | The sale invoice number.
my $mYOBSalesID = 56; # Integer | The primary key value for the MYOB sale record.
my $mYOBShipMethodID = 56; # Integer | the primary key value for the MYOB shipping method record.
my $mYOBTermsID = 56; # Integer | The primary key value for the MYOB sale terms record.
my $promiseDate = promiseDate_example; # String | The promise date on the sale invoice
my $purchaseOrder = purchaseOrder_example; # String | The purchase order number attached to a sale.
my $sRN = sRN_example; # String | The serial number of an item attached to a specific sale.
my $saleDate = saleDate_example; # String | The date the sale was filed for a customer.
my $salesID = 56; # Integer | The primary key value for a sale record.
my $typeID = 56; # Integer | The primary key value for a sale's type record.

eval { 
    my $result = $api_instance->salelistGet(entryDate => $entryDate, invoiceNumber => $invoiceNumber, mYOBSalesID => $mYOBSalesID, mYOBShipMethodID => $mYOBShipMethodID, mYOBTermsID => $mYOBTermsID, promiseDate => $promiseDate, purchaseOrder => $purchaseOrder, sRN => $sRN, saleDate => $saleDate, salesID => $salesID, typeID => $typeID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->salelistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
entryDate = entryDate_example # String | An date of entry for a specified sale (optional)
invoiceNumber = invoiceNumber_example # String | The sale invoice number. (optional)
mYOBSalesID = 56 # Integer | The primary key value for the MYOB sale record. (optional)
mYOBShipMethodID = 56 # Integer | the primary key value for the MYOB shipping method record. (optional)
mYOBTermsID = 56 # Integer | The primary key value for the MYOB sale terms record. (optional)
promiseDate = promiseDate_example # String | The promise date on the sale invoice (optional)
purchaseOrder = purchaseOrder_example # String | The purchase order number attached to a sale. (optional)
sRN = sRN_example # String | The serial number of an item attached to a specific sale. (optional)
saleDate = saleDate_example # String | The date the sale was filed for a customer. (optional)
salesID = 56 # Integer | The primary key value for a sale record. (optional)
typeID = 56 # Integer | The primary key value for a sale's type record. (optional)

try: 
    # Returns a list of sales
    api_response = api_instance.salelist_get(entryDate=entryDate, invoiceNumber=invoiceNumber, mYOBSalesID=mYOBSalesID, mYOBShipMethodID=mYOBShipMethodID, mYOBTermsID=mYOBTermsID, promiseDate=promiseDate, purchaseOrder=purchaseOrder, sRN=sRN, saleDate=saleDate, salesID=salesID, typeID=typeID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->salelistGet: %s\n" % e)

Parameters

Query parameters
Name Description
EntryDate
String
An date of entry for a specified sale
InvoiceNumber
String
The sale invoice number.
MYOBSalesID
Integer
The primary key value for the MYOB sale record.
MYOBShipMethodID
Integer
the primary key value for the MYOB shipping method record.
MYOBTermsID
Integer
The primary key value for the MYOB sale terms record.
PromiseDate
String
The promise date on the sale invoice
PurchaseOrder
String
The purchase order number attached to a sale.
SRN
String
The serial number of an item attached to a specific sale.
SaleDate
String
The date the sale was filed for a customer.
SalesID
Integer
The primary key value for a sale record.
TypeID
Integer
The primary key value for a sale's type record.

Responses

Status: 200 - OK


salesGet

Returns information about the specified sale.

The sales endpoint returns header sale order details with child sale line items. The primary key for sale orders is the INVOICE NUMBER and SRN together or saleid. Orders with the same SRN are related due to the backordering and split shipping of lines. Sale Returns can also be read using this endpoint and will usually have the same Invoice Number as the original Sale Invoice. The endpoint is used to obtain detailed information regarding customer sales orders and returns.


/sales

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/sales?EntryDate=&InvoiceNumber=&MYOBSalesID=&MYOBShipMethodID=&MYOBTermsID=&PromiseDate=&PurchaseOrder=&SRN=&SaleDate=&SalesID=&TypeID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String entryDate = entryDate_example; // String | An date of entry for a specified sale
        String invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
        Integer mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
        Integer mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
        Integer mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
        String promiseDate = promiseDate_example; // String | The promise date on the sale invoice
        String purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
        String sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
        String saleDate = saleDate_example; // String | The date the sale was filed for a customer.
        Integer salesID = 56; // Integer | The primary key value for a sale record.
        Integer typeID = 56; // Integer | The primary key value for a sale's type record.
        try {
            salesget result = apiInstance.salesGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String entryDate = entryDate_example; // String | An date of entry for a specified sale
        String invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
        Integer mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
        Integer mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
        Integer mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
        String promiseDate = promiseDate_example; // String | The promise date on the sale invoice
        String purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
        String sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
        String saleDate = saleDate_example; // String | The date the sale was filed for a customer.
        Integer salesID = 56; // Integer | The primary key value for a sale record.
        Integer typeID = 56; // Integer | The primary key value for a sale's type record.
        try {
            salesget result = apiInstance.salesGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *entryDate = entryDate_example; // An date of entry for a specified sale (optional)
String *invoiceNumber = invoiceNumber_example; // The sale invoice number. (optional)
Integer *mYOBSalesID = 56; // The primary key value for the MYOB sale record. (optional)
Integer *mYOBShipMethodID = 56; // the primary key value for the MYOB shipping method record. (optional)
Integer *mYOBTermsID = 56; // The primary key value for the MYOB sale terms record. (optional)
String *promiseDate = promiseDate_example; // The promise date on the sale invoice (optional)
String *purchaseOrder = purchaseOrder_example; // The purchase order number attached to a sale. (optional)
String *sRN = sRN_example; // The serial number of an item attached to a specific sale. (optional)
String *saleDate = saleDate_example; // The date the sale was filed for a customer. (optional)
Integer *salesID = 56; // The primary key value for a sale record. (optional)
Integer *typeID = 56; // The primary key value for a sale's type record. (optional)

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

// Returns information about the specified sale.
[apiInstance salesGetWith:entryDate
    invoiceNumber:invoiceNumber
    mYOBSalesID:mYOBSalesID
    mYOBShipMethodID:mYOBShipMethodID
    mYOBTermsID:mYOBTermsID
    promiseDate:promiseDate
    purchaseOrder:purchaseOrder
    sRN:sRN
    saleDate:saleDate
    salesID:salesID
    typeID:typeID
              completionHandler: ^(salesget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'entryDate': entryDate_example, // {{String}} An date of entry for a specified sale
  'invoiceNumber': invoiceNumber_example, // {{String}} The sale invoice number.
  'mYOBSalesID': 56, // {{Integer}} The primary key value for the MYOB sale record.
  'mYOBShipMethodID': 56, // {{Integer}} the primary key value for the MYOB shipping method record.
  'mYOBTermsID': 56, // {{Integer}} The primary key value for the MYOB sale terms record.
  'promiseDate': promiseDate_example, // {{String}} The promise date on the sale invoice
  'purchaseOrder': purchaseOrder_example, // {{String}} The purchase order number attached to a sale.
  'sRN': sRN_example, // {{String}} The serial number of an item attached to a specific sale.
  'saleDate': saleDate_example, // {{String}} The date the sale was filed for a customer.
  'salesID': 56, // {{Integer}} The primary key value for a sale record.
  'typeID': 56 // {{Integer}} The primary key value for a sale's type record.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.salesGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class salesGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var entryDate = entryDate_example;  // String | An date of entry for a specified sale (optional) 
            var invoiceNumber = invoiceNumber_example;  // String | The sale invoice number. (optional) 
            var mYOBSalesID = 56;  // Integer | The primary key value for the MYOB sale record. (optional) 
            var mYOBShipMethodID = 56;  // Integer | the primary key value for the MYOB shipping method record. (optional) 
            var mYOBTermsID = 56;  // Integer | The primary key value for the MYOB sale terms record. (optional) 
            var promiseDate = promiseDate_example;  // String | The promise date on the sale invoice (optional) 
            var purchaseOrder = purchaseOrder_example;  // String | The purchase order number attached to a sale. (optional) 
            var sRN = sRN_example;  // String | The serial number of an item attached to a specific sale. (optional) 
            var saleDate = saleDate_example;  // String | The date the sale was filed for a customer. (optional) 
            var salesID = 56;  // Integer | The primary key value for a sale record. (optional) 
            var typeID = 56;  // Integer | The primary key value for a sale's type record. (optional) 

            try
            {
                // Returns information about the specified sale.
                salesget result = apiInstance.salesGet(entryDate, invoiceNumber, mYOBSalesID, mYOBShipMethodID, mYOBTermsID, promiseDate, purchaseOrder, sRN, saleDate, salesID, typeID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.salesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$entryDate = entryDate_example; // String | An date of entry for a specified sale
$invoiceNumber = invoiceNumber_example; // String | The sale invoice number.
$mYOBSalesID = 56; // Integer | The primary key value for the MYOB sale record.
$mYOBShipMethodID = 56; // Integer | the primary key value for the MYOB shipping method record.
$mYOBTermsID = 56; // Integer | The primary key value for the MYOB sale terms record.
$promiseDate = promiseDate_example; // String | The promise date on the sale invoice
$purchaseOrder = purchaseOrder_example; // String | The purchase order number attached to a sale.
$sRN = sRN_example; // String | The serial number of an item attached to a specific sale.
$saleDate = saleDate_example; // String | The date the sale was filed for a customer.
$salesID = 56; // Integer | The primary key value for a sale record.
$typeID = 56; // Integer | The primary key value for a sale's type record.

try {
    $result = $api_instance->salesGet($entryDate, $invoiceNumber, $mYOBSalesID, $mYOBShipMethodID, $mYOBTermsID, $promiseDate, $purchaseOrder, $sRN, $saleDate, $salesID, $typeID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->salesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $entryDate = entryDate_example; # String | An date of entry for a specified sale
my $invoiceNumber = invoiceNumber_example; # String | The sale invoice number.
my $mYOBSalesID = 56; # Integer | The primary key value for the MYOB sale record.
my $mYOBShipMethodID = 56; # Integer | the primary key value for the MYOB shipping method record.
my $mYOBTermsID = 56; # Integer | The primary key value for the MYOB sale terms record.
my $promiseDate = promiseDate_example; # String | The promise date on the sale invoice
my $purchaseOrder = purchaseOrder_example; # String | The purchase order number attached to a sale.
my $sRN = sRN_example; # String | The serial number of an item attached to a specific sale.
my $saleDate = saleDate_example; # String | The date the sale was filed for a customer.
my $salesID = 56; # Integer | The primary key value for a sale record.
my $typeID = 56; # Integer | The primary key value for a sale's type record.

eval { 
    my $result = $api_instance->salesGet(entryDate => $entryDate, invoiceNumber => $invoiceNumber, mYOBSalesID => $mYOBSalesID, mYOBShipMethodID => $mYOBShipMethodID, mYOBTermsID => $mYOBTermsID, promiseDate => $promiseDate, purchaseOrder => $purchaseOrder, sRN => $sRN, saleDate => $saleDate, salesID => $salesID, typeID => $typeID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->salesGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
entryDate = entryDate_example # String | An date of entry for a specified sale (optional)
invoiceNumber = invoiceNumber_example # String | The sale invoice number. (optional)
mYOBSalesID = 56 # Integer | The primary key value for the MYOB sale record. (optional)
mYOBShipMethodID = 56 # Integer | the primary key value for the MYOB shipping method record. (optional)
mYOBTermsID = 56 # Integer | The primary key value for the MYOB sale terms record. (optional)
promiseDate = promiseDate_example # String | The promise date on the sale invoice (optional)
purchaseOrder = purchaseOrder_example # String | The purchase order number attached to a sale. (optional)
sRN = sRN_example # String | The serial number of an item attached to a specific sale. (optional)
saleDate = saleDate_example # String | The date the sale was filed for a customer. (optional)
salesID = 56 # Integer | The primary key value for a sale record. (optional)
typeID = 56 # Integer | The primary key value for a sale's type record. (optional)

try: 
    # Returns information about the specified sale.
    api_response = api_instance.sales_get(entryDate=entryDate, invoiceNumber=invoiceNumber, mYOBSalesID=mYOBSalesID, mYOBShipMethodID=mYOBShipMethodID, mYOBTermsID=mYOBTermsID, promiseDate=promiseDate, purchaseOrder=purchaseOrder, sRN=sRN, saleDate=saleDate, salesID=salesID, typeID=typeID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->salesGet: %s\n" % e)

Parameters

Query parameters
Name Description
EntryDate
String
An date of entry for a specified sale
InvoiceNumber
String
The sale invoice number.
MYOBSalesID
Integer
The primary key value for the MYOB sale record.
MYOBShipMethodID
Integer
the primary key value for the MYOB shipping method record.
MYOBTermsID
Integer
The primary key value for the MYOB sale terms record.
PromiseDate
String
The promise date on the sale invoice
PurchaseOrder
String
The purchase order number attached to a sale.
SRN
String
The serial number of an item attached to a specific sale.
SaleDate
String
The date the sale was filed for a customer.
SalesID
Integer
The primary key value for a sale record.
TypeID
Integer
The primary key value for a sale's type record.

Responses

Status: 200 - OK


salesqueueGet

Returns the current sale queue information.


/salesqueue

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/salesqueue?DELETE=&FLUSH=&FLUSH_WAIT=&UNLOCK=&WITHLOCK="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String dELETE = dELETE_example; // String | Delete the containing JSON queue files.
        String fLUSH = fLUSH_example; // String | Remove the lock.
        String fLUSHWAIT = fLUSHWAIT_example; // String | Wait.
        String uNLOCK = uNLOCK_example; // String | Unlock the folder
        String wITHLOCK = wITHLOCK_example; // String | Lock the folder.
        try {
            salesqueue result = apiInstance.salesqueueGet(dELETE, fLUSH, fLUSHWAIT, uNLOCK, wITHLOCK);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesqueueGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String dELETE = dELETE_example; // String | Delete the containing JSON queue files.
        String fLUSH = fLUSH_example; // String | Remove the lock.
        String fLUSHWAIT = fLUSHWAIT_example; // String | Wait.
        String uNLOCK = uNLOCK_example; // String | Unlock the folder
        String wITHLOCK = wITHLOCK_example; // String | Lock the folder.
        try {
            salesqueue result = apiInstance.salesqueueGet(dELETE, fLUSH, fLUSHWAIT, uNLOCK, wITHLOCK);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesqueueGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *dELETE = dELETE_example; // Delete the containing JSON queue files. (optional)
String *fLUSH = fLUSH_example; // Remove the lock. (optional)
String *fLUSHWAIT = fLUSHWAIT_example; // Wait. (optional)
String *uNLOCK = uNLOCK_example; // Unlock the folder (optional)
String *wITHLOCK = wITHLOCK_example; // Lock the folder. (optional)

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

// Returns the current sale queue information.
[apiInstance salesqueueGetWith:dELETE
    fLUSH:fLUSH
    fLUSHWAIT:fLUSHWAIT
    uNLOCK:uNLOCK
    wITHLOCK:wITHLOCK
              completionHandler: ^(salesqueue output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'dELETE': dELETE_example, // {{String}} Delete the containing JSON queue files.
  'fLUSH': fLUSH_example, // {{String}} Remove the lock.
  'fLUSHWAIT': fLUSHWAIT_example, // {{String}} Wait.
  'uNLOCK': uNLOCK_example, // {{String}} Unlock the folder
  'wITHLOCK': wITHLOCK_example // {{String}} Lock the folder.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.salesqueueGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class salesqueueGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var dELETE = dELETE_example;  // String | Delete the containing JSON queue files. (optional) 
            var fLUSH = fLUSH_example;  // String | Remove the lock. (optional) 
            var fLUSHWAIT = fLUSHWAIT_example;  // String | Wait. (optional) 
            var uNLOCK = uNLOCK_example;  // String | Unlock the folder (optional) 
            var wITHLOCK = wITHLOCK_example;  // String | Lock the folder. (optional) 

            try
            {
                // Returns the current sale queue information.
                salesqueue result = apiInstance.salesqueueGet(dELETE, fLUSH, fLUSHWAIT, uNLOCK, wITHLOCK);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.salesqueueGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$dELETE = dELETE_example; // String | Delete the containing JSON queue files.
$fLUSH = fLUSH_example; // String | Remove the lock.
$fLUSHWAIT = fLUSHWAIT_example; // String | Wait.
$uNLOCK = uNLOCK_example; // String | Unlock the folder
$wITHLOCK = wITHLOCK_example; // String | Lock the folder.

try {
    $result = $api_instance->salesqueueGet($dELETE, $fLUSH, $fLUSHWAIT, $uNLOCK, $wITHLOCK);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->salesqueueGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $dELETE = dELETE_example; # String | Delete the containing JSON queue files.
my $fLUSH = fLUSH_example; # String | Remove the lock.
my $fLUSHWAIT = fLUSHWAIT_example; # String | Wait.
my $uNLOCK = uNLOCK_example; # String | Unlock the folder
my $wITHLOCK = wITHLOCK_example; # String | Lock the folder.

eval { 
    my $result = $api_instance->salesqueueGet(dELETE => $dELETE, fLUSH => $fLUSH, fLUSHWAIT => $fLUSHWAIT, uNLOCK => $uNLOCK, wITHLOCK => $wITHLOCK);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->salesqueueGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
dELETE = dELETE_example # String | Delete the containing JSON queue files. (optional)
fLUSH = fLUSH_example # String | Remove the lock. (optional)
fLUSHWAIT = fLUSHWAIT_example # String | Wait. (optional)
uNLOCK = uNLOCK_example # String | Unlock the folder (optional)
wITHLOCK = wITHLOCK_example # String | Lock the folder. (optional)

try: 
    # Returns the current sale queue information.
    api_response = api_instance.salesqueue_get(dELETE=dELETE, fLUSH=fLUSH, fLUSHWAIT=fLUSHWAIT, uNLOCK=uNLOCK, wITHLOCK=wITHLOCK)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->salesqueueGet: %s\n" % e)

Parameters

Query parameters
Name Description
DELETE
String
Delete the containing JSON queue files.
FLUSH
String
Remove the lock.
FLUSH_WAIT
String
Wait.
UNLOCK
String
Unlock the folder
WITHLOCK
String
Lock the folder.

Responses

Status: 200 - OK


salesqueuecountGet

Returns a count of sale queue items.


/salesqueuecount

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/salesqueuecount"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        try {
            salesqueuecount result = apiInstance.salesqueuecountGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#salesqueuecountGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Returns a count of sale queue items.
[apiInstance salesqueuecountGetWithCompletionHandler: 
              ^(salesqueuecount output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class salesqueuecountGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();

            try
            {
                // Returns a count of sale queue items.
                salesqueuecount result = apiInstance.salesqueuecountGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.salesqueuecountGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->salesqueuecountGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->salesqueuecountGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->salesqueuecountGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->salesqueuecountGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Returns a count of sale queue items.
    api_response = api_instance.salesqueuecount_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->salesqueuecountGet: %s\n" % e)

Parameters

Responses

Status: 200 - OK


searchInventoryList

Returns current summary stock levels per basestockid.

The InventoryList endpoint is intended to enable queries on the item list returning current summary stock levels per basestockid. This endpoint will accept only ONE locationid parameter e.g. locationid = 5 or NO locationid which returns the total summary stock level for the entire inventory database.


/inventoryList

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/inventoryList?BaseStockID=&ItemNumber=&LocationID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer locationID = 56; // Integer | Pass by primary key of an items location.
        try {
            array[inventoryList] result = apiInstance.searchInventoryList(baseStockID, itemNumber, locationID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#searchInventoryList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        String itemNumber = itemNumber_example; // String | Pass by an item number.
        Integer locationID = 56; // Integer | Pass by primary key of an items location.
        try {
            array[inventoryList] result = apiInstance.searchInventoryList(baseStockID, itemNumber, locationID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#searchInventoryList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
String *itemNumber = itemNumber_example; // Pass by an item number. (optional)
Integer *locationID = 56; // Pass by primary key of an items location. (optional)

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

// Returns current summary stock levels per basestockid.
[apiInstance searchInventoryListWith:baseStockID
    itemNumber:itemNumber
    locationID:locationID
              completionHandler: ^(array[inventoryList] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'itemNumber': itemNumber_example, // {{String}} Pass by an item number.
  'locationID': 56 // {{Integer}} Pass by primary key of an items location.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchInventoryList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchInventoryListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var itemNumber = itemNumber_example;  // String | Pass by an item number. (optional) 
            var locationID = 56;  // Integer | Pass by primary key of an items location. (optional) 

            try
            {
                // Returns current summary stock levels per basestockid.
                array[inventoryList] result = apiInstance.searchInventoryList(baseStockID, itemNumber, locationID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.searchInventoryList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$itemNumber = itemNumber_example; // String | Pass by an item number.
$locationID = 56; // Integer | Pass by primary key of an items location.

try {
    $result = $api_instance->searchInventoryList($baseStockID, $itemNumber, $locationID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->searchInventoryList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $itemNumber = itemNumber_example; # String | Pass by an item number.
my $locationID = 56; # Integer | Pass by primary key of an items location.

eval { 
    my $result = $api_instance->searchInventoryList(baseStockID => $baseStockID, itemNumber => $itemNumber, locationID => $locationID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->searchInventoryList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
itemNumber = itemNumber_example # String | Pass by an item number. (optional)
locationID = 56 # Integer | Pass by primary key of an items location. (optional)

try: 
    # Returns current summary stock levels per basestockid.
    api_response = api_instance.search_inventory_list(baseStockID=baseStockID, itemNumber=itemNumber, locationID=locationID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->searchInventoryList: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
ItemNumber
String
Pass by an item number.
LocationID
Integer
Pass by primary key of an items location.

Responses

Status: 200 - OK


specialpricingGet

Returns information about the specified special price list.

The specialpricing endpoint is required to enable client applications to determine if any agreed or negotiated price RULES exist for a particular customer or customer group. This endpoint does not CALCULATE the price for the contact/item but returns the base rules that should be applied in order to determines a contacts pricing. If no results are returned then no rules apply - if an *ALL CUSTOMERS rule is active this will be returned for every GET Query.


/specialpricing

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/specialpricing?basestockid=&contactid=&isinactive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer basestockid = 56; // Integer | The primary key of the item master record.
        Integer contactid = 56; // Integer | The primary key of the stored contact record
        Boolean isinactive = true; // Boolean | is the list active.
        try {
            specialpricingget result = apiInstance.specialpricingGet(basestockid, contactid, isinactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#specialpricingGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer basestockid = 56; // Integer | The primary key of the item master record.
        Integer contactid = 56; // Integer | The primary key of the stored contact record
        Boolean isinactive = true; // Boolean | is the list active.
        try {
            specialpricingget result = apiInstance.specialpricingGet(basestockid, contactid, isinactive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#specialpricingGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *basestockid = 56; // The primary key of the item master record. (optional)
Integer *contactid = 56; // The primary key of the stored contact record (optional)
Boolean *isinactive = true; // is the list active. (optional)

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

// Returns information about the specified special price list.
[apiInstance specialpricingGetWith:basestockid
    contactid:contactid
    isinactive:isinactive
              completionHandler: ^(specialpricingget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'basestockid': 56, // {{Integer}} The primary key of the item master record.
  'contactid': 56, // {{Integer}} The primary key of the stored contact record
  'isinactive': true // {{Boolean}} is the list active.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.specialpricingGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class specialpricingGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var basestockid = 56;  // Integer | The primary key of the item master record. (optional) 
            var contactid = 56;  // Integer | The primary key of the stored contact record (optional) 
            var isinactive = true;  // Boolean | is the list active. (optional) 

            try
            {
                // Returns information about the specified special price list.
                specialpricingget result = apiInstance.specialpricingGet(basestockid, contactid, isinactive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.specialpricingGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$basestockid = 56; // Integer | The primary key of the item master record.
$contactid = 56; // Integer | The primary key of the stored contact record
$isinactive = true; // Boolean | is the list active.

try {
    $result = $api_instance->specialpricingGet($basestockid, $contactid, $isinactive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->specialpricingGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $basestockid = 56; # Integer | The primary key of the item master record.
my $contactid = 56; # Integer | The primary key of the stored contact record
my $isinactive = true; # Boolean | is the list active.

eval { 
    my $result = $api_instance->specialpricingGet(basestockid => $basestockid, contactid => $contactid, isinactive => $isinactive);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->specialpricingGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
basestockid = 56 # Integer | The primary key of the item master record. (optional)
contactid = 56 # Integer | The primary key of the stored contact record (optional)
isinactive = true # Boolean | is the list active. (optional)

try: 
    # Returns information about the specified special price list.
    api_response = api_instance.specialpricing_get(basestockid=basestockid, contactid=contactid, isinactive=isinactive)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->specialpricingGet: %s\n" % e)

Parameters

Query parameters
Name Description
basestockid
Integer
The primary key of the item master record.
contactid
Integer
The primary key of the stored contact record
isinactive
Boolean
is the list active.

Responses

Status: 200 - OK


statusGet

Returns order status information.

The status request returns information about the specified sale and transfers.


/status

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/status?PRN=&QID=&SalesID=&ShipReference=&TransfersID=&InvoiceNum=&OrderNum="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String pRN = pRN_example; // String | The payment reference number of a purchase.
        String qID = qID_example; // String | The transaction queue identification number.
        Integer salesID = 56; // Integer | The primary key value of a sale.
        String shipReference = shipReference_example; // String | A valid value is the valid ShipReference, that you used for the REST call.
        Integer transfersID = 56; // Integer | The primary key value for a transfer record.
        String invoiceNum = invoiceNum_example; // String | The sale invoice number.
        String orderNum = orderNum_example; // String | A valid value is the valid ordernum, that you used for the REST call.
        try {
            orderstatus result = apiInstance.statusGet(pRN, qID, salesID, shipReference, transfersID, invoiceNum, orderNum);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#statusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String pRN = pRN_example; // String | The payment reference number of a purchase.
        String qID = qID_example; // String | The transaction queue identification number.
        Integer salesID = 56; // Integer | The primary key value of a sale.
        String shipReference = shipReference_example; // String | A valid value is the valid ShipReference, that you used for the REST call.
        Integer transfersID = 56; // Integer | The primary key value for a transfer record.
        String invoiceNum = invoiceNum_example; // String | The sale invoice number.
        String orderNum = orderNum_example; // String | A valid value is the valid ordernum, that you used for the REST call.
        try {
            orderstatus result = apiInstance.statusGet(pRN, qID, salesID, shipReference, transfersID, invoiceNum, orderNum);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#statusGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *pRN = pRN_example; // The payment reference number of a purchase. (optional)
String *qID = qID_example; // The transaction queue identification number. (optional)
Integer *salesID = 56; // The primary key value of a sale. (optional)
String *shipReference = shipReference_example; // A valid value is the valid ShipReference, that you used for the REST call. (optional)
Integer *transfersID = 56; // The primary key value for a transfer record. (optional)
String *invoiceNum = invoiceNum_example; // The sale invoice number. (optional)
String *orderNum = orderNum_example; // A valid value is the valid ordernum, that you used for the REST call. (optional)

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

// Returns order status information.
[apiInstance statusGetWith:pRN
    qID:qID
    salesID:salesID
    shipReference:shipReference
    transfersID:transfersID
    invoiceNum:invoiceNum
    orderNum:orderNum
              completionHandler: ^(orderstatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'pRN': pRN_example, // {{String}} The payment reference number of a purchase.
  'qID': qID_example, // {{String}} The transaction queue identification number.
  'salesID': 56, // {{Integer}} The primary key value of a sale.
  'shipReference': shipReference_example, // {{String}} A valid value is the valid ShipReference, that you used for the REST call.
  'transfersID': 56, // {{Integer}} The primary key value for a transfer record.
  'invoiceNum': invoiceNum_example, // {{String}} The sale invoice number.
  'orderNum': orderNum_example // {{String}} A valid value is the valid ordernum, that you used for the REST call.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.statusGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class statusGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var pRN = pRN_example;  // String | The payment reference number of a purchase. (optional) 
            var qID = qID_example;  // String | The transaction queue identification number. (optional) 
            var salesID = 56;  // Integer | The primary key value of a sale. (optional) 
            var shipReference = shipReference_example;  // String | A valid value is the valid ShipReference, that you used for the REST call. (optional) 
            var transfersID = 56;  // Integer | The primary key value for a transfer record. (optional) 
            var invoiceNum = invoiceNum_example;  // String | The sale invoice number. (optional) 
            var orderNum = orderNum_example;  // String | A valid value is the valid ordernum, that you used for the REST call. (optional) 

            try
            {
                // Returns order status information.
                orderstatus result = apiInstance.statusGet(pRN, qID, salesID, shipReference, transfersID, invoiceNum, orderNum);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.statusGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$pRN = pRN_example; // String | The payment reference number of a purchase.
$qID = qID_example; // String | The transaction queue identification number.
$salesID = 56; // Integer | The primary key value of a sale.
$shipReference = shipReference_example; // String | A valid value is the valid ShipReference, that you used for the REST call.
$transfersID = 56; // Integer | The primary key value for a transfer record.
$invoiceNum = invoiceNum_example; // String | The sale invoice number.
$orderNum = orderNum_example; // String | A valid value is the valid ordernum, that you used for the REST call.

try {
    $result = $api_instance->statusGet($pRN, $qID, $salesID, $shipReference, $transfersID, $invoiceNum, $orderNum);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->statusGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $pRN = pRN_example; # String | The payment reference number of a purchase.
my $qID = qID_example; # String | The transaction queue identification number.
my $salesID = 56; # Integer | The primary key value of a sale.
my $shipReference = shipReference_example; # String | A valid value is the valid ShipReference, that you used for the REST call.
my $transfersID = 56; # Integer | The primary key value for a transfer record.
my $invoiceNum = invoiceNum_example; # String | The sale invoice number.
my $orderNum = orderNum_example; # String | A valid value is the valid ordernum, that you used for the REST call.

eval { 
    my $result = $api_instance->statusGet(pRN => $pRN, qID => $qID, salesID => $salesID, shipReference => $shipReference, transfersID => $transfersID, invoiceNum => $invoiceNum, orderNum => $orderNum);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->statusGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
pRN = pRN_example # String | The payment reference number of a purchase. (optional)
qID = qID_example # String | The transaction queue identification number. (optional)
salesID = 56 # Integer | The primary key value of a sale. (optional)
shipReference = shipReference_example # String | A valid value is the valid ShipReference, that you used for the REST call. (optional)
transfersID = 56 # Integer | The primary key value for a transfer record. (optional)
invoiceNum = invoiceNum_example # String | The sale invoice number. (optional)
orderNum = orderNum_example # String | A valid value is the valid ordernum, that you used for the REST call. (optional)

try: 
    # Returns order status information.
    api_response = api_instance.status_get(pRN=pRN, qID=qID, salesID=salesID, shipReference=shipReference, transfersID=transfersID, invoiceNum=invoiceNum, orderNum=orderNum)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->statusGet: %s\n" % e)

Parameters

Query parameters
Name Description
PRN
String
The payment reference number of a purchase.
QID
String
The transaction queue identification number.
SalesID
Integer
The primary key value of a sale.
ShipReference
String
A valid value is the valid ShipReference, that you used for the REST call.
TransfersID
Integer
The primary key value for a transfer record.
InvoiceNum
String
The sale invoice number.
OrderNum
String
A valid value is the valid ordernum, that you used for the REST call.

Responses

Status: 200 - OK


timestampGet

Returns time information about the specified server.

Returns information about the specified server.


/timestamp

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/timestamp"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        try {
            inline_response_200 result = apiInstance.timestampGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#timestampGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Returns time information about the specified server.
[apiInstance timestampGetWithCompletionHandler: 
              ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class timestampGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();

            try
            {
                // Returns time information about the specified server.
                inline_response_200 result = apiInstance.timestampGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.timestampGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->timestampGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->timestampGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->timestampGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->timestampGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Returns time information about the specified server.
    api_response = api_instance.timestamp_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->timestampGet: %s\n" % e)

Parameters

Responses

Status: 200 - OK


transferlistGet

Returns transfer list information

The Transferlist returns list of transfers.


/transferlist

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/transferlist?ContactName=&DstLocationID=&MyobShipMethodID=&Priority=&SrcLocationID=&StatusID=&TRN=&TransfersID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String contactName = contactName_example; // String | Contact name of the card attached to the transfer.
        Integer dstLocationID = 56; // Integer | the primary key value of the destination location.
        Integer myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
        Integer priority = 56; // Integer | Priority level
        Integer srcLocationID = 56; // Integer | The primary key value of the source location.
        Integer statusID = 56; // Integer | the primary key value of the status record.
        String tRN = tRN_example; // String | The transfer registration number.
        Integer transfersID = 56; // Integer | The primary key value of the transfer record/
        try {
            transferlist result = apiInstance.transferlistGet(contactName, dstLocationID, myobShipMethodID, priority, srcLocationID, statusID, tRN, transfersID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#transferlistGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String contactName = contactName_example; // String | Contact name of the card attached to the transfer.
        Integer dstLocationID = 56; // Integer | the primary key value of the destination location.
        Integer myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
        Integer priority = 56; // Integer | Priority level
        Integer srcLocationID = 56; // Integer | The primary key value of the source location.
        Integer statusID = 56; // Integer | the primary key value of the status record.
        String tRN = tRN_example; // String | The transfer registration number.
        Integer transfersID = 56; // Integer | The primary key value of the transfer record/
        try {
            transferlist result = apiInstance.transferlistGet(contactName, dstLocationID, myobShipMethodID, priority, srcLocationID, statusID, tRN, transfersID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#transferlistGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *contactName = contactName_example; // Contact name of the card attached to the transfer. (optional)
Integer *dstLocationID = 56; // the primary key value of the destination location. (optional)
Integer *myobShipMethodID = 56; // The primary key value of the MYOB ship method. (optional)
Integer *priority = 56; // Priority level (optional)
Integer *srcLocationID = 56; // The primary key value of the source location. (optional)
Integer *statusID = 56; // the primary key value of the status record. (optional)
String *tRN = tRN_example; // The transfer registration number. (optional)
Integer *transfersID = 56; // The primary key value of the transfer record/ (optional)

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

// Returns transfer list information
[apiInstance transferlistGetWith:contactName
    dstLocationID:dstLocationID
    myobShipMethodID:myobShipMethodID
    priority:priority
    srcLocationID:srcLocationID
    statusID:statusID
    tRN:tRN
    transfersID:transfersID
              completionHandler: ^(transferlist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'contactName': contactName_example, // {{String}} Contact name of the card attached to the transfer.
  'dstLocationID': 56, // {{Integer}} the primary key value of the destination location.
  'myobShipMethodID': 56, // {{Integer}} The primary key value of the MYOB ship method.
  'priority': 56, // {{Integer}} Priority level
  'srcLocationID': 56, // {{Integer}} The primary key value of the source location.
  'statusID': 56, // {{Integer}} the primary key value of the status record.
  'tRN': tRN_example, // {{String}} The transfer registration number.
  'transfersID': 56 // {{Integer}} The primary key value of the transfer record/
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transferlistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transferlistGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var contactName = contactName_example;  // String | Contact name of the card attached to the transfer. (optional) 
            var dstLocationID = 56;  // Integer | the primary key value of the destination location. (optional) 
            var myobShipMethodID = 56;  // Integer | The primary key value of the MYOB ship method. (optional) 
            var priority = 56;  // Integer | Priority level (optional) 
            var srcLocationID = 56;  // Integer | The primary key value of the source location. (optional) 
            var statusID = 56;  // Integer | the primary key value of the status record. (optional) 
            var tRN = tRN_example;  // String | The transfer registration number. (optional) 
            var transfersID = 56;  // Integer | The primary key value of the transfer record/ (optional) 

            try
            {
                // Returns transfer list information
                transferlist result = apiInstance.transferlistGet(contactName, dstLocationID, myobShipMethodID, priority, srcLocationID, statusID, tRN, transfersID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.transferlistGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$contactName = contactName_example; // String | Contact name of the card attached to the transfer.
$dstLocationID = 56; // Integer | the primary key value of the destination location.
$myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
$priority = 56; // Integer | Priority level
$srcLocationID = 56; // Integer | The primary key value of the source location.
$statusID = 56; // Integer | the primary key value of the status record.
$tRN = tRN_example; // String | The transfer registration number.
$transfersID = 56; // Integer | The primary key value of the transfer record/

try {
    $result = $api_instance->transferlistGet($contactName, $dstLocationID, $myobShipMethodID, $priority, $srcLocationID, $statusID, $tRN, $transfersID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->transferlistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $contactName = contactName_example; # String | Contact name of the card attached to the transfer.
my $dstLocationID = 56; # Integer | the primary key value of the destination location.
my $myobShipMethodID = 56; # Integer | The primary key value of the MYOB ship method.
my $priority = 56; # Integer | Priority level
my $srcLocationID = 56; # Integer | The primary key value of the source location.
my $statusID = 56; # Integer | the primary key value of the status record.
my $tRN = tRN_example; # String | The transfer registration number.
my $transfersID = 56; # Integer | The primary key value of the transfer record/

eval { 
    my $result = $api_instance->transferlistGet(contactName => $contactName, dstLocationID => $dstLocationID, myobShipMethodID => $myobShipMethodID, priority => $priority, srcLocationID => $srcLocationID, statusID => $statusID, tRN => $tRN, transfersID => $transfersID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->transferlistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
contactName = contactName_example # String | Contact name of the card attached to the transfer. (optional)
dstLocationID = 56 # Integer | the primary key value of the destination location. (optional)
myobShipMethodID = 56 # Integer | The primary key value of the MYOB ship method. (optional)
priority = 56 # Integer | Priority level (optional)
srcLocationID = 56 # Integer | The primary key value of the source location. (optional)
statusID = 56 # Integer | the primary key value of the status record. (optional)
tRN = tRN_example # String | The transfer registration number. (optional)
transfersID = 56 # Integer | The primary key value of the transfer record/ (optional)

try: 
    # Returns transfer list information
    api_response = api_instance.transferlist_get(contactName=contactName, dstLocationID=dstLocationID, myobShipMethodID=myobShipMethodID, priority=priority, srcLocationID=srcLocationID, statusID=statusID, tRN=tRN, transfersID=transfersID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->transferlistGet: %s\n" % e)

Parameters

Query parameters
Name Description
ContactName
String
Contact name of the card attached to the transfer.
DstLocationID
Integer
the primary key value of the destination location.
MyobShipMethodID
Integer
The primary key value of the MYOB ship method.
Priority
Integer
Priority level
SrcLocationID
Integer
The primary key value of the source location.
StatusID
Integer
the primary key value of the status record.
TRN
String
The transfer registration number.
TransfersID
Integer
The primary key value of the transfer record/

Responses

Status: 200 - OK


transfersGet

Returns information about the specified transfers.

The transfers request returns information about the specified transfer.


/transfers

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/transfers?ContactName=&CreateDate=&DstLocationID=&MyobShipMethodID=&Priority=&RecordDate=&SrcLocationID=&StatusID=&TRN=&TransfersID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        String contactName = contactName_example; // String | Contact name of the card attached to the transfer.
        String createDate = createDate_example; // String | Create date of the transfer entry.
        Integer dstLocationID = 56; // Integer | the primary key value of the destination location.
        Integer myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
        Integer priority = 56; // Integer | Priority level
        Integer recordDate = 56; // Integer | The date a transfer entry was recorded.
        Integer srcLocationID = 56; // Integer | The primary key value of the source location.
        Integer statusID = 56; // Integer | the primary key value of the status record.
        String tRN = tRN_example; // String | The transfer registration number.
        Integer transfersID = 56; // Integer | The primary key value of the transfer record/
        try {
            transfer result = apiInstance.transfersGet(contactName, createDate, dstLocationID, myobShipMethodID, priority, recordDate, srcLocationID, statusID, tRN, transfersID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#transfersGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        String contactName = contactName_example; // String | Contact name of the card attached to the transfer.
        String createDate = createDate_example; // String | Create date of the transfer entry.
        Integer dstLocationID = 56; // Integer | the primary key value of the destination location.
        Integer myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
        Integer priority = 56; // Integer | Priority level
        Integer recordDate = 56; // Integer | The date a transfer entry was recorded.
        Integer srcLocationID = 56; // Integer | The primary key value of the source location.
        Integer statusID = 56; // Integer | the primary key value of the status record.
        String tRN = tRN_example; // String | The transfer registration number.
        Integer transfersID = 56; // Integer | The primary key value of the transfer record/
        try {
            transfer result = apiInstance.transfersGet(contactName, createDate, dstLocationID, myobShipMethodID, priority, recordDate, srcLocationID, statusID, tRN, transfersID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#transfersGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *contactName = contactName_example; // Contact name of the card attached to the transfer. (optional)
String *createDate = createDate_example; // Create date of the transfer entry. (optional)
Integer *dstLocationID = 56; // the primary key value of the destination location. (optional)
Integer *myobShipMethodID = 56; // The primary key value of the MYOB ship method. (optional)
Integer *priority = 56; // Priority level (optional)
Integer *recordDate = 56; // The date a transfer entry was recorded. (optional)
Integer *srcLocationID = 56; // The primary key value of the source location. (optional)
Integer *statusID = 56; // the primary key value of the status record. (optional)
String *tRN = tRN_example; // The transfer registration number. (optional)
Integer *transfersID = 56; // The primary key value of the transfer record/ (optional)

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

// Returns information about the specified transfers.
[apiInstance transfersGetWith:contactName
    createDate:createDate
    dstLocationID:dstLocationID
    myobShipMethodID:myobShipMethodID
    priority:priority
    recordDate:recordDate
    srcLocationID:srcLocationID
    statusID:statusID
    tRN:tRN
    transfersID:transfersID
              completionHandler: ^(transfer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'contactName': contactName_example, // {{String}} Contact name of the card attached to the transfer.
  'createDate': createDate_example, // {{String}} Create date of the transfer entry.
  'dstLocationID': 56, // {{Integer}} the primary key value of the destination location.
  'myobShipMethodID': 56, // {{Integer}} The primary key value of the MYOB ship method.
  'priority': 56, // {{Integer}} Priority level
  'recordDate': 56, // {{Integer}} The date a transfer entry was recorded.
  'srcLocationID': 56, // {{Integer}} The primary key value of the source location.
  'statusID': 56, // {{Integer}} the primary key value of the status record.
  'tRN': tRN_example, // {{String}} The transfer registration number.
  'transfersID': 56 // {{Integer}} The primary key value of the transfer record/
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transfersGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transfersGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var contactName = contactName_example;  // String | Contact name of the card attached to the transfer. (optional) 
            var createDate = createDate_example;  // String | Create date of the transfer entry. (optional) 
            var dstLocationID = 56;  // Integer | the primary key value of the destination location. (optional) 
            var myobShipMethodID = 56;  // Integer | The primary key value of the MYOB ship method. (optional) 
            var priority = 56;  // Integer | Priority level (optional) 
            var recordDate = 56;  // Integer | The date a transfer entry was recorded. (optional) 
            var srcLocationID = 56;  // Integer | The primary key value of the source location. (optional) 
            var statusID = 56;  // Integer | the primary key value of the status record. (optional) 
            var tRN = tRN_example;  // String | The transfer registration number. (optional) 
            var transfersID = 56;  // Integer | The primary key value of the transfer record/ (optional) 

            try
            {
                // Returns information about the specified transfers.
                transfer result = apiInstance.transfersGet(contactName, createDate, dstLocationID, myobShipMethodID, priority, recordDate, srcLocationID, statusID, tRN, transfersID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.transfersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$contactName = contactName_example; // String | Contact name of the card attached to the transfer.
$createDate = createDate_example; // String | Create date of the transfer entry.
$dstLocationID = 56; // Integer | the primary key value of the destination location.
$myobShipMethodID = 56; // Integer | The primary key value of the MYOB ship method.
$priority = 56; // Integer | Priority level
$recordDate = 56; // Integer | The date a transfer entry was recorded.
$srcLocationID = 56; // Integer | The primary key value of the source location.
$statusID = 56; // Integer | the primary key value of the status record.
$tRN = tRN_example; // String | The transfer registration number.
$transfersID = 56; // Integer | The primary key value of the transfer record/

try {
    $result = $api_instance->transfersGet($contactName, $createDate, $dstLocationID, $myobShipMethodID, $priority, $recordDate, $srcLocationID, $statusID, $tRN, $transfersID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->transfersGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $contactName = contactName_example; # String | Contact name of the card attached to the transfer.
my $createDate = createDate_example; # String | Create date of the transfer entry.
my $dstLocationID = 56; # Integer | the primary key value of the destination location.
my $myobShipMethodID = 56; # Integer | The primary key value of the MYOB ship method.
my $priority = 56; # Integer | Priority level
my $recordDate = 56; # Integer | The date a transfer entry was recorded.
my $srcLocationID = 56; # Integer | The primary key value of the source location.
my $statusID = 56; # Integer | the primary key value of the status record.
my $tRN = tRN_example; # String | The transfer registration number.
my $transfersID = 56; # Integer | The primary key value of the transfer record/

eval { 
    my $result = $api_instance->transfersGet(contactName => $contactName, createDate => $createDate, dstLocationID => $dstLocationID, myobShipMethodID => $myobShipMethodID, priority => $priority, recordDate => $recordDate, srcLocationID => $srcLocationID, statusID => $statusID, tRN => $tRN, transfersID => $transfersID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->transfersGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
contactName = contactName_example # String | Contact name of the card attached to the transfer. (optional)
createDate = createDate_example # String | Create date of the transfer entry. (optional)
dstLocationID = 56 # Integer | the primary key value of the destination location. (optional)
myobShipMethodID = 56 # Integer | The primary key value of the MYOB ship method. (optional)
priority = 56 # Integer | Priority level (optional)
recordDate = 56 # Integer | The date a transfer entry was recorded. (optional)
srcLocationID = 56 # Integer | The primary key value of the source location. (optional)
statusID = 56 # Integer | the primary key value of the status record. (optional)
tRN = tRN_example # String | The transfer registration number. (optional)
transfersID = 56 # Integer | The primary key value of the transfer record/ (optional)

try: 
    # Returns information about the specified transfers.
    api_response = api_instance.transfers_get(contactName=contactName, createDate=createDate, dstLocationID=dstLocationID, myobShipMethodID=myobShipMethodID, priority=priority, recordDate=recordDate, srcLocationID=srcLocationID, statusID=statusID, tRN=tRN, transfersID=transfersID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->transfersGet: %s\n" % e)

Parameters

Query parameters
Name Description
ContactName
String
Contact name of the card attached to the transfer.
CreateDate
String
Create date of the transfer entry.
DstLocationID
Integer
the primary key value of the destination location.
MyobShipMethodID
Integer
The primary key value of the MYOB ship method.
Priority
Integer
Priority level
RecordDate
Integer
The date a transfer entry was recorded.
SrcLocationID
Integer
The primary key value of the source location.
StatusID
Integer
the primary key value of the status record.
TRN
String
The transfer registration number.
TransfersID
Integer
The primary key value of the transfer record/

Responses

Status: 200 - OK


xudfsGet

Returns user defined information about an item.


/xudfs

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/xudfs?BaseStockID=&ID=&isWebProduct=&TypeID1=&TypeID2=&TypeID3=&TypeID4=&TypeID5=&TypeID6=&TypeID7=&TypeID8=&UDFX1=&UDFX2=&UDFX3=&UDFX4=&UDFX5=&UDFX6=&UDFX7=&UDFX8="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;

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

public class GETOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        Integer iD = 56; // Integer | User defined identifier.
        Boolean isWebProduct = true; // Boolean | If true, the item is a web product
        Integer typeID1 = 56; // Integer | Customer type ID 1.
        Integer typeID2 = 56; // Integer | Customer type ID 2.
        Integer typeID3 = 56; // Integer | Customer type ID 3.
        Integer typeID4 = 56; // Integer | Customer type ID 4.
        Integer typeID5 = 56; // Integer | Customer type ID 5.
        Integer typeID6 = 56; // Integer | Customer type ID 6.
        Integer typeID7 = 56; // Integer | Customer type ID 7.
        Integer typeID8 = 56; // Integer | Customer type ID 8.
        String uDFX1 = uDFX1_example; // String | User Defined Field 1.
        String uDFX2 = uDFX2_example; // String | User Defined Field 2.
        String uDFX3 = uDFX3_example; // String | User Defined Field 3.
        String uDFX4 = uDFX4_example; // String | User Defined Field 4.
        String uDFX5 = uDFX5_example; // String | User Defined Field 5.
        String uDFX6 = uDFX6_example; // String | User Defined Field 6.
        String uDFX7 = uDFX7_example; // String | User Defined Field 7.
        String uDFX8 = uDFX8_example; // String | User Defined Field 8.
        try {
            xudf result = apiInstance.xudfsGet(baseStockID, iD, isWebProduct, typeID1, typeID2, typeID3, typeID4, typeID5, typeID6, typeID7, typeID8, uDFX1, uDFX2, uDFX3, uDFX4, uDFX5, uDFX6, uDFX7, uDFX8);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#xudfsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GETOperationsApi;

public class GETOperationsApiExample {

    public static void main(String[] args) {
        GETOperationsApi apiInstance = new GETOperationsApi();
        Integer baseStockID = 56; // Integer | Pass a primary key of an item master record.
        Integer iD = 56; // Integer | User defined identifier.
        Boolean isWebProduct = true; // Boolean | If true, the item is a web product
        Integer typeID1 = 56; // Integer | Customer type ID 1.
        Integer typeID2 = 56; // Integer | Customer type ID 2.
        Integer typeID3 = 56; // Integer | Customer type ID 3.
        Integer typeID4 = 56; // Integer | Customer type ID 4.
        Integer typeID5 = 56; // Integer | Customer type ID 5.
        Integer typeID6 = 56; // Integer | Customer type ID 6.
        Integer typeID7 = 56; // Integer | Customer type ID 7.
        Integer typeID8 = 56; // Integer | Customer type ID 8.
        String uDFX1 = uDFX1_example; // String | User Defined Field 1.
        String uDFX2 = uDFX2_example; // String | User Defined Field 2.
        String uDFX3 = uDFX3_example; // String | User Defined Field 3.
        String uDFX4 = uDFX4_example; // String | User Defined Field 4.
        String uDFX5 = uDFX5_example; // String | User Defined Field 5.
        String uDFX6 = uDFX6_example; // String | User Defined Field 6.
        String uDFX7 = uDFX7_example; // String | User Defined Field 7.
        String uDFX8 = uDFX8_example; // String | User Defined Field 8.
        try {
            xudf result = apiInstance.xudfsGet(baseStockID, iD, isWebProduct, typeID1, typeID2, typeID3, typeID4, typeID5, typeID6, typeID7, typeID8, uDFX1, uDFX2, uDFX3, uDFX4, uDFX5, uDFX6, uDFX7, uDFX8);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GETOperationsApi#xudfsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *baseStockID = 56; // Pass a primary key of an item master record. (optional)
Integer *iD = 56; // User defined identifier. (optional)
Boolean *isWebProduct = true; // If true, the item is a web product (optional)
Integer *typeID1 = 56; // Customer type ID 1. (optional)
Integer *typeID2 = 56; // Customer type ID 2. (optional)
Integer *typeID3 = 56; // Customer type ID 3. (optional)
Integer *typeID4 = 56; // Customer type ID 4. (optional)
Integer *typeID5 = 56; // Customer type ID 5. (optional)
Integer *typeID6 = 56; // Customer type ID 6. (optional)
Integer *typeID7 = 56; // Customer type ID 7. (optional)
Integer *typeID8 = 56; // Customer type ID 8. (optional)
String *uDFX1 = uDFX1_example; // User Defined Field 1. (optional)
String *uDFX2 = uDFX2_example; // User Defined Field 2. (optional)
String *uDFX3 = uDFX3_example; // User Defined Field 3. (optional)
String *uDFX4 = uDFX4_example; // User Defined Field 4. (optional)
String *uDFX5 = uDFX5_example; // User Defined Field 5. (optional)
String *uDFX6 = uDFX6_example; // User Defined Field 6. (optional)
String *uDFX7 = uDFX7_example; // User Defined Field 7. (optional)
String *uDFX8 = uDFX8_example; // User Defined Field 8. (optional)

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

// Returns user defined information about an item.
[apiInstance xudfsGetWith:baseStockID
    iD:iD
    isWebProduct:isWebProduct
    typeID1:typeID1
    typeID2:typeID2
    typeID3:typeID3
    typeID4:typeID4
    typeID5:typeID5
    typeID6:typeID6
    typeID7:typeID7
    typeID8:typeID8
    uDFX1:uDFX1
    uDFX2:uDFX2
    uDFX3:uDFX3
    uDFX4:uDFX4
    uDFX5:uDFX5
    uDFX6:uDFX6
    uDFX7:uDFX7
    uDFX8:uDFX8
              completionHandler: ^(xudf output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = { 
  'baseStockID': 56, // {{Integer}} Pass a primary key of an item master record.
  'iD': 56, // {{Integer}} User defined identifier.
  'isWebProduct': true, // {{Boolean}} If true, the item is a web product
  'typeID1': 56, // {{Integer}} Customer type ID 1.
  'typeID2': 56, // {{Integer}} Customer type ID 2.
  'typeID3': 56, // {{Integer}} Customer type ID 3.
  'typeID4': 56, // {{Integer}} Customer type ID 4.
  'typeID5': 56, // {{Integer}} Customer type ID 5.
  'typeID6': 56, // {{Integer}} Customer type ID 6.
  'typeID7': 56, // {{Integer}} Customer type ID 7.
  'typeID8': 56, // {{Integer}} Customer type ID 8.
  'uDFX1': uDFX1_example, // {{String}} User Defined Field 1.
  'uDFX2': uDFX2_example, // {{String}} User Defined Field 2.
  'uDFX3': uDFX3_example, // {{String}} User Defined Field 3.
  'uDFX4': uDFX4_example, // {{String}} User Defined Field 4.
  'uDFX5': uDFX5_example, // {{String}} User Defined Field 5.
  'uDFX6': uDFX6_example, // {{String}} User Defined Field 6.
  'uDFX7': uDFX7_example, // {{String}} User Defined Field 7.
  'uDFX8': uDFX8_example // {{String}} User Defined Field 8.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.xudfsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class xudfsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GETOperationsApi();
            var baseStockID = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var iD = 56;  // Integer | User defined identifier. (optional) 
            var isWebProduct = true;  // Boolean | If true, the item is a web product (optional) 
            var typeID1 = 56;  // Integer | Customer type ID 1. (optional) 
            var typeID2 = 56;  // Integer | Customer type ID 2. (optional) 
            var typeID3 = 56;  // Integer | Customer type ID 3. (optional) 
            var typeID4 = 56;  // Integer | Customer type ID 4. (optional) 
            var typeID5 = 56;  // Integer | Customer type ID 5. (optional) 
            var typeID6 = 56;  // Integer | Customer type ID 6. (optional) 
            var typeID7 = 56;  // Integer | Customer type ID 7. (optional) 
            var typeID8 = 56;  // Integer | Customer type ID 8. (optional) 
            var uDFX1 = uDFX1_example;  // String | User Defined Field 1. (optional) 
            var uDFX2 = uDFX2_example;  // String | User Defined Field 2. (optional) 
            var uDFX3 = uDFX3_example;  // String | User Defined Field 3. (optional) 
            var uDFX4 = uDFX4_example;  // String | User Defined Field 4. (optional) 
            var uDFX5 = uDFX5_example;  // String | User Defined Field 5. (optional) 
            var uDFX6 = uDFX6_example;  // String | User Defined Field 6. (optional) 
            var uDFX7 = uDFX7_example;  // String | User Defined Field 7. (optional) 
            var uDFX8 = uDFX8_example;  // String | User Defined Field 8. (optional) 

            try
            {
                // Returns user defined information about an item.
                xudf result = apiInstance.xudfsGet(baseStockID, iD, isWebProduct, typeID1, typeID2, typeID3, typeID4, typeID5, typeID6, typeID7, typeID8, uDFX1, uDFX2, uDFX3, uDFX4, uDFX5, uDFX6, uDFX7, uDFX8);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GETOperationsApi.xudfsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiGETOperationsApi();
$baseStockID = 56; // Integer | Pass a primary key of an item master record.
$iD = 56; // Integer | User defined identifier.
$isWebProduct = true; // Boolean | If true, the item is a web product
$typeID1 = 56; // Integer | Customer type ID 1.
$typeID2 = 56; // Integer | Customer type ID 2.
$typeID3 = 56; // Integer | Customer type ID 3.
$typeID4 = 56; // Integer | Customer type ID 4.
$typeID5 = 56; // Integer | Customer type ID 5.
$typeID6 = 56; // Integer | Customer type ID 6.
$typeID7 = 56; // Integer | Customer type ID 7.
$typeID8 = 56; // Integer | Customer type ID 8.
$uDFX1 = uDFX1_example; // String | User Defined Field 1.
$uDFX2 = uDFX2_example; // String | User Defined Field 2.
$uDFX3 = uDFX3_example; // String | User Defined Field 3.
$uDFX4 = uDFX4_example; // String | User Defined Field 4.
$uDFX5 = uDFX5_example; // String | User Defined Field 5.
$uDFX6 = uDFX6_example; // String | User Defined Field 6.
$uDFX7 = uDFX7_example; // String | User Defined Field 7.
$uDFX8 = uDFX8_example; // String | User Defined Field 8.

try {
    $result = $api_instance->xudfsGet($baseStockID, $iD, $isWebProduct, $typeID1, $typeID2, $typeID3, $typeID4, $typeID5, $typeID6, $typeID7, $typeID8, $uDFX1, $uDFX2, $uDFX3, $uDFX4, $uDFX5, $uDFX6, $uDFX7, $uDFX8);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GETOperationsApi->xudfsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $baseStockID = 56; # Integer | Pass a primary key of an item master record.
my $iD = 56; # Integer | User defined identifier.
my $isWebProduct = true; # Boolean | If true, the item is a web product
my $typeID1 = 56; # Integer | Customer type ID 1.
my $typeID2 = 56; # Integer | Customer type ID 2.
my $typeID3 = 56; # Integer | Customer type ID 3.
my $typeID4 = 56; # Integer | Customer type ID 4.
my $typeID5 = 56; # Integer | Customer type ID 5.
my $typeID6 = 56; # Integer | Customer type ID 6.
my $typeID7 = 56; # Integer | Customer type ID 7.
my $typeID8 = 56; # Integer | Customer type ID 8.
my $uDFX1 = uDFX1_example; # String | User Defined Field 1.
my $uDFX2 = uDFX2_example; # String | User Defined Field 2.
my $uDFX3 = uDFX3_example; # String | User Defined Field 3.
my $uDFX4 = uDFX4_example; # String | User Defined Field 4.
my $uDFX5 = uDFX5_example; # String | User Defined Field 5.
my $uDFX6 = uDFX6_example; # String | User Defined Field 6.
my $uDFX7 = uDFX7_example; # String | User Defined Field 7.
my $uDFX8 = uDFX8_example; # String | User Defined Field 8.

eval { 
    my $result = $api_instance->xudfsGet(baseStockID => $baseStockID, iD => $iD, isWebProduct => $isWebProduct, typeID1 => $typeID1, typeID2 => $typeID2, typeID3 => $typeID3, typeID4 => $typeID4, typeID5 => $typeID5, typeID6 => $typeID6, typeID7 => $typeID7, typeID8 => $typeID8, uDFX1 => $uDFX1, uDFX2 => $uDFX2, uDFX3 => $uDFX3, uDFX4 => $uDFX4, uDFX5 => $uDFX5, uDFX6 => $uDFX6, uDFX7 => $uDFX7, uDFX8 => $uDFX8);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GETOperationsApi->xudfsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
baseStockID = 56 # Integer | Pass a primary key of an item master record. (optional)
iD = 56 # Integer | User defined identifier. (optional)
isWebProduct = true # Boolean | If true, the item is a web product (optional)
typeID1 = 56 # Integer | Customer type ID 1. (optional)
typeID2 = 56 # Integer | Customer type ID 2. (optional)
typeID3 = 56 # Integer | Customer type ID 3. (optional)
typeID4 = 56 # Integer | Customer type ID 4. (optional)
typeID5 = 56 # Integer | Customer type ID 5. (optional)
typeID6 = 56 # Integer | Customer type ID 6. (optional)
typeID7 = 56 # Integer | Customer type ID 7. (optional)
typeID8 = 56 # Integer | Customer type ID 8. (optional)
uDFX1 = uDFX1_example # String | User Defined Field 1. (optional)
uDFX2 = uDFX2_example # String | User Defined Field 2. (optional)
uDFX3 = uDFX3_example # String | User Defined Field 3. (optional)
uDFX4 = uDFX4_example # String | User Defined Field 4. (optional)
uDFX5 = uDFX5_example # String | User Defined Field 5. (optional)
uDFX6 = uDFX6_example # String | User Defined Field 6. (optional)
uDFX7 = uDFX7_example # String | User Defined Field 7. (optional)
uDFX8 = uDFX8_example # String | User Defined Field 8. (optional)

try: 
    # Returns user defined information about an item.
    api_response = api_instance.xudfs_get(baseStockID=baseStockID, iD=iD, isWebProduct=isWebProduct, typeID1=typeID1, typeID2=typeID2, typeID3=typeID3, typeID4=typeID4, typeID5=typeID5, typeID6=typeID6, typeID7=typeID7, typeID8=typeID8, uDFX1=uDFX1, uDFX2=uDFX2, uDFX3=uDFX3, uDFX4=uDFX4, uDFX5=uDFX5, uDFX6=uDFX6, uDFX7=uDFX7, uDFX8=uDFX8)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GETOperationsApi->xudfsGet: %s\n" % e)

Parameters

Query parameters
Name Description
BaseStockID
Integer
Pass a primary key of an item master record.
ID
Integer
User defined identifier.
isWebProduct
Boolean
If true, the item is a web product
TypeID1
Integer
Customer type ID 1.
TypeID2
Integer
Customer type ID 2.
TypeID3
Integer
Customer type ID 3.
TypeID4
Integer
Customer type ID 4.
TypeID5
Integer
Customer type ID 5.
TypeID6
Integer
Customer type ID 6.
TypeID7
Integer
Customer type ID 7.
TypeID8
Integer
Customer type ID 8.
UDFX1
String
User Defined Field 1.
UDFX2
String
User Defined Field 2.
UDFX3
String
User Defined Field 3.
UDFX4
String
User Defined Field 4.
UDFX5
String
User Defined Field 5.
UDFX6
String
User Defined Field 6.
UDFX7
String
User Defined Field 7.
UDFX8
String
User Defined Field 8.

Responses

Status: 200 - OK


POSTOperations

addItem

Adds an item.

Adds an item to the system.


/items

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/items"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        POSTOperationsApi apiInstance = new POSTOperationsApi();
        ItemsPost body = ; // ItemsPost | Inventory item to add
        try {
            apiInstance.addItem(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#addItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSTOperationsApi;

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        ItemsPost body = ; // ItemsPost | Inventory item to add
        try {
            apiInstance.addItem(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#addItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
ItemsPost *body = ; // Inventory item to add (optional)

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

// Adds an item.
[apiInstance addItemWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.POSTOperationsApi()

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

namespace Example
{
    public class addItemExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();
            var body = new ItemsPost(); // ItemsPost | Inventory item to add (optional) 

            try
            {
                // Adds an item.
                apiInstance.addItem(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.addItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiPOSTOperationsApi();
$body = ; // ItemsPost | Inventory item to add

try {
    $api_instance->addItem($body);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->addItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::POSTOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ItemsPost->new(); # ItemsPost | Inventory item to add

eval { 
    $api_instance->addItem(body => $body);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->addItem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.POSTOperationsApi()
body =  # ItemsPost | Inventory item to add (optional)

try: 
    # Adds an item.
    api_instance.add_item(body=body)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->addItem: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - item created


billofmaterialsPost

Post order in XML and JSON format


/billofmaterials

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/billofmaterials"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        try {
            billofmaterialspost result = apiInstance.billofmaterialsPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#billofmaterialsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Post order in XML and JSON format
[apiInstance billofmaterialsPostWithCompletionHandler: 
              ^(billofmaterialspost output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class billofmaterialsPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();

            try
            {
                // Post order in XML and JSON format
                billofmaterialspost result = apiInstance.billofmaterialsPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.billofmaterialsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->billofmaterialsPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->billofmaterialsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->billofmaterialsPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->billofmaterialsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Post order in XML and JSON format
    api_response = api_instance.billofmaterials_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->billofmaterialsPost: %s\n" % e)

Parameters

Responses

Status: 200 - OK


contactsPost

Post contacts in XML and JSON format.


/contacts

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/contacts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        try {
            contactspost result = apiInstance.contactsPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#contactsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Post contacts in XML and JSON format.
[apiInstance contactsPostWithCompletionHandler: 
              ^(contactspost output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class contactsPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();

            try
            {
                // Post contacts in XML and JSON format.
                contactspost result = apiInstance.contactsPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.contactsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->contactsPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->contactsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->contactsPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->contactsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Post contacts in XML and JSON format.
    api_response = api_instance.contacts_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->contactsPost: %s\n" % e)

Parameters

Responses

Status: 200 - OK


customerpaymentsPost

Post payment details

Post customer payment details in XML and JSON format


/customerpayments

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/customerpayments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        try {
            customerpaymentspost result = apiInstance.customerpaymentsPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#customerpaymentsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Post payment details
[apiInstance customerpaymentsPostWithCompletionHandler: 
              ^(customerpaymentspost output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class customerpaymentsPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();

            try
            {
                // Post payment details
                customerpaymentspost result = apiInstance.customerpaymentsPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.customerpaymentsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->customerpaymentsPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->customerpaymentsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->customerpaymentsPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->customerpaymentsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Post payment details
    api_response = api_instance.customerpayments_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->customerpaymentsPost: %s\n" % e)

Parameters

Responses

Status: 200 - OK


itemFeaturePost

Post items in XML and JSON format.


/itemFeature

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/itemFeature"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        POSTOperationsApi apiInstance = new POSTOperationsApi();
        Body body = ; // Body | 
        try {
            apiInstance.itemFeaturePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#itemFeaturePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSTOperationsApi;

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        Body body = ; // Body | 
        try {
            apiInstance.itemFeaturePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#itemFeaturePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Body *body = ; //  (optional)

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

// Post items in XML and JSON format.
[apiInstance itemFeaturePostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.POSTOperationsApi()

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

namespace Example
{
    public class itemFeaturePostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();
            var body = new Body(); // Body |  (optional) 

            try
            {
                // Post items in XML and JSON format.
                apiInstance.itemFeaturePost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.itemFeaturePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiPOSTOperationsApi();
$body = ; // Body | 

try {
    $api_instance->itemFeaturePost($body);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->itemFeaturePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::POSTOperationsApi->new();
my $body = WWW::SwaggerClient::Object::Body->new(); # Body | 

eval { 
    $api_instance->itemFeaturePost(body => $body);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->itemFeaturePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.POSTOperationsApi()
body =  # Body |  (optional)

try: 
    # Post items in XML and JSON format.
    api_instance.item_feature_post(body=body)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->itemFeaturePost: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Item feature created.


paymentsupplierPost

Post payment information to the server


/paymentsupplier

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/paymentsupplier"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        try {
            paymentsupplierpost result = apiInstance.paymentsupplierPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#paymentsupplierPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Post payment information to the server
[apiInstance paymentsupplierPostWithCompletionHandler: 
              ^(paymentsupplierpost output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class paymentsupplierPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();

            try
            {
                // Post payment information to the server
                paymentsupplierpost result = apiInstance.paymentsupplierPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.paymentsupplierPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->paymentsupplierPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->paymentsupplierPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->paymentsupplierPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->paymentsupplierPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Post payment information to the server
    api_response = api_instance.paymentsupplier_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->paymentsupplierPost: %s\n" % e)

Parameters

Responses

Status: 200 - OK


pickstockPost

Post order pick information in JSON or XML format

The pick stock request posts information about the specified picked order.


/pickstock

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/pickstock"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        try {
            orderpick result = apiInstance.pickstockPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#pickstockPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Post order pick information in JSON or XML format
[apiInstance pickstockPostWithCompletionHandler: 
              ^(orderpick output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class pickstockPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();

            try
            {
                // Post order pick information in JSON or XML format
                orderpick result = apiInstance.pickstockPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.pickstockPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->pickstockPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->pickstockPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->pickstockPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->pickstockPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Post order pick information in JSON or XML format
    api_response = api_instance.pickstock_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->pickstockPost: %s\n" % e)

Parameters

Responses

Status: 200 - OK


purchaseorderPost

Posts purchase data to the server.


/purchaseorder

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/purchaseorder"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        try {
            purchaseorder result = apiInstance.purchaseorderPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#purchaseorderPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Posts purchase data to the server.
[apiInstance purchaseorderPostWithCompletionHandler: 
              ^(purchaseorder output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class purchaseorderPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();

            try
            {
                // Posts purchase data to the server.
                purchaseorder result = apiInstance.purchaseorderPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.purchaseorderPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->purchaseorderPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->purchaseorderPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->purchaseorderPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->purchaseorderPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Posts purchase data to the server.
    api_response = api_instance.purchaseorder_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->purchaseorderPost: %s\n" % e)

Parameters

Responses

Status: 200 - OK


salesPost

Post an order in JSON format.


/sales

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/sales"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        try {
            salespost result = apiInstance.salesPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#salesPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Post an order in JSON format.
[apiInstance salesPostWithCompletionHandler: 
              ^(salespost output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class salesPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();

            try
            {
                // Post an order in JSON format.
                salespost result = apiInstance.salesPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.salesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->salesPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->salesPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->salesPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->salesPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Post an order in JSON format.
    api_response = api_instance.sales_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->salesPost: %s\n" % e)

Parameters

Responses

Status: 200 - OK


salesqueuePost

Post sale queue data to the queue in JSON format.


/salesqueue

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/salesqueue"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        try {
            salespost result = apiInstance.salesqueuePost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#salesqueuePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Post sale queue data to the queue in JSON format.
[apiInstance salesqueuePostWithCompletionHandler: 
              ^(salespost output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class salesqueuePostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();

            try
            {
                // Post sale queue data to the queue in JSON format.
                salespost result = apiInstance.salesqueuePost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.salesqueuePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->salesqueuePost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->salesqueuePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->salesqueuePost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->salesqueuePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Post sale queue data to the queue in JSON format.
    api_response = api_instance.salesqueue_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->salesqueuePost: %s\n" % e)

Parameters

Responses

Status: 200 - OK


specialpricingPost

Post a special price list in XML and JSON format


/specialpricing

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/specialpricing"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        try {
            specialpricingpost result = apiInstance.specialpricingPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#specialpricingPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Post a special price list in XML and JSON format
[apiInstance specialpricingPostWithCompletionHandler: 
              ^(specialpricingpost output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class specialpricingPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();

            try
            {
                // Post a special price list in XML and JSON format
                specialpricingpost result = apiInstance.specialpricingPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.specialpricingPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->specialpricingPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->specialpricingPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->specialpricingPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->specialpricingPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Post a special price list in XML and JSON format
    api_response = api_instance.specialpricing_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->specialpricingPost: %s\n" % e)

Parameters

Responses

Status: 200 - OK


transactionsPost

Post a transaction in JSON format

The transaction create a transaction of following types. <br><br> - CheckIn (CI/CIP) <br> - CheckOut (CO/COP,TO/TOP) <br> - Adjustments (AO)


/transactions

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/transactions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        try {
            transaction result = apiInstance.transactionsPost();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#transactionsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

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

// Post a transaction in JSON format
[apiInstance transactionsPostWithCompletionHandler: 
              ^(transaction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

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

namespace Example
{
    public class transactionsPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();

            try
            {
                // Post a transaction in JSON format
                transaction result = apiInstance.transactionsPost();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.transactionsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

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

try {
    $result = $api_instance->transactionsPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->transactionsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

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

eval { 
    my $result = $api_instance->transactionsPost();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->transactionsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

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

try: 
    # Post a transaction in JSON format
    api_response = api_instance.transactions_post()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->transactionsPost: %s\n" % e)

Parameters

Responses

Status: 200 - OK


xudfsPost

Post items in XML and JSON format.


/xudfs

Usage and SDK Samples

curl -X POST -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/JSON/xudfs?basestockid=&UDFX1=&UDFX2=&UDFX3=&UDFX4=&UDFX5=&UDFX6=&UDFX7=&UDFX8="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.POSTOperationsApi;

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

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        POSTOperationsApi apiInstance = new POSTOperationsApi();
        Body_1 body = ; // Body_1 | 
        Integer basestockid = 56; // Integer | Pass a primary key of an item master record.
        String uDFX1 = uDFX1_example; // String | User Defined Field 1.
        String uDFX2 = uDFX2_example; // String | User Defined Field 2.
        String uDFX3 = uDFX3_example; // String | User Defined Field 3.
        String uDFX4 = uDFX4_example; // String | User Defined Field 4.
        String uDFX5 = uDFX5_example; // String | User Defined Field 5.
        String uDFX6 = uDFX6_example; // String | User Defined Field 6.
        String uDFX7 = uDFX7_example; // String | User Defined Field 7.
        String uDFX8 = uDFX8_example; // String | User Defined Field 8.
        try {
            apiInstance.xudfsPost(body, basestockid, uDFX1, uDFX2, uDFX3, uDFX4, uDFX5, uDFX6, uDFX7, uDFX8);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#xudfsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.POSTOperationsApi;

public class POSTOperationsApiExample {

    public static void main(String[] args) {
        POSTOperationsApi apiInstance = new POSTOperationsApi();
        Body_1 body = ; // Body_1 | 
        Integer basestockid = 56; // Integer | Pass a primary key of an item master record.
        String uDFX1 = uDFX1_example; // String | User Defined Field 1.
        String uDFX2 = uDFX2_example; // String | User Defined Field 2.
        String uDFX3 = uDFX3_example; // String | User Defined Field 3.
        String uDFX4 = uDFX4_example; // String | User Defined Field 4.
        String uDFX5 = uDFX5_example; // String | User Defined Field 5.
        String uDFX6 = uDFX6_example; // String | User Defined Field 6.
        String uDFX7 = uDFX7_example; // String | User Defined Field 7.
        String uDFX8 = uDFX8_example; // String | User Defined Field 8.
        try {
            apiInstance.xudfsPost(body, basestockid, uDFX1, uDFX2, uDFX3, uDFX4, uDFX5, uDFX6, uDFX7, uDFX8);
        } catch (ApiException e) {
            System.err.println("Exception when calling POSTOperationsApi#xudfsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Body_1 *body = ; //  (optional)
Integer *basestockid = 56; // Pass a primary key of an item master record. (optional)
String *uDFX1 = uDFX1_example; // User Defined Field 1. (optional)
String *uDFX2 = uDFX2_example; // User Defined Field 2. (optional)
String *uDFX3 = uDFX3_example; // User Defined Field 3. (optional)
String *uDFX4 = uDFX4_example; // User Defined Field 4. (optional)
String *uDFX5 = uDFX5_example; // User Defined Field 5. (optional)
String *uDFX6 = uDFX6_example; // User Defined Field 6. (optional)
String *uDFX7 = uDFX7_example; // User Defined Field 7. (optional)
String *uDFX8 = uDFX8_example; // User Defined Field 8. (optional)

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

// Post items in XML and JSON format.
[apiInstance xudfsPostWith:body
    basestockid:basestockid
    uDFX1:uDFX1
    uDFX2:uDFX2
    uDFX3:uDFX3
    uDFX4:uDFX4
    uDFX5:uDFX5
    uDFX6:uDFX6
    uDFX7:uDFX7
    uDFX8:uDFX8
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new ApiDocsHowItWorks.POSTOperationsApi()
var opts = { 
  'body':  // {{Body_1}} 
  'basestockid': 56 // {{Integer}} Pass a primary key of an item master record.
  'uDFX1': uDFX1_example // {{String}} User Defined Field 1.
  'uDFX2': uDFX2_example // {{String}} User Defined Field 2.
  'uDFX3': uDFX3_example // {{String}} User Defined Field 3.
  'uDFX4': uDFX4_example // {{String}} User Defined Field 4.
  'uDFX5': uDFX5_example // {{String}} User Defined Field 5.
  'uDFX6': uDFX6_example // {{String}} User Defined Field 6.
  'uDFX7': uDFX7_example // {{String}} User Defined Field 7.
  'uDFX8': uDFX8_example // {{String}} User Defined Field 8.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.xudfsPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class xudfsPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new POSTOperationsApi();
            var body = new Body_1(); // Body_1 |  (optional) 
            var basestockid = 56;  // Integer | Pass a primary key of an item master record. (optional) 
            var uDFX1 = uDFX1_example;  // String | User Defined Field 1. (optional) 
            var uDFX2 = uDFX2_example;  // String | User Defined Field 2. (optional) 
            var uDFX3 = uDFX3_example;  // String | User Defined Field 3. (optional) 
            var uDFX4 = uDFX4_example;  // String | User Defined Field 4. (optional) 
            var uDFX5 = uDFX5_example;  // String | User Defined Field 5. (optional) 
            var uDFX6 = uDFX6_example;  // String | User Defined Field 6. (optional) 
            var uDFX7 = uDFX7_example;  // String | User Defined Field 7. (optional) 
            var uDFX8 = uDFX8_example;  // String | User Defined Field 8. (optional) 

            try
            {
                // Post items in XML and JSON format.
                apiInstance.xudfsPost(body, basestockid, uDFX1, uDFX2, uDFX3, uDFX4, uDFX5, uDFX6, uDFX7, uDFX8);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling POSTOperationsApi.xudfsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiPOSTOperationsApi();
$body = ; // Body_1 | 
$basestockid = 56; // Integer | Pass a primary key of an item master record.
$uDFX1 = uDFX1_example; // String | User Defined Field 1.
$uDFX2 = uDFX2_example; // String | User Defined Field 2.
$uDFX3 = uDFX3_example; // String | User Defined Field 3.
$uDFX4 = uDFX4_example; // String | User Defined Field 4.
$uDFX5 = uDFX5_example; // String | User Defined Field 5.
$uDFX6 = uDFX6_example; // String | User Defined Field 6.
$uDFX7 = uDFX7_example; // String | User Defined Field 7.
$uDFX8 = uDFX8_example; // String | User Defined Field 8.

try {
    $api_instance->xudfsPost($body, $basestockid, $uDFX1, $uDFX2, $uDFX3, $uDFX4, $uDFX5, $uDFX6, $uDFX7, $uDFX8);
} catch (Exception $e) {
    echo 'Exception when calling POSTOperationsApi->xudfsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::POSTOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::POSTOperationsApi->new();
my $body = WWW::SwaggerClient::Object::Body_1->new(); # Body_1 | 
my $basestockid = 56; # Integer | Pass a primary key of an item master record.
my $uDFX1 = uDFX1_example; # String | User Defined Field 1.
my $uDFX2 = uDFX2_example; # String | User Defined Field 2.
my $uDFX3 = uDFX3_example; # String | User Defined Field 3.
my $uDFX4 = uDFX4_example; # String | User Defined Field 4.
my $uDFX5 = uDFX5_example; # String | User Defined Field 5.
my $uDFX6 = uDFX6_example; # String | User Defined Field 6.
my $uDFX7 = uDFX7_example; # String | User Defined Field 7.
my $uDFX8 = uDFX8_example; # String | User Defined Field 8.

eval { 
    $api_instance->xudfsPost(body => $body, basestockid => $basestockid, uDFX1 => $uDFX1, uDFX2 => $uDFX2, uDFX3 => $uDFX3, uDFX4 => $uDFX4, uDFX5 => $uDFX5, uDFX6 => $uDFX6, uDFX7 => $uDFX7, uDFX8 => $uDFX8);
};
if ($@) {
    warn "Exception when calling POSTOperationsApi->xudfsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.POSTOperationsApi()
body =  # Body_1 |  (optional)
basestockid = 56 # Integer | Pass a primary key of an item master record. (optional)
uDFX1 = uDFX1_example # String | User Defined Field 1. (optional)
uDFX2 = uDFX2_example # String | User Defined Field 2. (optional)
uDFX3 = uDFX3_example # String | User Defined Field 3. (optional)
uDFX4 = uDFX4_example # String | User Defined Field 4. (optional)
uDFX5 = uDFX5_example # String | User Defined Field 5. (optional)
uDFX6 = uDFX6_example # String | User Defined Field 6. (optional)
uDFX7 = uDFX7_example # String | User Defined Field 7. (optional)
uDFX8 = uDFX8_example # String | User Defined Field 8. (optional)

try: 
    # Post items in XML and JSON format.
    api_instance.xudfs_post(body=body, basestockid=basestockid, uDFX1=uDFX1, uDFX2=uDFX2, uDFX3=uDFX3, uDFX4=uDFX4, uDFX5=uDFX5, uDFX6=uDFX6, uDFX7=uDFX7, uDFX8=uDFX8)
except ApiException as e:
    print("Exception when calling POSTOperationsApi->xudfsPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
basestockid
Integer
Pass a primary key of an item master record.
UDFX1
String
User Defined Field 1.
UDFX2
String
User Defined Field 2.
UDFX3
String
User Defined Field 3.
UDFX4
String
User Defined Field 4.
UDFX5
String
User Defined Field 5.
UDFX6
String
User Defined Field 6.
UDFX7
String
User Defined Field 7.
UDFX8
String
User Defined Field 8.

Responses

Status: 200 - Item feature created.


Sample Code

C# SDK with sample application

For the latest version of the Datapel Software Developer Kit (SDK) please visit GitHub.

https://github.com/breezeapi/ccBreezeSDK

This repository provides all the necessary c# libraries to place GET and POST requests to either local or cloud API installations.

PHP code example

The following code snippet demonstrates how to authenticate with the Breeze DataServer and obtain an authorisation token. Using the token a GET Query is made to inquire on the server timestamp and item code.

<?php
 
       function get_data($userName, $userPassword, $filter, $process, $verbetype, $updatetype, $requesttype) {
            //encapsulate the credentials into a base64 string
            $authString = base64_encode($userName . ":" . $userPassword);
            $ch = curl_init();
            if($requesttype=="Post")
            {
                  // POST REQUEST
                  if($verbetype=="xml")
                  {
                        $filter=str_replace("<"," &lt;",$filter);
                        $filter=str_replace(">"," &gt;",$filter);
                        $dataToPost="<?xml version=\"1.0\" encoding=\"utf-16\"?><PostRequest xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"><updatetype>".$updatetype."</updatetype><filter>".$filter."</filter></PostRequest>";
                  }
                  else
                  {
                        $filter=str_replace('"','\"',$filter);
                        $dataToPost="{\"".updatetype."\":\"Insert\",\"filter\":\"".$filter."\"}";
                  }
                  curl_setopt($ch, CURLOPT_POST, 1);
                  curl_setopt($ch, CURLOPT_POSTFIELDS, $dataToPost);
                  $datapelUrl = "http://salesin.datapel.net/".$verbetype."/" . $process . "?filter~";        
            }
            else
            {
                  // GET REQUEST
                  $dataToPost= "";
                  $datapelUrl = "http://salesin.datapel.net/".$verbetype."/".$process."?filter~".urlencode($filter);
            }
            //init header array
            $header = array();
            //$header[] = 'Content-length:'.strlen($dataToPost);
            $header[] = 'Content-type: application/json';
            $header[] = 'Authorization: '.$authString;


            echo $datapelUrl;
            echo nl2br("\n");
            echo nl2br("\n");    
            //init curl api and send request - return data

            $timeout = 5;

            curl_setopt($ch, CURLOPT_URL, $datapelUrl);
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
            curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
            curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
            $data = curl_exec($ch);
            curl_close($ch);
            return $data;
       }

        // request server timestamp
        echo get_data("developer", "passw0rd",  "", "timestamp", "json", "Query", "GET");
        echo nl2br("\n");

        // request itemlist element by itemnumber match
        echo get_data("developer", "passw0rd", "itemnumber='\c'", "items", "json", "Query", "GET");
        echo nl2br("\n");

?>

JavaScript code example

The following code snippet demonstrates how to authenticate with the Breeze DataServer and obtain an authorisation token. Using the token a GET Query is made to inquire on the server timestamp and item code.


/*!
 * Datapel apiConnect Library v1.2.0 (http://api.datapel.net)
 * Copyright 2011-2016 Datapel Systems Pty Ltd.
 * Licensed under MIT
 */

if (typeof jQuery === 'undefined') { throw new Error('Datapel API Connection JavaScript requires jQuery') }

/* ========================================================================
 * apiConnect: apiConnect.js v1.2.0
 * http://api.datapel.net/samplecode
 * ========================================================================
 * Copyright 2011-2016 Datapel Systems Pty Ltd.
 *
 * Example Usage:
 * ========================================================================
 * apiConnect.username = "username";
 * apiConnect.password = "password";
 * apiConnect.url = "http://url:port";
 * 
 * ======================================================================== */

var apiConnect = new function () {
    // Define Connection Properties
    this.masterKey = "";
    this.username = "";
    this.password = "";
    this.url = "";
    this.token = "";
    this.recordCount = 0;
    this.pageCount = 0;
    this.pageNumber = 0;
    this.pageSize = 0;
    this.pageStartTime = 0;
    this.pageEndTime = 0;
    this.pagePrimaryKeyName = "";
    this.pageTableName = "";
    this.pageQueryFilter = "";
    this.pageColumns = "";
    this.pageTag = "";
    this.pageElapseTime = 0;
    this.pageResultSet = [];
    this.requestResultSet = [];
    this.requestEstimatedTime = 0;
    this.onPageComplete = function(){};
    this.onPageException = function(){};
    this.onRequestReady = function(){};
    this.onRequestComplete = function(){};    
    this.localscope = {};

    // ========================================================================
    // openService();
    //
    this.openService = function (callback) {
        // allow cross domain access
        $.support.cors = true;
        // Initialise the token
        this.token = "";
        // Encode authorisation credentials
        this.masterKey = this.encode64(this.username + ':' + this.password);
        // Request API session token
        console.log(this.masterKey);                                  
        // trigger the caller
                           
   
    };
    // ========================================================================
    // getRequest()
    //    
    this.getRequest = function (apiResource, apiFilter, callback) {
        var urlResponse;
        // form the request based on the resource
        var urlRequest = this.url + "/json/" + apiResource + "?filter~" + encodeURI(apiFilter);
        // append security credentials
        urlRequest = urlRequest + '&authorization=' + this.masterKey 
        // pass request to server
        console.log("requesting: " + urlRequest);
        // allow cross domain by default
        $.support.cors = true;
        // Make request
        $.ajax({
            // pass the resource request
            url: urlRequest,
            type: 'GET',
            crossDomain: true,
            async: true,
            success: function(result) {
                // completed request
                callback(result);
            },
            error: function() {
                //failed result                
                callback(false);
            }
        });
    };    
    // ========================================================================
    // getTimeStamp()
    //    
    this.getTimeStamp = function (callback) {
        var urlResponse;
        // form the request based on the resource
        var urlRequest = this.url + "/json/timestamp?filter~";
        // append security credentials
        urlRequest = urlRequest + '&authorization=' + this.masterKey 
        // pass request to server
        console.log("requesting: " + urlRequest);        
        // allow cross domain by default
        $.support.cors = true;
        // Make request
        $.ajax({
            // pass the resource request
            url: urlRequest,
            type: 'GET',
            crossDomain: true,
            async: true,
            success: function(result) {
                // check response is valid
                if(result!=null && result !=undefined) {
                    //successful result
                    callback(result.ServerTimeStamp);                    
                } else {
                    //invalid result
                    callback(false);                    
                }            
            },
            error: function() {
                //failed result        
                callback(false);                
            }
        });
    };
    // ========================================================================
    // getDataSetPage()
    //    
    this.getDataSetPage = function (tableName, tableColumns, tableFilter, tablePkey, pageSize, pageNumber) {
        var queryString = "";
        try {
            // All Rows or filtered dataSet
            if (!tableFilter.trim()) {
            // is empty or whitespace
                tableFilter = "1=1";
            }
            // All Columns or subSet
            if (!tableColumns.trim()) {
            // is empty or whitespace
                tableColumns = "*";
            }
            // create the page query with filter
            queryString = "SELECT " + tableColumns + " FROM " + tableName + " WHERE " + tableFilter + " AND " + tablePkey + " IN ";
            queryString = queryString + "(SELECT TOP " + pageSize + " " + tablePkey + " FROM " + tableName + " WHERE " + tableFilter + " AND " + tablePkey + " NOT IN ";
            queryString = queryString + "(SELECT TOP " + pageSize*(pageNumber-1) + " " + tablePkey + " FROM " + tableName + " WHERE " + tableFilter + " ORDER BY " + tablePkey + ")";
            queryString = queryString + " ORDER BY " + tablePkey + ")" + " ORDER BY " + tablePkey;
            // echo the query for debug
            console.log("Page Query:" + queryString);
            //debugger;            

        } catch (ex) {
          alert("getDataset: Failed!");
          console.log("Error:" + ex.message);
          queryString = "";          
        }
        // Return the page query
        return(queryString);
    };

    // ========================================================================
    // getPagedRequest()
    //    
    this.getPagedRequest = function (tableFilter, onPageComplete, onPageException, onRequestReady, onRequestComplete) {
        // New QueryString
        var queryRequest = "";
        var self = this;        
        // Initialise context
        self.pageQueryFilter = tableFilter;
        // Initialise Event callbacks
        self.onPageComplete = onPageComplete;
        self.onPageException = onPageException;
        self.onRequestReady = onRequestReady;
        self.onRequestComplete = onRequestComplete;
        self.pageResultSet = [];
        self.requestResultSet = [];
        // Determine the number of records in the dataSet
        setTimeout(function() {
            // From Table get RecordCount
            queryRequest = "SELECT COUNT(*) AS recordCount FROM " + self.pageTableName + " WHERE " + self.pageQueryFilter;
            apiConnect.getRequest("sql", queryRequest, apiConnect.pagedRequestBegin);            
        }, 3000);         
    };    
    // ========================================================================
    // pagedRequestBegin()
    //    
    this.pagedRequestBegin = function (resultSet) {
        var queryRequest = "";
        var recordCount = 0;
        var pagesCount = 1;
        var self = apiConnect;            
        // Echo resultSet to console
        if (resultSet) {
            console.log("Items Loaded :" + JSON.stringify(resultSet));
        } else {
            console.log("No results.");
        }
        // Validate the previous resultSet            
        if (resultSet) {
            console.log("Records Loaded :" + JSON.stringify(resultSet));
            recordCount = parseInt(resultSet[0].recordCount);
            if (recordCount > 0) {
                pagesCount = Math.ceil(recordCount / self.pageSize);
            }
        } else {
            console.log("No results.");
        }
        // Initialise the apiConnect with pageCount 
        self.pageCount = pagesCount;
        // initiate the event callback
        self.onRequestReady('onRequestReady');
        // fire Request("sql-request", filter-select query, callback)
        setTimeout(function() {
            // Complete Request
            self.pageNumber = 1;
            queryRequest = self.getDataSetPage(self.pageTableName, self.pageColumns, self.pageQueryFilter, self.pagePrimaryKeyName, self.pageSize, self.pageNumber);
            if (queryRequest.trim()) {
                self.pageStartTime = performance.now();
                self.getRequest("sql", queryRequest, self.pagedRequestNext);
            } else {
                console.log("Server Connection Failed: (Invalid DataSet)");    
            }            
        }, 3000);                 
    };
    // ========================================================================
    // pagedRequestNext()
    //    
    this.pagedRequestNext = function (resultSet) {
        // New QueryString
        var queryRequest = "";
        var self = apiConnect;
        // Mark Page Loaded
        self.pageEndTime = performance.now();
        self.pageElapseTime = self.pageEndTime - self.pageStartTime;
        self.requestEstimatedTime = self.pageElapseTime * self.pageCount;
        // Echo resultSet to console
        if (resultSet) {
            self.pageResultSet = resultSet;
            self.requestResultSet = self.requestResultSet.concat(resultSet);
            console.log("pageResultSet :" + JSON.stringify(resultSet));            
        } else {
            console.log("No results.");
        }
        // initiate the event callback
        self.onPageComplete('onPageComplete');            
        // Page Download Complete - step to next page
        self.pageNumber = self.pageNumber + 1;        
        // fire page Request with filter-select query, then callback
        setTimeout(function() {
            // Complete Request
            self.pageStartTime = performance.now();
            queryRequest = self.getDataSetPage(self.pageTableName, self.pageColumns, self.pageQueryFilter, self.pagePrimaryKeyName, self.pageSize, self.pageNumber);
            if (queryRequest.trim()) {
                if (self.pageNumber != self.pageCount) {
                    // Download next page in Request Set
                    self.getRequest("sql", queryRequest, self.pagedRequestNext);
                } else {
                    // Final page download in Request Set
                    self.getRequest("sql", queryRequest, self.pagedRequestComplete);                    
                }
            } else {
                console.log("Server Connection Failed: (Invalid DataSet)");
            }            
        }, 3000);              
    };
    // ========================================================================
    // pagedRequestComplete()
    //    
    this.pagedRequestComplete = function (resultSet) {
        try {
            var self = apiConnect;
            if (resultSet) {
                self.pageResultSet = resultSet;
                self.requestResultSet =  self.requestResultSet.concat(resultSet);
                console.log("requestResultSet :" + JSON.stringify(self.requestResultSet));
            } else {
                console.log("No results.");
            }
            // initiate the event callback
            self.onRequestComplete('onRequestComplete');            
            console.log("Request COMPLETE!");
        } catch (ex) {
          alert("Failed!");
          console.log("Error:" + ex.message);    
        }        
    };    
    // Use this function to encode64 ONLY FOR APIKEY
    this.encode64 = function (input) {

          var keyStr = "ABCDEFGHIJKLMNOP" +
                   "QRSTUVWXYZabcdef" +
                   "ghijklmnopqrstuv" +
                   "wxyz0123456789+/" +
                   "=";

         var output = "";
         var chr1, chr2, chr3 = "";
         var enc1, enc2, enc3, enc4 = "";
         var i = 0;     
         do {
            chr1 = input.charCodeAt(i++);
            chr2 = input.charCodeAt(i++);
            chr3 = input.charCodeAt(i++);
            enc1 = chr1 >> 2;
            enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);
            enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);
            enc4 = chr3 & 63;
            if (isNaN(chr2)) {
               enc3 = enc4 = 64;
            } else if (isNaN(chr3)) {
               enc4 = 64;
            }
            output = output +
               keyStr.charAt(enc1) +
               keyStr.charAt(enc2) +
               keyStr.charAt(enc3) +
               keyStr.charAt(enc4);
            chr1 = chr2 = chr3 = "";
            enc1 = enc2 = enc3 = enc4 = "";
         } while (i < input.length);
         return output;
    };
};
>

apiConnect Sample Snippet

The following code snippet demonstrates the use of the apiConnect class to connect and make requests using callback functions.


  <index.html>
  .....
  <script src="assets/js/apiConnect.js"></script>

  <script>
        $(document).ready(function() {
            Main.init();

        });

    function connectInit() {
            try {
                // Open Connection to API Server
                apiConnect.username = "superuser";
                apiConnect.password = "password";
                apiConnect.url = "http://api.datapel.net";
                // initialise Page Helper defaults
                apiConnect.pageNumber = 1;
                apiConnect.pageSize = 20;
                apiConnect.recordCount = 0;                

                setTimeout(function() {apiConnect.openService(connectComplete); }, 1000); 

            } catch(ex) {
                console.log("Error:" + ex.message);    
            }
    };

    function connectComplete(token) {
        if (token) {
            apiConnect.token = token;
            console.log("Authenticated..." + token);
            // Trigger Connection Verification
            setModalMessage('Verifying Connection...');
            setTimeout(function() {apiConnect.getTimeStamp(connectReady); }, 1000); 

        } else {
            console.log("Server Connection Failed.");
            // Unable to connect - Check username / password or connection
            setModalMessage('Server Connection Failed: (No resource available)');    
        }
    };

    function connectReady(timeStamp) {
        if (timeStamp) {
            console.log("Connected @ " + timeStamp);
            //Connection Successful
            setModalMessage('Connected @ ' + timeStamp);        
            // Display Connected Status
            // Continue to access Api
        } else {
            console.log("Connection Not Ready.");
        }
    };

HTTP Methods and Request Structure

The Breeze API is a REST/SOAP server and responds to HTTP Web requests with XML or JSON formatted responses. The Breeze server works with HTTP GET and POST methods and each endpoint will respond differently based on its specification. Typically GET is used to retrieve a Dataset from a resource while POST is used to push or INSERT/UPDATE a Dataset to the server.

The HTTP request has THREE basic components as below:

HTTP part Description Used by Breeze Server
Header Contains details regarding the format of the message Optional Credentials
URL The destination resource or endpoint and additional parameters Required for endpoint identification
Message Body An optional message body e.g. file, query data, or query result Optional POST details

GET Method

In order to request information from an endpoint the Breeze server will respond to the GET method and returns information in the message body as json or xml depending on the URL. It is possible to push information to some endpoint resources using the GET method if data is accepted via the parameters passed in the URL. Check specific Endpoint references to see if this method is supported. An example URL is shown below:

http://api.datapel.com:8080/xml/ENDPOINT?filter~myfilterstring&authorization~code&auth_token=token 

POST Method

In order to insert or update information to an endpoint the Breeze server responds to the POST method and returns status information in the message body. Typically the information being sent to the endpoint is carried in the message body however most endpoints support the passing of small datasets via the URL as a single parameter. Specific restrictions depend on the endpoint functionality, generally the raw dataset can be passed via the URL if not otherwise specified.

The Breeze server has a predefined structure for the POST REQUEST message body as below:

"<?xml version="1.0" encoding="utf-16"?>  
<PostRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">    
<updatetype>Insert</updatetype>    
<filter />    
<updateObject xsi:type="xsd:string">
{"JsonOrXML":true}
</updateObject>  
</PostRequest>" 

The POSTREQUEST is defined as below:

Property Description Example
UpdateType Either INSERT/UPDATE/DELETE/QUERY INSERT
Filter A valid filter criteria using properties and operators filter~basestockid=5
UpdateObject JSON or XML encoded Dataset <see endpoint POST samples>*

The SIMPLIFIED POST option allows the Message Body to be JUST THE UPDATE OBJECT and the Update type is assumed INSERT. This also applies to POST with UpdateObject as URL parameter line in the following format: filter~UpdateObject where the message body must be an empty string.

Authentication and User Access Control

To manage access to your workspace all information requests must present credentials to be authenticated by the Breeze Data Server.

Authentication Workflow

In order to access the Data Server you must have an API Username and Password. The master API Username and Password will be configured by your system administrator within your Breeze Data Server config.xml file. The Authentication process works as follows:

  1. GET Request is made to the /token endpoint passing AUTHORIZATION = base64_UTF8_encoded(Username:Password)
  2. If Username and Password are valid a Session Token is returned.
  3. Session Tokens are valid for 24 hours only and must be considered as part of the overall integration design pattern.
  4. To read a resource BOTH the AUTHORIZATION code and TOKEN must be passed to the Breeze Data Server.

Providing security credentials can be done in one of two ways:

  • Encoding Authorisation information in the HTTP header (or)
  • Passing Authorisation token keys in the URL

SSL Certificates

The Breeze Data Server can be configured to operate over HTTP or HTTPS (SSL).

With HTTPS the information transmitted from sender to receiver is encrypted and is the most secure method of ensuring data transmitted will not be decrypted or tampered with. In order to use HTTPS you will require an SSL Certificate and this usually relates to the domain name from where the server is referenced, for example: api.datapel.com. You will need to install the certificate on the physical operating system hosting the Breeze Data Server.

To specify HTTP or HTTPS you must setup in the Breeze Data Server config.xml and ensure the service is restarted for changes to come into effect.

Specifying the Request Header

Every request for Breeze Data Server resources must contain the following attributes in the header.

Field Description Example
Content-Type MIME type of the request body. application/xml
Host The host for handling request; Data Server host name. api.datapel.com
Accept-Encoding Enables encoding of the request. gzip,deflate
Optional Additional Header Security attributes:
Field Description Example
Authorization Required parameter for authorising the request. See below - Authorization
Auth_Token Required parameter issued for your session by serever. See below - Authorization

Specifying Credentials as URL Level Parameters

In addition to (or instead of) the above Request Header encoding the session token and authorisation key can be passed directly via the URL as parameters.

  • The URL must take on the standard form of /type(json/xml)/endpoint?filter~filterstring

An example detailing URL security encoding is shown below.

URL encoding Authorisation Example

The following example describes the HTTP GET query for obtaining a SESSION TOKEN and then making an endpoint request.

First you are required to create the Authorization key from base64 encoded master api Username and Passord in the following form:

  • Assuming master api username:password pair of "superuser:password" generates the Authorization Key = c3VwZXJ1c2VyOnBhc3N3b3Jk
  • To get the session token:
    
    http://api.datapel.com:8080/json/token?authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk
    
    Returns a session token as below: 
    [
      {
        "token": "oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA" 
      }
    ]
    
  • You may now use the credentials in the URL or HEADER to perform GET/POST requests to service endpoints.
    
    Example: GET current api timestamp with URL authorization
    
    http://api.datapel.com:8080/json/timestamp?filter~&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA
    
    Returns a response as below: 
    {
      "ServerTimeStamp": "2014-11-04 20:23:51" 
    }
    
  • For all future ENDPOINT requests your URL must be in the following form....
    
    http://api.datapel.com:8080/json/ENDPOINT?filter~myfilterstring&authorization~url_encoded_base64(user:pass)&auth_token=url_encoded_server_access_token
    
    
  • Tokens must be refreshed within 24 hours or they will be rejected so it is recommended that a daily task of refreshing the session token be added to your system design.
  • Always make sure the token is URL ENCODED before encoding the entire URL otherwise because base64 contains characters like + etc that will be decoded on the server side and cause authentication to fail.

Endpoint Parameters and Operators

When requesting a dataset from an endpoint a criteria filter can be set to limit the number of results or find a specific record subset. Generally the parameters are limited to the properties of the dataset. This reference shows the valid parameters for each endpoint resource under the Paramters tab.

Multiple parameters can be combined to produce a logical criteria however there are restrictions on the syntax and only a limited set of operators are valid as below:

Operator Description Example
= Equal to itemname = 'Jacket'
<> Not Equal to quantity <> 0
>, <, Greater than/Less than accountbalance > 0
>=, <=, Greater or Equal/Less or Equal basestockid >=20
in () parameter in set basestockid in (5,6,7,10,50)
AND required criteria colour='blue' and quantity>0
OR optional criteria udf1='dealeronly' or udf='promo'

The endpoint URL must always begin with filter~. Brackets are not support and may cause incorrect results - for example:

filter~(itemname='Jacket' AND colour='blue') OR udf1="pants" 

Will NOT work under the current criteria parser and returns: _500 Query filter could not be parsed._

If you require complex criteria contact Datapel technical support for suggestions on how best to manage these via the Breeze API.

OnPremise or CloudMirror Configuration Considerations

The Breeze Dataserver API has two very distinct configuration options as described below:

  • OnPremise : In this case the Breeze API server is installed locally on the customer server or same local network as the SQL Server instance and Datapel application software - this configuration is termed "On Premise". In this configuration any changes made by users are immediately accessible to the Breeze Dataserver - and any posted sales can be reviewed in real-time.
  • CloudMirror : The Datapel Public Cloud is a high performance internet server with the latest Breeze Dataserver API server. You will be allocated a public URL that references your companies Cloud Services. For example http://OurCompany.datapel.net. In this configuration any information from your on premise Datapel application is "mirrored" to the cloud server on a periodic basis, typically every 5 - 15 minutes. This configuration is preferable as your "On Premise" server is protected from public access via the internet. Generally the Datapel Cloud Mirror Service communicates with your On Premise Datapel application via SSL connection that can be IP Address authenticated - thereby securing your connection, server and master database. As the CloudMirror is just a copy of your server public attacks on this server will not impact the local on premise operations or system data integrity. As the CloudMirror requires relaying of information there is a 5 - 15 minute lag between the real-time system and the cloud data view. In most cases this is easily managed by establishing stock buffers or isolating "online" vs "onpremise" operations using system defined Locations.

Best Practice Read Workflow Example

To ensure a RESPONSIVE design the REST interface should not introduce long DELAYS while data is being served from an endpoint query. It is generally bad practice to select an excessive number of records in a single query as a large volume of data will cause your web page and the breeze server to appear "lockedup" while it processes and returns the raw data.

Where possible data derived from long lists should be "paged" and retrieved as datasets with each block representing a number of records. The number of records to read will depend on the number and size of properties being returned from the endpoint. In general you determine the page size based on the expected BANDWIDTH of the connection you have between the client browser / application and the Breeze Dataserver.

For example you may have a typical internet connection (ADSL) 1MB/s equivalent to approximately 128kb/s. It will take approximately 1 second to download 128k of information so using the ITEMS endpoint a typical JSON record can require about 2k per item master record. If your dataset has 5000 items then to read ALL RECORDS the response time would be around 78 seconds or 1 minute / 18 seconds to download. So presenting a new item list in real-time direct from the server is not practical. In reality a remote "copy" of the item master list would be held at the web server/remote application - and ideally only changes would be updated directly from the data server on demand or as they happen.

If your application and Dataserver are hosted on the same physical machine or local network then transfer rates would be much higher and result sets transferred in under 1 second - making live access to data feasible. So the use of paged datasets needs to be part of your design planning.

Using TimeStamp Endpoint and Property as Changed Record Trigger

To assist in minimising the amount of redundant information being transferred between the client application and server the TIMESTAMP endpoint and a TIMESTAMP property is available for most ENDPOINT query resources. Typically the workflow for obtaining ONLY changed records is as follows:

  1. Start list update
  2. Authenicate Connection
  3. Get Server TIMESTAMP as NEW-TIMESTAMP
  4. Read Endpoint with ?FILTER~TIMESTAMP > 'LASTACCESSED-TIMESTAMP'
  5. Update local client / app records
  6. LASTACCESSED-TIMESTAMP = NEW-TIMESTAMP
  7. Wait a fixed period of time or on demand for resource loop to start

By following this general endpoint query pattern the resulting dataset will always return just the records that have changed after the last endpoint read hence minimising the amount of data being transferred from the Dataserver to the browser/client application. This approach assumes you have an existing list inplace - if not the first pass will return ALL records from the endpoint resource as the TimeStamp would be NULL.

Paging Hints (PAGING)

When working with large data sets it is useful to return partial result sets. This technique is commonly referred to as response PAGING. Endpoints that support PAGING will have the PAGING tag on the endpoint verbs bar within the "Try It" pages. The default pageSize is 500 records and can be adjusted in the DataServer configuration management panel. This example shows a pageSize = 100 records.


Use the WITH PAGING hint to enable page referencing of partial data sets as shown below:

http://api.datapel.com:8080/JSON/sql?filter~SELECT * FROM BST_BaseStock WITH PAGING

Response result set will now contain a transaction cacheid reference and always returns the first page of results:

...
        "Status": "OK",
        "cacheid": "ca79e867-36dd-47fc-8113-2c70f7c73653",
        "RowChanges": "100",
        "PageNumber": "1",
        "RowTotal": "198" 
...

By specifying the WITH PAGING hint further pages can be requested using the cacheid reference as shown below.


Use the WITH PAGING ON cacheid PAGE XX to return the relevant page number from the initial data set.

http://api.datapel.com:8080/JSON/itemslist?filter~* WITH PAGING ON ca79e867-36dd-47fc-8113-2c70f7c73653 PAGE 2

Response result set will contain the cacheid reference:

...
        "Status": "OK",
        "cacheid": "ca79e867-36dd-47fc-8113-2c70f7c73653",
        "RowChanges": "98",
        "PageNumber": "2",
        "RowTotal": "198" 
...

If the page number contains no records an EMPTY response will result.

Paging via Queries and SQL Endpoint

Paging is not supported on all endpoints via the Breeze Dataserver and may require implementation via a client side run of queries. Where this is required it should be implemented as per the example shown below. In this case you require an indexing column against which the dataset will be sorted.

In order to complete the query you should maintain a @PAGE_SIZE being the number of records per page and the @PAGE_NUMBER being the offset into the dataset that you require. In the example below we show the main Item Master table and use the Item Master ID as the ASCENDING index.

SELECT * FROM BST_BaseStock WHERE BST_ID IN 
 (SELECT TOP @PAGE_SIZE BST_ID FROM BST_BaseStock WHERE BST_ID NOT IN 
 (SELECT TOP @PAGE_SIZE*(@PAGE_NUMBER-1) BST_ID FROM BST_BaseStock ORDER BY BST_ID) 
ORDER BY BST_ID) ORDER BY BST_ID

In the below example we retrieve all Item Details with the PAGE_SIZE = 20 and are requesting PAGE_NUMBER=3. Note Security URL parameters are omitted for clarity.

http://api.datapel.com:8080/JSON/sql?filter~SELECT * FROM BST_BaseStock WHERE BST_ID IN 
                                            (SELECT TOP 20 BST_ID FROM BST_BaseStock WHERE BST_ID NOT IN 
                                            (SELECT TOP 40 BST_ID FROM BST_BaseStock ORDER BY BST_ID) ORDER BY BST_ID) ORDER BY BST_ID

When possible please use the built in Paging Hints as these hints remove dependencies on primary key index fields and will improve backward compatibility of your client application with future DataServer releases.

Server Side Cache and Diff Hints (DIFFX)

In order to maximise performance of the Breeze Dataserver a number of endpoints support server side caching and the Datapel DIFFX engine. The DIFFX engine allows the caller to reference a previous transaction and request ONLY THE DIFFERENCES. This can dramatically improve the response times of your client application. Endpoints that support the DIFFX engine will have the DIFFX tag on the endpoint verbs bar within the "Try It" pages.


Use the WITH CACHE hint to create a server-side response copy as shown below:

http://api.datapel.com:8080/JSON/itemslist?filter~* WITH CACHE

Response result set will now contain a transaction cacheid reference:

...
"cacheid": "8af515f5-c786-49cd-a179-edd250cf0207" 
...

By specifying the WITH CACHE hint the Breeze DataServer will keep a copy of the response server-side. To request ONLY changed data specify the WITH DIFF ON cacheid hint and reference the previously cached response.


Use the WITH DIFF ON cacheid to return only data changes since between the request responses.

http://api.datapel.com:8080/JSON/itemslist?filter~* WITH DIFF ON 8af515f5-c786-49cd-a179-edd250cf0207

Response result set will contain a NEW transaction cacheid reference:

...
"cacheid": "0aee6203-d0e1-4b5f-8eca-80775de787e1" 
...

If no changes have occurred then an EMPTY response will result - continue to use the existing cacheid and WITH DIFF hint.

DIFFX Cache Persistence

The DIFFX response cache typically remains for 3-5 days after the initial cache event. Any DIFF ON hints that return a difference will create a new cache entry. Generally you should always use the latest cacheid from the most recent response. There is no limit to the number or size of cache requests you can make.

Keep in mind that using DIFFX adds more load to the DataServer as it persists more response information and adds overhead to the processing of a response while it processes the differences between current and previous response messages. Generally the response size is reduced to 10-20% compared to standard response messages when using DIFFX hints. Furthermore, the more frequent the requests the smaller the responses tend to be.

If the cacheid DOES NOT EXIST the server will just return the full response, automatically cache the data and return a new valid cacheid. Generally there is little risk of "missing" data changes due to server side cache expiration.

Endpoint Versions

Generally as the Breeze Dataserver is upgraded the endpoint resources will return properties that are backward compatible with previous versions. This allows client applications to remain unchanged as the inventory management system and Breeze Dataserver improve and are upgraded. In some cases however functionality of a specific endpoint may need to change dramatically and potentially cause existing applications to break as returned information or filters are no longer valid.

To minimise the work required by third parties to maintain compatibility with Breeze Dataserver the endpoint interface supports a VERSION path. This allows an external application to bind directly to a specific version of an ENDPOINT so the QUERY response complies with return properties consistent with the API version that the client application was developed against. Endpoint versions will be published direct to developers as and when specification and requirement change dictates endpoint versioning.

At all times the default endpoint will support the latest functionality for the Breeze Dataserver.

  • To access a specific ENDPOINT version the request URL must be in the following form....
    
    http://api.datapel.com:8080/json/vX/ENDPOINT?filter~myfilterstring&authorization~base64(user:pass)&auth_token=server_access_token
    
    WHERE vX is v1, v2, v3 etc the version provided by Datapel required to support your client application interface.
    
    The older the application the lower the version number; v1 would be the oldest deprecated endpoint version.
    
    

Best Practice Order Write Workflow

POST as with the READ/GET process from the API needs to ensure RESPONSIVE design and not incur DELAYS while data is processed or consumed by an endpoint service. In the case of pushing transaction information via Breeze API there are currently two methods available:

  • The "in process" ORDER POST (sales endpoint) or
  • QUEUED POST of an ORDER (salesqueue endpoint)

The "in process" option will attempt to commit the transaction immediately and any exceptions will be sent back via the API requiring the client to handle the response. The QUEUED POST pushes the order into a list of orders that will be processed by the server as part of a batch or to be initiated by a local administrator or administrator process. Furthermore the QUEUE can be cleared or FLUSHED via the API and forces the server to consume the posted orders.

Currently we are recommending that Sale Orders be POSTED via the SalesQueue Endpoint and triggered for processing on the server-side using a SalesQueueCount&FLUSH query with the appended FLUSH parameter as shown.

  • POST sale xml to the salequeue endpoint as:
    http://api.datapel.com:8080/xml/salesqueue?filter~&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA
    
  • Valid Response will be a QID code: e.g. QID-1234-5678
  • GET sale queue count with Flush to commit orders as:
    http://api.datapel.com:8080/xml/salesqueuecount?filter~FLUSH&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA
    
    NOTE: Flush is not required when working with CLOUD MIRROR configurations - flush will occur automatically based on cloud mirror cycle time. 
    
  • Check order status using GET status endpoint.
    If you supplied the invoice number you can use this as search field:
    
    http://api.datapel.com:8080/xml/status?filter~invoicenum='remoteinvoicenum'&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA
    
    It is recommended the QID is used to reference the transaction as shown below:
    
    http://api.datapel.com:8080/xml/status?filter~qid='QID-1234-5678'&authorization~c3VwZXJ1c2VyOnBhc3N3b3Jk=&auth_token=oUMf4ifG0UgAAAAAAAAAAAAAAAAAAAAA
    
    

Note that there maybe some delay between the sale queue flush and the ability to check status - generally via the API each sale order takes 5 - 10 seconds to process and become visible to the status endpoint. If you need to query the status immediately use the FLUSH_WAIT parameter instead which causes the API to wait for the orders to complete importing and then returns a response.

POST Order Sample

The Order POST supports XML encoding only at the time of release.

Sample XML Order Message


<NewDataSet>
   <tREMOTETransHeader>
      <Company_ID>DATAPEL</Company_ID>
      <StoreCode>PRESTON</StoreCode>
      <PostingDate>2015-08-31T02:17:08Z</PostingDate>
      <TransID>#2689009</TransID>
      <TransDate/>
      <Salesperson>lyndenmcdonald@yahoo.com.au</Salesperson>
      <CardIdentification>THELNSW</CardIdentification>
      <SaleType>S</SaleType>
      <Special2>ROAD</Special2>
      <ShippingMethod>Star Track</ShippingMethod>
      <ClosedYN>Y</ClosedYN>
      <OriginalSaleType>O</OriginalSaleType>
   </tREMOTETransHeader>
   <tREMOTETransCustomer>
      <ShipToName/>
      <ShipToAddress1>273a Peel Street</ShipToAddress1>
      <ShipToAddress2/>
      <ShipToSuburb>Tamworth</ShipToSuburb>
      <ShipToPostCode>2340</ShipToPostCode>
      <ShipToState>NSW</ShipToState>
      <Address1>273a Peel Street</Address1>
      <Suburb>Tamworth</Suburb>
      <PostCode>2340</PostCode>
      <PhoneNo1>02 6766 9288</PhoneNo1>
      <EmailAddress>shop@lemonhouse.com.au</EmailAddress>
   </tREMOTETransCustomer>
   <tREMOTETransSaleTenders>
      <TenderAmount>0</TenderAmount>
   </tREMOTETransSaleTenders>
   <tREMOTETransSaleLines>
      <SKU>G0751ESS15</SKU>
      <SaleQty>1</SaleQty>
      <SaleUnitAmountIncTax>95.00</SaleUnitAmountIncTax>
      <SaleTaxByHost>Y</SaleTaxByHost>
      <SaleTaxRate>10</SaleTaxRate>
      <SKUDescription>Blue/tan SYKE SMALL BAG (ETA 15-08)</SKUDescription>
      <SalePriceByHost>N</SalePriceByHost>
   </tREMOTETransSaleLines>
</NewDataSet>

XML Order Property Reference

The following table describes each property, type and example value.

Message Text/String Encoding

Preferred string encoding is UTF-8. The fields in the xml file should NOT use cdata and should not contain any of the following characters without encoding ~ < > & TAB CR LF ( ascii 10 / 13).

Special Character encoding is required as shown below.

Value Encoding
~ ~tl~
< ~lt~
> ~gt~
& ~am~
Chr(9) ~09~
Chr(10) ~10~
Chr(13) ~13~
' Single quotes do not require any encoding

Glossary

Record Field Information