JoT API v2.1

API Summary
• ACCOUNTDOCUMENTNOTES
• notesDeleteNotes
• notesGetAll
• notesGetByCode
• notesPatchNotes
• notesPostNotes
• ACCOUNTDOCUMENTS
• accountDocumentsDeleteDocumentAsync
• accountDocumentsGetAll
• accountDocumentsGetDocumentByCode
• accountDocumentsPatchAsync
• accountDocumentsPost
• ACCOUNTNOTEBOOKS
• accountNotebooksGetAll
• accountNotebooksGetNotebookByCode
• accountNotebooksPost
• ACCOUNTPHONENUMBERS
• accountPhonesGetAll
• accountPhonesGetByCode
• accountPhonesPatchAsync
• accountPhonesPost
• ACCOUNTTITLES
• accountTitlesGetAll
• accountTitlesPatch
• ACCOUNTS
• accountsCreate
• accountsGetAll
• accountsGetByCode
• accountsPatch
• ACTIVITYCENTERSTATUSES
• activityCenterStatusesGetAll
• activityCenterStatusesPatchAsync
• CARTS
• cartsAddPromotionCodes
• cartsCreateCart
• cartsDelete
• cartsDeleteItem
• cartsDeletePaymentsAsync
• cartsDeletePromotionCodes
• cartsGetAll
• cartsGetAllItems
• cartsGetAllPromotionCodes
• cartsGetCartByCode
• cartsGetCartItemByCode
• cartsGetFreightAsync
• cartsPatch
• cartsPatchCartItemByCode
• cartsPostItem
• cartsPostPaymentsAsync
• cartsSubmitCart
• CATEGORIES
• categoriesGetAll
• categoriesGetByCategoryCode
• categoriesPatchAsync
• categoriesPostAsync
• EXEMPTIONS
• exemptionsGetAll
• exemptionsGetByCode
• exemptionsPatch
• exemptionsPost
• GENEALOGY
• genealogyGetByCode
• INVENTORIES
• inventoriesDeleteByCode
• inventoriesGetAll
• inventoriesGetByCode
• inventoriesPatchAsync
• inventoriesPostAsync
• LINEAGES
• lineagesGetAll
• lineagesGetLineageByCode
• lineagesGetLineagesByAccount
• lineagesGetSponsorsByAccountDownline
• lineagesGetSponsorsByAccountUpline
• lineagesPatchSponsorAsync
• lineagesPostSponsorAsync
• OFFERS
• offersGetAll
• offersGetByCode
• offersPatch
• offersPost
• ORDERS
• ordersGetAll
• ordersGetOrderByCode
• ordersPost
• PRODUCTQUANTITYLIMITS
• productQuantityLimitsGetAll
• productQuantityLimitsPatch
• productQuantityLimitsPostAsync
• PRODUCTS
• productsGetAll
• productsGetByProductCode
• productsPatchAsync
• productsPostAsync
• RESOURCES
• resourcesDeleteByCode
• resourcesGetAll
• resourcesGetByKey
• resourcesPatch
• resourcesPost
• SHIPMENTS
• shipmentsConfirmSelected
• shipmentsConfirmSingleByOrder
• shipmentsConfirmSingleByPackslip
• shipmentsGetAll
• shipmentsGetByCode
• shipmentsPost
• SPONSORRULES
• sponsorRulesGetByAccountCode
• sponsorRulesGetByCountryPostcodeName
• STOCKS
• stocksGetAll
• stocksPatchAsync
• stocksPostAdjustmentsAsync
• stocksPostAsync
• TASKS
• tasksGetAll
• tasksGetByCode
• tasksPost
• TICKETS
• ticketsGetAll
• ticketsGetByAccount
• ticketsGetTicketByCode
• ticketsPatchAsync
• ticketsPostAsync
• ticketsPostTicksForAccountAsync
• UPLINES
• uplinesGetAsync
• VOLUMES
• volumesGetAll
• volumesGetAllByOrder
• volumesGetByCode
• volumesPatch
• volumesPost
• WAREHOUSES
• warehousesGetAll
• warehousesGetByCode
• warehousesPatchAsync
• warehousesPostAsync
Jenkon REST API

V2.1
API and SDK
Documentation
Version: v2.1
AccountDocumentNotes
notesDeleteNotes
Get account notes by document
code.
/api/Accounts/{accountCode}/Doc
uments/{documentCode}/Notes
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
curl -X DELETE "https://localho

st:44356/api/Accounts/{accountC
ode}/Documents/{documentCode}/N
otes"
import io.swagger.client.*;
import io.swagger.client.auth.*
;
import io.swagger.client.model.
*;
import io.swagger.client.api.Ac
countDocumentNotesApi;
import java.io.File;
import java.util.*;
public class AccountDocumentNot

esApiExample {
public static void main(Str

ing[] args) {
ApiClient defaultClient
= Configuration.getDefaultApiCl
ient();
// Configure OAuth2 acc

ess token for authorization: oa
uth2
OAuth oauth2 = (OAuth)

defaultClient.getAuthentication
("oauth2");
oauth2.setAccessToken("
YOUR ACCESS TOKEN");
AccountDocumentNotesApi
apiInstance = new AccountDocume
ntNotesApi();
String accountCode = ac
countCode_example; // String |
String documentCode = d
ocumentCode_example; // String
|
array[String] notesCode
s = ; // array[String] |
String authorization =
authorization_example; // Strin
g | access token
String acceptLanguage =
acceptLanguage_example; // Stri
ng | Accept-Language
String apiVersion = api
Version_example; // String | Ap
i-Version
try {
Object result = api

Instance.notesDeleteNotes(accou
ntCode, documentCode, notesCode
s, authorization, acceptLanguag
e, apiVersion);
System.out.println(
result);
} catch (ApiException e
) {
System.err.println(
"Exception when calling Account
DocumentNotesApi#notesDeleteNot
es");
e.printStackTrace()
;

esApiExample {
ing[] args) {
ntNotesApi();
|
array[String] notesCode
s = ; // array[String] |
g | access token

i-Version
try {
Object result = api

Instance.notesDeleteNotes(accou
ntCode, documentCode, notesCode
s, authorization, acceptLanguag
e, apiVersion);
System.out.println(
result);
) {
System.err.println(
DocumentNotesApi#notesDeleteNot
es");
e.printStackTrace()
;
Configuration *apiConfig = [Con

figuration sharedConfig];
// Configure OAuth2 access toke

n for authorization: (authentic
ation scheme: oauth2)
[apiConfig setAccessToken:@"YOU
R_ACCESS_TOKEN"];
String *accountCode = accountCo

de_example; //
String *documentCode = document

Code_example; //
array[String] *notesCodes = ; /
/
String *authorization = authori

zation_example; // access token
(optional)
String *acceptLanguage = accept
Language_example; // Accept-Lan
guage (optional) (default to en
-US)
String *apiVersion = apiVersion

_example; // Api-Version (optio
nal) (default to 1.0)
AccountDocumentNotesApi *apiIns
tance = [[AccountDocumentNotesA
pi alloc] init];
// Get account notes by documen

t code.
[apiInstance notesDeleteNotesWi
th:accountCode
documentCode:documentCode
notesCodes:notesCodes
authorization:authorization
acceptLanguage:acceptLangua
ge
apiVersion:apiVersion
completionHandler
: ^(Object output, NSError* err
or) {
if
(output) {
NSLog(@"%@", output);
}
if
(error) {
NSLog(@"Error: %@", error);
}];
var JenkonRestApiV1 = require('

jenkon_rest_api_v1');
var defaultClient = JenkonRestA

piV1.ApiClient.instance;

n for authorization: oauth2
var oauth2 = defaultClient.auth

entications['oauth2'];
oauth2.accessToken = "YOUR ACCE

SS TOKEN"
var api = new JenkonRestApiV1.A

ccountDocumentNotesApi()
var accountCode = accountCode_e

xample; // {String}
var documentCode = documentCode
_example; // {String}
var notesCodes = ; // {array[St

ring]}
var opts = {
'authorization': authorizatio
n_example, // {String} access t
oken
'acceptLanguage': acceptLangu
age_example, // {String} Accept
-Language
'apiVersion': apiVersion_exam
ple // {String} Api-Version
};
var callback = function(error,

data, response) {
if (error) {
console.error(error);
} else {
console.log('API called suc

cessfully. Returned data: ' + d
ata);
};
api.notesDeleteNotes(accountCod
e, documentCode, notesCodes, op
ts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
public class notesDeleteNot

esExample
public void main()
// Configure OAuth2
access token for authorization:
oauth2
Configuration.Defau
lt.AccessToken = "YOUR_ACCESS_T
OKEN";
var apiInstance = n
ew AccountDocumentNotesApi();
var accountCode = a
ccountCode_example; // String
|
var documentCode =
documentCode_example; // Strin
g |
var notesCodes = ne
w array[String](); // array[Str
ing] |
var authorization =
authorization_example; // Stri
ng | access token (optional)
var acceptLanguage
= acceptLanguage_example; // S
tring | Accept-Language (option
al) (default to en-US)
var apiVersion = ap
iVersion_example; // String |
Api-Version (optional) (defaul
t to 1.0)
try
// Get account
notes by document code.
Object result =
apiInstance.notesDeleteNotes(ac
countCode, documentCode, notesC
odes, authorization, acceptLang
uage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling AccountDoc
umentNotesApi.notesDeleteNotes:
" + e.Message );
<?php
require_once(__DIR__ . '/vendor
/autoload.php');

Swagger\Client\Configuration::g
etDefaultConfiguration()->setAc
cessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Cli

ent\Api\AccountDocumentNotesApi
();
$accountCode = accountCode_exam
ple; // String |
$documentCode = documentCode_ex
ample; // String |
$notesCodes = ; // array[String
] |
$authorization = authorization_
example; // String | access tok
en
$acceptLanguage = acceptLanguag
e_example; // String | Accept-L
anguage
$apiVersion = apiVersion_exampl
e; // String | Api-Version
try {
$result = $api_instance->no
tesDeleteNotes($accountCode, $d
ocumentCode, $notesCodes, $auth
orization, $acceptLanguage, $ap
iVersion);
print_r($result);
} catch (Exception $e) {
echo 'Exception when callin

g AccountDocumentNotesApi->note
sDeleteNotes: ', $e->getMessage
(), PHP_EOL;
?>
use Data::Dumper;
use WWW::SwaggerClient::Configu
ration;
use WWW::SwaggerClient::Account
DocumentNotesApi;
# Configure OAuth2 access token

for authorization: oauth2
$WWW::SwaggerClient::Configurat
ion::access_token = 'YOUR_ACCES
S_TOKEN';
my $api_instance = WWW::Swagger
Client::AccountDocumentNotesApi
->new();
my $accountCode = accountCode_e
xample; # String |
my $documentCode = documentCode
_example; # String |
my $notesCodes = [WWW::SwaggerC
lient::Object::array[String]->n
ew()]; # array[String] |
my $authorization = authorizati
on_example; # String | access t
oken
my $acceptLanguage = acceptLang
uage_example; # String | Accept
-Language
my $apiVersion = apiVersion_exa
mple; # String | Api-Version
eval {
my $result = $api_instance-
>notesDeleteNotes(accountCode =
> $accountCode, documentCode =>
$documentCode, notesCodes => $n
otesCodes, authorization => $au
thorization, acceptLanguage =>
$acceptLanguage, apiVersion =>
$apiVersion);
print Dumper($result);
};
if ($@) {
warn "Exception when callin

sDeleteNotes: $@\n";
from __future__ import print_st

atement
import time
import swagger_client
from swagger_client.rest import

ApiException
from pprint import pprint

swagger_client.configuration.ac
cess_token = 'YOUR_ACCESS_TOKEN
'
# create an instance of the API

class
api_instance = swagger_client.A
accountCode = accountCode_examp
le # String |
documentCode = documentCode_exa
mple # String |
notesCodes = # array[String] |
authorization = authorization_e
xample # String | access token
(optional)
acceptLanguage = acceptLanguage
_example # String | Accept-Lang
uage (optional) (default to en-
US)
apiVersion = apiVersion_example
# String | Api-Version (optiona
l) (default to 1.0)
try:
# Get account notes by docu

ment code.
api_response = api_instance
.notes_delete_notes(accountCode
, documentCode, notesCodes, aut
horization=authorization, accep
tLanguage=acceptLanguage, apiVe
rsion=apiVersion)
pprint(api_response)
except ApiException as e:
print("Exception when calli

ng AccountDocumentNotesApi->not
esDeleteNotes: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Required
documentCode* String
Required
Header parameters
Name Description
Authorization String
access token
Accept-Language String
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
notesCodes * [
string
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
notesGetAll
code.
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
curl -X GET "https://localhost:

44356/api/Accounts/{accountCode
}/Documents/{documentCode}/Note
s?pageNumber=&pageSize=&sortTyp
e=&filters="
;
*;
import java.util.*;

esApiExample {

ing[] args) {
ient();

uth2

("oauth2");
ntNotesApi();
|
Integer pageNumber = 56
; // Integer | PageNumber, a nu
mber greater than or equal to 0
Integer pageSize = 56;

// Integer | PageSize, a number
greater than 0
String sortType = sortT

ype_example; // String | SortTy
pe, 0 or 'asc' for 'Ascending'
and 1 or 'desc' for 'Descending
'
g | access token

i-Version
String filters = filter

s_example; // String | # Filter
s
**Example:**
Cost>50;Name~=a;and$LastName!|=
a;StartDate==2020-06-07
**SQL equivalent:**
SELECT * FROM Table WHERE (Cost
> 50 AND Name LIKE '%a%') OR (L
astName NOT LIKE '%a' AND Start
Date == '20200607')
**Supported operators:**
| Operators | Sign |
Number | String | Char | DateTi
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
| NotEqual |**!=** |
✓ | ✓ | ✓ | ✓ |
| GreaterThan |**>** |
✓ | ✘ | ✘ | ✓ |
| GreaterOrEqualThan |**>=** |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
| LessOrEqualThan |**<=** |
✓ | ✘ | ✘ | ✓ |
| Contains |**~=** |
✘ | ✓ | ✘ | ✘ |
| NotContains |**!~=**|
✘ | ✓ | ✘ | ✘ |
| StartsWith |**_=** |
✘ | ✓ | ✘ | ✘ |
| NotStartsWith |**!_=**|
✘ | ✓ | ✘ | ✘ |
| EndsWith |**│=** |
✘ | ✓ | ✘ | ✘ |
| NotEndsWith |**!│=**|
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.NoteDto result = apiInst
ance.notesGetAll(accountCode, d
ocumentCode, pageNumber, pageSi
ze, sortType, authorization, ac
ceptLanguage, apiVersion, filte
rs);
System.out.println(
result);
) {
System.err.println(
DocumentNotesApi#notesGetAll");
e.printStackTrace()
;
}

esApiExample {

ing[] args) {
ntNotesApi();
|

greater than 0

'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.NoteDto result = apiInst
ance.notesGetAll(accountCode, d
ocumentCode, pageNumber, pageSi
rs);
System.out.println(
result);
) {
System.err.println(
DocumentNotesApi#notesGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

de_example; //

Code_example; //
Integer *pageNumber = 56; // Pa
geNumber, a number greater than
or equal to 0 (default to 1)
Integer *pageSize = 56; // Page

Size, a number greater than 0 (
default to 25)
String *sortType = sortType_exa

mple; // SortType, 0 or 'asc' f
or 'Ascending' and 1 or 'desc'
for 'Descending' (default to as
c)

(optional)

-US)

String *filters = filters_examp

le; // # Filters
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
pi alloc] init];

t code.
[apiInstance notesGetAllWith:ac
countCode
pageNumber:pageNumber
pageSize:pageSize
sortType:sortType
ge
filters:filters
completionHandler
: ^(HateoasCollectionResponse.N
oteDto output, NSError* error)
{
if
(output) {
if
(error) {
}];





SS TOKEN"

xample; // {String}

var pageNumber = 56; // {Intege

r} PageNumber, a number greater
than or equal to 0
var pageSize = 56; // {Integer}

PageSize, a number greater than
0
var sortType = sortType_example

; // {String} SortType, 0 or 'a
sc' for 'Ascending' and 1 or 'd
esc' for 'Descending'
var opts = {
oken
-Language
ple, // {String} Api-Version
'filters': filters_example //
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {
ata);
};
api.notesGetAll(accountCode, do
cumentCode, pageNumber, pageSiz
e, sortType, opts, callback);
using System;
namespace Example
public class notesGetAllExa

mple
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var accountCode = a
|
var documentCode =
g |
var pageNumber = 56
; // Integer | PageNumber, a n
umber greater than or equal to
0 (default to 1)
var pageSize = 56;

greater than 0 (default to 25)
var sortType = sort

Type_example; // String | Sort
Type, 0 or 'asc' for 'Ascending
' and 1 or 'desc' for 'Descendi
ng' (default to asc)
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var filters = filte

rs_example; // String | # Filt
ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get account
HateoasCollecti
onResponse.NoteDto result = api
Instance.notesGetAll(accountCod
e, documentCode, pageNumber, pa
geSize, sortType, authorization
, acceptLanguage, apiVersion, f
ilters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
umentNotesApi.notesGetAll: " +
e.Message );
<?php
/autoload.php');


();
ple; // String |
ample; // String |
$pageNumber = 56; // Integer |

PageNumber, a number greater th
an or equal to 0
$pageSize = 56; // Integer | Pa

geSize, a number greater than 0
$sortType = sortType_example; /
/ String | SortType, 0 or 'asc'
for 'Ascending' and 1 or 'desc'
for 'Descending'
en
anguage
$filters = filters_example; //
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
tesGetAll($accountCode, $docume
ntCode, $pageNumber, $pageSize,
$sortType, $authorization, $acc
eptLanguage, $apiVersion, $filt
ers);
print_r($result);

sGetAll: ', $e->getMessage(), P
HP_EOL;
}
?>
use Data::Dumper;
ration;
DocumentNotesApi;

S_TOKEN';
->new();
xample; # String |
my $pageNumber = 56; # Integer

| PageNumber, a number greater
than or equal to 0
my $pageSize = 56; # Integer |

0
my $sortType = sortType_example
; # String | SortType, 0 or 'as
c' for 'Ascending' and 1 or 'de
sc' for 'Descending'
oken
-Language
my $filters = filters_example;
# String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>notesGetAll(accountCode => $ac
countCode, documentCode => $doc
umentCode, pageNumber => $pageN
umber, pageSize => $pageSize, s
ortType => $sortType, authoriza
tion => $authorization, acceptL
anguage => $acceptLanguage, api
Version => $apiVersion, filters
=> $filters);
};
if ($@) {

sGetAll: $@\n";

atement
import time

ApiException

'

class
le # String |
mple # String |
pageNumber = 56 # Integer | Pag

eNumber, a number greater than
pageSize = 56 # Integer | PageS

ize, a number greater than 0 (d
efault to 25)
sortType = sortType_example # S
tring | SortType, 0 or 'asc' fo
r 'Ascending' and 1 or 'desc' f
or 'Descending' (default to asc
)
(optional)
US)
l) (default to 1.0)
filters = filters_example # Str

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:

ment code.
.notes_get_all(accountCode, doc
umentCode, pageNumber, pageSize
, sortType, authorization=autho
rization, acceptLanguage=accept
Language, apiVersion=apiVersion
, filters=filters)

esGetAll: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Required
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
PageNumber, a number greater than or equal to 0
Required
pageSize* Integer
PageSize, a number greater than 0
Required
sortType* String
SortType, 0 or 'asc' for 'Ascending' and 1 or 'desc' for

'Descending'
Required
filters String
# Filters **Example:**
Cost>50;Name~=a;and$LastName!|=a;StartDate==2020-06-07
**SQL equivalent:** SELECT * FROM Table WHERE (Cost >
50 AND Name LIKE '%a%') OR (LastName NOT LIKE '%a'
AND StartDate == '20200607') **Supported operators:** |
Operators | Sign | Number | String | Char | DateTime | | ----------
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
✓ | ✓ | | NotEqual |**!=** | ✓ | ✓ | ✓ | ✓ | | GreaterThan |**>**
| ✓ | ✘ | ✘ | ✓ | | GreaterOrEqualThan |**>=** | ✓ | ✘ | ✘ | ✓
| | LessThan |**<** | ✓ | ✘ | ✘ | ✓ | | LessOrEqualThan
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
NotContains |**!~=**| ✘ | ✓ | ✘ | ✘ | | StartsWith |**_=** | ✘ | ✓
| ✘ | ✘ | | NotStartsWith |**!_=**| ✘ | ✓ | ✘ | ✘ | | EndsWith
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
HATEOAS collection response
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
Previous page url, will be null if not
exist
Next:
string
Next page url, will be null if not exist
Last:
string
Last page url
Items:
[
Items
NoteDto {
NoteDto.
DocumentNoteType:
DocumentNoteType string
minLength:1 maxLength:50
}
]
}
notesGetByCode
code.
/api/Notes/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Notes/{code}"
;
*;
import java.util.*;

esApiExample {

ing[] args) {
ient();

uth2

("oauth2");
ntNotesApi();
String code = code_exam

ple; // String |
g | access token

i-Version
try {
NoteDto result = ap
iInstance.notesGetByCode(code,
authorization, acceptLanguage,
apiVersion);
System.out.println(
result);
) {
System.err.println(
DocumentNotesApi#notesGetByCode
");
e.printStackTrace()
;

esApiExample {

ing[] args) {
ntNotesApi();

ple; // String |
g | access token

i-Version
try {
NoteDto result = ap
iInstance.notesGetByCode(code,
apiVersion);
System.out.println(
result);
) {
System.err.println(
DocumentNotesApi#notesGetByCode
");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
String *code = code_example; //

(optional)

-US)

pi alloc] init];

t code.
[apiInstance notesGetByCodeWith
:code
ge
completionHandler
: ^(NoteDto output, NSError* er
ror) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"

var code = code_example; // {St

ring}
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.notesGetByCode(code, opts,
callback);
using System;
namespace Example
public class notesGetByCode

Example
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var code = code_exa

mple; // String |
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get account
NoteDto result
= apiInstance.notesGetByCode(co
de, authorization, acceptLangua
ge, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
umentNotesApi.notesGetByCode: "
+ e.Message );
<?php
/autoload.php');


();
$code = code_example; // String

|
en
anguage
try {
tesGetByCode($code, $authorizat
ion, $acceptLanguage, $apiVersi
on);
print_r($result);

sGetByCode: ', $e->getMessage()
, PHP_EOL;
?>
use Data::Dumper;
ration;
DocumentNotesApi;

S_TOKEN';
->new();
my $code = code_example; # Stri

ng |
oken
-Language
eval {
>notesGetByCode(code => $code,
authorization => $authorization
, acceptLanguage => $acceptLang
uage, apiVersion => $apiVersion
);
};
if ($@) {

sGetByCode: $@\n";

atement
import time

ApiException

'

class
code = code_example # String |
(optional)
US)
l) (default to 1.0)
try:

ment code.
.notes_get_by_code(code, author
ization=authorization, acceptLa
nguage=acceptLanguage, apiVersi
on=apiVersion)

esGetByCode: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
NoteDto {
NoteDto.
DocumentNoteType:
DocumentNoteType string
}
notesPatchNotes
Update document notes for an
specific document and account code.
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
curl -X PATCH "https://localhos
t:44356/api/Accounts/{accountCo
de}/Documents/{documentCode}/No
tes"
;
*;
import java.util.*;

esApiExample {

ing[] args) {
ient();

uth2
("oauth2");
ntNotesApi();
|
array[NotePatch] notes
= ; // array[NotePatch] |
g | access token

i-Version
try {
Object result = api

Instance.notesPatchNotes(accoun
tCode, documentCode, notes, aut
horization, acceptLanguage, api
Version);
System.out.println(
result);
) {
System.err.println(
DocumentNotesApi#notesPatchNote
s");
e.printStackTrace()
;

esApiExample {

ing[] args) {
ntNotesApi();
|
array[NotePatch] notes
= ; // array[NotePatch] |
g | access token

i-Version
try {
Object result = api

Instance.notesPatchNotes(accoun
tCode, documentCode, notes, aut
Version);
System.out.println(
result);
) {
System.err.println(
DocumentNotesApi#notesPatchNote
s");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];

de_example; //

Code_example; //
array[NotePatch] *notes = ; //

(optional)

-US)

pi alloc] init];
// Update document notes for an

specific document and account c
ode.
[apiInstance notesPatchNotesWit
h:accountCode
notes:notes
ge
completionHandler
or) {
if
(output) {
if
(error) {
}
}];





SS TOKEN"


xample; // {String}

var notes = ; // {array[NotePat

ch]}
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.notesPatchNotes(accountCode
, documentCode, notes, opts, ca
llback);
using System;
namespace Example
public class notesPatchNote

sExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var accountCode = a
|
var documentCode =
g |
var notes = new arr
ay[NotePatch](); // array[NoteP
atch] |
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Update docum
ent notes for an specific docum
ent and account code.
Object result =
apiInstance.notesPatchNotes(acc
ountCode, documentCode, notes,
apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
{
Debug.Print("Ex
umentNotesApi.notesPatchNotes:
" + e.Message );
<?php
/autoload.php');


();
ple; // String |
ample; // String |
$notes = ; // array[NotePatch]
|
en
anguage
try {
tesPatchNotes($accountCode, $do
cumentCode, $notes, $authorizat
on);
print_r($result);

sPatchNotes: ', $e->getMessage(
), PHP_EOL;
?>
use Data::Dumper;
ration;
DocumentNotesApi;
S_TOKEN';
->new();
xample; # String |
my $notes = [WWW::SwaggerClient
::Object::array[NotePatch]->new
()]; # array[NotePatch] |
oken
-Language
eval {
>notesPatchNotes(accountCode =>
$accountCode, documentCode => $
documentCode, notes => $notes,
);
};
if ($@) {

sPatchNotes: $@\n";

atement
import time

ApiException

'
class
le # String |
mple # String |
notes = # array[NotePatch] |
(optional)
US)
l) (default to 1.0)
try:
# Update document notes for

an specific document and accoun
t code.
.notes_patch_notes(accountCode,
documentCode, notes, authorizat
ion=authorization, acceptLangua
ge=acceptLanguage, apiVersion=a
piVersion)

esPatchNotes: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Required
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
notes * [
undefined
Responses
Status: 200 - OK
• Schema
{
}
Status: 201 - Created
notesPostNotes
Create document notes for an
specific document and account code.
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
curl -X POST "https://localhost

:44356/api/Accounts/{accountCod
e}/Documents/{documentCode}/Not
es"
;
*;
import java.util.*;

esApiExample {

ing[] args) {
ient();

uth2

("oauth2");
ntNotesApi();
|
array[NotePost] notes =
; // array[NotePost] |
g | access token
i-Version
try {
Object result = api

Instance.notesPostNotes(account
Code, documentCode, notes, auth
orization, acceptLanguage, apiV
ersion);
System.out.println(
result);
) {
System.err.println(
DocumentNotesApi#notesPostNotes
");
e.printStackTrace()
;

esApiExample {
ing[] args) {
ntNotesApi();
|
array[NotePost] notes =
; // array[NotePost] |
g | access token

i-Version
try {
Object result = api

Instance.notesPostNotes(account
Code, documentCode, notes, auth
ersion);
System.out.println(
result);
) {
System.err.println(
DocumentNotesApi#notesPostNotes
");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

de_example; //

Code_example; //
array[NotePost] *notes = ; //

(optional)

-US)

pi alloc] init];
// Create document notes for an

specific document and account c
ode.
[apiInstance notesPostNotesWith
:accountCode
notes:notes
ge
completionHandler
or) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"


xample; // {String}
var notes = ; // {array[NotePos

t]}
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.notesPostNotes(accountCode,
documentCode, notes, opts, call
back);
using System;
namespace Example
public class notesPostNotes

Example
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var accountCode = a
|
var documentCode =
g |
var notes = new arr

ay[NotePost](); // array[NotePo
st] |
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create docum
ent notes for an specific docum
ent and account code.
Object result =
apiInstance.notesPostNotes(acco
untCode, documentCode, notes, a
uthorization, acceptLanguage, a
piVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
umentNotesApi.notesPostNotes: "
+ e.Message );
<?php
/autoload.php');

();
ple; // String |
ample; // String |
$notes = ; // array[NotePost] |
en
anguage
try {
tesPostNotes($accountCode, $doc
umentCode, $notes, $authorizati
on, $acceptLanguage, $apiVersio
n);
print_r($result);

sPostNotes: ', $e->getMessage()
, PHP_EOL;
}
?>
use Data::Dumper;
ration;
DocumentNotesApi;

S_TOKEN';
->new();
xample; # String |
my $notes = [WWW::SwaggerClient
::Object::array[NotePost]->new(
)]; # array[NotePost] |
oken
-Language
eval {
>notesPostNotes(accountCode =>
$accountCode, documentCode => $
documentCode, notes => $notes,
);
};
if ($@) {

sPostNotes: $@\n";

atement
import time

ApiException

'

class
le # String |
mple # String |
notes = # array[NotePost] |
(optional)
US)
l) (default to 1.0)
try:
# Create document notes for

an specific document and accoun
t code.
.notes_post_notes(accountCode,
documentCode, notes, authorizat
piVersion)

esPostNotes: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Required
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
notes * [
undefined
Responses
Status: 200 - OK
• Schema
{
}
AccountDocuments
accountDocumentsDelete
DocumentAsync
Delete a document.
/api/Documents/{documentCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

st:44356/api/Documents/{documen
tCode}"
;
*;
countDocumentsApi;
import java.util.*;
public class AccountDocumentsAp

iExample {

ing[] args) {
ient();

uth2

("oauth2");
AccountDocumentsApi api
Instance = new AccountDocuments
Api();
| Document code.
g | access token

i-Version
try {
Object result = api

Instance.accountDocumentsDelete
DocumentAsync(documentCode, aut
Version);
System.out.println(
result);
) {
System.err.println(
DocumentsApi#accountDocumentsDe
leteDocumentAsync");
e.printStackTrace()
;
countDocumentsApi;
iExample {

ing[] args) {
Api();
| Document code.
g | access token

i-Version
try {
Object result = api

Instance.accountDocumentsDelete
DocumentAsync(documentCode, aut
Version);
System.out.println(
result);
) {
System.err.println(
DocumentsApi#accountDocumentsDe
leteDocumentAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

Code_example; // Document code.

(optional)

-US)
AccountDocumentsApi *apiInstanc
e = [[AccountDocumentsApi alloc
] init];
// Delete a document.
[apiInstance accountDocumentsDe
leteDocumentAsyncWith:documentC
ode
ge
completionHandler
or) {
if
(output) {
if
(error) {

}
}];





SS TOKEN"

ccountDocumentsApi()

_example; // {String} Document
code.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.accountDocumentsDeleteDocum
entAsync(documentCode, opts, ca
llback);
using System;
namespace Example
public class accountDocumen

tsDeleteDocumentAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew AccountDocumentsApi();
var documentCode =
g | Document code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Delete a doc
ument.
Object result =
apiInstance.accountDocumentsDel
eteDocumentAsync(documentCode,
apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
umentsApi.accountDocumentsDelet
eDocumentAsync: " + e.Message )
;
}
<?php
/autoload.php');


ent\Api\AccountDocumentsApi();
ample; // String | Document cod
e.
en
anguage
try {
$result = $api_instance->ac
countDocumentsDeleteDocumentAsy
nc($documentCode, $authorizatio
n, $acceptLanguage, $apiVersion
);
print_r($result);

g AccountDocumentsApi->accountD
ocumentsDeleteDocumentAsync: ',
$e->getMessage(), PHP_EOL;
?>
use Data::Dumper;
ration;
DocumentsApi;

S_TOKEN';
Client::AccountDocumentsApi->ne
w();
_example; # String | Document c
ode.
oken
-Language
eval {
>accountDocumentsDeleteDocument
Async(documentCode => $document
Code, authorization => $authori
zation, acceptLanguage => $acce
ptLanguage, apiVersion => $apiV
ersion);
};
if ($@) {

ocumentsDeleteDocumentAsync: $@
\n";

atement
import time
ApiException

'

class
mple # String | Document code.
(optional)
US)
l) (default to 1.0)
try:
# Delete a document.
.account_documents_delete_docum
ent_async(documentCode, authori
zation=authorization, acceptLan
guage=acceptLanguage, apiVersio
n=apiVersion)

ng AccountDocumentsApi->account
DocumentsDeleteDocumentAsync: %
s\n" % e)
Parameters
Path parameters
Name Description
Document code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
accountDocumentsGetAll
Get all the documents for a specific
account.
uments
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

}/Documents?culture=&filters="
;
*;
countDocumentsApi;
import java.util.*;

iExample {

ing[] args) {
ient();

uth2

("oauth2");
Api();
Account code.
g | access token

i-Version
String culture = cultur

e_example; // String | Culture,
not required, but if present, i
t must be a valid culture. If n
ot specified,
the defa
ult culture will be used.

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
CollectionResponse.
AccountDocumentDto result = api
Instance.accountDocumentsGetAll
(accountCode, authorization, ac
ceptLanguage, apiVersion, cultu
re, filters);
System.out.println(
result);
) {
System.err.println(
DocumentsApi#accountDocumentsGe
tAll");
e.printStackTrace()
;
countDocumentsApi;

iExample {

ing[] args) {
Api();
Account code.
g | access token

i-Version

ot specified,
the defa

s
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
CollectionResponse.
AccountDocumentDto result = api
Instance.accountDocumentsGetAll
re, filters);
System.out.println(
result);
) {
System.err.println(
tAll");
e.printStackTrace()
;
}

R_ACCESS_TOKEN"];

de_example; // Account code.

(optional)

-US)

String *culture = culture_examp

le; // Culture, not required, b
ut if present, it must be a val
id culture. If not specified,
the defa
ult culture will be used. (opti
onal) (default to en-US)

le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
] init];
// Get all the documents for a

specific account.
[apiInstance accountDocumentsGe
tAllWith:accountCode
ge
culture:culture
filters:filters
completionHandler
: ^(CollectionResponse.AccountD
ocumentDto output, NSError* err
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"


xample; // {String} Account cod
e.
var opts = {
oken
-Language
'culture': culture_example, /
/ {String} Culture, not require
d, but if present, it must be a
valid culture. If not specified
,
the defa
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
}
};
api.accountDocumentsGetAll(acco
untCode, opts, callback);
using System;
namespace Example

tsGetAllExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var accountCode = a
| Account code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

re_example; // String | Cultur
e, not required, but if present
, it must be a valid culture. I
f not specified,
the defa
var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get all the

documents for a specific accoun
t.
CollectionRespo
nse.AccountDocumentDto result =
apiInstance.accountDocumentsGet
All(accountCode, authorization,
acceptLanguage, apiVersion, cul
ture, filters);
Debug.WriteLine
(result);
catch (Exception e)
{
Debug.Print("Ex
umentsApi.accountDocumentsGetAl
l: " + e.Message );
<?php
/autoload.php');


ple; // String | Account code.
en
anguage
$culture = culture_example; //
String | Culture, not required,
but if present, it must be a va
lid culture. If not specified,
the defa
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
countDocumentsGetAll($accountCo
de, $authorization, $acceptLang
uage, $apiVersion, $culture, $f
ilters);
print_r($result);

ocumentsGetAll: ', $e->getMessa
ge(), PHP_EOL;
?>
use Data::Dumper;
ration;
DocumentsApi;

S_TOKEN';
w();
xample; # String | Account code
.
oken
-Language
my $culture = culture_example;
# String | Culture, not require
,
the defa
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>accountDocumentsGetAll(account
Code => $accountCode, authoriza
Version => $apiVersion, culture
=> $culture, filters => $filter
s);
};
if ($@) {

ocumentsGetAll: $@\n";

atement
import time
ApiException

'

class
le # String | Account code.
(optional)
US)
l) (default to 1.0)
culture = culture_example # Str

ing | Culture, not required, bu
t if present, it must be a vali
d culture. If not specified,
the defa

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get all the documents for

a specific account.
.account_documents_get_all(acco
untCode, authorization=authoriz
ation, acceptLanguage=acceptLan
guage, apiVersion=apiVersion, c
ulture=culture, filters=filters
)

DocumentsGetAll: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String
Culture, not required, but if present, it must be a valid culture. If

not specified, the default culture will be used.
filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
Collection response to be used by
Mediator
TotalCount:
integer (int32)
Total count
Items:
[
Items
{
Account document.
Code:
string
Document code.
DocumentType:
string
Document type.
DocumentOption:
string
Document option.
AppliedDate:
string (date-time)
Applied date.
EffectiveDate:
string (date-time)
Effective date.
ExpirationDate:
string (date-time)
Expiration date.
DocumentStatus:
string
Document status.
DocumentAdditionalStatus:
string
Document additional status.
}
]
}
accountDocumentsGetDoc
umentByCode
Get a document by code.
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Documents/{documentCo
de}?culture="
;
*;
countDocumentsApi;
import java.util.*;

iExample {

ing[] args) {
ient();

uth2

("oauth2");
Api();
| Document Code.
g | access token

i-Version

ot specified,
the defa
try {
AccountDocumentDto
result = apiInstance.accountDoc
umentsGetDocumentByCode(documen
tCode, authorization, acceptLan
guage, apiVersion, culture);
System.out.println(
result);
) {
System.err.println(
tDocumentByCode");
e.printStackTrace()
;
}
countDocumentsApi;

iExample {

ing[] args) {
Api();
| Document Code.
g | access token

i-Version

ot specified,
the defa
try {
AccountDocumentDto
result = apiInstance.accountDoc
umentsGetDocumentByCode(documen
System.out.println(
result);
) {
System.err.println(
tDocumentByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

Code_example; // Document Code.

(optional)

-US)


the defa
] init];
// Get a document by code.
[apiInstance accountDocumentsGe
tDocumentByCodeWith:documentCod
e
ge
culture:culture
completionHandler
: ^(AccountDocumentDto output,
NSError* error) {
if
(output) {
if
(error) {
}];




SS TOKEN"


_example; // {String} Document
Code.
var opts = {
oken
-Language
'culture': culture_example //
{String} Culture, not required,
the defa
};
data, response) {
if (error) {
} else {

ata);
};
api.accountDocumentsGetDocument
ByCode(documentCode, opts, call
back);
using System;
namespace Example

tsGetDocumentByCodeExample
{
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var documentCode =
g | Document Code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get a docume
nt by code.
AccountDocument
Dto result = apiInstance.accoun
tDocumentsGetDocumentByCode(doc
umentCode, authorization, accep
tLanguage, apiVersion, culture)
;
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
umentsApi.accountDocumentsGetDo
cumentByCode: " + e.Message );
}
<?php
/autoload.php');


ample; // String | Document Cod
e.
en
anguage
the defa
try {
countDocumentsGetDocumentByCode
($documentCode, $authorization,
$acceptLanguage, $apiVersion, $
culture);
print_r($result);

ocumentsGetDocumentByCode: ', $
e->getMessage(), PHP_EOL;
?>
use Data::Dumper;
ration;
DocumentsApi;

S_TOKEN';
w();
_example; # String | Document C
ode.
oken
-Language
,
the defa
eval {
>accountDocumentsGetDocumentByC
ode(documentCode => $documentCo
de, authorization => $authoriza
tion, acceptLanguage => $accept
Language, apiVersion => $apiVer
sion, culture => $culture);
};
if ($@) {

ocumentsGetDocumentByCode: $@\n
";

atement
import time

ApiException

'

class
mple # String | Document Code.
(optional)
US)
l) (default to 1.0)

the defa
try:
# Get a document by code.
.account_documents_get_document
_by_code(documentCode, authoriz
ation=authorization, acceptLang
uage=acceptLanguage, apiVersion
=apiVersion, culture=culture)

DocumentsGetDocumentByCode: %s\
n" % e)
Parameters
Path parameters
Name Description
Document Code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String

Responses
Status: 200 - OK
• Schema
{
Account document.
Code:
string
Document code.
DocumentType:
string
Document type.
DocumentOption:
string
Document option.
AppliedDate:
string (date-time)
Applied date.
EffectiveDate:
string (date-time)
Effective date.
ExpirationDate:
string (date-time)
Expiration date.
DocumentStatus:
string
Document status.
string
Document additional status.
}
accountDocumentsPatchA
sync
Patch a document entry.
Provide only the fields to modify.
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Documents/{document
Code}"
;
*;
countDocumentsApi;
import java.util.*;

iExample {

ing[] args) {
ient();

uth2

("oauth2");
Api();
| The account document of the e
ntry to patch.
AccountDocumentPatch do
cumentPatch = ; // AccountDocum
entPatch | The subset of docume
nt fields to patch.
g | access token

i-Version
try {
Object result = api

Instance.accountDocumentsPatchA
sync(documentCode, documentPatc
h, authorization, acceptLanguag
e, apiVersion);
System.out.println(
result);
) {
System.err.println(
DocumentsApi#accountDocumentsPa
tchAsync");
e.printStackTrace()
;
}
countDocumentsApi;

iExample {

ing[] args) {
Api();
| The account document of the e
ntry to patch.
AccountDocumentPatch do
cumentPatch = ; // AccountDocum
nt fields to patch.
g | access token
i-Version
try {
Object result = api

Instance.accountDocumentsPatchA
sync(documentCode, documentPatc
h, authorization, acceptLanguag
e, apiVersion);
System.out.println(
result);
) {
System.err.println(
DocumentsApi#accountDocumentsPa
tchAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

Code_example; // The account do
cument of the entry to patch.
AccountDocumentPatch *documentP
atch = ; // The subset of docum
ent fields to patch.

(optional)

-US)

] init];
// Patch a document entry.
[apiInstance accountDocumentsPa
tchAsyncWith:documentCode
documentPatch:documentPatch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"


_example; // {String} The accou
nt document of the entry to pat
ch.
var documentPatch = ; // {Accou

ntDocumentPatch} The subset of
document fields to patch.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.accountDocumentsPatchAsync(
documentCode, documentPatch, op
ts, callback);
using System;
namespace Example

tsPatchAsyncExample
public void main()
{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var documentCode =
g | The account document of the
entry to patch.
var documentPatch =
new AccountDocumentPatch(); //
AccountDocumentPatch | The subs
et of document fields to patch.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
{
// Patch a docu
ment entry.
Object result =
apiInstance.accountDocumentsPat
chAsync(documentCode, documentP
atch, authorization, acceptLang
uage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
umentsApi.accountDocumentsPatch
Async: " + e.Message );
<?php
/autoload.php');


ample; // String | The account
document of the entry to patch.
$documentPatch = ; // AccountDo
cumentPatch | The subset of doc
ument fields to patch.
en
anguage
try {
countDocumentsPatchAsync($docum
entCode, $documentPatch, $autho
rization, $acceptLanguage, $api
Version);
print_r($result);

ocumentsPatchAsync: ', $e->getM
essage(), PHP_EOL;
?>
use Data::Dumper;
ration;
DocumentsApi;

S_TOKEN';
w();
_example; # String | The accoun
t document of the entry to patc
h.
my $documentPatch = WWW::Swagge
rClient::Object::AccountDocumen
tPatch->new(); # AccountDocumen
tPatch | The subset of document
fields to patch.
oken
-Language
eval {
>accountDocumentsPatchAsync(doc
umentCode => $documentCode, doc
umentPatch => $documentPatch, a
uthorization => $authorization,
acceptLanguage => $acceptLangua
ge, apiVersion => $apiVersion);
};
if ($@) {

ocumentsPatchAsync: $@\n";

atement
import time
ApiException

'

class
mple # String | The account doc
ument of the entry to patch.
documentPatch = # AccountDocum
nt fields to patch.
(optional)
US)
l) (default to 1.0)
try:
# Patch a document entry.
.account_documents_patch_async(
documentCode, documentPatch, au
thorization=authorization, acce
ptLanguage=acceptLanguage, apiV
ersion=apiVersion)

DocumentsPatchAsync: %s\n" % e)
Parameters
Path parameters
Name Description
The account document of the entry to patch.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
documentPatch * {
Subset of properties to update an Account title.

DocumentType:
DocumentType string maxLength:50
DocumentOption:
DocumentOption string maxLength:50
AppliedDate:
AppliedDate string (date-time)
EffectiveDate:
EffectiveDate string (date-time)
ExpirationDate:
ExpirationDate string (date-time)
DocumentStatus:
DocumentStatus string maxLength:50
DocumentAdditionalStatus string maxLength:50
}
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
accountDocumentsPost
Create an account document.
uments
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

e}/Documents"
;
*;
countDocumentsApi;
import java.util.*;

iExample {

ing[] args) {
ient();

uth2

("oauth2");
Api();
Account code.
AccountDocumentPost acc
ountDocument = ; // AccountDocu
mentPost | Account document.
g | access token

i-Version
try {
apiInstance.account
DocumentsPost(accountCode, acco
untDocument, authorization, acc
eptLanguage, apiVersion);
) {
System.err.println(
DocumentsApi#accountDocumentsPo
st");
e.printStackTrace()
;
}
}
countDocumentsApi;

iExample {

ing[] args) {
Api();
Account code.
AccountDocumentPost acc
ountDocument = ; // AccountDocu
mentPost | Account document.
g | access token

i-Version
try {
apiInstance.account
DocumentsPost(accountCode, acco
untDocument, authorization, acc
) {
System.err.println(
DocumentsApi#accountDocumentsPo
st");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

AccountDocumentPost *accountDoc
ument = ; // Account document.
(optional)

-US)

] init];
// Create an account document.
[apiInstance accountDocumentsPo
stWith:accountCode
accountDocument:accountDocu
ment
ge
completionHandler
: ^(NSError* error) {
if
(error) {
}];





SS TOKEN"


e.
var accountDocument = ; // {Acc

ountDocumentPost} Account docum
ent.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

cessfully.');
};
api.accountDocumentsPost(accoun
tCode, accountDocument, opts, c
allback);
using System;
namespace Example

tsPostExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var accountCode = a
| Account code.
var accountDocument
= new AccountDocumentPost(); //
AccountDocumentPost | Account d
ocument.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create an ac
count document.
apiInstance.acc
ountDocumentsPost(accountCode,
accountDocument, authorization,
acceptLanguage, apiVersion);
catch (Exception e)
Debug.Print("Ex
umentsApi.accountDocumentsPost:
" + e.Message );
}
}
<?php
/autoload.php');


$accountDocument = ; // Account
DocumentPost | Account document
.
en
anguage
try {
$api_instance->accountDocum
entsPost($accountCode, $account
Document, $authorization, $acce
ptLanguage, $apiVersion);

ocumentsPost: ', $e->getMessage
(), PHP_EOL;
?>
use Data::Dumper;
ration;
DocumentsApi;

S_TOKEN';
w();
.
my $accountDocument = WWW::Swag
gerClient::Object::AccountDocum
entPost->new(); # AccountDocume
ntPost | Account document.
oken
-Language
eval {
$api_instance->accountDocum
entsPost(accountCode => $accoun
tCode, accountDocument => $acco
untDocument, authorization => $
authorization, acceptLanguage =
> $acceptLanguage, apiVersion =
> $apiVersion);
};
if ($@) {

ocumentsPost: $@\n";
}
atement
import time

ApiException

'

class
accountDocument = # AccountDoc
umentPost | Account document.
(optional)
US)
l) (default to 1.0)
try:
# Create an account documen

t.
api_instance.account_docume
nts_post(accountCode, accountDo
cument, authorization=authoriza
tion, acceptLanguage=acceptLang
uage, apiVersion=apiVersion)

DocumentsPost: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
accountDocument AccountDocumentPost {
*
Account document.
Required:
DocumentAdditionalStatus,DocumentOption,DocumentStatus,DocumentType
DocumentType:
DocumentType string maxLength:50
DocumentOption:
DocumentOption string maxLength:50
AppliedDate:
AppliedDate string (date-time)
EffectiveDate:
ExpirationDate:
ExpirationDate string (date-time)
DocumentStatus:
DocumentStatus string maxLength:50
DocumentAdditionalStatus string maxLength:50
}
Responses
Status: 200 - Returns
the location response
header with the new
resource
AccountNotebooks
accountNotebooksGetAll
Get all the notebook notes for a
specific account.
/api/Accounts/{accountCode}/Not
ebooks
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
}/Notebooks?culture=&filters="
;
*;
countNotebooksApi;
import java.util.*;
public class AccountNotebooksAp

iExample {

ing[] args) {
ient();

uth2
("oauth2");
AccountNotebooksApi api
Instance = new AccountNotebooks
Api();
Account code.
g | access token

i-Version

ot specified,
the defa

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
CollectionResponse.
AccountNotebookDto result = api
Instance.accountNotebooksGetAll
re, filters);
System.out.println(
result);
) {
System.err.println(
NotebooksApi#accountNotebooksGe
tAll");
e.printStackTrace()
;
countNotebooksApi;

iExample {

ing[] args) {
Api();
Account code.
g | access token

i-Version
ot specified,
the defa

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
CollectionResponse.
AccountNotebookDto result = api
Instance.accountNotebooksGetAll
re, filters);
System.out.println(
result);
) {
System.err.println(
tAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

(optional)

-US)


the defa

le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
AccountNotebooksApi *apiInstanc
e = [[AccountNotebooksApi alloc
] init];
// Get all the notebook notes f

or a specific account.
[apiInstance accountNotebooksGe
tAllWith:accountCode
ge
culture:culture
filters:filters
completionHandler
: ^(CollectionResponse.AccountN
otebookDto output, NSError* err
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"

ccountNotebooksApi()

e.
var opts = {
oken
-Language
,
the defa
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.accountNotebooksGetAll(acco
untCode, opts, callback);
using System;
namespace Example
public class accountNoteboo

ksGetAllExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew AccountNotebooksApi();
var accountCode = a
| Account code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get all the

notebook notes for a specific a
ccount.
CollectionRespo
nse.AccountNotebookDto result =
apiInstance.accountNotebooksGet
All(accountCode, authorization,
ture, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling AccountNot
ebooksApi.accountNotebooksGetAl
l: " + e.Message );
}
<?php
/autoload.php');


ent\Api\AccountNotebooksApi();
en
anguage
the defa
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
countNotebooksGetAll($accountCo
uage, $apiVersion, $culture, $f
ilters);
print_r($result);

g AccountNotebooksApi->accountN
otebooksGetAll: ', $e->getMessa
ge(), PHP_EOL;
?>
use Data::Dumper;
ration;
NotebooksApi;

S_TOKEN';
Client::AccountNotebooksApi->ne
w();
.
oken
-Language
,
the defa
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>accountNotebooksGetAll(account
Code => $accountCode, authoriza
Version => $apiVersion, culture
=> $culture, filters => $filter
s);
};
if ($@) {

otebooksGetAll: $@\n";

atement
import time

ApiException

'
class
(optional)
US)
l) (default to 1.0)

the defa

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get all the notebook note

s for a specific account.
.account_notebooks_get_all(acco
untCode, authorization=authoriz
guage, apiVersion=apiVersion, c
ulture=culture, filters=filters
)

ng AccountNotebooksApi->account
NotebooksGetAll: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String

filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
Mediator
TotalCount:
integer (int32)
Total count
Items:
[
Items
{
Account notebook.
Code:
string
Notebook code.
User:
string
User code.
Note:
string
Note.
External:
boolean
External flag.
NoteType:
string
Note type.
Subject:
string
Note subject.
ModifiedDate:
string (date-time)
Modified Date.
}
]
}
accountNotebooksGetNot
ebookByCode
Get a notebook note by code.
/api/Notebooks/{notebookCode}
Usage and SDK
Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Notebooks/{notebookCo
de}?culture="
;
*;
countNotebooksApi;
import java.util.*;

iExample {
ing[] args) {
ient();

uth2

("oauth2");
Api();
String notebookCode = n
otebookCode_example; // String
| Notebook Code.
g | access token

i-Version
ot specified,
the defa
try {
AccountNotebookDto
result = apiInstance.accountNot
ebooksGetNotebookByCode(noteboo
kCode, authorization, acceptLan
System.out.println(
result);
) {
System.err.println(
tNotebookByCode");
e.printStackTrace()
;
countNotebooksApi;
iExample {

ing[] args) {
Api();
String notebookCode = n
otebookCode_example; // String
| Notebook Code.
g | access token

i-Version

ot specified,
the defa
try {
AccountNotebookDto
result = apiInstance.accountNot
ebooksGetNotebookByCode(noteboo
kCode, authorization, acceptLan
System.out.println(
result);
) {
System.err.println(
tNotebookByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
String *notebookCode = notebook

Code_example; // Notebook Code.
(optional)

-US)


the defa
] init];
// Get a notebook note by code.
[apiInstance accountNotebooksGe
tNotebookByCodeWith:notebookCod
e
ge
culture:culture
completionHandler
: ^(AccountNotebookDto output,
NSError* error) {
if
(output) {
if
(error) {
}];





SS TOKEN"
var notebookCode = notebookCode

_example; // {String} Notebook
Code.
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.accountNotebooksGetNotebook
ByCode(notebookCode, opts, call
back);
using System;
namespace Example

ksGetNotebookByCodeExample
public void main()
{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var notebookCode =
notebookCode_example; // Strin
g | Notebook Code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get a notebo
ok note by code.
AccountNotebook
Dto result = apiInstance.accoun
tNotebooksGetNotebookByCode(not
ebookCode, authorization, accep
tLanguage, apiVersion, culture)
;
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ebooksApi.accountNotebooksGetNo
tebookByCode: " + e.Message );
<?php
/autoload.php');

$notebookCode = notebookCode_ex
ample; // String | Notebook Cod
e.
en
anguage
the defa
try {
countNotebooksGetNotebookByCode
($notebookCode, $authorization,
culture);
print_r($result);

otebooksGetNotebookByCode: ', $
?>
use Data::Dumper;
ration;
NotebooksApi;

S_TOKEN';
w();
my $notebookCode = notebookCode
_example; # String | Notebook C
ode.
oken
-Language
,
the defa
eval {
>accountNotebooksGetNotebookByC
ode(notebookCode => $notebookCo
sion, culture => $culture);
};
if ($@) {

otebooksGetNotebookByCode: $@\n
";
}

atement
import time

ApiException

'

class
notebookCode = notebookCode_exa
mple # String | Notebook Code.
(optional)
US)
l) (default to 1.0)

the defa
try:
# Get a notebook note by co

de.
.account_notebooks_get_notebook
_by_code(notebookCode, authoriz
ation=authorization, acceptLang
uage=acceptLanguage, apiVersion
=apiVersion, culture=culture)

NotebooksGetNotebookByCode: %s\
n" % e)
Parameters
Path parameters
Name Description
notebookCode* String
Notebook Code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String

Responses
Status: 200 - OK
• Schema
{
Account notebook.
Code:
string
Notebook code.
User:
string
User code.
Note:
string
Note.
External:
boolean
External flag.
NoteType:
string
Note type.
Subject:
string
Note subject.
ModifiedDate:
string (date-time)
Modified Date.
}
accountNotebooksPost
Create an account notebook note.
/api/Accounts/{accountCode}/Not
ebooks
Usage and SDK
Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

e}/Notebooks"
;
*;
countNotebooksApi;
import java.util.*;

iExample {
ing[] args) {
ient();

uth2

("oauth2");
Api();
Account code.
AccountNotebookPost acc
ountNotebook = ; // AccountNote
bookPost | Account notebook.
g | access token
i-Version
try {
apiInstance.account
NotebooksPost(accountCode, acco
untNotebook, authorization, acc
) {
System.err.println(
NotebooksApi#accountNotebooksPo
st");
e.printStackTrace()
;
countNotebooksApi;

iExample {

ing[] args) {
Api();
Account code.
AccountNotebookPost acc
ountNotebook = ; // AccountNote
bookPost | Account notebook.
g | access token

i-Version
try {
apiInstance.account
NotebooksPost(accountCode, acco
untNotebook, authorization, acc
) {
System.err.println(
NotebooksApi#accountNotebooksPo
st");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];

AccountNotebookPost *accountNot
ebook = ; // Account notebook.

(optional)

-US)

] init];
// Create an account notebook n
ote.
[apiInstance accountNotebooksPo
stWith:accountCode
accountNotebook:accountNote
book
ge
completionHandler
if
(error) {
}];




SS TOKEN"


e.
var accountNotebook = ; // {Acc

ountNotebookPost} Account noteb
ook.
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

cessfully.');
};
api.accountNotebooksPost(accoun
tCode, accountNotebook, opts, c
allback);
using System;
namespace Example

ksPostExample
public void main()

{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var accountCode = a
| Account code.
var accountNotebook
= new AccountNotebookPost(); //
AccountNotebookPost | Account n
otebook.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
{
// Create an ac
count notebook note.
apiInstance.acc
ountNotebooksPost(accountCode,
accountNotebook, authorization,
catch (Exception e)
Debug.Print("Ex
ebooksApi.accountNotebooksPost:
" + e.Message );
<?php
/autoload.php');

$accountNotebook = ; // Account
NotebookPost | Account notebook
.
en
anguage
try {
$api_instance->accountNoteb
ooksPost($accountCode, $account
Notebook, $authorization, $acce

otebooksPost: ', $e->getMessage
(), PHP_EOL;
?>
use Data::Dumper;
ration;
NotebooksApi;

S_TOKEN';
w();
.
my $accountNotebook = WWW::Swag
gerClient::Object::AccountNoteb
ookPost->new(); # AccountNotebo
okPost | Account notebook.
oken
-Language
eval {
$api_instance->accountNoteb
ooksPost(accountCode => $accoun
tCode, accountNotebook => $acco
untNotebook, authorization => $
> $apiVersion);
};
if ($@) {

otebooksPost: $@\n";

atement
import time

ApiException

'
class
accountNotebook = # AccountNot
ebookPost | Account notebook.
(optional)
US)
l) (default to 1.0)
try:
# Create an account noteboo

k note.
api_instance.account_notebo
oks_post(accountCode, accountNo
tebook, authorization=authoriza
NotebooksPost: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
accountNotebook AccountNotebookPost {
*
Account document.
Required: External,NoteType
User:
User string maxLength:50
Note:
Note string maxLength:4000
External:
External boolean
NoteType:
NoteType string maxLength:50
}
Responses

header with the new
resource
AccountPhoneNumbers
accountPhonesGetAll
Get all the phones for an specific
account.
/api/Accounts/{accountCode}/Pho
neNumbers
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

}/PhoneNumbers?culture="
;
*;
countPhoneNumbersApi;
import java.util.*;
public class AccountPhoneNumber

sApiExample {

ing[] args) {
ient();

uth2

("oauth2");
AccountPhoneNumbersApi
apiInstance = new AccountPhoneN
umbersApi();
Account code.
g | access token

i-Version

ot specified,
the defa
try {
CollectionResponse.
AccountPhoneDto result = apiIns
tance.accountPhonesGetAll(accou
ntCode, authorization, acceptLa
nguage, apiVersion, culture);
System.out.println(
result);
) {
System.err.println(
PhoneNumbersApi#accountPhonesGe
tAll");
e.printStackTrace()
;

sApiExample {
ing[] args) {
umbersApi();
Account code.
g | access token

i-Version

ot specified,
the defa
try {
CollectionResponse.
AccountPhoneDto result = apiIns
tance.accountPhonesGetAll(accou
ntCode, authorization, acceptLa
nguage, apiVersion, culture);
System.out.println(
result);
) {
System.err.println(
tAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];


(optional)
-US)


the defa
AccountPhoneNumbersApi *apiInst
ance = [[AccountPhoneNumbersApi
alloc] init];
// Get all the phones for an sp

ecific account.
[apiInstance accountPhonesGetAl
lWith:accountCode
ge
culture:culture
completionHandler
: ^(CollectionResponse.AccountP
honeDto output, NSError* error)
{
if
(output) {
if
(error) {
}];





SS TOKEN"

ccountPhoneNumbersApi()
e.
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {
ata);
};
api.accountPhonesGetAll(account
Code, opts, callback);
using System;
namespace Example
public class accountPhonesG

etAllExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew AccountPhoneNumbersApi();
var accountCode = a
| Account code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
{
// Get all the
phones for an specific account.
CollectionRespo
nse.AccountPhoneDto result = ap
iInstance.accountPhonesGetAll(a
ccountCode, authorization, acce
ptLanguage, apiVersion, culture
);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling AccountPho
neNumbersApi.accountPhonesGetAl
l: " + e.Message );
<?php
/autoload.php');


ent\Api\AccountPhoneNumbersApi(
);
en
anguage
the defa
try {
countPhonesGetAll($accountCode,
$authorization, $acceptLanguage
, $apiVersion, $culture);
print_r($result);

g AccountPhoneNumbersApi->accou
ntPhonesGetAll: ', $e->getMessa
ge(), PHP_EOL;
?>
use Data::Dumper;
ration;
PhoneNumbersApi;

S_TOKEN';
Client::AccountPhoneNumbersApi-
>new();
.
oken
-Language
,
the defa
eval {
>accountPhonesGetAll(accountCod
e => $accountCode, authorizatio
n => $authorization, acceptLang
uage => $acceptLanguage, apiVer
sion => $apiVersion, culture =>
$culture);
};
if ($@) {

ntPhonesGetAll: $@\n";

atement
import time

ApiException

'

class
(optional)
US)
l) (default to 1.0)
the defa
try:
# Get all the phones for an

specific account.
.account_phones_get_all(account
Code, authorization=authorizati
on, acceptLanguage=acceptLangua
ge, apiVersion=apiVersion, cult
ure=culture)

ng AccountPhoneNumbersApi->acco
untPhonesGetAll: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String

Responses
Status: 200 - OK
• Schema
{
Mediator
TotalCount:
integer (int32)
Total count
Items:
[
Items
{
Account Phone Dto.
AccountCode:
string
Account code.
Code:
string
Phone code.
Number:
string
Title group code.
NumericPhoneNumber:
string
Numeric phone number.
PhoneNumberType:
string
Phone number type.
Primary:
boolean
Is it the primary number?
}
]
}
accountPhonesGetByCode
Get an account phone by code.
/api/PhoneNumbers/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/PhoneNumbers/{code}?c
ulture="
;
*;
import java.util.*;
sApiExample {

ing[] args) {
ient();

uth2

("oauth2");
umbersApi();

ple; // String | Phone Code.
g | access token
i-Version

ot specified,
the defa
try {
AccountPhoneDto res
ult = apiInstance.accountPhones
GetByCode(code, authorization,
ture);
System.out.println(
result);
) {
System.err.println(
tByCode");
e.printStackTrace()
;
}

sApiExample {

ing[] args) {
umbersApi();

ple; // String | Phone Code.
g | access token

i-Version

ot specified,
the defa
try {
AccountPhoneDto res
ult = apiInstance.accountPhones
GetByCode(code, authorization,
ture);
System.out.println(
result);
) {
System.err.println(
tByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

Phone Code.
(optional)

-US)


the defa
alloc] init];
// Get an account phone by code

.
[apiInstance accountPhonesGetBy
CodeWith:code
ge
culture:culture
completionHandler
: ^(AccountPhoneDto output, NSE
rror* error) {
if
(output) {
if
(error) {
}];





SS TOKEN"

ring} Phone Code.
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {
ata);
};
api.accountPhonesGetByCode(code
, opts, callback);
using System;
namespace Example
public class accountPhonesG

etByCodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var code = code_exa

mple; // String | Phone Code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
{
// Get an accou
nt phone by code.
AccountPhoneDto
result = apiInstance.accountPho
nesGetByCode(code, authorizatio
n, acceptLanguage, apiVersion,
culture);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
neNumbersApi.accountPhonesGetBy
Code: " + e.Message );
<?php
/autoload.php');


);

| Phone Code.
en
anguage
the defa
try {
countPhonesGetByCode($code, $au
thorization, $acceptLanguage, $
apiVersion, $culture);
print_r($result);

ntPhonesGetByCode: ', $e->getMe
ssage(), PHP_EOL;
?>
use Data::Dumper;
ration;
PhoneNumbersApi;

S_TOKEN';
>new();

ng | Phone Code.
oken
-Language
,
the defa
eval {
>accountPhonesGetByCode(code =>
$code, authorization => $author
ization, acceptLanguage => $acc
eptLanguage, apiVersion => $api
Version, culture => $culture);
};
if ($@) {

ntPhonesGetByCode: $@\n";

atement
import time

ApiException

'

class

Phone Code.
(optional)
US)
l) (default to 1.0)
the defa
try:
# Get an account phone by c

ode.
.account_phones_get_by_code(cod
e, authorization=authorization,
acceptLanguage=acceptLanguage,
apiVersion=apiVersion, culture=
culture)

untPhonesGetByCode: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Phone Code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String

Responses
Status: 200 - OK
• Schema
{
Account Phone Dto.
AccountCode:
string
Account code.
Code:
string
Phone code.
Number:
string
Title group code.
NumericPhoneNumber:
string
Numeric phone number.
PhoneNumberType:
string
Phone number type.
Primary:
boolean
Is it the primary number?
}
accountPhonesPatchAsyn
c
Patch an account phone number
entry.
Provide only the fields to modify.
/api/PhoneNumbers/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/PhoneNumbers/{code}
"
;
*;
import java.util.*;

sApiExample {

ing[] args) {
ient();

uth2

("oauth2");
umbersApi();

ple; // String | The account ph
one number of the entry to patc
h.
AccountPhonePatch accou
ntPhonePatch = ; // AccountPhon
ePatch | The subset of account
phone fields to patch.
g | access token
i-Version
try {
Object result = api

Instance.accountPhonesPatchAsyn
c(code, accountPhonePatch, auth
ersion);
System.out.println(
result);
) {
System.err.println(
PhoneNumbersApi#accountPhonesPa
tchAsync");
e.printStackTrace()
;

sApiExample {
ing[] args) {
umbersApi();

ple; // String | The account ph
one number of the entry to patc
h.
AccountPhonePatch accou
ntPhonePatch = ; // AccountPhon
ePatch | The subset of account
phone fields to patch.
g | access token

i-Version
try {
Object result = api

Instance.accountPhonesPatchAsyn
c(code, accountPhonePatch, auth
ersion);
System.out.println(
result);
) {
System.err.println(
PhoneNumbersApi#accountPhonesPa
tchAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

The account phone number of the
entry to patch.
AccountPhonePatch *accountPhone
Patch = ; // The subset of acco
unt phone fields to patch.

(optional)

-US)

alloc] init];
// Patch an account phone numbe

r entry.
[apiInstance accountPhonesPatch
AsyncWith:code
accountPhonePatch:accountPh
onePatch
ge
completionHandler
or) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"


ring} The account phone number
of the entry to patch.
var accountPhonePatch = ; // {A
ccountPhonePatch} The subset of
account phone fields to patch.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.accountPhonesPatchAsync(cod
e, accountPhonePatch, opts, cal
lback);
using System;
namespace Example
public class accountPhonesP

atchAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var code = code_exa

mple; // String | The account
phone number of the entry to pa
tch.
var accountPhonePat
ch = new AccountPhonePatch(); /
/ AccountPhonePatch | The subse
t of account phone fields to pa
tch.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch an acc
ount phone number entry.
Object result =
apiInstance.accountPhonesPatchA
sync(code, accountPhonePatch, a
piVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
neNumbersApi.accountPhonesPatch
Async: " + e.Message );
<?php
/autoload.php');


);
| The account phone number of t
he entry to patch.
$accountPhonePatch = ; // Accou
ntPhonePatch | The subset of ac
count phone fields to patch.
en
anguage
try {
countPhonesPatchAsync($code, $a
ccountPhonePatch, $authorizatio
);
print_r($result);

ntPhonesPatchAsync: ', $e->getM
essage(), PHP_EOL;
?>
use Data::Dumper;
ration;
PhoneNumbersApi;

S_TOKEN';
>new();

ng | The account phone number o
f the entry to patch.
my $accountPhonePatch = WWW::Sw
aggerClient::Object::AccountPho
nePatch->new(); # AccountPhoneP
atch | The subset of account ph
one fields to patch.
oken
-Language
eval {
>accountPhonesPatchAsync(code =
> $code, accountPhonePatch => $
accountPhonePatch, authorizatio
sion => $apiVersion);
};
if ($@) {

ntPhonesPatchAsync: $@\n";

atement
import time

ApiException

'

class

The account phone number of the
entry to patch.
accountPhonePatch = # AccountP
honePatch | The subset of accou
nt phone fields to patch.
(optional)
US)
l) (default to 1.0)
try:
# Patch an account phone nu

mber entry.
.account_phones_patch_async(cod
e, accountPhonePatch, authoriza
tion=authorization, acceptLangu
age=acceptLanguage, apiVersion=
apiVersion)

untPhonesPatchAsync: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
The account phone number of the entry to patch.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
accountPhonePatch AccountPhonePost {
*
Account Phone Patch Request Model.
Required: Number,Primary,Type
Type:
Type string maxLength:50
Number:
Number string maxLength:50
Primary:
Primary boolean
}
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
accountPhonesPost
Create a new account phone
/api/Accounts/{accountCode}/Pho
neNumbers
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

e}/PhoneNumbers"
;
*;
import java.util.*;

sApiExample {

ing[] args) {
ient();

uth2

("oauth2");
umbersApi();
Account code.
AccountPhonePost accoun
tPhone = ; // AccountPhonePost
| Account phone values
g | access token

i-Version
try {
apiInstance.account
PhonesPost(accountCode, account
Phone, authorization, acceptLan
guage, apiVersion);
) {
System.err.println(
PhoneNumbersApi#accountPhonesPo
st");
e.printStackTrace()
;
sApiExample {

ing[] args) {
umbersApi();
Account code.
AccountPhonePost accoun
tPhone = ; // AccountPhonePost
| Account phone values
g | access token

i-Version
try {
apiInstance.account
PhonesPost(accountCode, account
Phone, authorization, acceptLan
guage, apiVersion);
) {
System.err.println(
PhoneNumbersApi#accountPhonesPo
st");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

AccountPhonePost *accountPhone
= ; // Account phone values

(optional)

-US)
alloc] init];
// Create a new account phone
[apiInstance accountPhonesPostW
ith:accountCode
accountPhone:accountPhone
ge
completionHandler
if
(error) {
}];




SS TOKEN"


e.
var accountPhone = ; // {Accoun

tPhonePost} Account phone value
s
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

cessfully.');
};
api.accountPhonesPost(accountCo
de, accountPhone, opts, callbac
k);
using System;
namespace Example
{
public class accountPhonesP
ostExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var accountCode = a
| Account code.
var accountPhone =
new AccountPhonePost(); // Acco
untPhonePost | Account phone va
lues
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a new
account phone
apiInstance.acc
ountPhonesPost(accountCode, acc
ountPhone, authorization, accep
tLanguage, apiVersion);
catch (Exception e)
Debug.Print("Ex
neNumbersApi.accountPhonesPost:
" + e.Message );
<?php
/autoload.php');

);
$accountPhone = ; // AccountPho
nePost | Account phone values
en
anguage
try {
$api_instance->accountPhone
sPost($accountCode, $accountPho
ne, $authorization, $acceptLang
uage, $apiVersion);

ntPhonesPost: ', $e->getMessage
(), PHP_EOL;
?>
use Data::Dumper;
ration;
PhoneNumbersApi;

S_TOKEN';
>new();
.
my $accountPhone = WWW::Swagger
Client::Object::AccountPhonePos
t->new(); # AccountPhonePost |
Account phone values
oken
-Language
eval {
$api_instance->accountPhone
sPost(accountCode => $accountCo
de, accountPhone => $accountPho
ne, authorization => $authoriza
sion);
};
if ($@) {

ntPhonesPost: $@\n";

atement
import time

ApiException

'

class
accountPhone = # AccountPhoneP
ost | Account phone values
(optional)
US)
l) (default to 1.0)
try:
# Create a new account phon
e
api_instance.account_phones
_post(accountCode, accountPhone
, authorization=authorization,
apiVersion=apiVersion)

untPhonesPost: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
accountPhone * AccountPhonePost {
Phone Number request for Post method.

Required: Number,Primary,Type
Type:
Number:
Primary:
Primary boolean
}
Responses

header with the new
resource
AccountTitles
accountTitlesGetAll
Get all the titles for an specific
account.
/api/Accounts/{code}/Titles
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Accounts/{code}/Title
s?culture="
;
*;
countTitlesApi;
import java.util.*;
public class AccountTitlesApiEx
ample {

ing[] args) {
ient();

uth2

("oauth2");
AccountTitlesApi apiIns
tance = new AccountTitlesApi();

g | access token
i-Version

ot specified,
the defa
try {
CollectionResponse.
AccountTitleDto result = apiIns
tance.accountTitlesGetAll(code,
apiVersion, culture);
System.out.println(
result);
) {
System.err.println(
TitlesApi#accountTitlesGetAll")
;
e.printStackTrace()
;
}
countTitlesApi;

ample {

ing[] args) {

g | access token

i-Version

ot specified,
the defa
try {
CollectionResponse.
AccountTitleDto result = apiIns
tance.accountTitlesGetAll(code,
apiVersion, culture);
System.out.println(
result);
) {
System.err.println(
TitlesApi#accountTitlesGetAll")
;
e.printStackTrace()
;


R_ACCESS_TOKEN"];

Account code.
(optional)

-US)


the defa
AccountTitlesApi *apiInstance =
[[AccountTitlesApi alloc] init]
;
// Get all the titles for an sp

ecific account.
[apiInstance accountTitlesGetAl
lWith:code
ge
culture:culture
completionHandler
: ^(CollectionResponse.AccountT
itleDto output, NSError* error)
{
if
(output) {
if
(error) {
}];





SS TOKEN"
ccountTitlesApi()

ring} Account code.
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.accountTitlesGetAll(code, o
pts, callback);
using System;
namespace Example
public class accountTitlesG

etAllExample
public void main()
{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew AccountTitlesApi();
var code = code_exa

mple; // String | Account code
.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get all the

titles for an specific account.
CollectionRespo
nse.AccountTitleDto result = ap
iInstance.accountTitlesGetAll(c
ode, authorization, acceptLangu
age, apiVersion, culture);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling AccountTit
lesApi.accountTitlesGetAll: " +
e.Message );
<?php
/autoload.php');

ent\Api\AccountTitlesApi();

| Account code.
en
anguage
the defa
try {
countTitlesGetAll($code, $autho
Version, $culture);
print_r($result);

g AccountTitlesApi->accountTitl
esGetAll: ', $e->getMessage(),
PHP_EOL;
?>
use Data::Dumper;
ration;
TitlesApi;

S_TOKEN';
Client::AccountTitlesApi->new()
;

ng | Account code.
oken
-Language
,
the defa
eval {
>accountTitlesGetAll(code => $c
ode, authorization => $authoriz
ation, acceptLanguage => $accep
tLanguage, apiVersion => $apiVe
rsion, culture => $culture);
};
if ($@) {

esGetAll: $@\n";

atement
import time

ApiException

'

class
ccountTitlesApi()

Account code.
(optional)
US)
l) (default to 1.0)
the defa
try:
# Get all the titles for an

specific account.
.account_titles_get_all(code, a
uthorization=authorization, acc
eptLanguage=acceptLanguage, api
Version=apiVersion, culture=cul
ture)

ng AccountTitlesApi->accountTit
lesGetAll: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String

Responses
Status: 200 - OK
• Schema
{
Mediator
TotalCount:
integer (int32)
Total count
Items:
[
Items
{
Account title.
ActivityCenter:
string
Activity center code.
TitleCodeGroup:
string
Title group code.
TitleCode:
string
Title code.
TitleDate:
string (date-time)
Effective date.
Description:
string
Description.
Rank:
integer (int32)
Rank.
HighestRankDate:
string (date-time)
Highest (rank) title date
HighestRank:
integer (int32)
Highest (rank) title
}
]
}
accountTitlesPatch
Patch an account tile.
/api/Accounts/{code}/Titles/{ti
tleCodeGroup}/{titleCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Accounts/{code}/Tit
les/{titleCodeGroup}/{titleCode
}"
;
*;
countTitlesApi;
import java.util.*;

ample {

ing[] args) {
ient();

uth2

("oauth2");

String titleCodeGroup =
titleCodeGroup_example; // Stri
ng | Title code group.
String titleCode = titl

eCode_example; // String | Titl
e code.
AccountTitlePatch accou
ntTitle = ; // AccountTitlePatc
h | Account title.
g | access token

i-Version
try {
Object result = api

Instance.accountTitlesPatch(cod
e, titleCodeGroup, titleCode, a
ccountTitle, authorization, acc
System.out.println(
result);
) {
System.err.println(
TitlesApi#accountTitlesPatch");
e.printStackTrace()
;
countTitlesApi;

ample {

ing[] args) {

String titleCodeGroup =
titleCodeGroup_example; // Stri
ng | Title code group.
String titleCode = titl

eCode_example; // String | Titl
e code.
AccountTitlePatch accou
ntTitle = ; // AccountTitlePatc
h | Account title.
g | access token

i-Version
try {
Object result = api

Instance.accountTitlesPatch(cod
e, titleCodeGroup, titleCode, a
ccountTitle, authorization, acc
System.out.println(
result);
) {
System.err.println(
TitlesApi#accountTitlesPatch");
e.printStackTrace()
;

R_ACCESS_TOKEN"];

Account code.
String *titleCodeGroup = titleC

odeGroup_example; // Title code
group.
String *titleCode = titleCode_e

xample; // Title code.
AccountTitlePatch *accountTitle
= ; // Account title.

(optional)

-US)

AccountTitlesApi *apiInstance =
[[AccountTitlesApi alloc] init]
;
// Patch an account tile.
[apiInstance accountTitlesPatch
With:code
titleCodeGroup:titleCodeGro
up
titleCode:titleCode
accountTitle:accountTitle
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

ccountTitlesApi()

ring} Account code.
var titleCodeGroup = titleCodeG

roup_example; // {String} Title
code group.
var titleCode = titleCode_examp

le; // {String} Title code.
var accountTitle = ; // {Accoun

tTitlePatch} Account title.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.accountTitlesPatch(code, ti
tleCodeGroup, titleCode, accoun
tTitle, opts, callback);
using System;
namespace Example
public class accountTitlesP

atchExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew AccountTitlesApi();
var code = code_exa

.
var titleCodeGroup
= titleCodeGroup_example; // S
tring | Title code group.
var titleCode = tit

leCode_example; // String | Ti
tle code.
var accountTitle =
new AccountTitlePatch(); // Acc
ountTitlePatch | Account title.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch an acc
ount tile.
Object result =
apiInstance.accountTitlesPatch(
code, titleCodeGroup, titleCode
, accountTitle, authorization,
Debug.WriteLine
(result);
}
catch (Exception e)
Debug.Print("Ex
ception when calling AccountTit
lesApi.accountTitlesPatch: " +
e.Message );
<?php
/autoload.php');


ent\Api\AccountTitlesApi();

| Account code.
$titleCodeGroup = titleCodeGrou
p_example; // String | Title co
de group.
$titleCode = titleCode_example;
// String | Title code.
$accountTitle = ; // AccountTit
lePatch | Account title.
en
anguage
try {
countTitlesPatch($code, $titleC
odeGroup, $titleCode, $accountT
itle, $authorization, $acceptLa
nguage, $apiVersion);
print_r($result);

esPatch: ', $e->getMessage(), P
HP_EOL;
}
?>
use Data::Dumper;
ration;
TitlesApi;

S_TOKEN';
Client::AccountTitlesApi->new()
;

ng | Account code.
my $titleCodeGroup = titleCodeG
roup_example; # String | Title
code group.
my $titleCode = titleCode_examp
le; # String | Title code.
my $accountTitle = WWW::Swagger
Client::Object::AccountTitlePat
ch->new(); # AccountTitlePatch
| Account title.
oken
-Language
eval {
>accountTitlesPatch(code => $co
de, titleCodeGroup => $titleCod
eGroup, titleCode => $titleCode
, accountTitle => $accountTitle
, authorization => $authorizati
on, acceptLanguage => $acceptLa
nguage, apiVersion => $apiVersi
on);
};
if ($@) {

esPatch: $@\n";

atement
import time

ApiException

'

class
ccountTitlesApi()

Account code.
titleCodeGroup = titleCodeGroup
_example # String | Title code
group.
titleCode = titleCode_example #
String | Title code.
accountTitle = # AccountTitleP
atch | Account title.
(optional)
US)
l) (default to 1.0)
try:
# Patch an account tile.
.account_titles_patch(code, tit
leCodeGroup, titleCode, account
Title, authorization=authorizat
ion, acceptLanguage=acceptLangu
age, apiVersion=apiVersion)

ng AccountTitlesApi->accountTit
lesPatch: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Account code.
Required
titleCodeGroup* String
Title code group.
Required
titleCode* String
Title code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
accountTitle * {
Subset of properties to update an Account title.

TitleDate:
TitleDate string (date-time)
TitleCode:
TitleCode string maxLength:50
}
Responses
Status: 200 - OK
• Schema
{
}
Accounts
accountsCreate
Create a new Account.
/api/Accounts
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
:44356/api/Accounts"
;
*;
countsApi;
import java.util.*;
public class AccountsApiExample

{

ing[] args) {
ient();

uth2
("oauth2");
AccountsApi apiInstance
= new AccountsApi();
AccountPost model = ; /
/ AccountPost | Account model.
g | access token

i-Version
try {
Object result = api

Instance.accountsCreate(model,
apiVersion);
System.out.println(
result);
) {
System.err.println(
sApi#accountsCreate");
e.printStackTrace()
;
countsApi;

{

ing[] args) {
AccountPost model = ; /
/ AccountPost | Account model.
g | access token

i-Version
try {
Object result = api
Instance.accountsCreate(model,
apiVersion);
System.out.println(
result);
) {
System.err.println(
sApi#accountsCreate");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
AccountPost *model = ; // Accou

nt model.
(optional)

-US)

AccountsApi *apiInstance = [[Ac

countsApi alloc] init];
// Create a new Account.
[apiInstance accountsCreateWith
:model
ge
completionHandler
or) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"

ccountsApi()
var model = ; // {AccountPost}

Account model.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.accountsCreate(model, opts,
callback);
using System;
namespace Example
public class accountsCreate

Example
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew AccountsApi();
var model = new Acc

ountPost(); // AccountPost | Ac
count model.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a new
Account.
Object result =
apiInstance.accountsCreate(mode
l, authorization, acceptLanguag
e, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling AccountsAp
i.accountsCreate: " + e.Message
);
}
}
<?php
/autoload.php');


ent\Api\AccountsApi();
$model = ; // AccountPost | Acc

ount model.
en
anguage
try {
countsCreate($model, $authoriza
tion, $acceptLanguage, $apiVers
ion);
print_r($result);

g AccountsApi->accountsCreate:
', $e->getMessage(), PHP_EOL;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';
Client::AccountsApi->new();
my $model = WWW::SwaggerClient:
:Object::AccountPost->new(); #
AccountPost | Account model.
oken
-Language
eval {
>accountsCreate(model => $model
on);
};
if ($@) {

g AccountsApi->accountsCreate:
$@\n";

atement
import time
ApiException

'

class
ccountsApi()
model = # AccountPost | Accoun

t model.
(optional)
US)
l) (default to 1.0)
try:
# Create a new Account.

.accounts_create(model, authori
zation=authorization, acceptLan
guage=acceptLanguage, apiVersio
n=apiVersion)

ng AccountsApi->accountsCreate:
%s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
model AccountPost {
*
Account Post Request, enroll a new account
Required:
AccountType,Code,Country,Culture,Currency,DefaultShippingAddress,Email,FamilyName,G
Code:
Code string maxLength:50
Country:
Country string maxLength:2
Currency:
Currency string maxLength:3
AccountType:
AccountType string maxLength:50
Email:
Email string maxLength:255
Prefix:
Prefix string maxLength:50
GivenName:
GivenName string maxLength:255
MiddleName:
MiddleName string maxLength:255
FamilyName:
FamilyName string maxLength:255
SecondFamilyName:
SecondFamilyName string maxLength:255
Suffix:
Suffix string maxLength:50
KnownAs:
KnownAs string maxLength:255
BirthDate:
BirthDate string (date-time)
Phone:
Phone string maxLength:50
Culture:
Culture string maxLength:50
SMS:
SMS string maxLength:255
CompanyName:
CompanyName string maxLength:255
Passport:
Passport string maxLength:255
Gender:
Gender string maxLength:50
User:
User string maxLength:50
Password:
Password string maxLength:512
TaxId:
TaxId string maxLength:255
Sponsor:
Sponsor string maxLength:50
JoinDate:
JoinDate string (date-time)
IdentityDocumentType:
IdentityDocumentType string maxLength:50
IdentityDocument:
IdentityDocument string maxLength:50
CostCenter:
CostCenter string maxLength:50
EmployeeCode:
EmployeeCode string maxLength:50
PlaceOfIssuance:
PlaceOfIssuance string maxLength:50
Nationality:
Nationality string maxLength:50
Race:
Race string maxLength:50
MaritalStatus:
MaritalStatus string maxLength:50
SpouseIdentityDocumentType:
SpouseIdentityDocumentType string maxLength:50
SpouseIdentityDocument:
SpouseIdentityDocument string maxLength:50
SpouseName:
SpouseName string maxLength:255
SpouseBirthDate:
SpouseBirthDate string (date-time)
BankName:
BankName string maxLength:255
BankAccountCode:
BankAccountCode string maxLength:255
BankAccountNumber:
BankAccountNumber string maxLength:255
LegalAddress:
{
Required: Country
Line1:
Line1 string
Line2:
Line2 string
Country:
Country string
PostalCode:
PostalCode string
City:
City string
County:
County string
StateProvince:
StateProvince string
}
DefaultShippingAddress:
{
Required: Country
Line1:
Line1 string
Line2:
Line2 string
Country:
Country string
PostalCode:
PostalCode string
City:
City string
County:
County string
StateProvince:
}
OtherAddresses:
OtherAddresses[
{
Required: Country
Line1:
Line1 string maxLength:255
Line2:
Country:
PostalCode:
PostalCode string maxLength:255
City:
City string maxLength:255
County:
County string maxLength:255
StateProvince:
StateProvince string maxLength:255
}
]
OtherPhones:
OtherPhones[
{
Required: Number,Type
Type:
Number:
}
]
}
Responses
Status: 200 - OK
• Schema
{
}
accountsGetAll
Get data for Account entries.
/api/Accounts
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Accounts?activityCent
erRequired=&excludeTerminated=&
additionalDetails=&pageNumber=&
pageSize=&sortType=&filters="
;
*;
countsApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");

greater than 0
'
Boolean activityCenterR
equired = true; // Boolean | Ac
tivity Center Required.
Boolean excludeTerminat
ed = true; // Boolean | Exclude
Terminated.
Boolean additionalDetai
ls = true; // Boolean | Additio
nal Details. Response will incl
ude all addresses and Other Pho
ne Numbers.
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.AccountDto result = apiI
nstance.accountsGetAll(pageNumb
er, pageSize, sortType, activit
yCenterRequired, excludeTermina
ted, additionalDetails, authori
zation, acceptLanguage, apiVers
ion, filters);
System.out.println(
result);
) {
System.err.println(
sApi#accountsGetAll");
e.printStackTrace()
;
}
}
countsApi;

{

ing[] args) {

greater than 0

'
Boolean activityCenterR
equired = true; // Boolean | Ac
tivity Center Required.
Boolean excludeTerminat
ed = true; // Boolean | Exclude
Terminated.
Boolean additionalDetai
ls = true; // Boolean | Additio
nal Details. Response will incl
ude all addresses and Other Pho
ne Numbers.
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.AccountDto result = apiI
nstance.accountsGetAll(pageNumb
er, pageSize, sortType, activit
yCenterRequired, excludeTermina
ted, additionalDetails, authori
ion, filters);
System.out.println(
result);
) {
System.err.println(
sApi#accountsGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];


default to 25)

c)
Boolean *activityCenterRequired
= true; // Activity Center Requ
ired. (optional) (default to fa
lse)
Boolean *excludeTerminated = tr
ue; // Exclude Terminated. (opt
ional) (default to false)
Boolean *additionalDetails = tr
ue; // Additional Details. Resp
onse will include all addresses
and Other Phone Numbers. (optio
nal) (default to false)

(optional)

-US)

le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)

// Get data for Account entries

.
[apiInstance accountsGetAllWith
:pageNumber
pageSize:pageSize
sortType:sortType
activityCenterRequired:acti
vityCenterRequired
excludeTerminated:excludeTe
rminated
additionalDetails:additiona
lDetails
ge
filters:filters
completionHandler
: ^(HateoasCollectionResponse.A
ccountDto output, NSError* erro
r) {
if
(output) {
if
(error) {

}
}];





SS TOKEN"

ccountsApi()

than or equal to 0

0

var opts = {
'activityCenterRequired': tru
e, // {Boolean} Activity Center
Required.
'excludeTerminated': true, //
{Boolean} Exclude Terminated.
'additionalDetails': true, //
{Boolean} Additional Details. R
esponse will include all addres
ses and Other Phone Numbers.
oken
-Language
{String} # Filters
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.accountsGetAll(pageNumber,
pageSize, sortType, opts, callb
ack);
using System;
namespace Example
public class accountsGetAll

Example
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew AccountsApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;
var sortType = sort

var activityCenterR
equired = true; // Boolean | A
ctivity Center Required. (optio
var excludeTerminat
ed = true; // Boolean | Exclud
e Terminated. (optional) (defa
ult to false)
var additionalDetai
ls = true; // Boolean | Additi
onal Details. Response will inc
lude all addresses and Other Ph
one Numbers. (optional) (defau
lt to false)
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var filters = filte
ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get data for

Account entries.
HateoasCollecti
onResponse.AccountDto result =
apiInstance.accountsGetAll(page
Number, pageSize, sortType, act
ivityCenterRequired, excludeTer
minated, additionalDetails, aut
Version, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.accountsGetAll: " + e.Message
);
<?php
/autoload.php');


an or equal to 0

for 'Descending'
$activityCenterRequired = true;
// Boolean | Activity Center Re
quired.
$excludeTerminated = true; // B
oolean | Exclude Terminated.
$additionalDetails = true; // B
oolean | Additional Details. Re
sponse will include all address
es and Other Phone Numbers.
en
anguage
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
countsGetAll($pageNumber, $page
Size, $sortType, $activityCente
rRequired, $excludeTerminated,
$additionalDetails, $authorizat
on, $filters);
print_r($result);

g AccountsApi->accountsGetAll:
}
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';

than or equal to 0

0
my $activityCenterRequired = tr
ue; # Boolean | Activity Center
Required.
my $excludeTerminated = true; #
Boolean | Exclude Terminated.
my $additionalDetails = true; #
Boolean | Additional Details. R
esponse will include all addres
ses and Other Phone Numbers.
oken
-Language
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>accountsGetAll(pageNumber => $
pageNumber, pageSize => $pageSi
ze, sortType => $sortType, acti
vityCenterRequired => $activity
CenterRequired, excludeTerminat
ed => $excludeTerminated, addit
ionalDetails => $additionalDeta
ils, authorization => $authoriz
rsion, filters => $filters);
};
if ($@) {

g AccountsApi->accountsGetAll:
$@\n";

atement
import time

ApiException

'

class
ccountsApi()


efault to 25)
)
activityCenterRequired = true #
Boolean | Activity Center Requi
red. (optional) (default to fal
se)
excludeTerminated = true # Bool

ean | Exclude Terminated. (opti
onal) (default to false)
additionalDetails = true # Bool
ean | Additional Details. Respo
nse will include all addresses
and Other Phone Numbers. (optio
(optional)
US)
l) (default to 1.0)

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get data for Account entr

ies.
.accounts_get_all(pageNumber, p
ageSize, sortType, activityCent
erRequired=activityCenterRequir
ed, excludeTerminated=excludeTe
rminated, additionalDetails=add
itionalDetails, authorization=a
uthorization, acceptLanguage=ac
ceptLanguage, apiVersion=apiVer
sion, filters=filters)

ng AccountsApi->accountsGetAll:
%s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
activityCenterRequired Boolean
Activity Center Required.
excludeTerminated Boolean
Exclude Terminated.
additionalDetails Boolean
Additional Details. Response will include all addresses and

Other Phone Numbers.
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String
'Descending'
Required
filters String
Cost>50;Name~=a;and$LastName!|=a;StartDate==2020-
06-07 **SQL equivalent:** SELECT * FROM Table
WHERE (Cost > 50 AND Name LIKE '%a%') OR
(LastName NOT LIKE '%a' AND StartDate == '20200607')
**Supported operators:** | Operators | Sign | Number |
String | Char | DateTime | | ------------------ | ----- | ------ | -----
- | ---- | -------- | | Equal |**==** | ✓ | ✓ | ✓ | ✓ | | NotEqual
|**!=** | ✓ | ✓ | ✓ | ✓ | | GreaterThan |**>** | ✓ | ✘ | ✘ |
✓ | | GreaterOrEqualThan |**>=** | ✓ | ✘ | ✘ | ✓ | |
LessThan |**<** | ✓ | ✘ | ✘ | ✓ | | LessOrEqualThan
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ |
| NotContains |**!~=**| ✘ | ✓ | ✘ | ✘ | | StartsWith |**_=** |
✘ | ✓ | ✘ | ✘ | | NotStartsWith |**!_=**| ✘ | ✓ | ✘ | ✘ | |
EndsWith |**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘
|✓|✘|✘|
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Account Dto.
Code:
string
Code of the Account.
Name:
string
Name.
ReportName:
string
Report Name.
Country:
string
Country.
Currency:
string
Currency.
AccountType:
string
Account Type.
Email:
string
Email.
Placement:
boolean
Placement.
Prefix:
string
Prefix.
GivenName:
string
Given Name.
MiddleName:
string
Middle Name.
FamilyName:
string
Family Name.
SecondFamilyName:
string
Second Family Name.
Suffix:
string
Suffix.
KnownAs:
string
Known As.
BirthDate:
string (date-time)
Birth Date.
Phone:
string
Phone.
Culture:
string
Culture.
SMS:
string
SMS.
ModifiedDate:
string (date-time)
Modified Date.
CompanyName:
string
Company Name.
Passport:
string
Passport.
Gender:
string
Gender.
MaskedTaxId:
string
MaskedTaxId.
CreatedDate:
string (date-time)
Created Date.
DisbursementType:
string
Disbursement Type.
string
Identity Document Type.
IdentityDocument:
string
Identity Document.
CostCenter:
string
Cost Center.
EmployeeCode:
string
Employee Code.
PlaceOfIssuance:
string
Place Of Issuance.
Nationality:
string
Nationality.
Race:
string
Race.
MaritalStatus:
string
Marital Status.
string
Spouse Identity Document Type.
string
Spouse Identity Document.
SpouseName:
string
Spouse Name.
SpouseBirthDate:
string (date-time)
Spouse Birth Date.
BankName:
string
Bank Name.
MaskedBankAccountCode:
string
Masked Bank Account Code.
MaskedBankAccountNumber:
string
Masked Bank Account Number.
LegalAddress:
AddressDto {
Address Dto.
Required: Country
Line1:
Line2:
Country:
PostalCode:
City:
County:
StateProvince:
}
AddressDto {
Address Dto.
Required: Country
Line1:
Line2:
Country:
PostalCode:
City:
County:
StateProvince:
}
OtherAddresses:
[
Any other addresses.
AddressDto {
Address Dto.
Required: Country
Line1:
Line2:
Country:
PostalCode:
City:
County:
StateProvince:
}
]
OtherPhones:
[
Any other phone numbers.
PhoneNumberDto {
Phone Number Dto.
Type:
Number:
}
]
}
]
}
accountsGetByCode
Get data for an Account entry
/api/Accounts/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Accounts/{code}"
;
*;
countsApi;
import java.util.*;
{

ing[] args) {
ient();

uth2

("oauth2");

ple; // String | The Account Co
de to retrieve.
g | access token
i-Version
try {
AccountDto result =
apiInstance.accountsGetByCode(c
age, apiVersion);
System.out.println(
result);
) {
System.err.println(
sApi#accountsGetByCode");
e.printStackTrace()
;
countsApi;

{

ing[] args) {

de to retrieve.
g | access token

i-Version
try {
AccountDto result =
apiInstance.accountsGetByCode(c
age, apiVersion);
System.out.println(
result);
) {
System.err.println(
sApi#accountsGetByCode");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];

The Account Code to retrieve.

(optional)

-US)


// Get data for an Account entr

y
[apiInstance accountsGetByCodeW
ith:code
ge
completionHandler
: ^(AccountDto output, NSError*
error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

ccountsApi()

ring} The Account Code to retri
eve.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.accountsGetByCode(code, opt
s, callback);
using System;
namespace Example
public class accountsGetByC

odeExample
public void main()
{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew AccountsApi();
var code = code_exa

mple; // String | The Account
Code to retrieve.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get data for

an Account entry
AccountDto resu
lt = apiInstance.accountsGetByC
ode(code, authorization, accept
Language, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.accountsGetByCode: " + e.Mess
age );
<?php
/autoload.php');


| The Account Code to retrieve.
en
anguage
try {
countsGetByCode($code, $authori
zation, $acceptLanguage, $apiVe
rsion);
print_r($result);

g AccountsApi->accountsGetByCod
e: ', $e->getMessage(), PHP_EOL
;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';

ng | The Account Code to retrie
ve.
oken
-Language
eval {
>accountsGetByCode(code => $cod
e, authorization => $authorizat
ion, acceptLanguage => $acceptL
anguage, apiVersion => $apiVers
ion);
};
if ($@) {

g AccountsApi->accountsGetByCod
e: $@\n";

atement
import time

ApiException

'

class
ccountsApi()

(optional)
US)
l) (default to 1.0)
try:
# Get data for an Account e

ntry
.accounts_get_by_code(code, aut
rsion=apiVersion)

ng AccountsApi->accountsGetByCo
de: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
Account Dto.
Code:
string
Code of the Account.
Name:
string
Name.
ReportName:
string
Report Name.
Country:
string
Country.
Currency:
string
Currency.
AccountType:
string
Account Type.
Email:
string
Email.
Placement:
boolean
Placement.
Prefix:
string
Prefix.
GivenName:
string
Given Name.
MiddleName:
string
Middle Name.
FamilyName:
string
Family Name.
SecondFamilyName:
string
Second Family Name.
Suffix:
string
Suffix.
KnownAs:
string
Known As.
BirthDate:
string (date-time)
Birth Date.
Phone:
string
Phone.
Culture:
string
Culture.
SMS:
string
SMS.
ModifiedDate:
string (date-time)
Modified Date.
CompanyName:
string
Company Name.
Passport:
string
Passport.
Gender:
string
Gender.
MaskedTaxId:
string
MaskedTaxId.
CreatedDate:
string (date-time)
Created Date.
DisbursementType:
string
Disbursement Type.
string
Identity Document Type.
IdentityDocument:
string
Identity Document.
CostCenter:
string
Cost Center.
EmployeeCode:
string
Employee Code.
PlaceOfIssuance:
string
Place Of Issuance.
Nationality:
string
Nationality.
Race:
string
Race.
MaritalStatus:
string
Marital Status.
string
Spouse Identity Document Type.
string
Spouse Identity Document.
SpouseName:
string
Spouse Name.
SpouseBirthDate:
string (date-time)
Spouse Birth Date.
BankName:
string
Bank Name.
MaskedBankAccountCode:
string
Masked Bank Account Code.
MaskedBankAccountNumber:
string
Masked Bank Account Number.
LegalAddress:
AddressDto {
Address Dto.
Required: Country
Line1:
Line2:
Country:
PostalCode:
City:
County:
StateProvince:
}
AddressDto {
Address Dto.
Required: Country
Line1:
Line2:
Country:
PostalCode:
City:
County:
StateProvince:
}
OtherAddresses:
[
Any other addresses.
AddressDto {
Address Dto.
Required: Country
Line1:
Line2:
Country:
PostalCode:
City:
County:
StateProvince:
}
]
OtherPhones:
[
Any other phone numbers.
PhoneNumberDto {
Phone Number Dto.
Type:
Number:
}
]
}
accountsPatch
Update a subset of an account's
properties
/api/Accounts/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Accounts/{code}"
;
*;
countsApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");

AccountPatch accountPat
ch = ; // AccountPatch | Accoun
t patch model.
g | access token

i-Version
try {
Object result = api

Instance.accountsPatch(code, ac
countPatch, authorization, acce
ptLanguage, apiVersion);
System.out.println(
result);
) {
System.err.println(
sApi#accountsPatch");
e.printStackTrace()
;
}
countsApi;

{

ing[] args) {

AccountPatch accountPat
ch = ; // AccountPatch | Accoun
t patch model.
g | access token

i-Version
try {
Object result = api

Instance.accountsPatch(code, ac
countPatch, authorization, acce
System.out.println(
result);
) {
System.err.println(
sApi#accountsPatch");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

Account code.
AccountPatch *accountPatch = ;
// Account patch model.

(optional)
-US)


// Update a subset of an accoun

t's properties
[apiInstance accountsPatchWith:
code
accountPatch:accountPatch
ge
completionHandler
or) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"

ccountsApi()

ring} Account code.
var accountPatch = ; // {Accoun

tPatch} Account patch model.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.accountsPatch(code, account
Patch, opts, callback);
using System;
namespace Example
public class accountsPatchE

xample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew AccountsApi();
var code = code_exa

.
var accountPatch =
new AccountPatch(); // AccountP
atch | Account patch model.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Update a sub
set of an account's properties
Object result =
apiInstance.accountsPatch(code,
accountPatch, authorization, ac
ceptLanguage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.accountsPatch: " + e.Message
);
}
}
<?php
/autoload.php');



| Account code.
$accountPatch = ; // AccountPat
ch | Account patch model.
en
anguage
try {
countsPatch($code, $accountPatc
h, $authorization, $acceptLangu
age, $apiVersion);
print_r($result);

g AccountsApi->accountsPatch: '
, $e->getMessage(), PHP_EOL;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';
ng | Account code.
my $accountPatch = WWW::Swagger
Client::Object::AccountPatch->n
ew(); # AccountPatch | Account
patch model.
oken
-Language
eval {
>accountsPatch(code => $code, a
ccountPatch => $accountPatch, a
};
if ($@) {

g AccountsApi->accountsPatch: $
@\n";
}
atement
import time

ApiException

'

class
ccountsApi()

Account code.
accountPatch = # AccountPatch
| Account patch model.
(optional)
US)
l) (default to 1.0)
try:
# Update a subset of an acc

ount's properties
.accounts_patch(code, accountPa
tch, authorization=authorizatio
n, acceptLanguage=acceptLanguag
e, apiVersion=apiVersion)

ng AccountsApi->accountsPatch:
%s\n" % e)
Parameters
Path parameters
Name Description
code* String
Account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
accountPatch * AccountPatch {
Account Patch Request

Country:
Currency:
AccountType:
AccountType string maxLength:50
Email:
Email string maxLength:255
Prefix:
Prefix string maxLength:50
GivenName:
GivenName string maxLength:255
MiddleName:
MiddleName string maxLength:255
FamilyName:
FamilyName string maxLength:255
SecondFamilyName:
SecondFamilyName string maxLength:255
Suffix:
Suffix string maxLength:50
KnownAs:
KnownAs string maxLength:255
BirthDate:
BirthDate string (date-time)
Phone:
Phone string maxLength:50
Culture:
Culture string maxLength:50
SMS:
SMS string maxLength:255
CompanyName:
CompanyName string maxLength:255
Passport:
Passport string maxLength:255
Gender:
Gender string maxLength:50
TaxId:
TaxId string maxLength:255
JoinDate:
JoinDate string (date-time)
IdentityDocumentType string maxLength:50
IdentityDocument:
IdentityDocument string maxLength:50
CostCenter:
CostCenter string maxLength:50
EmployeeCode:
EmployeeCode string maxLength:50
PlaceOfIssuance:
PlaceOfIssuance string maxLength:50
Nationality:
Nationality string maxLength:50
Race:
Race string maxLength:50
MaritalStatus:
MaritalStatus string maxLength:50
SpouseIdentityDocumentType string maxLength:50
SpouseIdentityDocument string maxLength:50
SpouseName:
SpouseName string maxLength:255
SpouseBirthDate:
SpouseBirthDate string (date-time)
BankName:
BankName string maxLength:255
BankAccountCode:
BankAccountCode string maxLength:255
BankAccountNumber:
BankAccountNumber string maxLength:255
LegalAddress:
AddressPatch {
Address Patch Model.
Required: Country
Line1:
Line1 string
Line2:
Line2 string
Country:
Country string
PostalCode:
PostalCode string
City:
City string
County:
County string
StateProvince:
}
AddressPatch {
Required: Country
Line1:
Line1 string
Line2:
Line2 string
Country:
Country string
PostalCode:
PostalCode string
City:
City string
County:
County string
StateProvince:
}
OtherAddresses:
OtherAddresses[
{
Required: Country
Line1:
Line2:
Country:
PostalCode:
City:
County:
StateProvince:
}
]
OtherPhones:
OtherPhones[
{
Type:
Number:
}
]
}
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
ActivityCenterStatuses
activityCenterStatuses
GetAll
Get account's primary activity center
custom plan statuses
/api/ActivityCenterStatuses/{ac
countCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/ActivityCenterStatuse
s/{accountCode}?pageNumber=&pag
eSize=&sortType="
;
*;
tivityCenterStatusesApi;
import java.util.*;
public class ActivityCenterStat

usesApiExample {

ing[] args) {
ient();
uth2

("oauth2");
ActivityCenterStatusesA
pi apiInstance = new ActivityCe
nterStatusesApi();
The account code to retrieve

greater than 0

'
g | access token
i-Version
try {
HateoasCollectionRe
sponse.CustomPlanStatusDto resu
lt = apiInstance.activityCenter
StatusesGetAll(accountCode, pag
eNumber, pageSize, sortType, au
thorization, acceptLanguage, ap
iVersion);
System.out.println(
result);
) {
System.err.println(
"Exception when calling Activit
yCenterStatusesApi#activityCent
erStatusesGetAll");
e.printStackTrace()
;

usesApiExample {
ing[] args) {
nterStatusesApi();

greater than 0

'
g | access token

i-Version
try {
HateoasCollectionRe
sponse.CustomPlanStatusDto resu
lt = apiInstance.activityCenter
StatusesGetAll(accountCode, pag
iVersion);
System.out.println(
result);
) {
System.err.println(
erStatusesGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
de_example; // The account code
to retrieve


default to 25)

c)

(optional)

-US)

ActivityCenterStatusesApi *apiI
nstance = [[ActivityCenterStatu
sesApi alloc] init];
// Get account's primary activi

ty center custom plan statuses
[apiInstance activityCenterStat
usesGetAllWith:accountCode
pageSize:pageSize
sortType:sortType
ge
completionHandler
: ^(HateoasCollectionResponse.C
ustomPlanStatusDto output, NSEr
ror* error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

ctivityCenterStatusesApi()

xample; // {String} The account
code to retrieve

than or equal to 0

0

var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.activityCenterStatusesGetAl
l(accountCode, pageNumber, page
Size, sortType, opts, callback)
;
using System;
namespace Example
public class activityCenter

StatusesGetAllExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ActivityCenterStatusesApi();
var accountCode = a
| The account code to retrieve
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get account'
s primary activity center custo
m plan statuses
HateoasCollecti
onResponse.CustomPlanStatusDto
result = apiInstance.activityCe
nterStatusesGetAll(accountCode,
pageNumber, pageSize, sortType,
apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling ActivityCe
nterStatusesApi.activityCenterS
tatusesGetAll: " + e.Message );
<?php
/autoload.php');

ent\Api\ActivityCenterStatusesA
pi();
ple; // String | The account co
de to retrieve

an or equal to 0

for 'Descending'
en
anguage
try {
tivityCenterStatusesGetAll($acc
ountCode, $pageNumber, $pageSiz
e, $sortType, $authorization, $
acceptLanguage, $apiVersion);
print_r($result);

g ActivityCenterStatusesApi->ac
tivityCenterStatusesGetAll: ',
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Activit
yCenterStatusesApi;

S_TOKEN';
Client::ActivityCenterStatusesA
pi->new();
xample; # String | The account
code to retrieve

than or equal to 0
0
oken
-Language
eval {
>activityCenterStatusesGetAll(a
ccountCode => $accountCode, pag
eNumber => $pageNumber, pageSiz
e => $pageSize, sortType => $so
rtType, authorization => $autho
rization, acceptLanguage => $ac
ceptLanguage, apiVersion => $ap
iVersion);
};
if ($@) {

tivityCenterStatusesGetAll: $@\
n";

atement
import time

ApiException

'

class
le # String | The account code
to retrieve

efault to 25)
)
(optional)
US)
l) (default to 1.0)
try:
# Get account's primary act

ivity center custom plan status
es
.activity_center_statuses_get_a
ll(accountCode, pageNumber, pag
eSize, sortType, authorization=
authorization, acceptLanguage=a
cceptLanguage, apiVersion=apiVe
rsion)
ng ActivityCenterStatusesApi->a
ctivityCenterStatusesGetAll: %s
\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Custom plan status
Key:
string
The Key of the custom plan value
Type:
string
The {System.Type} name
corresponding to the type of
{System.Object} stored
Value:
string
The custom plan Value, represented
as a string regardless of Type
}
]
}
activityCenterStatuses
PatchAsync
Patch account's primary activity
center custom plan statuses
Provide only the keys and values for
custom plan statuses to update
/api/ActivityCenterStatuses/{ac
countCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/ActivityCenterStatu
ses/{accountCode}"
;
*;
import java.util.*;

usesApiExample {

ing[] args) {
ient();

uth2

("oauth2");
nterStatusesApi();
The account code to update
array[CustomPlanStatusD
to] customPlanStatuses = ; // a
rray[CustomPlanStatusDto] | Sub
set of {CustomPlanStatus} to up
date
g | access token

i-Version
try {
Object result = api

Instance.activityCenterStatuses
PatchAsync(accountCode, customP
lanStatuses, authorization, acc
System.out.println(
result);
) {
System.err.println(
erStatusesPatchAsync");
e.printStackTrace()
;

usesApiExample {

ing[] args) {
nterStatusesApi();
array[CustomPlanStatusD
to] customPlanStatuses = ; // a
date
g | access token

i-Version
try {
Object result = api

Instance.activityCenterStatuses
PatchAsync(accountCode, customP
lanStatuses, authorization, acc
System.out.println(
result);
) {
System.err.println(
erStatusesPatchAsync");
e.printStackTrace()
;

R_ACCESS_TOKEN"];

to update
array[CustomPlanStatusDto] *cus
tomPlanStatuses = ; // Subset o
f {CustomPlanStatus} to update

(optional)

-US)

ActivityCenterStatusesApi *apiI
nstance = [[ActivityCenterStatu
sesApi alloc] init];
// Patch account's primary acti

vity center custom plan statuse
s
[apiInstance activityCenterStat
usesPatchAsyncWith:accountCode
customPlanStatuses:customPl
anStatuses
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"


code to update
var customPlanStatuses = ; // {
array[CustomPlanStatusDto]} Sub
date
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

ata);
};
api.activityCenterStatusesPatch
Async(accountCode, customPlanSt
atuses, opts, callback);
using System;
namespace Example
public class activityCenter

StatusesPatchAsyncExample
{
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ActivityCenterStatusesApi();
var accountCode = a
| The account code to update
var customPlanStatu
ses = new array[CustomPlanStatu
sDto](); // array[CustomPlanSta
tusDto] | Subset of {CustomPlan
Status} to update
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch accoun
t's primary activity center cus
tom plan statuses
Object result =
apiInstance.activityCenterStatu
sesPatchAsync(accountCode, cust
omPlanStatuses, authorization,
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling ActivityCe
nterStatusesApi.activityCenterS
tatusesPatchAsync: " + e.Messag
e );
}
<?php
/autoload.php');


ent\Api\ActivityCenterStatusesA
pi();
de to update
$customPlanStatuses = ; // arra
y[CustomPlanStatusDto] | Subset
of {CustomPlanStatus} to update
en
anguage
try {
tivityCenterStatusesPatchAsync(
$accountCode, $customPlanStatus
es, $authorization, $acceptLang
uage, $apiVersion);
print_r($result);

tivityCenterStatusesPatchAsync:
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Activit
yCenterStatusesApi;

S_TOKEN';
Client::ActivityCenterStatusesA
pi->new();
code to update
my $customPlanStatuses = [WWW::
SwaggerClient::Object::array[Cu
stomPlanStatusDto]->new()]; # a
date
oken
-Language
eval {
>activityCenterStatusesPatchAsy
nc(accountCode => $accountCode,
customPlanStatuses => $customPl
anStatuses, authorization => $a
uthorization, acceptLanguage =>
$apiVersion);
};
if ($@) {

tivityCenterStatusesPatchAsync:
$@\n";

atement
import time

ApiException

'

class
to update
customPlanStatuses = # array[C
ustomPlanStatusDto] | Subset of
{CustomPlanStatus} to update
(optional)
US)
l) (default to 1.0)
try:
# Patch account's primary a

ctivity center custom plan stat
uses
.activity_center_statuses_patch
_async(accountCode, customPlanS
tatuses, authorization=authoriz
guage, apiVersion=apiVersion)

ng ActivityCenterStatusesApi->a
ctivityCenterStatusesPatchAsync
: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
customPlanStatuses [
*
undefined
Responses
Status: 200 - OK
• Schema
{
}
Carts
cartsAddPromotionCodes
Add promotion codes to the cart.
/api/Carts/{cartCode}/Promotion
Codes
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Carts/{cartCode}/Pro
motionCodes"
;
*;
import io.swagger.client.api.Ca
rtsApi;
import java.util.*;
public class CartsApiExample {

ing[] args) {
ient();

uth2

("oauth2");
CartsApi apiInstance =
new CartsApi();
String cartCode = cartC

ode_example; // String | Cart c
ode.
array[String] promotion
Codes = ; // array[String] | Pr
omotion codes.
g | access token

i-Version
try {
Object result = api

Instance.cartsAddPromotionCodes
(cartCode, promotionCodes, auth
ersion);
System.out.println(
result);
) {
System.err.println(
"Exception when calling CartsAp
i#cartsAddPromotionCodes");
e.printStackTrace()
;
}
rtsApi;

ing[] args) {
new CartsApi();

ode.
omotion codes.
g | access token

i-Version
try {
Object result = api
Instance.cartsAddPromotionCodes
(cartCode, promotionCodes, auth
ersion);
System.out.println(
result);
) {
System.err.println(
i#cartsAddPromotionCodes");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
String *cartCode = cartCode_exa

mple; // Cart code.
array[String] *promotionCodes =
; // Promotion codes.

(optional)

-US)

CartsApi *apiInstance = [[Carts

Api alloc] init];
// Add promotion codes to the c

art.
[apiInstance cartsAddPromotionC
odesWith:cartCode
promotionCodes:promotionCod
es
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"
var api = new JenkonRestApiV1.C

artsApi()
var cartCode = cartCode_example
; // {String} Cart code.
var promotionCodes = ; // {arra

y[String]} Promotion codes.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsAddPromotionCodes(cart
Code, promotionCodes, opts, cal
lback);
using System;
namespace Example
public class cartsAddPromot

ionCodesExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart

Code_example; // String | Cart
code.
var promotionCodes
= new array[String](); // array
[String] | Promotion codes.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Add promotio
n codes to the cart.
Object result =
apiInstance.cartsAddPromotionCo
des(cartCode, promotionCodes, a
piVersion);
Debug.WriteLine
(result);
}
catch (Exception e)
Debug.Print("Ex
ception when calling CartsApi.c
artsAddPromotionCodes: " + e.Me
ssage );
<?php
/autoload.php');


ent\Api\CartsApi();
$cartCode = cartCode_example; /
/ String | Cart code.
$promotionCodes = ; // array[St
ring] | Promotion codes.
en
anguage
try {
$result = $api_instance->ca
rtsAddPromotionCodes($cartCode,
$promotionCodes, $authorization
, $acceptLanguage, $apiVersion)
;
print_r($result);

g CartsApi->cartsAddPromotionCo
des: ', $e->getMessage(), PHP_E
OL;
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::CartsAp
i;

S_TOKEN';
Client::CartsApi->new();
my $cartCode = cartCode_example
; # String | Cart code.
my $promotionCodes = [WWW::Swag
gerClient::Object::array[String
]->new()]; # array[String] | Pr
omotion codes.
oken
-Language
eval {
>cartsAddPromotionCodes(cartCod
e => $cartCode, promotionCodes
=> $promotionCodes, authorizati
on => $authorization, acceptLan
guage => $acceptLanguage, apiVe
rsion => $apiVersion);
};
if ($@) {

g CartsApi->cartsAddPromotionCo
des: $@\n";

atement
import time

ApiException

'

class
api_instance = swagger_client.C
artsApi()
cartCode = cartCode_example # S
tring | Cart code.
promotionCodes = # array[Strin
g] | Promotion codes.
(optional)
US)
l) (default to 1.0)
try:
# Add promotion codes to th

e cart.
.carts_add_promotion_codes(cart
Code, promotionCodes, authoriza
apiVersion)
ng CartsApi->cartsAddPromotionC
odes: %s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
promotionCodes * [
string
]
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
cartsCreateCart
Create a cart.
/api/Carts
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Carts"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();
uth2

("oauth2");
new CartsApi();
CartPost cartModel = ;
// CartPost | Cart model.
g | access token

i-Version
try {
Object result = api

Instance.cartsCreateCart(cartMo
del, authorization, acceptLangu
age, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsCreateCart");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();
CartPost cartModel = ;
// CartPost | Cart model.
g | access token

i-Version
try {
Object result = api

Instance.cartsCreateCart(cartMo
age, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsCreateCart");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
CartPost *cartModel = ; // Cart

model.
(optional)

-US)


Api alloc] init];
// Create a cart.
[apiInstance cartsCreateCartWit
h:cartModel
ge
completionHandler
or) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"

artsApi()
var cartModel = ; // {CartPost}

Cart model.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsCreateCart(cartModel,
opts, callback);
using System;
namespace Example
public class cartsCreateCar

tExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartModel = new

CartPost(); // CartPost | Cart
model.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a car
t.
Object result =
apiInstance.cartsCreateCart(car
tModel, authorization, acceptLa
nguage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsCreateCart: " + e.Message )
;
}
}
<?php
/autoload.php');


ent\Api\CartsApi();
$cartModel = ; // CartPost | Ca
rt model.
en
anguage
try {
rtsCreateCart($cartModel, $auth
iVersion);
print_r($result);

g CartsApi->cartsCreateCart: ',
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
my $cartModel = WWW::SwaggerCli
ent::Object::CartPost->new(); #
CartPost | Cart model.
oken
-Language
eval {
>cartsCreateCart(cartModel => $
cartModel, authorization => $au
$apiVersion);
};
if ($@) {

g CartsApi->cartsCreateCart: $@
\n";

atement
import time
ApiException

'

class
artsApi()
cartModel = # CartPost | Cart

model.
(optional)
US)
l) (default to 1.0)
try:
# Create a cart.
.carts_create_cart(cartModel, a
Version=apiVersion)

ng CartsApi->cartsCreateCart: %
s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
cartModel * CartPost {
Model to create a cart.

Required:
AccountType,ActivityCenter,CartType,OwnerActivityCenter
Account:
Account string minLength:1 maxLength:50
ActivityCenter:
ActivityCenter string minLength:1 maxLength:50
CartType:
CartType string minLength:1 maxLength:50
PrimaryCurrency:
PrimaryCurrency string minLength:3 maxLength:3
OwnerAccountType:
OwnerAccountType string minLength:1 maxLength:50
OwnerActivityCenter:
OwnerActivityCenter string minLength:1 maxLength:50
AccountType:
AccountType string minLength:1 maxLength:50
ActivityCenterAccountType:
ActivityCenterAccountType string minLength:1 maxLength:50
PromotionCodes:
PromotionCodes[
PromotionCode string minLength:1 maxLength:50
]
Address:
AddressDto {
Address Dto.
Required: Country
Line1:
Line1 string
Line2:
Line2 string
Country:
Country string
PostalCode:
PostalCode string
City:
City string
County:
County string
StateProvince:
}
CarrierMethod:
CarrierMethod string minLength:1 maxLength:50
Enrollment:
Enrollment string minLength:1 maxLength:50
Required to create an enrollment cart.
}
Responses
Status: 200 - OK
• Schema
{
}
cartsDelete
Delete a cart by code.
/api/Carts/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

st:44356/api/Carts/{code}"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();
uth2

("oauth2");
new CartsApi();

ple; // String | Cart code.
g | access token

i-Version
try {
Object result = api

Instance.cartsDelete(code, auth
ersion);
System.out.println(
result);
) {
System.err.println(
i#cartsDelete");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

g | access token

i-Version
try {
Object result = api

Instance.cartsDelete(code, auth
ersion);
System.out.println(
result);
) {
System.err.println(
i#cartsDelete");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

Cart code.
(optional)

-US)


Api alloc] init];
// Delete a cart by code.
[apiInstance cartsDeleteWith:co
de
ge
completionHandler
or) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"

artsApi()

ring} Cart code.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsDelete(code, opts, cal

lback);
using System;
namespace Example
public class cartsDeleteExa

mple
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var code = code_exa

mple; // String | Cart code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Delete a car
t by code.
Object result =
apiInstance.cartsDelete(code, a
piVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsDelete: " + e.Message );
<?php
/autoload.php');


ent\Api\CartsApi();

| Cart code.
en
anguage
try {
rtsDelete($code, $authorization
, $acceptLanguage, $apiVersion)
;
print_r($result);

g CartsApi->cartsDelete: ', $e-
>getMessage(), PHP_EOL;
?>
use Data::Dumper;
ration;
i;

S_TOKEN';

ng | Cart code.
oken
-Language
eval {
>cartsDelete(code => $code, aut
horization => $authorization, a
cceptLanguage => $acceptLanguag
e, apiVersion => $apiVersion);
};
if ($@) {

g CartsApi->cartsDelete: $@\n";

atement
import time

ApiException

'

class
artsApi()

Cart code.
(optional)
US)
l) (default to 1.0)
try:
# Delete a cart by code.
.carts_delete(code, authorizati
on=authorization, acceptLanguag
e=acceptLanguage, apiVersion=ap
iVersion)
ng CartsApi->cartsDelete: %s\n"
% e)
Parameters
Path parameters
Name Description
code* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
cartsDeleteItem
Delete items from the cart.
/api/Carts/{cartCode}/Items
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

st:44356/api/Carts/{cartCode}/I
tems"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();

ode.
array[String] items = ;
// array[String] | Items codes.
g | access token

i-Version
try {
Object result = api

Instance.cartsDeleteItem(cartCo
de, items, authorization, accep
System.out.println(
result);
) {
System.err.println(
i#cartsDeleteItem");
e.printStackTrace()
;
}
}
rtsApi;

ing[] args) {
new CartsApi();

ode.
array[String] items = ;
// array[String] | Items codes.
g | access token

i-Version
try {
Object result = api

Instance.cartsDeleteItem(cartCo
de, items, authorization, accep
System.out.println(
result);
) {
System.err.println(
i#cartsDeleteItem");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

mple; // Cart code.
array[String] *items = ; // Ite

ms codes.
(optional)

-US)


Api alloc] init];
// Delete items from the cart.
[apiInstance cartsDeleteItemWit
h:cartCode
items:items
ge
completionHandler
or) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"

artsApi()

var items = ; // {array[String]
} Items codes.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsDeleteItem(cartCode, i
tems, opts, callback);
using System;
namespace Example
public class cartsDeleteIte

mExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart
code.
var items = new arr

ay[String](); // array[String]
| Items codes.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Delete items
from the cart.
Object result =
apiInstance.cartsDeleteItem(car
tCode, items, authorization, ac
Debug.WriteLine
(result);
catch (Exception e)
{
Debug.Print("Ex
artsDeleteItem: " + e.Message )
;
<?php
/autoload.php');


ent\Api\CartsApi();
$items = ; // array[String] | I
tems codes.
en
anguage
try {
rtsDeleteItem($cartCode, $items
, $authorization, $acceptLangua
ge, $apiVersion);
print_r($result);

g CartsApi->cartsDeleteItem: ',
?>
use Data::Dumper;
ration;
i;
S_TOKEN';
my $items = [WWW::SwaggerClient
::Object::array[String]->new()]
; # array[String] | Items codes
.
oken
-Language
eval {
>cartsDeleteItem(cartCode => $c
artCode, items => $items, autho
rization => $authorization, acc
eptLanguage => $acceptLanguage,
apiVersion => $apiVersion);
};
if ($@) {

g CartsApi->cartsDeleteItem: $@
\n";

atement
import time

ApiException

'

class
artsApi()
tring | Cart code.
items = # array[String] | Item
s codes.
(optional)
US)
l) (default to 1.0)
try:
# Delete items from the car

t.
.carts_delete_item(cartCode, it
ems, authorization=authorizatio

ng CartsApi->cartsDeleteItem: %
s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
items * [
string
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
cartsDeletePaymentsAsy
nc
Add payment to the cart
/api/Carts/{cartCode}/Payments
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

st:44356/api/Carts/{cartCode}/P
ayments"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();

ode.
array[String] payments
= ; // array[String] | Payments
.
g | access token

i-Version
try {
Object result = api

Instance.cartsDeletePaymentsAsy
nc(cartCode, payments, authoriz
ation, acceptLanguage, apiVersi
on);
System.out.println(
result);
) {
System.err.println(
i#cartsDeletePaymentsAsync");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

ode.
array[String] payments
= ; // array[String] | Payments
.
g | access token
i-Version
try {
Object result = api

Instance.cartsDeletePaymentsAsy
nc(cartCode, payments, authoriz
on);
System.out.println(
result);
) {
System.err.println(
i#cartsDeletePaymentsAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
mple; // Cart code.
array[String] *payments = ; //
Payments.

(optional)

-US)


Api alloc] init];
// Add payment to the cart
[apiInstance cartsDeletePayment
sAsyncWith:cartCode
payments:payments
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"
artsApi()

var payments = ; // {array[Stri

ng]} Payments.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {
ata);
};
api.cartsDeletePaymentsAsync(ca
rtCode, payments, opts, callbac
k);
using System;
namespace Example
public class cartsDeletePay

mentsAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart

code.
var payments = new

array[String](); // array[Strin
g] | Payments.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Add payment
to the cart
Object result =
apiInstance.cartsDeletePayments
Async(cartCode, payments, autho
rization, acceptLanguage, apiVe
rsion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsDeletePaymentsAsync: " + e.
Message );
<?php
/autoload.php');

ent\Api\CartsApi();
$payments = ; // array[String]
| Payments.
en
anguage
try {
rtsDeletePaymentsAsync($cartCod
e, $payments, $authorization, $
acceptLanguage, $apiVersion);
print_r($result);

g CartsApi->cartsDeletePayments
Async: ', $e->getMessage(), PHP
_EOL;
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
my $payments = [WWW::SwaggerCli
ent::Object::array[String]->new
()]; # array[String] | Payments
.
oken
-Language
eval {
>cartsDeletePaymentsAsync(cartC
ode => $cartCode, payments => $
payments, authorization => $aut
horization, acceptLanguage => $
acceptLanguage, apiVersion => $
apiVersion);
};
if ($@) {

g CartsApi->cartsDeletePayments
Async: $@\n";

atement
import time

ApiException

'
class
artsApi()
tring | Cart code.
payments = # array[String] | P
ayments.
(optional)
US)
l) (default to 1.0)
try:
# Add payment to the cart
.carts_delete_payments_async(ca
rtCode, payments, authorization
=authorization, acceptLanguage=
acceptLanguage, apiVersion=apiV
ersion)
ng CartsApi->cartsDeletePayment
sAsync: %s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
payments * [
string
]
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
cartsDeletePromotionCo
des
Delete cart's promotion codes.
Codes
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

st:44356/api/Carts/{cartCode}/P
romotionCodes"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();
uth2

("oauth2");
new CartsApi();

ode.
omotion codes.
g | access token

i-Version
try {
Object result = api

Instance.cartsDeletePromotionCo
piVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsDeletePromotionCodes");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

ode.
omotion codes.
g | access token

i-Version
try {
Object result = api

Instance.cartsDeletePromotionCo
piVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsDeletePromotionCodes");
e.printStackTrace()
;
}

R_ACCESS_TOKEN"];

mple; // Cart code.
array[String] *promotionCodes =
; // Promotion codes.

(optional)

-US)


Api alloc] init];
// Delete cart's promotion code

s.
[apiInstance cartsDeletePromoti
onCodesWith:cartCode
promotionCodes:promotionCod
es
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

artsApi()

var promotionCodes = ; // {arra

y[String]} Promotion codes.
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

ata);
};
api.cartsDeletePromotionCodes(c
artCode, promotionCodes, opts,
callback);
using System;
namespace Example
public class cartsDeletePro

motionCodesExample
{
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart

code.
var promotionCodes
= new array[String](); // array
[String] | Promotion codes.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Delete cart'
s promotion codes.
Object result =
apiInstance.cartsDeletePromotio
nCodes(cartCode, promotionCodes
, authorization, acceptLanguage
, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsDeletePromotionCodes: " + e
.Message );
<?php
/autoload.php');

ent\Api\CartsApi();
$promotionCodes = ; // array[St
ring] | Promotion codes.
en
anguage
try {
rtsDeletePromotionCodes($cartCo
de, $promotionCodes, $authoriza
ion);
print_r($result);

g CartsApi->cartsDeletePromotio
nCodes: ', $e->getMessage(), PH
P_EOL;
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
my $promotionCodes = [WWW::Swag
gerClient::Object::array[String
]->new()]; # array[String] | Pr
omotion codes.
oken
-Language
eval {
>cartsDeletePromotionCodes(cart
Code => $cartCode, promotionCod
es => $promotionCodes, authoriz
ation => $authorization, accept
Language => $acceptLanguage, ap
iVersion => $apiVersion);
};
if ($@) {

g CartsApi->cartsDeletePromotio
nCodes: $@\n";

atement
import time

ApiException

'

class
artsApi()
tring | Cart code.
promotionCodes = # array[Strin
g] | Promotion codes.
(optional)
US)
l) (default to 1.0)
try:
# Delete cart's promotion c

odes.
.carts_delete_promotion_codes(c
artCode, promotionCodes, author
ization=authorization, acceptLa
nguage=acceptLanguage, apiVersi
on=apiVersion)

ng CartsApi->cartsDeletePromoti
onCodes: %s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
promotionCodes * [
string
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
cartsGetAll
Get all carts.
/api/Carts
Usage and SDK
Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Carts?pageNumber=&pag
eSize=&sortType=&filters="
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();

greater than 0

'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.SimpleCartDto result = a
piInstance.cartsGetAll(pageNumb
er, pageSize, sortType, authori
ion, filters);
System.out.println(
result);
) {
System.err.println(
i#cartsGetAll");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();
greater than 0

'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.SimpleCartDto result = a
piInstance.cartsGetAll(pageNumb
ion, filters);
System.out.println(
result);
) {
System.err.println(
i#cartsGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];


default to 25)

c)

(optional)

-US)


le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)

Api alloc] init];
// Get all carts.
[apiInstance cartsGetAllWith:pa
geNumber
pageSize:pageSize
sortType:sortType
ge
filters:filters
completionHandler
: ^(HateoasCollectionResponse.S
impleCartDto output, NSError* e
rror) {
if
(output) {
if
(error) {
}];





SS TOKEN"

artsApi()
than or equal to 0

0

var opts = {
oken
-Language
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsGetAll(pageNumber, pag
eSize, sortType, opts, callback
);
using System;
namespace Example
public class cartsGetAllExa

mple
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var filters = filte

ers
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get all cart

s.
HateoasCollecti
onResponse.SimpleCartDto result
= apiInstance.cartsGetAll(pageN
umber, pageSize, sortType, auth
ersion, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsGetAll: " + e.Message );
}
}
<?php
/autoload.php');


ent\Api\CartsApi();

an or equal to 0

for 'Descending'
en
anguage
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
rtsGetAll($pageNumber, $pageSiz
e, $sortType, $authorization, $
acceptLanguage, $apiVersion, $f
ilters);
print_r($result);

g CartsApi->cartsGetAll: ', $e-
?>
use Data::Dumper;
ration;
i;

S_TOKEN';

than or equal to 0
0
oken
-Language
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>cartsGetAll(pageNumber => $pag
eNumber, pageSize => $pageSize,
sortType => $sortType, authoriz
iVersion => $apiVersion, filter
s => $filters);
};
if ($@) {

g CartsApi->cartsGetAll: $@\n";

atement
import time

ApiException

'

class
artsApi()


efault to 25)
)
(optional)
US)
l) (default to 1.0)
ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get all carts.
.carts_get_all(pageNumber, page
Size, sortType, authorization=a
sion, filters=filters)

ng CartsApi->cartsGetAll: %s\n"
% e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
CartDto.
Code:
string
Cart Code.
Account:
string
Account code.
ActivityCenter:
string
string
Owner activity center code.
OwnerCart:
string
OwnerCart.
Enrollment:
boolean
Enrollment.
ReturnOrder:
boolean
ReturnOrder.
Version:
integer (int32)
Version.
Link:
string
Link to full cart information.
}
]
}
cartsGetAllItems
Get all the items for an specific cart.
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Carts/{cartCode}/Item
s"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();
uth2

("oauth2");
new CartsApi();

ode.
g | access token

i-Version
try {
HateoasCollectionRe
sponse.CartItemDto result = api
Instance.cartsGetAllItems(cartC
age, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsGetAllItems");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

ode.
g | access token
i-Version
try {
HateoasCollectionRe
sponse.CartItemDto result = api
Instance.cartsGetAllItems(cartC
age, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsGetAllItems");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
mple; // Cart code.

(optional)

-US)


Api alloc] init];
// Get all the items for an spe

cific cart.
[apiInstance cartsGetAllItemsWi
th:cartCode
ge
completionHandler
artItemDto output, NSError* err
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"

artsApi()
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsGetAllItems(cartCode,
opts, callback);
using System;
namespace Example
public class cartsGetAllIte

msExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart
code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get all the

items for an specific cart.
HateoasCollecti
onResponse.CartItemDto result =
apiInstance.cartsGetAllItems(ca
rtCode, authorization, acceptLa
Debug.WriteLine
(result);
catch (Exception e)
{
Debug.Print("Ex
artsGetAllItems: " + e.Message
);
<?php
/autoload.php');


ent\Api\CartsApi();
en
anguage
try {
rtsGetAllItems($cartCode, $auth
iVersion);
print_r($result);

g CartsApi->cartsGetAllItems: '
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
oken
-Language
eval {
>cartsGetAllItems(cartCode => $
cartCode, authorization => $aut
apiVersion);
};
if ($@) {

g CartsApi->cartsGetAllItems: $
@\n";

atement
import time

ApiException

'

class
artsApi()
tring | Cart code.
(optional)
US)
l) (default to 1.0)
try:
# Get all the items for an

specific cart.
.carts_get_all_items(cartCode,
authorization=authorization, ac
ceptLanguage=acceptLanguage, ap
iVersion=apiVersion)

ng CartsApi->cartsGetAllItems:
%s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
CartItemDto.
Code:
string
Code.
Plan:
string
Plan code.
PlanRule:
string
Rule code.
Offer:
string
Offer code.
Quantity:
integer (int32)
Quantity.
Product:
string
Product code.
PriceType:
string
Price type.
Currency:
string
Currency.
}
]
}
cartsGetAllPromotionCo
des
Get all the promotion codes for a
cart.
Codes
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Carts/{cartCode}/Prom
otionCodes"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();

ode.
g | access token

i-Version
try {
HateoasCollectionRe
sponse.'String' result = apiIns
tance.cartsGetAllPromotionCodes
(cartCode, authorization, accep
System.out.println(
result);
) {
System.err.println(
i#cartsGetAllPromotionCodes");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

ode.
g | access token

i-Version
try {
HateoasCollectionRe
sponse.'String' result = apiIns
tance.cartsGetAllPromotionCodes
(cartCode, authorization, accep
System.out.println(
result);
) {
System.err.println(
i#cartsGetAllPromotionCodes");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

mple; // Cart code.

(optional)

-US)

Api alloc] init];
// Get all the promotion codes

for a cart.
[apiInstance cartsGetAllPromoti
onCodesWith:cartCode
ge
completionHandler
: ^(HateoasCollectionResponse.'
String' output, NSError* error)
{
if
(output) {
if
(error) {
}];




SS TOKEN"

artsApi()

var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsGetAllPromotionCodes(c
artCode, opts, callback);
using System;
namespace Example
public class cartsGetAllPro

motionCodesExample
{
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart

code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
{
// Get all the

promotion codes for a cart.
HateoasCollecti
onResponse.'String' result = ap
iInstance.cartsGetAllPromotionC
odes(cartCode, authorization, a
cceptLanguage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsGetAllPromotionCodes: " + e
.Message );
<?php
/autoload.php');


ent\Api\CartsApi();
en
anguage
try {
rtsGetAllPromotionCodes($cartCo
uage, $apiVersion);
print_r($result);

g CartsApi->cartsGetAllPromotio
nCodes: ', $e->getMessage(), PH
P_EOL;
}
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
oken
-Language
eval {
>cartsGetAllPromotionCodes(cart
Code => $cartCode, authorizatio
sion => $apiVersion);
};
if ($@) {

g CartsApi->cartsGetAllPromotio
nCodes: $@\n";

atement
import time

ApiException

'
class
artsApi()
tring | Cart code.
(optional)
US)
l) (default to 1.0)
try:
# Get all the promotion cod

es for a cart.
.carts_get_all_promotion_codes(
cartCode, authorization=authori
zation, acceptLanguage=acceptLa
nguage, apiVersion=apiVersion)

ng CartsApi->cartsGetAllPromoti
onCodes: %s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
string
]
}
cartsGetCartByCode
Get cart by code.
/api/Carts/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Carts/{code}"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();

g | access token

i-Version
try {
CartDto result = ap
iInstance.cartsGetCartByCode(co
ge, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsGetCartByCode");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

g | access token

i-Version
try {
CartDto result = ap
iInstance.cartsGetCartByCode(co
ge, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsGetCartByCode");
e.printStackTrace()
;

R_ACCESS_TOKEN"];

Cart code.

(optional)

-US)


Api alloc] init];
// Get cart by code.
[apiInstance cartsGetCartByCode
With:code
ge
completionHandler
: ^(CartDto output, NSError* er
ror) {
if
(output) {
if
(error) {
}];





SS TOKEN"
artsApi()

ring} Cart code.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsGetCartByCode(code, op
ts, callback);
using System;
namespace Example
public class cartsGetCartBy

CodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var code = code_exa
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get cart by
code.
CartDto result
= apiInstance.cartsGetCartByCod
e(code, authorization, acceptLa
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsGetCartByCode: " + e.Messag
e );
<?php
/autoload.php');


ent\Api\CartsApi();

| Cart code.
en
anguage
try {
rtsGetCartByCode($code, $author
ization, $acceptLanguage, $apiV
ersion);
print_r($result);

g CartsApi->cartsGetCartByCode:
?>
use Data::Dumper;
ration;
i;

S_TOKEN';

ng | Cart code.
oken
-Language
eval {
>cartsGetCartByCode(code => $co
sion);
};
if ($@) {

g CartsApi->cartsGetCartByCode:
$@\n";

atement
import time

ApiException

'

class
artsApi()

Cart code.
(optional)
US)
l) (default to 1.0)
try:
# Get cart by code.
.carts_get_cart_by_code(code, a
Version=apiVersion)

ng CartsApi->cartsGetCartByCode
: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
CartDto.
Code:
string
Code.
Version:
integer (int32)
Version.
CartHash:
string
Hash, optimization, skip update
(flush cart cache).
PersistCart:
boolean
Persist Cart?.
AlternateCodes:
[
AlternateCodes.
{
CartAlternateCodeDto.
Cart:
string
Cart code
Type:
string
Alternate code type
Code:
string
Alternate code
EffectiveDate:
string (date-time)
alternate code effective date
}
]
Alias:
string
cart alias code.
ExternalReference:
string
Reference to order created outside
of j6 prior to this cart.
Address:
AddressDto {
Address Dto.
Required: Country
Line1:
Line2:
Country:
PostalCode:
City:
County:
StateProvince:
}
DefaultBillingAddress:
AddressDto {
Address Dto.
Required: Country
Line1:
Line2:
Country:
PostalCode:
City:
County:
StateProvince:
}
ActivityCenter:
string
The ActivityCenter code.
CartType:
string
Type of cart.
OrderType:
string
Type of cart.
ReturnOrder:
string
Order that this cart is derived from.
HideVolumes:
boolean
Determines whether or not volumes
should be hidden in the UI.
CarrierMethod:
string
The carrier and shipping method.
CarrierMethodLocation:
string
Gets or sets the pickup point code.
ContainsShippableItems:
boolean
Read only to determine if any
products are shippable.
CreditCardInformation:
string
The credit card information for
autoship
ReservedOrderCode:
string
The shipping instructions
ShippingInstructions:
{
ShippingInstructionsDto.
Comments:
string
Shipping comments such as
instructions.
DeliveryDaysMessage:
string
Historical delivery days message
storage per sales order
Name:
string
The name of the person on the
shipping information
Phone:
string
The shipping phone number
}
Account:
string
The Account, unless anonymous
ReasonCode:
{
ReasonCodeKeyDto.
ReasonCodeType:
string
ReasonCodeType
Category:
string
Category
Number:
string
Number
}
Items:
[
The items in the order.
{
CartItemDto.
Code:
string
Code.
Plan:
string
Plan code.
PlanRule:
string
Rule code.
Offer:
string
Offer code.
Quantity:
integer (int32)
Quantity.
Product:
string
Product code.
PriceType:
string
Price type.
Currency:
string
Currency.
}
]
Exchange:
{
ExchangeDto.
ExchangeRate:
{
ExchangeRateDto.
Code:
string
FromCurrency:
string
ToCurrency:
string
ExchangeRateType:
string
Rate:
number
EffectiveDate:
string
Source:
string
Rounding:
integer
}
EffectiveExchangeRate:
number (double)
EffectiveExchangeRate.
EffectiveDate:
string (date-time)
EffectiveDate.
}
Primary:
{
CartWalletManagerDto.
NetTotal:
{
MoneyDto.
Amount:
number
DisplayValue:
string
NegativeDisplayValue:
string
Currency:
string
Format:
string
}
FullExtendedPrice:
{
MoneyDto.
Amount:
number
DisplayValue:
string
string
Currency:
string
Format:
string
}
FullDiscountAmount:
{
MoneyDto.
Amount:
number
DisplayValue:
string
string
Currency:
string
Format:
string
}
NetTotalAmount:
number (double)
Net total amount.
Exchange:
{
ExchangeDto.
ExchangeRate:
{}
number
EffectiveDate:
string
}
Currency:
string
Currency.
DefaultCurrencyFormat:
string
DefaultCurrencyFormat.
}
Local:
{
CartWalletManagerDto.
NetTotal:
{
MoneyDto.
Amount:
number
DisplayValue:
string
string
Currency:
string
Format:
string
}
FullExtendedPrice:
{
MoneyDto.
Amount:
number
DisplayValue:
string
string
Currency:
string
Format:
string
}
FullDiscountAmount:
{
MoneyDto.
Amount:
number
DisplayValue:
string
string
Currency:
string
Format:
string
}
NetTotalAmount:
number (double)
Net total amount.
Exchange:
{
ExchangeDto.
ExchangeRate:
{}
number
EffectiveDate:
string
}
Currency:
string
Currency.
string
}
CreationDate:
string (date-time)
The date Code was created.
CreateAutoship:
boolean
Gets CreateAutoship boolean from
Code type.
Service:
boolean
Gets Service flag from cart type.
Award:
boolean
Gets Award flag from cart type.
AllowShipmentBatch:
boolean
Gets AllowShipmentBatch flag from
cart type.
Enrollment:
string
An optional reference to the
associated Enrollment.
Active:
boolean
An identifier showing if autoship cart
is active.
Frequency:
string
Autoship frequency.
NextShipDate:
string (date-time)
Holds the next ship date for
autoship.
EndDate:
string (date-time)
Autoship end date.
ApplicationSource:
string
Application were the cart was
created.
User:
string
User who created cart.
string
Activity center of account getting the
credit at time of cart creation.
OwnerAccountType:
string
AccountType of account getting the
credit at time of cart creation.
AccountType:
string
Account class of customer account
at time of cart creation.
ActivityCenterAccountType:
string
AccountType of the activity center at
time of cart creation.
OwnerCart:
string
Link to cart that this one will replace.
Event:
string
The code of any linked event.
PersistBalance:
boolean
Should the cart balance be
persisted; used by
EventCartRepository.
ModifiedDate:
string (date-time)
The date when this cart was last
modified.
EffectiveDate:
string (date-time)
The effective date of the Cart. If the
cart is associated with the Event, the
date is the EventDate. If the cart is
not associated with an Event, the
date is today.
Lock:
boolean
Locked.
CreateShipmentBatch:
boolean
CreateShipmentBatch flag that
specifies if Shipment Batch should
be created when order is submitted.
CreateInvoiceBatch:
boolean
CreateInvoiceBatch flag that
specifies if Invoice Batch should be
created when order is submitted.
Country:
string
The country associated with this
transaction.
SalesOrderIncentives:
[
The list of available Sales Order
Incentives.
{
CartIncentiveProductDto.
Plan:
string
The plan that granted the incentive
Rule:
string
The particular rule that granted the
incentive
CountEarned:
integer (int32)
The quantity granted
CountUsed:
integer (int32)
The quantity already used
PriceType:
string
The price type granted
Product:
string
The product granted
Removable:
boolean
If the offer can be declined
Visible:
boolean
If the offer is shown
IsReward:
boolean
If the offer is a reward
Cart:
string
The cart associated to this incentive.
UserDeclined:
boolean
If the user declined to accept this
incentive
Category:
string
Used to determine which summary
grid to display the incentive in.
Order:
integer (int32)
Display order for summary grids
Summarize:
boolean
If the incentive is summarized
OutOfStockWarning:
boolean
Out of stock warning
ExcludeCredit:
boolean
Exclude this from the credit, for
example this value - QV does not
count to party QV
AwardTrackingKey:
{
AwardTrackingKeyDto.
ActivityCenter:
string
ActivityCenter
IncentiveCode:
string
IncentiveCode
Level:
string
Level
Plan:
string
Plan
Period:
string
Period
AwardPeriod:
string
Award Period
Rule:
string
Rule
SubstituteKey:
string
Product
}
CartItemValue:
{
CartItemValueDto.
Plan:
string
Plan Code
Rule:
string
Rule name
CartItem:
string
CartItem
IncentiveCode:
string
Incentive code
Category:
string
Category to display incentive
ApplyTo:
string
ApplyTo, e.g. Price, TaxBase, or
Volumes
DiscountType:
string
DiscountType
Reduced:
boolean
Apply to reduce amount?
ApplyOrder:
integer (int32)
Order discount apply
Scale:
number (double)
Discount Scale
ExtendedPrice:
boolean
Part of ExtendedPrice?
IsReward:
boolean
Does this CartItemValue represent a
reward? (i.e. display in the sales
order reward column)
Flat:
boolean
Flat or percentage
Bonus:
boolean
the bonuses this value comes from
Quantity:
integer (int32)
Gets or sets the quantity.
AdvertisementOriginCode:
string
Advertisement Origin code
CalculateOnly:
boolean
Don't persist, this is just added for
computing, NotPersist make default
to persist
ExcludeCredit:
boolean
this value does not contribute to
credit
Amount:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Negative display value.
Currency:
string
Currency.
Format:
string
Format.
}
Discount:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
Exchange:
{
ExchangeDto.
ExchangeRate:
{
ExchangeRateDto.
Code:
string
Code.
FromCurrency:
string
FromCurrency.
ToCurrency:
string
ToCurrency.
ExchangeRateType:
string
ExchangeRateType.
Rate:
number (double)
Rate.
EffectiveDate:
string (date-time)
EffectiveDate.
Source:
string
Source.
Rounding:
integer (int32)
Rounding.
}
number (double)
EffectiveDate:
string (date-time)
EffectiveDate.
}
Currency:
string
Currency.
string
}
IndirectApplied:
boolean
If the plan should not direct execute
again this cart type, by plan
associate, keep this incentive
ReferentialPriceTracking:
{
Tracking of incentive codes for
referential price
IsReward:
boolean
Whether to display reward column
ApplyOrder:
integer (int32)
incentive apply order
IncentiveCode:
string
The user configured incentive code
Plan:
string
The plan associated with the
incentive code
Rule:
string
The rule associated with the
incentive code
string
The advertisement origin code
}
AllowManualEntryForIncentives:
boolean
If manual entry for incentives is
allowed
IsDeclinable:
boolean
Whether this incentive is declinable
ProductIncentiveRuleOverride:
string
The product incentive rule override.
When this value is set to an existing
rule this incentive will reference it's
parent Rule.
ContributorRule:
string
The rule that contributed to the
award of this incentive
AutomaticRemoval:
boolean
Indicator for the system to
automatically adjust incentive item or
remove it if incentive falls below
threshold
AddedByIncentive:
boolean
Indicates whether this item was
added by an incentive
}
]
IncentiveSummaries:
[
Incentive summaries include
EarnedProduct,
EarnedCartDiscount, CartValue and
COA.
{
IncentiveSummaryDto.
Plan:
string
Plan
Rule:
string
Rule
Grid:
string
Grid
GridSequenceOrder:
integer (int32)
Grid sequence order
SequenceOrder:
integer (int32)
Sequence order
IncentiveDescription:
string
Incentive description
Earned:
string
Earned
Used:
string
Used
Remaining:
string
Remaining
Declined:
string
Declined
IsSummary:
boolean
Is summary
HasUsed:
boolean
HasUsed
HasEarned:
boolean
HasEarned
HasRemaining:
boolean
Has award not used
HasDeclined:
boolean
Has Declined
DiscountType:
string
Discount type
Currency:
string
Currency
IncentiveSummarySource:
string
Where this incentive summary
comes from
}
]
PriorLineItemValues:
[
Gets or sets the prior line item
values, comma delimited = code,
price-type, quantity.
string
]
IncentiveDiscounts:
[
Cart type discounts applicable to this
cart.
{
A discount produced from cart plan
rule.
Cart:
string
The cart to which the discount is
attached
Plan:
string
The plan that generated the discount
Rule:
string
The rule that generated the discount
Percent:
number (double)
percent value, computes by cart type
plan
PriceType:
string
Price type string, computes by cart
type plan
Currency:
string
Currency code, computes by cart
type plan
DiscountType:
string
Discount Type
Amount:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
}
]
CartUserDiscounts:
[
User applied discounts.
{
CartUserDiscountDto
Cart:
string
Cart code
User:
string
User who applied discount to cart
DiscountType:
string
Discount Type
Amount:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
}
]
PaymentTransactions:
[
Cart Payments.
{
PaymentTransactionDto.
PaymentMethod:
string
Payment Method Code
PaymentType:
string
Payment Type Code
PaymentTypeDesc:
string
Resourced Payment Type
Description
Date:
string (date-time)
Payment Date
User:
string
User making payment
Account:
string
Account for which payment is being
made
Enrollment:
string
Account for which payment is being
made
AccountName:
string
Account Name for which payment is
being made
ReferenceNumber:
string
Optional reference number
Authorized:
boolean
Authorized flag to specify if the
payment has been authorized
PaymentStatus:
string
PaymentStatus
PaymentStatusDesc:
string
Resourced Payment Status
Description
Lock:
boolean
Payment Lock
SinglePayment:
boolean
Single Payment
CreditLimit:
boolean
Credit Limit
CanEdit:
boolean
Flag to specify if transaction can be
edited
CanDelete:
boolean
Flag to specify if transaction can be
deleted
Posts:
[
Payment Posts
{
k__BackingField:
string
k__BackingField:
string
_currency:
string
k__BackingField:
{
_format:
string
_currency:
string
k__BackingField:
number (double)
k__BackingField:
string
IdentifierChanged:
{
Method:
{
}
Target:
{
}
}
}
k__BackingField:
{
_format:
string
_currency:
string
k__BackingField:
number (double)
k__BackingField:
string
IdentifierChanged:
{
Method:
{
}
Target:
{
}
}
}
k__BackingField:
integer (int32)
k__BackingField:
string (date-time)
k__BackingField:
boolean
_key:
string
k__BackingField:
integer (int32)
IdentifierChanged:
{
Method:
{
}
Target:
{
}
}
}
]
Refund:
boolean
True if this transaction was a refund
transaction
RefundTransactionCode:
string
Gets or sets the transaction code to
refund.
Comment:
string
hook for passing misc info with auth
request
Paid:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
CreditBalance:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
}
]
PayerIdOverride:
string
The overridden PayerId.
MerchantCountry:
string
The merchant country to use for
credit card transactions.
Advice:
[
List of Advice.
{
AdviceDetailDto.
ResourceText:
string
Resourced text explanation
ResourceKey:
string
Content key associated with
resourced text
DisplayOrder:
integer (int32)
The sequence to display this
message
Rule:
string
The rule that created this notification
Plan:
string
The plan that created this notification
AdviceType:
string
The type of advice
CartIncentiveProducts:
[
List of incentives associated with this
advice
{
CartIncentiveProductDto.
Plan:
string
The plan that granted the incentive
Rule:
string
The particular rule that granted the
incentive
CountEarned:
integer (int32)
The quantity granted
CountUsed:
integer (int32)
The quantity already used
PriceType:
string
The price type granted
Product:
string
The product granted
Removable:
boolean
If the offer can be declined
Visible:
boolean
If the offer is shown
IsReward:
boolean
If the offer is a reward
Cart:
string
The cart associated to this incentive.
UserDeclined:
boolean
If the user declined to accept this
incentive
Category:
string
Order:
integer (int32)
Display order for summary grids
Summarize:
boolean
If the incentive is summarized
OutOfStockWarning:
boolean
Out of stock warning
ExcludeCredit:
boolean
Exclude this from the credit, for
example this value - QV does not
count to party QV
AwardTrackingKey:
{
AwardTrackingKeyDto.
ActivityCenter:
string
ActivityCenter
IncentiveCode:
string
IncentiveCode
Level:
string
Level
Plan:
string
Plan
Period:
string
Period
AwardPeriod:
string
Award Period
Rule:
string
Rule
SubstituteKey:
string
Product
}
CartItemValue:
{
CartItemValueDto.
Plan:
string
Plan Code
Rule:
string
Rule name
CartItem:
string
CartItem
IncentiveCode:
string
Incentive code
Category:
string
Category to display incentive
ApplyTo:
string
ApplyTo, e.g. Price, TaxBase, or
Volumes
DiscountType:
string
DiscountType
Reduced:
boolean
Apply to reduce amount?
ApplyOrder:
integer (int32)
Order discount apply
Scale:
number (double)
Discount Scale
ExtendedPrice:
boolean
Part of ExtendedPrice?
IsReward:
boolean
Does this CartItemValue represent a
reward? (i.e. display in the sales
order reward column)
Flat:
boolean
Flat or percentage
Bonus:
boolean
the bonuses this value comes from
Quantity:
integer (int32)
Gets or sets the quantity.
string
Advertisement Origin code
CalculateOnly:
boolean
Don't persist, this is just added for
computing, NotPersist make default
to persist
ExcludeCredit:
boolean
this value does not contribute to
credit
Amount:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
Discount:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
Exchange:
{
ExchangeDto.
ExchangeRate:
{
ExchangeRateDto.
Code:
string
Code.
FromCurrency:
string
FromCurrency.
ToCurrency:
string
ToCurrency.
ExchangeRateType:
string
ExchangeRateType.
Rate:
number (double)
Rate.
EffectiveDate:
string (date-time)
EffectiveDate.
Source:
string
Source.
Rounding:
integer (int32)
Rounding.
}
number (double)
EffectiveDate:
string (date-time)
EffectiveDate.
}
Currency:
string
Currency.
string
}
IndirectApplied:
boolean
If the plan should not direct execute
again this cart type, by plan
associate, keep this incentive
ReferentialPriceTracking:
{
Tracking of incentive codes for
referential price
IsReward:
boolean
Whether to display reward column
ApplyOrder:
integer (int32)
incentive apply order
IncentiveCode:
string
The user configured incentive code
Plan:
string
The plan associated with the
incentive code
Rule:
string
The rule associated with the
incentive code
string
The advertisement origin code
}
AllowManualEntryForIncentives:
boolean
If manual entry for incentives is
allowed
IsDeclinable:
boolean
Whether this incentive is declinable
ProductIncentiveRuleOverride:
string
The product incentive rule override.
When this value is set to an existing
rule this incentive will reference it's
parent Rule.
ContributorRule:
string
The rule that contributed to the
award of this incentive
AutomaticRemoval:
boolean
Indicator for the system to
automatically adjust incentive item or
remove it if incentive falls below
threshold
AddedByIncentive:
boolean
Indicates whether this item was
added by an incentive
}
]
}
]
Availability:
[
List of Availability status.
{
Indication of accessibility/usability
k__BackingField:
string
k__BackingField:
boolean
k__BackingField:
string
k__BackingField:
string
k__BackingField:
string
k__BackingField:
string
k__BackingField:
string
k__BackingField:
string
k__BackingField:
string
k__BackingField:
[
{
key:
string
value:
{
}
}
]
k__BackingField:
string
k__BackingField:
string
k__BackingField:
string
}
]
HasError:
boolean
Indication of Availability errors.
GetDiscountTotals:
{
Returns a dictionary of discount
totals by discount type.
}
Values:
[
Computed values.
{
CartRuleValueDto.
Category:
string
Value:
string
The string representation of the
value.
Type:
string
The name of the data-type of the
value, drawn from a subset of SQL
types.
Plan:
string
The plan that calculated this value
Rule:
string
The rule that calculated this value
}
]
Balances:
[
Cash on account balances.
{
CartBalanceDto
Plan:
string
Plan
Rule:
string
Rule
AmountAvailable:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
Category:
string
Category
}
]
CustomerName:
string
Name of customer.
Warehouse:
string
Warehouse that will fulfill ordered
items.
MultipleWarehouse:
boolean
Indicates multiple Warehouses could
fulfill ordered items.
Empty:
boolean
Indication of cart is empty.
CartCoa:
{
CartCoaDto.
CartCode:
string
CartCode
Applicable:
boolean
Coa Applicable to this cart (Cart
type)
CartCoaState:
string
COA payment state
Balance:
{
MoneyDto.
Amount:
number
DisplayValue:
string
string
Currency:
string
Format:
string
}
FullAmount:
{
MoneyDto.
Amount:
number
DisplayValue:
string
string
Currency:
string
Format:
string
}
MaxApplicable:
{
MoneyDto.
Amount:
number
DisplayValue:
string
string
Currency:
string
Format:
string
}
OrderBalance:
{
MoneyDto.
Amount:
number
DisplayValue:
string
string
Currency:
string
Format:
string
}
Amount:
{
MoneyDto.
Amount:
number
DisplayValue:
string
string
Currency:
string
Format:
string
}
}
PaymentCurrency:
string
The currency intended to be used for
payment for this cart.
PriceTypeDescription:
string
Price Type Description.
DirectShip:
boolean
Indicates that a cart is being directly
shipped.
DeliveryMethod:
string
Gets or sets the delivery method.
AutoshipType:
boolean
Indicates if cart is an autoship type.
AwardsType:
boolean
Indicates if cart is an awards type.
CartPlanParameters:
{
string is key
PlanCode:ParameterName.
}
AwardTrackings:
[
Account active awards (awards
tracking).
{
AwardTrackingDto.
ActivityCenter:
string
ActivityCenter
IncentiveCode:
string
Incentive code
Level:
string
Level
Plan:
string
Plan
Period:
string
Period
AwardPeriod:
string
AwardPeriod
Rule:
string
Rule
SubstituteKey:
string
SubstituteKey
Products:
string
Products, comma separator string
PlanDescription:
string
The description for the Key plan
Quantity:
integer (int32)
Quantity
PriceType:
string
PriceType
QualifiedDate:
string (date-time)
QualifiedDate
QualifiedOrder:
string
Qualified order
AwardInBatchOrder:
string
Award in batch order, in case can't
award in order, then set this field
with order code, which indicate that
award will be process late in batch
AwardInBatchDate:
string (date-time)
Date after which the award should
be added to a batch
BatchPrizeOrder:
string
Sales order code that create in batch
AwardInOrder:
string
the order code the prize was added
BatchQualifiedOrder:
string
Order code where qualified and that
it is intended to be batched
ShippedDate:
string (date-time)
the date the order contains the prize
was shipped
StartDate:
string (date-time)
Award active start Date
EndDate:
string (date-time)
Award active end Date
LostDate:
string (date-time)
Date prize expired
Cumulative:
boolean
Cumulate?
EarningCode:
string
Earning Code
Currency:
string
Currency
Amount:
number (double)
Amount
OrderBatch:
string
Create order batch code
BatchCartType:
string
Cart type process this batch award
string
Advertisement Origin Code
Batch:
boolean
Batch true if this is a batch award
UpdatingDispatchMethod:
boolean
This will be true if the element is
locked by Updating Dispatch Method
process.
}
]
Titles:
[
Account titles.
string
]
Exemptions:
[
Active exemption.
string
]
UserPromoCodes:
[
User entered promotion codes.
string
]
ActivityCenterStatus:
{
ActivityCenterStatusDto
ActivityCenter:
string
Activity Center code this class
extends
ModifiedDate:
string (date-time)
Last Date/time this object was
modified. Null means no change
since this feature was added.
Custom:
[
Custom extensions to the Activity
Center
{
Custom field extending
ActivityCenterStatus, AccountStatus,
or AccountDemographics
Key:
string
Column Name
Type:
string
Column Type
Value:
{
Column Value
}
ControlPath:
string
Control path
}
]
}
IncentiveGridDisplay:
{
Active exemption.
}
DefaultRowIncentiveSequence:
integer (int32)
DefaultRowIncentiveSequence.
Zone:
string
Account Zone.
PriorOrderCount:
integer (int32)
Count of prior orders
UserDeclinedIncentives:
string
User decline incentives.
Bonuses:
[
Cart item discount.
{
BonusDto
ActivityCenter:
string
ActivityCenter
IncentiveCode:
string
Incentive code
Plan:
string
Plan
Period:
string
Period
Rule:
string
Rule
DiscountType:
string
Discount Type
BonusStatus:
string
Bonus status
StartDate:
string (date-time)
Optional Start Date
ExpirationDate:
string (date-time)
Expiration Date
Amount:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
}
]
CheckItemAvailability:
boolean
cart empty or warehouse is not clear
identified, then no need to check cart
item error.
GridSummaries:
[
Collection of Grid Summary
information.
{
GridSummaryDto.
Code:
string
The identifying grid
Title:
string
A title for the grid
Display:
boolean
Should the grid be displayed, or
hidden?
SequenceOrder:
integer (int32)
The sequence in which the grid
should display relative to other grids
GridItemSummary:
[
GridItemSummaries
{
GridItemSummaryDto
Grid:
string
Grid code
Title:
string
Title
SubTitle:
string
SubTitle
Group:
integer (int32)
Group
SequenceOrder:
integer (int32)
The sequence in which the grid
should display relative to other grids
Adjust:
boolean
Adjust?
SubTotal:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
Total:
{
MoneyDto.
Amount:
number (double)
Amount.
DisplayValue:
string
Display value.
string
Currency:
string
Currency.
Format:
string
Format.
}
}
]
}
]
BaseVolume:
[
List of BaseVolume summaries.
{
OfferBaseVolumeDto
VolumeCode:
string
Volume code.
Amount:
number (double)
Volume amount.
Description:
string
Used to hold display value for UI
Currency:
string
Currency.
IsDefault:
boolean
Read only indicator for
recommended BaseVolumeType
AmountString:
string
Read only localized amount string.
}
]
PublishContext:
{
PublishContextDto.
Offer:
{
offer code:offer currently cart item
point to
}
MostRecentOffers:
[
active offers for cart item, in case
use has permission or there are new
more recent offers, you can find from
this colections
{
Offer
ActivityCenter:
string
Activity center
Code:
string
Code
Country:
string
Country
Currency:
string
Currency
Product:
string
Product
StartDate:
string (date-time)
Start date
EndDate:
string (date-time)
End date
PriceType:
string
Price type
Price:
number (double)
Price
TaxBase:
number (double)
Tax base
CreditBase:
number (double)
Credit base
TaxInclusive:
boolean
Tax inclusive
Discountable:
boolean
Discountable
ReferentialPrice:
number (double)
Referential price
Flag1:
boolean
Flag1
PriceVolume:
[
Price volume
{
Offer volume
Required: Amount,VolumeCode
VolumeCode:
VolumeCode string minLength:1
maxLength:50
Amount:
Amount number (double)
(ex)minimum:true
}
]
}
]
OtherOffers:
[
Same as MostRecentOffers, but if
price type not allow changing, this is
empty
{
Offer
ActivityCenter:
string
Activity center
Code:
string
Code
Country:
string
Country
Currency:
string
Currency
Product:
string
Product
StartDate:
string (date-time)
Start date
EndDate:
string (date-time)
End date
PriceType:
string
Price type
Price:
number (double)
Price
TaxBase:
number (double)
Tax base
CreditBase:
number (double)
Credit base
TaxInclusive:
boolean
Tax inclusive
Discountable:
boolean
Discountable
ReferentialPrice:
number (double)
Referential price
Flag1:
boolean
Flag1
PriceVolume:
[
Price volume
{
Offer volume
VolumeCode:
maxLength:50
Amount:
(ex)minimum:true
}
]
}
]
Products:
{
Products and component products
offer reference to, component
product are used in availability
checking
}
UserCanOverridePriceType:
boolean
User Can Override PriceType?
UserCanSelectPriceType:
boolean
User Can Select PriceType?
}
CustomData:
string
custom data, may need more though
to carry forward complicate customer
data.
ProductLifetimeQuantity:
[
Product Lifetime Quantity by cart
Account.
{
ProductLifetimeQuantityDto
Account:
string
Code for the associated Account
Count:
integer (int32)
Count of items ordered toward the
given product and price type
(product and price type are given in
the associated
ProductQuantityLimit).
}
]
PromoCodeStatus:
[
Promotion codes statuses to be
display in the UI.
{
PromoCodeMapDto
Code:
string
Code
Description:
string
Description
Status:
string
Status
StatusDescription:
string
StatusDescription
}
]
}
cartsGetCartItemByCode
Get an item for an specific cart.
/api/Carts/{cartCode}/Items/{it
emCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Carts/{cartCode}/Item
s/{itemCode}"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();

ode.
String itemCode = itemC

ode_example; // String | Item c
ode.
g | access token

i-Version
try {
CartItemDto result
= apiInstance.cartsGetCartItemB
yCode(cartCode, itemCode, autho
rsion);
System.out.println(
result);
) {
System.err.println(
i#cartsGetCartItemByCode");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

ode.
String itemCode = itemC

ode_example; // String | Item c
ode.
g | access token

i-Version
try {
CartItemDto result
= apiInstance.cartsGetCartItemB
yCode(cartCode, itemCode, autho
rsion);
System.out.println(
result);
) {
System.err.println(
i#cartsGetCartItemByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

mple; // Cart code.
String *itemCode = itemCode_exa

mple; // Item code.

(optional)

-US)


Api alloc] init];
// Get an item for an specific

cart.
[apiInstance cartsGetCartItemBy
CodeWith:cartCode
itemCode:itemCode
ge
completionHandler
: ^(CartItemDto output, NSError
* error) {
if
(output) {
if
(error) {
}];





SS TOKEN"

artsApi()

var itemCode = itemCode_example

; // {String} Item code.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsGetCartItemByCode(cart
Code, itemCode, opts, callback)
;
using System;
namespace Example
public class cartsGetCartIt

emByCodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart

code.
var itemCode = item

Code_example; // String | Item
code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get an item
for an specific cart.
CartItemDto res
ult = apiInstance.cartsGetCartI
temByCode(cartCode, itemCode, a
piVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsGetCartItemByCode: " + e.Me
ssage );
}
<?php
/autoload.php');


ent\Api\CartsApi();
$itemCode = itemCode_example; /
/ String | Item code.
en
anguage
try {
rtsGetCartItemByCode($cartCode,
$itemCode, $authorization, $acc
eptLanguage, $apiVersion);
print_r($result);

g CartsApi->cartsGetCartItemByC
ode: ', $e->getMessage(), PHP_E
OL;
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
my $itemCode = itemCode_example
; # String | Item code.
oken
-Language
eval {
>cartsGetCartItemByCode(cartCod
e => $cartCode, itemCode => $it
emCode, authorization => $autho
iVersion);
};
if ($@) {

g CartsApi->cartsGetCartItemByC
ode: $@\n";
}

atement
import time

ApiException

'

class
artsApi()
tring | Cart code.
itemCode = itemCode_example # S
tring | Item code.
(optional)
US)
l) (default to 1.0)
try:
# Get an item for an specif

ic cart.
.carts_get_cart_item_by_code(ca
rtCode, itemCode, authorization
ersion)

ng CartsApi->cartsGetCartItemBy
Code: %s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
itemCode* String
Item code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
CartItemDto.
Code:
string
Code.
Plan:
string
Plan code.
PlanRule:
string
Rule code.
Offer:
string
Offer code.
Quantity:
integer (int32)
Quantity.
Product:
string
Product code.
PriceType:
string
Price type.
Currency:
string
Currency.
}
cartsGetFreightAsync
Get cart Freight.
/api/Carts/{cartCode}/Freight
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Carts/{cartCode}/Frei
ght?culture="
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();

ode.
g | access token

i-Version

ot specified,
the defa
try {
FreightDto result =
apiInstance.cartsGetFreightAsyn
c(cartCode, authorization, acce
);
System.out.println(
result);
) {
System.err.println(
i#cartsGetFreightAsync");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

ode.
g | access token

i-Version

ot specified,
the defa
try {
FreightDto result =
apiInstance.cartsGetFreightAsyn
c(cartCode, authorization, acce
);
System.out.println(
result);
) {
System.err.println(
i#cartsGetFreightAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

mple; // Cart code.

(optional)

-US)

the defa

Api alloc] init];
// Get cart Freight.
[apiInstance cartsGetFreightAsy
ncWith:cartCode
ge
culture:culture
completionHandler
: ^(FreightDto output, NSError*
error) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"

artsApi()

var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsGetFreightAsync(cartCo
de, opts, callback);
using System;
namespace Example
public class cartsGetFreigh

tAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart
code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get cart Fre

ight.
FreightDto resu
lt = apiInstance.cartsGetFreigh
tAsync(cartCode, authorization,
ture);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsGetFreightAsync: " + e.Mess
age );
<?php
/autoload.php');


ent\Api\CartsApi();
en
anguage
the defa
try {
rtsGetFreightAsync($cartCode, $
authorization, $acceptLanguage,
$apiVersion, $culture);
print_r($result);

g CartsApi->cartsGetFreightAsyn
c: ', $e->getMessage(), PHP_EOL
;
}
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
oken
-Language
,
the defa
eval {
>cartsGetFreightAsync(cartCode
=> $cartCode, authorization =>
$authorization, acceptLanguage
=> $acceptLanguage, apiVersion
=> $apiVersion, culture => $cul
ture);
};
if ($@) {

g CartsApi->cartsGetFreightAsyn
c: $@\n";

atement
import time

ApiException

'

class
artsApi()
tring | Cart code.
(optional)
US)
l) (default to 1.0)

the defa
try:
# Get cart Freight.
.carts_get_freight_async(cartCo
de, authorization=authorization
, acceptLanguage=acceptLanguage
, apiVersion=apiVersion, cultur
e=culture)

ng CartsApi->cartsGetFreightAsy
nc: %s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String

Responses
Status: 200 - OK
• Schema
{
Cart freight.
Freight:
string
Freight.
Subtotals:
{
Subtotals.
}
OrderTotal:
MoneyModel {
Money.
Required: Amount,Currency
Amount:
Currency:
}
FreightTaxBase:
MoneyModel {
Money.
Amount:
Currency:
}
FreightTaxPercentage:
number (double)
Freight Tax.
Balance:
MoneyModel {
Money.
Amount:
Currency:
}
ShippingOptions:
{
Shipping options.
}
Discounts:
[
Discounts.
{
FreightDiscountDto.
Code:
string
Discount code.
Type:
string
Discount type.
Amount:
MoneyModel {
Money.
Amount:
Currency:
}
}
]
}
cartsPatch
Patch a subset of properties of the
cart.
/api/Carts/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
t:44356/api/Carts/{code}"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2
("oauth2");
new CartsApi();

CartPatch model = ; //
CartPatch |
g | access token

i-Version
try {
Object result = api

Instance.cartsPatch(code, model
, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsPatch");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

CartPatch model = ; //
CartPatch |
g | access token
i-Version
try {
Object result = api

Instance.cartsPatch(code, model
, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsPatch");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
Cart code.
CartPatch *model = ; //

(optional)

-US)


Api alloc] init];
// Patch a subset of properties

of the cart.
[apiInstance cartsPatchWith:cod
e
model:model
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"
artsApi()

ring} Cart code.
var model = ; // {CartPatch}
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
}
};
api.cartsPatch(code, model, opt

s, callback);
using System;
namespace Example
public class cartsPatchExam

ple
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var code = code_exa

var model = new Car

tPatch(); // CartPatch |
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch a subs
et of properties of the cart.
Object result =
apiInstance.cartsPatch(code, mo
age, apiVersion);
Debug.WriteLine
(result);
}
catch (Exception e)
Debug.Print("Ex
artsPatch: " + e.Message );
<?php
/autoload.php');


ent\Api\CartsApi();

| Cart code.
$model = ; // CartPatch |
en
anguage
try {
rtsPatch($code, $model, $author
ersion);
print_r($result);

g CartsApi->cartsPatch: ', $e->
getMessage(), PHP_EOL;
?>
use Data::Dumper;
ration;
i;
S_TOKEN';

ng | Cart code.
:Object::CartPatch->new(); # Ca
rtPatch |
oken
-Language
eval {
>cartsPatch(code => $code, mode
l => $model, authorization => $
> $apiVersion);
};
if ($@) {

g CartsApi->cartsPatch: $@\n";

atement
import time

ApiException

'

class
artsApi()

Cart code.
model = # CartPatch |
(optional)
US)
l) (default to 1.0)
try:
# Patch a subset of propert

ies of the cart.
.carts_patch(code, model, autho
rization=authorization, acceptL
anguage=acceptLanguage, apiVers
ion=apiVersion)

ng CartsApi->cartsPatch: %s\n"
% e)
Parameters
Path parameters
Name Description
code* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
model * CartPatch {
Subset of properties to patch a cart.

ExternalReference:
ExternalReference string
Address:
AddressPatch {
Required: Country
Line1:
Line1 string
Line2:
Line2 string
Country:
Country string
PostalCode:
PostalCode string
City:
City string
County:
County string
StateProvince:
}
DefaultBillingAddress:
AddressPatch {
Required: Country
Line1:
Line1 string
Line2:
Line2 string
Country:
Country string
PostalCode:
PostalCode string
City:
City string
County:
County string
StateProvince:
}
CarrierMethod:
CarrierMethod string maxLength:50
ShippingInstructions:
ShippingInstructionsPatch {
Shipping instruction information.
Comments:
Comments string
DeliveryDaysMessage:
DeliveryDaysMessage string
Name:
Name string
Phone:
Phone string
}
Warehouse:
Warehouse string maxLength:50
}
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
cartsPatchCartItemByCo
de
Patch cart items properties.
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Carts/{cartCode}/It
ems"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();

ode.
array[CartItemPatch] ca
rtItems = ; // array[CartItemPa
tch] | Cart items.
g | access token

i-Version
try {
Object result = api
Instance.cartsPatchCartItemByCo
de(cartCode, cartItems, authori
ion);
System.out.println(
result);
) {
System.err.println(
i#cartsPatchCartItemByCode");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();
ode.
array[CartItemPatch] ca
rtItems = ; // array[CartItemPa
tch] | Cart items.
g | access token

i-Version
try {
Object result = api

Instance.cartsPatchCartItemByCo
de(cartCode, cartItems, authori
ion);
System.out.println(
result);
) {
System.err.println(
i#cartsPatchCartItemByCode");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];

mple; // Cart code.
array[CartItemPatch] *cartItems
= ; // Cart items.

(optional)

-US)


Api alloc] init];
// Patch cart items properties.
[apiInstance cartsPatchCartItem
ByCodeWith:cartCode
cartItems:cartItems
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

artsApi()

var cartItems = ; // {array[Car

tItemPatch]} Cart items.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsPatchCartItemByCode(ca
rtCode, cartItems, opts, callba
ck);
using System;
namespace Example
{
public class cartsPatchCart
ItemByCodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart

code.
var cartItems = new

array[CartItemPatch](); // arra
y[CartItemPatch] | Cart items.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch cart i
tems properties.
Object result =
apiInstance.cartsPatchCartItemB
yCode(cartCode, cartItems, auth
ersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsPatchCartItemByCode: " + e.
Message );
<?php
/autoload.php');


ent\Api\CartsApi();
$cartItems = ; // array[CartIte
mPatch] | Cart items.
en
anguage
try {
rtsPatchCartItemByCode($cartCod
e, $cartItems, $authorization,
$acceptLanguage, $apiVersion);
print_r($result);

g CartsApi->cartsPatchCartItemB
yCode: ', $e->getMessage(), PHP
_EOL;
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
my $cartItems = [WWW::SwaggerCl
ient::Object::array[CartItemPat
ch]->new()]; # array[CartItemPa
tch] | Cart items.
oken
-Language
eval {
>cartsPatchCartItemByCode(cartC
ode => $cartCode, cartItems =>
$cartItems, authorization => $a
$apiVersion);
};
if ($@) {

g CartsApi->cartsPatchCartItemB
yCode: $@\n";

atement
import time
ApiException

'

class
artsApi()
tring | Cart code.
cartItems = # array[CartItemPa
tch] | Cart items.
(optional)
US)
l) (default to 1.0)
try:
# Patch cart items properti

es.
.carts_patch_cart_item_by_code(
cartCode, cartItems, authorizat
piVersion)

ng CartsApi->cartsPatchCartItem
ByCode: %s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
cartItems * [
undefined
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
cartsPostItem
Add items to the cart.
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Carts/{cartCode}/Ite
ms"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();

ode.
array[CartItemPost] ite
ms = ; // array[CartItemPost] |
Cart items.
g | access token

i-Version
try {
Object result = api

Instance.cartsPostItem(cartCode
, items, authorization, acceptL
anguage, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsPostItem");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

ode.
array[CartItemPost] ite
ms = ; // array[CartItemPost] |
Cart items.
g | access token

i-Version
try {
Object result = api

Instance.cartsPostItem(cartCode
, items, authorization, acceptL
System.out.println(
result);
) {
System.err.println(
i#cartsPostItem");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

mple; // Cart code.
array[CartItemPost] *items = ;
// Cart items.

(optional)

-US)

Api alloc] init];
// Add items to the cart.
[apiInstance cartsPostItemWith:
cartCode
items:items
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

artsApi()

var items = ; // {array[CartIte

mPost]} Cart items.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsPostItem(cartCode, ite
ms, opts, callback);
using System;
namespace Example
public class cartsPostItemE

xample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart

code.
var items = new arr

ay[CartItemPost](); // array[Ca
rtItemPost] | Cart items.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Add items to
the cart.
Object result =
apiInstance.cartsPostItem(cartC
ode, items, authorization, acce
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsPostItem: " + e.Message );
}
<?php
/autoload.php');


ent\Api\CartsApi();
$items = ; // array[CartItemPos
t] | Cart items.
en
anguage
try {
rtsPostItem($cartCode, $items,
, $apiVersion);
print_r($result);

g CartsApi->cartsPostItem: ', $
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
my $items = [WWW::SwaggerClient
::Object::array[CartItemPost]->
new()]; # array[CartItemPost] |
Cart items.
oken
-Language
eval {
>cartsPostItem(cartCode => $car
tCode, items => $items, authori
zation => $authorization, accep
tLanguage => $acceptLanguage, a
piVersion => $apiVersion);
};
if ($@) {

g CartsApi->cartsPostItem: $@\n
";

atement
import time

ApiException

'

class
artsApi()
tring | Cart code.
items = # array[CartItemPost]
| Cart items.
(optional)
US)
l) (default to 1.0)
try:
# Add items to the cart.
.carts_post_item(cartCode, item
s, authorization=authorization,

ng CartsApi->cartsPostItem: %s\
n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
items * [
undefined
Responses
Status: 200 - OK
• Schema
{
}
cartsPostPaymentsAsync
Add payment to the cart
/api/Carts/{cartCode}/Payments
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Carts/{cartCode}/Pay
ments"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();

ode.
array[PaymentTransactio
nPost] payments = ; // array[Pa
ymentTransactionPost] | Payment
s.
g | access token

i-Version
try {
Object result = api

Instance.cartsPostPaymentsAsync
(cartCode, payments, authorizat
ion, acceptLanguage, apiVersion
);
System.out.println(
result);
) {
System.err.println(
i#cartsPostPaymentsAsync");
e.printStackTrace()
;
rtsApi;

ing[] args) {
new CartsApi();

ode.
array[PaymentTransactio
nPost] payments = ; // array[Pa
s.
g | access token

i-Version
try {
Object result = api

Instance.cartsPostPaymentsAsync
(cartCode, payments, authorizat
);
System.out.println(
result);
) {
System.err.println(
i#cartsPostPaymentsAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

mple; // Cart code.
array[PaymentTransactionPost] *
payments = ; // Payments.

(optional)

-US)

Api alloc] init];
// Add payment to the cart
[apiInstance cartsPostPaymentsA
syncWith:cartCode
payments:payments
ge
completionHandler
or) {
if
(output) {
if
(error) {

}
}];





SS TOKEN"

artsApi()

var payments = ; // {array[Paym

entTransactionPost]} Payments.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsPostPaymentsAsync(cart
Code, payments, opts, callback)
;
using System;
namespace Example
public class cartsPostPayme

ntsAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart

code.
var payments = new

array[PaymentTransactionPost]()
; // array[PaymentTransactionPo
st] | Payments.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Add payment
to the cart
Object result =
apiInstance.cartsPostPaymentsAs
ync(cartCode, payments, authori
ion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsPostPaymentsAsync: " + e.Me
ssage );
}
<?php
/autoload.php');


ent\Api\CartsApi();
$payments = ; // array[PaymentT
ransactionPost] | Payments.
en
anguage
try {
rtsPostPaymentsAsync($cartCode,
$payments, $authorization, $acc
print_r($result);

g CartsApi->cartsPostPaymentsAs
ync: ', $e->getMessage(), PHP_E
OL;
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
my $payments = [WWW::SwaggerCli
ent::Object::array[PaymentTrans
actionPost]->new()]; # array[Pa
s.
oken
-Language
eval {
>cartsPostPaymentsAsync(cartCod
e => $cartCode, payments => $pa
yments, authorization => $autho
iVersion);
};
if ($@) {
g CartsApi->cartsPostPaymentsAs
ync: $@\n";

atement
import time

ApiException

'

class
artsApi()
tring | Cart code.
payments = # array[PaymentTran
sactionPost] | Payments.
(optional)
US)
l) (default to 1.0)
try:
# Add payment to the cart
.carts_post_payments_async(cart
Code, payments, authorization=a
sion)

ng CartsApi->cartsPostPaymentsA
sync: %s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
payments * [
undefined
Responses
Status: 200 - OK
• Schema
{
}
cartsSubmitCart
Submit a cart.
/api/Carts/{cartCode}/Submit
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Carts/{cartCode}/Sub
mit"
;
*;
rtsApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new CartsApi();
ode.
g | access token

i-Version
try {
Object result = api

Instance.cartsSubmitCart(cartCo
ge, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsSubmitCart");
e.printStackTrace()
;
}
rtsApi;

ing[] args) {
new CartsApi();

ode.
g | access token

i-Version
try {
Object result = api

Instance.cartsSubmitCart(cartCo
ge, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#cartsSubmitCart");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

mple; // Cart code.

(optional)

-US)

Api alloc] init];
// Submit a cart.
[apiInstance cartsSubmitCartWit
h:cartCode
ge
completionHandler
or) {
if
(output) {
if
(error) {
}
}];





SS TOKEN"

artsApi()

var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.cartsSubmitCart(cartCode, o
pts, callback);
using System;
namespace Example
{
public class cartsSubmitCar
tExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CartsApi();
var cartCode = cart

code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Submit a car
t.
Object result =
apiInstance.cartsSubmitCart(car
guage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
artsSubmitCart: " + e.Message )
;
<?php
/autoload.php');

ent\Api\CartsApi();
en
anguage
try {
rtsSubmitCart($cartCode, $autho
Version);
print_r($result);

g CartsApi->cartsSubmitCart: ',
}
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
oken
-Language
eval {
>cartsSubmitCart(cartCode => $c
artCode, authorization => $auth
orization, acceptLanguage => $a
cceptLanguage, apiVersion => $a
piVersion);
};
if ($@) {

g CartsApi->cartsSubmitCart: $@
\n";

atement
import time

ApiException

'
class
artsApi()
tring | Cart code.
(optional)
US)
l) (default to 1.0)
try:
# Submit a cart.
.carts_submit_cart(cartCode, au
ersion=apiVersion)
ng CartsApi->cartsSubmitCart: %
s\n" % e)
Parameters
Path parameters
Name Description
cartCode* String
Cart code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
}
Categories
categoriesGetAll
Get data for Category entries
/api/Categories
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Categories?pageNumber
=&pageSize=&sortType=&culture=&
filters="
;
*;
tegoriesApi;
import java.util.*;
public class CategoriesApiExamp

le {

ing[] args) {
ient();

uth2

("oauth2");
CategoriesApi apiInstan
ce = new CategoriesApi();

greater than 0

'
g | access token

i-Version

ot specified,
the defa
s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.CategoryDto result = api
Instance.categoriesGetAll(pageN
ersion, culture, filters);
System.out.println(
result);
) {
System.err.println(
"Exception when calling Categor
iesApi#categoriesGetAll");
e.printStackTrace()
;
tegoriesApi;

le {

ing[] args) {

greater than 0

'
g | access token

i-Version

ot specified,
the defa

s
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.CategoryDto result = api
Instance.categoriesGetAll(pageN
ersion, culture, filters);
System.out.println(
result);
) {
System.err.println(
iesApi#categoriesGetAll");
e.printStackTrace()
;

R_ACCESS_TOKEN"];


default to 25)

c)

(optional)

-US)


the defa

le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
CategoriesApi *apiInstance = [[
CategoriesApi alloc] init];
// Get data for Category entrie

s
[apiInstance categoriesGetAllWi
th:pageNumber
pageSize:pageSize
sortType:sortType
ge
culture:culture
filters:filters
completionHandler
ategoryDto output, NSError* err
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

ategoriesApi()

than or equal to 0

0

var opts = {
oken
-Language
,
the defa
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.categoriesGetAll(pageNumber
, pageSize, sortType, opts, cal
lback);
using System;
namespace Example
public class categoriesGetA

llExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CategoriesApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get data for

Category entries
HateoasCollecti
onResponse.CategoryDto result =
apiInstance.categoriesGetAll(pa
geNumber, pageSize, sortType, a
piVersion, culture, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling Categories
Api.categoriesGetAll: " + e.Mes
sage );
}
}
<?php
/autoload.php');


ent\Api\CategoriesApi();

an or equal to 0

for 'Descending'
en
anguage
the defa
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
tegoriesGetAll($pageNumber, $pa
geSize, $sortType, $authorizati
n, $culture, $filters);
print_r($result);

g CategoriesApi->categoriesGetA
ll: ', $e->getMessage(), PHP_EO
L;
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Categor
iesApi;

S_TOKEN';
Client::CategoriesApi->new();
than or equal to 0

0
oken
-Language
,
the defa
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>categoriesGetAll(pageNumber =>
$pageNumber, pageSize => $pageS
ize, sortType => $sortType, aut
e, apiVersion => $apiVersion, c
ulture => $culture, filters =>
$filters);
};
if ($@) {

g CategoriesApi->categoriesGetA
ll: $@\n";
}

atement
import time

ApiException

'

class
ategoriesApi()


efault to 25)
)
(optional)
US)
l) (default to 1.0)

the defa

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get data for Category ent

ries
.categories_get_all(pageNumber,
pageSize, sortType, authorizati
iVersion, culture=culture, filt
ers=filters)

ng CategoriesApi->categoriesGet
All: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
culture String

filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Create category model.
Code:
string
Category Code.
Sequence:
integer (int32)
Sequence number.
Enabled:
boolean
Is enabled.
Parent:
string
Parent code.
Description:
string
Description.
LongDescription:
string
Long description.
}
]
}
categoriesGetByCategor
yCode
Get data for a category entry
/api/Categories/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Categories/{code}?cul
ture="
;
*;
tegoriesApi;
import java.util.*;

le {

ing[] args) {
ient();

uth2

("oauth2");
ple; // String | The Category C
ode to retrieve
g | access token

i-Version

ot specified,
the defa
try {
CategoryDto result
= apiInstance.categoriesGetByCa
tegoryCode(code, authorization,
ture);
System.out.println(
result);
) {
System.err.println(
iesApi#categoriesGetByCategoryC
ode");
e.printStackTrace()
;
tegoriesApi;

le {

ing[] args) {

ode to retrieve
g | access token

i-Version
ot specified,
the defa
try {
CategoryDto result
= apiInstance.categoriesGetByCa
tegoryCode(code, authorization,
ture);
System.out.println(
result);
) {
System.err.println(
iesApi#categoriesGetByCategoryC
ode");
e.printStackTrace()
;

R_ACCESS_TOKEN"];

The Category Code to retrieve

(optional)

-US)


the defa
// Get data for a category entr

y
[apiInstance categoriesGetByCat
egoryCodeWith:code
ge
culture:culture
completionHandler
: ^(CategoryDto output, NSError
* error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

ategoriesApi()

ring} The Category Code to retr
ieve
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.categoriesGetByCategoryCode
(code, opts, callback);
using System;
namespace Example
public class categoriesGetB

yCategoryCodeExample
{
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CategoriesApi();
var code = code_exa

mple; // String | The Category
Code to retrieve
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get data for

a category entry
CategoryDto res
ult = apiInstance.categoriesGet
ByCategoryCode(code, authorizat
, culture);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
Api.categoriesGetByCategoryCode
: " + e.Message );
}
}
<?php
/autoload.php');



| The Category Code to retrieve
en
anguage
the defa
try {
tegoriesGetByCategoryCode($code
ge, $apiVersion, $culture);
print_r($result);

g CategoriesApi->categoriesGetB
yCategoryCode: ', $e->getMessag
e(), PHP_EOL;
?>
use Data::Dumper;
ration;
iesApi;

S_TOKEN';

ng | The Category Code to retri
eve
oken
-Language
,
the defa
eval {
>categoriesGetByCategoryCode(co
de => $code, authorization => $
> $apiVersion, culture => $cult
ure);
};
if ($@) {

g CategoriesApi->categoriesGetB
yCategoryCode: $@\n";

atement
import time

ApiException

'

class
ategoriesApi()

(optional)
US)
l) (default to 1.0)

the defa
try:
# Get data for a category e

ntry
.categories_get_by_category_cod
e(code, authorization=authoriza
uage, apiVersion=apiVersion, cu
lture=culture)
ng CategoriesApi->categoriesGet
ByCategoryCode: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String
Responses
Status: 200 - OK
• Schema
{
Create category model.
Code:
string
Category Code.
Sequence:
integer (int32)
Sequence number.
Enabled:
boolean
Is enabled.
Parent:
string
Parent code.
Description:
string
Description.
LongDescription:
string
Long description.
}
categoriesPatchAsync
Patch an Category entry
Provide only the fields to modify,
leaving the others null
/api/Categories/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Categories/{code}"
;
*;
tegoriesApi;
import java.util.*;

le {

ing[] args) {
ient();

uth2

("oauth2");

ode of the entry to patch
CategoryPatch categoryP
atch = ; // CategoryPatch | The
subset of Category fields to pa
tch
g | access token

i-Version
try {
Object result = api

Instance.categoriesPatchAsync(c
ode, categoryPatch, authorizati
on, acceptLanguage, apiVersion)
;
System.out.println(
result);
) {
System.err.println(
iesApi#categoriesPatchAsync");
e.printStackTrace()
;
}
}
tegoriesApi;

le {

ing[] args) {

CategoryPatch categoryP
atch = ; // CategoryPatch | The
subset of Category fields to pa
tch
g | access token

i-Version
try {
Object result = api
Instance.categoriesPatchAsync(c
ode, categoryPatch, authorizati
;
System.out.println(
result);
) {
System.err.println(
iesApi#categoriesPatchAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

The Category Code of the entry
to patch
CategoryPatch *categoryPatch =
; // The subset of Category fie
lds to patch

(optional)

-US)

// Patch an Category entry
[apiInstance categoriesPatchAsy
ncWith:code
categoryPatch:categoryPatch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"

ategoriesApi()
ring} The Category Code of the
entry to patch
var categoryPatch = ; // {Categ

oryPatch} The subset of Categor
y fields to patch
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
}
};
api.categoriesPatchAsync(code,
categoryPatch, opts, callback);
using System;
namespace Example
public class categoriesPatc

hAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CategoriesApi();
var code = code_exa

Code of the entry to patch
var categoryPatch =
new CategoryPatch(); // Categor
yPatch | The subset of Category
fields to patch
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch an Cat
egory entry
Object result =
apiInstance.categoriesPatchAsyn
c(code, categoryPatch, authoriz
on);
Debug.WriteLine
(result);
}
catch (Exception e)
Debug.Print("Ex
Api.categoriesPatchAsync: " + e
.Message );
<?php
/autoload.php');



| The Category Code of the entr
y to patch
$categoryPatch = ; // CategoryP
atch | The subset of Category f
ields to patch
en
anguage
try {
tegoriesPatchAsync($code, $cate
goryPatch, $authorization, $acc
print_r($result);

g CategoriesApi->categoriesPatc
hAsync: ', $e->getMessage(), PH
P_EOL;
?>
use Data::Dumper;
ration;
iesApi;

S_TOKEN';

ng | The Category Code of the e
ntry to patch
my $categoryPatch = WWW::Swagge
rClient::Object::CategoryPatch-
>new(); # CategoryPatch | The s
ubset of Category fields to pat
ch
oken
-Language
eval {
>categoriesPatchAsync(code => $
code, categoryPatch => $categor
yPatch, authorization => $autho
iVersion);
};
if ($@) {

g CategoriesApi->categoriesPatc
hAsync: $@\n";

atement
import time

ApiException

'
class
ategoriesApi()

The Category Code of the entry
to patch
categoryPatch = # CategoryPatc
h | The subset of Category fiel
ds to patch
(optional)
US)
l) (default to 1.0)
try:
# Patch an Category entry
.categories_patch_async(code, c
ategoryPatch, authorization=aut
horization, acceptLanguage=acce
ptLanguage, apiVersion=apiVersi
on)
ng CategoriesApi->categoriesPat
chAsync: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
The Category Code of the entry to patch
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
categoryPatch * CategoryPatch {
Category patch model.

Sequence:
Sequence integer (int32)
Enabled:
Enabled boolean
Parent:
Parent string minLength:1 maxLength:50
}
Responses
Status: 200 - OK
• Schema
{
}
categoriesPostAsync
Create an Category entry
/api/Categories
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Categories"
;
*;
tegoriesApi;
import java.util.*;

le {

ing[] args) {
ient();
uth2

("oauth2");
CategoryPost category =
; // CategoryPost | The {Catego
ry} data to create
g | access token

i-Version
try {
apiInstance.categor
iesPostAsync(category, authoriz
on);
) {
System.err.println(
iesApi#categoriesPostAsync");
e.printStackTrace()
;
tegoriesApi;

le {

ing[] args) {
CategoryPost category =
; // CategoryPost | The {Catego
ry} data to create
g | access token
i-Version
try {
apiInstance.categor
iesPostAsync(category, authoriz
on);
) {
System.err.println(
iesApi#categoriesPostAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
CategoryPost *category = ; // T
he {Category} data to create

(optional)

-US)

// Create an Category entry
[apiInstance categoriesPostAsyn
cWith:category
ge
completionHandler
if
(error) {

}
}];





SS TOKEN"

ategoriesApi()
var category = ; // {CategoryPo

st} The {Category} data to cre
ate
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

cessfully.');
};
api.categoriesPostAsync(categor
y, opts, callback);
using System;
namespace Example
public class categoriesPost

AsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew CategoriesApi();
var category = new

CategoryPost(); // CategoryPost
| The {Category} data to creat
e
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create an Ca
tegory entry
apiInstance.cat
egoriesPostAsync(category, auth
ersion);
catch (Exception e)
Debug.Print("Ex
Api.categoriesPostAsync: " + e.
Message );
<?php
/autoload.php');

$category = ; // CategoryPost |
The {Category} data to create
en
anguage
try {
$api_instance->categoriesPo
stAsync($category, $authorizati
n);

g CategoriesApi->categoriesPost
_EOL;
}
?>
use Data::Dumper;
ration;
iesApi;

S_TOKEN';
my $category = WWW::SwaggerClie
nt::Object::CategoryPost->new()
; # CategoryPost | The {Categor
y} data to create
oken
-Language
eval {
$api_instance->categoriesPo
stAsync(category => $category,
);
};
if ($@) {

g CategoriesApi->categoriesPost
Async: $@\n";

atement
import time

ApiException

'
class
ategoriesApi()
category = # CategoryPost | Th
e {Category} data to create
(optional)
US)
l) (default to 1.0)
try:
# Create an Category entry
api_instance.categories_pos
t_async(category, authorization
ersion)

ng CategoriesApi->categoriesPos
tAsync: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
category * {
Model to create a category.

Code:
string
Category Code.
Sequence:
integer (int32)
Sequence number.
Enabled:
boolean
Is enabled.
Parent:
string
Parent code.
}
Responses
Status: 200 - OK
Exemptions
exemptionsGetAll
Get all exemptions for a specific
account.
/api/Accounts/{accountCode}/Exe
mptions
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

}/Exemptions?pageNumber=&pageSi
ze=&sortType=&filters="
;
*;
import io.swagger.client.api.Ex
emptionsApi;
import java.util.*;
public class ExemptionsApiExamp

le {

ing[] args) {
ient();

uth2

("oauth2");
ExemptionsApi apiInstan
ce = new ExemptionsApi();
account code.

greater than 0

'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.ExemptionDto result = ap
iInstance.exemptionsGetAll(acco
untCode, pageNumber, pageSize,
sortType, authorization, accept
Language, apiVersion, filters);
System.out.println(
result);
) {
System.err.println(
"Exception when calling Exempti
onsApi#exemptionsGetAll");
e.printStackTrace()
;
emptionsApi;

le {

ing[] args) {
account code.

greater than 0

'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.ExemptionDto result = ap
iInstance.exemptionsGetAll(acco
untCode, pageNumber, pageSize,
sortType, authorization, accept
Language, apiVersion, filters);
System.out.println(
result);
) {
System.err.println(
onsApi#exemptionsGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

de_example; // account code.

default to 25)

c)

(optional)

-US)


le; // # Filters
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
ExemptionsApi *apiInstance = [[
ExemptionsApi alloc] init];
// Get all exemptions for a spe

cific account.
[apiInstance exemptionsGetAllWi
th:accountCode
pageSize:pageSize
sortType:sortType
ge
filters:filters
completionHandler
: ^(HateoasCollectionResponse.E
xemptionDto output, NSError* er
ror) {
if
(output) {
if
(error) {
}];





SS TOKEN"
var api = new JenkonRestApiV1.E

xemptionsApi()
xample; // {String} account cod
e.

than or equal to 0

0

var opts = {
oken
-Language
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
}
};
api.exemptionsGetAll(accountCod
e, pageNumber, pageSize, sortTy
pe, opts, callback);
using System;
namespace Example
public class exemptionsGetA

llExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ExemptionsApi();
var accountCode = a
| account code.
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get all exem

ptions for a specific account.
HateoasCollecti
onResponse.ExemptionDto result
= apiInstance.exemptionsGetAll(
accountCode, pageNumber, pageSi
rs);
Debug.WriteLine
(result);
}
catch (Exception e)
Debug.Print("Ex
ception when calling Exemptions
Api.exemptionsGetAll: " + e.Mes
sage );
<?php
/autoload.php');


ent\Api\ExemptionsApi();
ple; // String | account code.

an or equal to 0
for 'Descending'
en
anguage
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
$result = $api_instance->ex
emptionsGetAll($accountCode, $p
ageNumber, $pageSize, $sortType
ge, $apiVersion, $filters);
print_r($result);

g ExemptionsApi->exemptionsGetA
L;
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Exempti
onsApi;

S_TOKEN';
Client::ExemptionsApi->new();
xample; # String | account code
.

than or equal to 0

0
oken
-Language
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>exemptionsGetAll(accountCode =
> $accountCode, pageNumber => $
ze, sortType => $sortType, auth
orization => $authorization, ac
ceptLanguage => $acceptLanguage
, apiVersion => $apiVersion, fi
lters => $filters);
};
if ($@) {

g ExemptionsApi->exemptionsGetA
ll: $@\n";
}

atement
import time

ApiException

'

class
api_instance = swagger_client.E
xemptionsApi()
le # String | account code.


efault to 25)
)
(optional)
US)
l) (default to 1.0)

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get all exemptions for a

specific account.
.exemptions_get_all(accountCode
, pageNumber, pageSize, sortTyp
apiVersion=apiVersion, filters=
filters)

ng ExemptionsApi->exemptionsGet
All: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Exemption Dto
Code:
string
Task Code
ActivityCenter:
string
Activity Center Code
ExemptionCode:
string
Exemption Code
InternalComments:
string
Exemption InternalComments
StartDate:
string (date-time)
Exemption start date
EndDate:
string (date-time)
Exemption end date
}
]
}
exemptionsGetByCode
Get exemption for a specific
exemption code.
/api/Exemptions/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Exemptions/{code}"
;
*;
emptionsApi;
import java.util.*;

le {

ing[] args) {
ient();

uth2

("oauth2");

ple; // String | exemption code
.
g | access token

i-Version
try {
ExemptionDto result
= apiInstance.exemptionsGetByCo
de(code, authorization, acceptL
System.out.println(
result);
) {
System.err.println(
onsApi#exemptionsGetByCode");
e.printStackTrace()
;
emptionsApi;
le {

ing[] args) {

ple; // String | exemption code
.
g | access token

i-Version
try {
ExemptionDto result
= apiInstance.exemptionsGetByCo
System.out.println(
result);
) {
System.err.println(
onsApi#exemptionsGetByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

exemption code.

(optional)

-US)

// Get exemption for a specific

exemption code.
[apiInstance exemptionsGetByCod
eWith:code
ge
completionHandler
: ^(ExemptionDto output, NSErro
r* error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

xemptionsApi()

ring} exemption code.
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

ata);
};
api.exemptionsGetByCode(code, o
pts, callback);
using System;
namespace Example
public class exemptionsGetB

yCodeExample
public void main()

{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ExemptionsApi();
var code = code_exa

mple; // String | exemption co
de.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
{
// Get exemptio
n for a specific exemption code
.
ExemptionDto re
sult = apiInstance.exemptionsGe
tByCode(code, authorization, ac
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
Api.exemptionsGetByCode: " + e.
Message );
<?php
/autoload.php');



| exemption code.
en
anguage
try {
emptionsGetByCode($code, $autho
Version);
print_r($result);

g ExemptionsApi->exemptionsGetB
_EOL;
}
?>
use Data::Dumper;
ration;
onsApi;

S_TOKEN';

ng | exemption code.
oken
-Language
eval {
>exemptionsGetByCode(code => $c
rsion);
};
if ($@) {

g ExemptionsApi->exemptionsGetB
yCode: $@\n";

atement
import time

ApiException

'
class
xemptionsApi()

exemption code.
(optional)
US)
l) (default to 1.0)
try:
# Get exemption for a speci

fic exemption code.
.exemptions_get_by_code(code, a
Version=apiVersion)

ng ExemptionsApi->exemptionsGet
ByCode: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
exemption code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
Exemption Dto
Code:
string
Task Code
ActivityCenter:
string
Activity Center Code
ExemptionCode:
string
Exemption Code
InternalComments:
string
Exemption InternalComments
StartDate:
string (date-time)
Exemption start date
EndDate:
string (date-time)
Exemption end date
}
exemptionsPatch
Patch an existing volume.
/api/Exemptions/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Exemptions/{code}"
;
*;
emptionsApi;
import java.util.*;

le {

ing[] args) {
ient();
uth2

("oauth2");

ple; // String | Exemption code
.
ExemptionPatch exemptio
nPatch = ; // ExemptionPatch |
Exemption patch.
g | access token

i-Version
try {
Object result = api

Instance.exemptionsPatch(code,
exemptionPatch, authorization,
System.out.println(
result);
) {
System.err.println(
onsApi#exemptionsPatch");
e.printStackTrace()
;
emptionsApi;

le {

ing[] args) {

ple; // String | Exemption code
.
ExemptionPatch exemptio
nPatch = ; // ExemptionPatch |
Exemption patch.
g | access token

i-Version
try {
Object result = api

Instance.exemptionsPatch(code,
exemptionPatch, authorization,
System.out.println(
result);
) {
System.err.println(
onsApi#exemptionsPatch");
e.printStackTrace()
;
}

R_ACCESS_TOKEN"];

Exemption code.
ExemptionPatch *exemptionPatch
= ; // Exemption patch.

(optional)

-US)

// Patch an existing volume.

[apiInstance exemptionsPatchWit
h:code
exemptionPatch:exemptionPat
ch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

xemptionsApi()

ring} Exemption code.
var exemptionPatch = ; // {Exem

ptionPatch} Exemption patch.
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

ata);
};
api.exemptionsPatch(code, exemp
tionPatch, opts, callback);
using System;
namespace Example
public class exemptionsPatc

hExample
public void main()

{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ExemptionsApi();
var code = code_exa

mple; // String | Exemption co
de.
var exemptionPatch
= new ExemptionPatch(); // Exem
ptionPatch | Exemption patch.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
{
// Patch an exi
sting volume.
Object result =
apiInstance.exemptionsPatch(cod
e, exemptionPatch, authorizatio
n, acceptLanguage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
Api.exemptionsPatch: " + e.Mess
age );
<?php
/autoload.php');



| Exemption code.
$exemptionPatch = ; // Exemptio
nPatch | Exemption patch.
en
anguage
try {
emptionsPatch($code, $exemption
Patch, $authorization, $acceptL
anguage, $apiVersion);
print_r($result);

g ExemptionsApi->exemptionsPatc
h: ', $e->getMessage(), PHP_EOL
;
}
?>
use Data::Dumper;
ration;
onsApi;

S_TOKEN';

ng | Exemption code.
my $exemptionPatch = WWW::Swagg
erClient::Object::ExemptionPatc
h->new(); # ExemptionPatch | Ex
emption patch.
oken
-Language
eval {
>exemptionsPatch(code => $code,
exemptionPatch => $exemptionPat
ch, authorization => $authoriza
sion);
};
if ($@) {

g ExemptionsApi->exemptionsPatc
h: $@\n";

atement
import time

ApiException

'

class
xemptionsApi()

Exemption code.
exemptionPatch = # ExemptionPa
tch | Exemption patch.
(optional)
US)
l) (default to 1.0)
try:
# Patch an existing volume.
.exemptions_patch(code, exempti
onPatch, authorization=authoriz

ng ExemptionsApi->exemptionsPat
ch: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Exemption code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
exemptionPatch * ExemptionPatch {
Subset of properties to patch a exemption.

Required: ExemptionCode,StartDate
ExemptionCode:
ExemptionCode string minLength:1 maxLength:50
InternalComments:
InternalComments string
StartDate:
StartDate string (date-time)
EndDate:
EndDate string (date-time)
}
Responses
Status: 200 - OK
• Schema
{
}
exemptionsPost
Create a new exemption.
/api/Exemptions
Usage and SDK
Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Exemptions"
;
*;
emptionsApi;
import java.util.*;

le {
ing[] args) {
ient();

uth2

("oauth2");
ExemptionPost exemption
Post = ; // ExemptionPost | Exe
mption post.
g | access token

i-Version
try {
Object result = api
Instance.exemptionsPost(exempti
onPost, authorization, acceptLa
System.out.println(
result);
) {
System.err.println(
onsApi#exemptionsPost");
e.printStackTrace()
;
emptionsApi;

le {

ing[] args) {
ExemptionPost exemption
Post = ; // ExemptionPost | Exe
mption post.
g | access token

i-Version
try {
Object result = api

Instance.exemptionsPost(exempti
onPost, authorization, acceptLa
System.out.println(
result);
) {
System.err.println(
onsApi#exemptionsPost");
e.printStackTrace()
;
}

R_ACCESS_TOKEN"];
ExemptionPost *exemptionPost =
; // Exemption post.

(optional)

-US)

// Create a new exemption.
[apiInstance exemptionsPostWith
:exemptionPost
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

xemptionsApi()
var exemptionPost = ; // {Exemp

tionPost} Exemption post.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {
ata);
};
api.exemptionsPost(exemptionPos
t, opts, callback);
using System;
namespace Example
public class exemptionsPost

Example
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ExemptionsApi();
var exemptionPost =
new ExemptionPost(); // Exempti
onPost | Exemption post.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a new
exemption.
Object result =
apiInstance.exemptionsPost(exem
ptionPost, authorization, accep
Debug.WriteLine
(result);
}
catch (Exception e)
Debug.Print("Ex
Api.exemptionsPost: " + e.Messa
ge );
<?php
/autoload.php');


$exemptionPost = ; // Exemption
Post | Exemption post.
en
anguage
try {
emptionsPost($exemptionPost, $a
uthorization, $acceptLanguage,
$apiVersion);
print_r($result);

g ExemptionsApi->exemptionsPost
: ', $e->getMessage(), PHP_EOL;
?>
use Data::Dumper;
ration;
onsApi;
S_TOKEN';
my $exemptionPost = WWW::Swagge
rClient::Object::ExemptionPost-
>new(); # ExemptionPost | Exemp
tion post.
oken
-Language
eval {
>exemptionsPost(exemptionPost =
> $exemptionPost, authorization
=> $authorization, acceptLangua
ge => $acceptLanguage, apiVersi
on => $apiVersion);
};
if ($@) {

g ExemptionsApi->exemptionsPost
: $@\n";

atement
import time

ApiException

'

class
xemptionsApi()
exemptionPost = # ExemptionPos
t | Exemption post.
(optional)
US)
l) (default to 1.0)
try:
# Create a new exemption.
.exemptions_post(exemptionPost,

ng ExemptionsApi->exemptionsPos
t: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
exemptionPost * ExemptionPost {
Exemption post request, new exemption

Required: ActivityCenter,ExemptionCode,StartDate
Code:
ActivityCenter:
ExemptionCode:
ExemptionCode string minLength:1 maxLength:50
InternalComments:
StartDate:
EndDate:
}
Responses
Status: 200 - OK
• Schema
{
}
Genealogy
genealogyGetByCode
Get the genealogy tree for an
account given a plan, period and
lineage.
/api/Genealogy/{account}/{plan}
/{period}/{lineage}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Genealogy/{account}/{
plan}/{period}/{lineage}?maxDep
th="
;
*;
import io.swagger.client.api.Ge
nealogyApi;
import java.util.*;
public class GenealogyApiExampl

e {

ing[] args) {
ient();

uth2

("oauth2");
GenealogyApi apiInstanc
e = new GenealogyApi();
String account = accoun

t_example; // String | Account
Code.
String plan = plan_exam

ple; // String | Plan Code.
String period = period_

example; // String | Period Cod
e.
String lineage = lineag

e_example; // String | Lineage
Code.
Integer maxDepth = 56;

// Integer | Maximum tree depth
. If not specified it will defa
ult to 2.
g | access token

i-Version
try {
GenealogyDto result
= apiInstance.genealogyGetByCod
e(account, plan, period, lineag
e, maxDepth, authorization, acc
System.out.println(
result);
) {
System.err.println(
"Exception when calling Genealo
gyApi#genealogyGetByCode");
e.printStackTrace()
;
import io.swagger.client.api.Ge
nealogyApi;
public class GenealogyApiExampl

e {

ing[] args) {
GenealogyApi apiInstanc
e = new GenealogyApi();
String account = accoun
t_example; // String | Account
Code.
String plan = plan_exam

ple; // String | Plan Code.
String period = period_

example; // String | Period Cod
e.
String lineage = lineag

e_example; // String | Lineage
Code.
Integer maxDepth = 56;

ult to 2.
g | access token

i-Version
try {
GenealogyDto result
= apiInstance.genealogyGetByCod
e(account, plan, period, lineag
e, maxDepth, authorization, acc
System.out.println(
result);
) {
System.err.println(
"Exception when calling Genealo
gyApi#genealogyGetByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
String *account = account_examp

le; // Account Code.
String *plan = plan_example; //

Plan Code.
String *period = period_example

; // Period Code.
String *lineage = lineage_examp

le; // Lineage Code.
Integer *maxDepth = 56; // Maxi
mum tree depth. If not specifie
d it will default to 2. (option
al) (default to 2)

(optional)

-US)

GenealogyApi *apiInstance = [[G

enealogyApi alloc] init];
// Get the genealogy tree for a

n account given a plan, period
and lineage.
[apiInstance genealogyGetByCode
With:account
plan:plan
period:period
lineage:lineage
maxDepth:maxDepth
ge
completionHandler
: ^(GenealogyDto output, NSErro
r* error) {
if
(output) {
if
(error) {
}];




SS TOKEN"
var api = new JenkonRestApiV1.G

enealogyApi()
var account = account_example;

// {String} Account Code.
var plan = plan_example; // {St

ring} Plan Code.
var period = period_example; //

{String} Period Code.
var lineage = lineage_example;

// {String} Lineage Code.
var opts = {
'maxDepth': 56, // {Integer}

Maximum tree depth. If not spec
ified it will default to 2.
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.genealogyGetByCode(account,
plan, period, lineage, opts, ca
llback);
using System;
namespace Example
{
public class genealogyGetBy

CodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew GenealogyApi();
var account = accou

nt_example; // String | Accoun
t Code.
var plan = plan_exa

mple; // String | Plan Code.
var period = period

_example; // String | Period C
ode.
var lineage = linea

ge_example; // String | Lineag
e Code.
var maxDepth = 56;

ult to 2. (optional) (default
to 2)
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get the gene

alogy tree for an account given
a plan, period and lineage.
GenealogyDto re
sult = apiInstance.genealogyGet
ByCode(account, plan, period, l
ineage, maxDepth, authorization
, acceptLanguage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
{
Debug.Print("Ex
ception when calling GenealogyA
pi.genealogyGetByCode: " + e.Me
ssage );
<?php
/autoload.php');


ent\Api\GenealogyApi();
$account = account_example; //
String | Account Code.
$plan = plan_example; // String

| Plan Code.
$period = period_example; // St
ring | Period Code.
$lineage = lineage_example; //
String | Lineage Code.
$maxDepth = 56; // Integer | Ma

ximum tree depth. If not specif
ied it will default to 2.
en
anguage
try {
$result = $api_instance->ge
nealogyGetByCode($account, $pla
n, $period, $lineage, $maxDepth
ge, $apiVersion);
print_r($result);

g GenealogyApi->genealogyGetByC
OL;
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Genealo
gyApi;

S_TOKEN';
Client::GenealogyApi->new();
my $account = account_example;
# String | Account Code.
my $plan = plan_example; # Stri

ng | Plan Code.
my $period = period_example; #
String | Period Code.
my $lineage = lineage_example;
# String | Lineage Code.
my $maxDepth = 56; # Integer |

Maximum tree depth. If not spec
ified it will default to 2.
oken
-Language
eval {
>genealogyGetByCode(account =>
$account, plan => $plan, period
=> $period, lineage => $lineage
, maxDepth => $maxDepth, author
ization => $authorization, acce
ptLanguage => $acceptLanguage,
};
if ($@) {

g GenealogyApi->genealogyGetByC
ode: $@\n";

atement
import time

ApiException

'

class
api_instance = swagger_client.G
enealogyApi()
account = account_example # Str

ing | Account Code.
plan = plan_example # String |

Plan Code.
period = period_example # Strin

g | Period Code.
lineage = lineage_example # Str

ing | Lineage Code.
maxDepth = 56 # Integer | Maxim

um tree depth. If not specified
it will default to 2. (optional
) (default to 2)
(optional)
US)
l) (default to 1.0)
try:
# Get the genealogy tree fo

r an account given a plan, peri
od and lineage.
.genealogy_get_by_code(account,
plan, period, lineage, maxDepth
=maxDepth, authorization=author
ization, acceptLanguage=acceptL
anguage, apiVersion=apiVersion)

ng GenealogyApi->genealogyGetBy
Code: %s\n" % e)
Parameters
Path parameters
Name Description
account* String
Account Code.
Required
plan* String
Plan Code.
Required
period* String
Period Code.
Required
lineage* String
Lineage Code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
maxDepth Integer (int32)
Maximum tree depth. If not specified it will default to 2.

Responses
Status: 200 - OK
• Schema
Inventories
inventoriesDeleteByCod
e
Delete an Inventory entry
/api/Inventories/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
st:44356/api/Inventories/{code}
"
;
*;
import io.swagger.client.api.In
ventoriesApi;
import java.util.*;
public class InventoriesApiExam

ple {

ing[] args) {
ient();

uth2
("oauth2");
InventoriesApi apiInsta
nce = new InventoriesApi();

ple; // String | The Inventory
Code to delete
g | access token

i-Version
try {
Object result = api

Instance.inventoriesDeleteByCod
System.out.println(
result);
) {
System.err.println(
"Exception when calling Invento
riesApi#inventoriesDeleteByCode
");
e.printStackTrace()
;
ventoriesApi;

ple {

ing[] args) {

Code to delete
g | access token
i-Version
try {
Object result = api

Instance.inventoriesDeleteByCod
System.out.println(
result);
) {
System.err.println(
riesApi#inventoriesDeleteByCode
");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
The Inventory Code to delete

(optional)

-US)

InventoriesApi *apiInstance = [
[InventoriesApi alloc] init];
// Delete an Inventory entry
[apiInstance inventoriesDeleteB
yCodeWith:code
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"
var api = new JenkonRestApiV1.I

nventoriesApi()

ring} The Inventory Code to del
ete
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.inventoriesDeleteByCode(cod
e, opts, callback);
using System;
namespace Example
public class inventoriesDel

eteByCodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew InventoriesApi();
var code = code_exa

mple; // String | The Inventor
y Code to delete
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Delete an In
ventory entry
Object result =
apiInstance.inventoriesDeleteBy
Code(code, authorization, accep
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling Inventorie
sApi.inventoriesDeleteByCode: "
+ e.Message );
}
}
<?php
/autoload.php');


ent\Api\InventoriesApi();

| The Inventory Code to delete
en
anguage
try {
$result = $api_instance->in
ventoriesDeleteByCode($code, $a
$apiVersion);
print_r($result);

g InventoriesApi->inventoriesDe
leteByCode: ', $e->getMessage()
, PHP_EOL;
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Invento
riesApi;

S_TOKEN';
Client::InventoriesApi->new();

ng | The Inventory Code to dele
te
oken
-Language
eval {
>inventoriesDeleteByCode(code =
> $code, authorization => $auth
piVersion);
};
if ($@) {

g InventoriesApi->inventoriesDe
leteByCode: $@\n";

atement
import time
ApiException

'

class
api_instance = swagger_client.I
nventoriesApi()

(optional)
US)
l) (default to 1.0)
try:
# Delete an Inventory entry

.inventories_delete_by_code(cod

ng InventoriesApi->inventoriesD
eleteByCode: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
inventoriesGetAll
Get data for Inventory entries
/api/Inventories
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Inventories?pageNumbe
r=&pageSize=&sortType=&filters=
"
;
*;
ventoriesApi;
import java.util.*;

ple {

ing[] args) {
ient();
uth2

("oauth2");

greater than 0

'
g | access token

i-Version
s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.InventoryDto result = ap
iInstance.inventoriesGetAll(pag
iVersion, filters);
System.out.println(
result);
) {
System.err.println(
riesApi#inventoriesGetAll");
e.printStackTrace()
;
ventoriesApi;

ple {

ing[] args) {

greater than 0

'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.InventoryDto result = ap
iInstance.inventoriesGetAll(pag
iVersion, filters);
System.out.println(
result);
) {
System.err.println(
riesApi#inventoriesGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

default to 25)

c)

(optional)

-US)


le; // # Filters
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
// Get data for Inventory entri

es
[apiInstance inventoriesGetAllW
ith:pageNumber
pageSize:pageSize
sortType:sortType
ge
filters:filters
completionHandler
: ^(HateoasCollectionResponse.I
nventoryDto output, NSError* er
ror) {
if
(output) {
if
(error) {
}];





SS TOKEN"

nventoriesApi()
than or equal to 0

0

var opts = {
oken
-Language
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.inventoriesGetAll(pageNumbe
r, pageSize, sortType, opts, ca
llback);
using System;
namespace Example
public class inventoriesGet

AllExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var pageNumber = 56
0 (default to 1)
var pageSize = 56;
var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get data for

Inventory entries
HateoasCollecti
onResponse.InventoryDto result
= apiInstance.inventoriesGetAll
(pageNumber, pageSize, sortType
, apiVersion, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
sApi.inventoriesGetAll: " + e.M
essage );
}
}
<?php
/autoload.php');



an or equal to 0

for 'Descending'
en
anguage
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
ventoriesGetAll($pageNumber, $p
ageSize, $sortType, $authorizat
on, $filters);
print_r($result);

g InventoriesApi->inventoriesGe
tAll: ', $e->getMessage(), PHP_
EOL;
?>
use Data::Dumper;
ration;
riesApi;

S_TOKEN';

than or equal to 0

0
oken
-Language
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>inventoriesGetAll(pageNumber =
> $pageNumber, pageSize => $pag
eSize, sortType => $sortType, a
ge, apiVersion => $apiVersion,
filters => $filters);
};
if ($@) {

tAll: $@\n";

atement
import time

ApiException

'

class
nventoriesApi()


efault to 25)
)
(optional)
US)
l) (default to 1.0)

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get data for Inventory en

tries
.inventories_get_all(pageNumber
, pageSize, sortType, authoriza
apiVersion, filters=filters)
ng InventoriesApi->inventoriesG
etAll: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
The data for an item that can be
shipped
Code:
string
The unique external identifier for the
Inventory entry
Description:
string
Description of the Inventory entry
WarrantyTypeCode:
string
Code of the associated Warranty
Type
InternalCost:
number (double)
Internal Value (Average cost) for the
Inventory (intended for reporting)
InternalCostCurrency:
string
Currency Code associated with the
Internal Value (Average cost)
StandardCost:
number (double)
(Average cost) for the Inventory
StandardCostCurrency:
string
(Average cost)
InternalCorpCost:
number (double)
Internal Value (Average corp cost)
for the Inventory
InternalCorpCostCurrency:
string
StandardCorpCost:
number (double)
(Average corp cost) for the Inventory
StandardCorpCostCurrency:
string
(Average corp cost)
AssignedForAllotment:
boolean
Flag indicating whether the Inventory
is under lot control, meaning if lot #
is tracked and required
Family:
string
External code for the 1st and highest
level of product hierarchy
Category:
string
External code for 2nd level of the
product hierarchy
SubCategory:
string
External code for 3rd level of the
product hierarchy
Line:
string
External code for 4th level of the
product hierarchy
Range:
string
product hierarchy
Brand:
string
An alphanumeric code used to
define an additional characteristic of
a product
Medium:
string
An alphanumeric field used to
identify products communicated in a
certain special space in a catalog
Gender:
string
An alphanumeric field used to define
an additional characteristic of the
product
Type:
string
the type code
CountryOfOrigin:
string
Country Code to allow for optional
import/export cost calculation and
tax reporting based on country of
production vs. country of sale.
Weight:
number (double)
Per item Weight, measured in
WeightUnit
WeightUnit:
string
Unit of measure for Weight
}
]
}
inventoriesGetByCode
Get data for an Inventory entry
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
44356/api/Inventories/{code}"
;
*;
ventoriesApi;
import java.util.*;

ple {

ing[] args) {
ient();

uth2
("oauth2");

Code to retrieve
g | access token

i-Version
try {
InventoryDto result
= apiInstance.inventoriesGetByC
System.out.println(
result);
) {
System.err.println(
riesApi#inventoriesGetByCode");
e.printStackTrace()
;
ventoriesApi;

ple {

ing[] args) {

Code to retrieve
g | access token
i-Version
try {
InventoryDto result
= apiInstance.inventoriesGetByC
System.out.println(
result);
) {
System.err.println(
riesApi#inventoriesGetByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
The Inventory Code to retrieve

(optional)

-US)

// Get data for an Inventory en

try
[apiInstance inventoriesGetByCo
deWith:code
ge
completionHandler
: ^(InventoryDto output, NSErro
r* error) {
if
(output) {
if
(error) {
}];





SS TOKEN"

nventoriesApi()
ring} The Inventory Code to ret
rieve
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.inventoriesGetByCode(code,
opts, callback);
using System;
namespace Example
public class inventoriesGet

ByCodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var code = code_exa
y Code to retrieve
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get data for

an Inventory entry
InventoryDto re
sult = apiInstance.inventoriesG
etByCode(code, authorization, a
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
sApi.inventoriesGetByCode: " +
e.Message );
<?php
/autoload.php');



| The Inventory Code to retriev
e
en
anguage
try {
ventoriesGetByCode($code, $auth
iVersion);
print_r($result);

tByCode: ', $e->getMessage(), P
HP_EOL;
?>
use Data::Dumper;
ration;
riesApi;

S_TOKEN';

ng | The Inventory Code to retr
ieve
oken
-Language
eval {
>inventoriesGetByCode(code => $
code, authorization => $authori
ersion);
};
if ($@) {

tByCode: $@\n";
}
atement
import time

ApiException

'

class
nventoriesApi()

(optional)
US)
l) (default to 1.0)
try:
# Get data for an Inventory

entry
.inventories_get_by_code(code,

ng InventoriesApi->inventoriesG
etByCode: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
The data for an item that can be
shipped
Code:
string
The unique external identifier for the
Inventory entry
Description:
string
WarrantyTypeCode:
string
Code of the associated Warranty
Type
InternalCost:
number (double)
Internal Value (Average cost) for the
Inventory (intended for reporting)
string
Internal Value (Average cost)
StandardCost:
number (double)
string
(Average cost)
InternalCorpCost:
number (double)
for the Inventory
string
StandardCorpCost:
number (double)
string
(Average corp cost)
boolean
Flag indicating whether the Inventory
is under lot control, meaning if lot #
is tracked and required
Family:
string
External code for the 1st and highest
level of product hierarchy
Category:
string
External code for 2nd level of the
product hierarchy
SubCategory:
string
External code for 3rd level of the
product hierarchy
Line:
string
product hierarchy
Range:
string
product hierarchy
Brand:
string
An alphanumeric code used to
define an additional characteristic of
a product
Medium:
string
An alphanumeric field used to
identify products communicated in a
certain special space in a catalog
Gender:
string
an additional characteristic of the
product
Type:
string
the type code
CountryOfOrigin:
string
Country Code to allow for optional
import/export cost calculation and
tax reporting based on country of
production vs. country of sale.
Weight:
number (double)
Per item Weight, measured in
WeightUnit
WeightUnit:
string
}
inventoriesPatchAsync
Patch an Inventory entry
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Inventories/{code}"
;
*;
ventoriesApi;
import java.util.*;

ple {

ing[] args) {
ient();

uth2

("oauth2");

InventoryPatch inventor
yPatch = ; // InventoryPatch |
The subset of Inventory fields
to patch
g | access token

i-Version
try {
Object result = api

Instance.inventoriesPatchAsync(
code, inventoryPatch, authoriza
tion, acceptLanguage, apiVersio
n);
System.out.println(
result);
) {
System.err.println(
riesApi#inventoriesPatchAsync")
;
e.printStackTrace()
;
ventoriesApi;

ple {

ing[] args) {

InventoryPatch inventor
yPatch = ; // InventoryPatch |
The subset of Inventory fields
to patch
g | access token

i-Version
try {
Object result = api

Instance.inventoriesPatchAsync(
code, inventoryPatch, authoriza
n);
System.out.println(
result);
) {
System.err.println(
riesApi#inventoriesPatchAsync")
;
e.printStackTrace()
;

R_ACCESS_TOKEN"];

The Inventory Code of the entry
to patch
InventoryPatch *inventoryPatch
= ; // The subset of Inventory
fields to patch

(optional)

-US)

// Patch an Inventory entry
[apiInstance inventoriesPatchAs
yncWith:code
inventoryPatch:inventoryPat
ch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

nventoriesApi()

ring} The Inventory Code of the
entry to patch
var inventoryPatch = ; // {Inve

ntoryPatch} The subset of Inven
tory fields to patch
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

ata);
};
api.inventoriesPatchAsync(code,
inventoryPatch, opts, callback)
;
using System;
namespace Example
public class inventoriesPat

chAsyncExample
{
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var code = code_exa

y Code of the entry to patch
var inventoryPatch
= new InventoryPatch(); // Inve
ntoryPatch | The subset of Inve
ntory fields to patch
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch an Inv
entory entry
Object result =
apiInstance.inventoriesPatchAsy
nc(code, inventoryPatch, author
ization, acceptLanguage, apiVer
sion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
sApi.inventoriesPatchAsync: " +
e.Message );
<?php
/autoload.php');


| The Inventory Code of the ent
ry to patch
$inventoryPatch = ; // Inventor
yPatch | The subset of Inventor
y fields to patch
en
anguage
try {
ventoriesPatchAsync($code, $inv
entoryPatch, $authorization, $a
cceptLanguage, $apiVersion);
print_r($result);

g InventoriesApi->inventoriesPa
tchAsync: ', $e->getMessage(),
PHP_EOL;
?>
use Data::Dumper;
ration;
riesApi;

S_TOKEN';

ng | The Inventory Code of the
entry to patch
my $inventoryPatch = WWW::Swagg
erClient::Object::InventoryPatc
h->new(); # InventoryPatch | Th
e subset of Inventory fields to
patch
oken
-Language
eval {
>inventoriesPatchAsync(code =>
$code, inventoryPatch => $inven
toryPatch, authorization => $au
$apiVersion);
};
if ($@) {

g InventoriesApi->inventoriesPa
tchAsync: $@\n";

atement
import time
ApiException

'

class
nventoriesApi()

The Inventory Code of the entry
to patch
inventoryPatch = # InventoryPa
tch | The subset of Inventory f
ields to patch
(optional)
US)
l) (default to 1.0)
try:
# Patch an Inventory entry
.inventories_patch_async(code,
inventoryPatch, authorization=a
sion)

ng InventoriesApi->inventoriesP
atchAsync: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
The Inventory Code of the entry to patch
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
inventoryPatch * InventoryPatch {
The data to Patch an Inventory entry

Description:
Description string maxLength:2000
WarrantyTypeCode:
WarrantyTypeCode string maxLength:50
AssignedForAllotment boolean
Brand:
Brand string maxLength:255
Category:
Category string maxLength:255
CountryOfOrigin:
CountryOfOrigin string minLength:2 maxLength:2
Family:
Family string maxLength:255
Gender:
Gender string minLength:2 maxLength:2
Line:
Line string maxLength:255
Medium:
Medium string maxLength:255
Range:
Range string maxLength:255
SubCategory:
SubCategory string maxLength:255
Type:
Type string minLength:2 maxLength:2
Weight:
Weight number (double)
WeightUnit:
WeightUnit string maxLength:50
InternalCost:
MoneyModel {
Money.
Amount:
Amount number
Currency:
Currency string
}
StandardCost:
MoneyModel {
Money.
Amount:
Amount number
Currency:
Currency string
}
InternalCorpCost:
MoneyModel {
Money.
Amount:
Amount number
Currency:
Currency string
}
StandardCorpCost:
MoneyModel {
Money.
Amount:
Amount number
Currency:
Currency string
}
}
Responses
Status: 200 - OK
• Schema
{
}
Status: 204 -
NoContent
inventoriesPostAsync
Create an Inventory entry
/api/Inventories
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Inventories"
;
*;
ventoriesApi;
import java.util.*;

ple {

ing[] args) {
ient();
uth2

("oauth2");
InventoryDto inventory
= ; // InventoryDto | The {Inve
ntory} data to create
g | access token

i-Version
try {
Object result = api

Instance.inventoriesPostAsync(i
nventory, authorization, accept
System.out.println(
result);
) {
System.err.println(
riesApi#inventoriesPostAsync");
e.printStackTrace()
;
ventoriesApi;

ple {

ing[] args) {
InventoryDto inventory
= ; // InventoryDto | The {Inve
ntory} data to create
g | access token

i-Version
try {
Object result = api

Instance.inventoriesPostAsync(i
nventory, authorization, accept
System.out.println(
result);
) {
System.err.println(
riesApi#inventoriesPostAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
InventoryDto *inventory = ; //
The {Inventory} data to create

(optional)

-US)

// Create an Inventory entry
[apiInstance inventoriesPostAsy
ncWith:inventory
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"

nventoriesApi()
var inventory = ; // {Inventory
Dto} The {Inventory} data to cr
eate
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.inventoriesPostAsync(invent
ory, opts, callback);
using System;
namespace Example
public class inventoriesPos

tAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var inventory = new

InventoryDto(); // InventoryDto
| The {Inventory} data to creat
e
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create an In
ventory entry
Object result =
apiInstance.inventoriesPostAsyn
c(inventory, authorization, acc
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
sApi.inventoriesPostAsync: " +
e.Message );
<?php
/autoload.php');


$inventory = ; // InventoryDto
| The {Inventory} data to creat
e
en
anguage
try {
ventoriesPostAsync($inventory,
, $apiVersion);
print_r($result);

g InventoriesApi->inventoriesPo
stAsync: ', $e->getMessage(), P
HP_EOL;
?>
use Data::Dumper;
ration;
riesApi;

S_TOKEN';
my $inventory = WWW::SwaggerCli
ent::Object::InventoryDto->new(
); # InventoryDto | The {Invent
ory} data to create
oken
-Language
eval {
>inventoriesPostAsync(inventory
=> $inventory, authorization =>
=> $apiVersion);
};
if ($@) {

g InventoriesApi->inventoriesPo
stAsync: $@\n";
}

atement
import time

ApiException

'

class
nventoriesApi()
inventory = # InventoryDto | T
he {Inventory} data to create
(optional)
US)
l) (default to 1.0)
try:
# Create an Inventory entry
.inventories_post_async(invento
ry, authorization=authorization
, apiVersion=apiVersion)

ng InventoriesApi->inventoriesP
ostAsync: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
inventory * {
The data for an item that can be shipped

Code:
string
The unique external identifier for the Inventory entry
Description:
string
WarrantyTypeCode:
string
Code of the associated Warranty Type
InternalCost:
number (double)
Internal Value (Average cost) for the Inventory (intended for
reporting)
string
Currency Code associated with the Internal Value (Average
cost)
StandardCost:
number (double)
string
Currency Code associated with the (Average cost)
InternalCorpCost:
number (double)
Internal Value (Average corp cost) for the Inventory
string
Currency Code associated with the Internal Value (Average
corp cost)
StandardCorpCost:
number (double)
string
Currency Code associated with the (Average corp cost)
boolean
Flag indicating whether the Inventory is under lot control,
meaning if lot # is tracked and required
Family:
string
External code for the 1st and highest level of product hierarchy
Category:
string
External code for 2nd level of the product hierarchy
SubCategory:
string
External code for 3rd level of the product hierarchy
Line:
string
External code for 4th level of the product hierarchy
Range:
string
External code for 5th level of the product hierarchy
Brand:
string
An alphanumeric code used to define an additional
characteristic of a product
Medium:
string
An alphanumeric field used to identify products communicated
in a certain special space in a catalog
Gender:
string
An alphanumeric field used to define an additional
characteristic of the product
Type:
string
An alphanumeric field used to define the type code
CountryOfOrigin:
string
Country Code to allow for optional import/export cost
calculation and tax reporting based on country of production
vs. country of sale.
Weight:
number (double)
Per item Weight, measured in WeightUnit
WeightUnit:
string
}
Responses
Status: 200 - OK
• Schema
{
}
Lineages
lineagesGetAll
Get data for Lineage entries
/api/Lineages
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Lineages?pageNumber=&
pageSize=&sortType=&culture=&fi
lters="
;
*;
import io.swagger.client.api.Li
neagesApi;
import java.util.*;
public class LineagesApiExample

{

ing[] args) {
ient();

uth2

("oauth2");
LineagesApi apiInstance
= new LineagesApi();

greater than 0
'
g | access token

i-Version

ot specified,
the defa

s
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.LineageDtoLink result =
apiInstance.lineagesGetAll(page
Number, pageSize, sortType, aut
Version, culture, filters);
System.out.println(
result);
) {
System.err.println(
"Exception when calling Lineage
sApi#lineagesGetAll");
e.printStackTrace()
;
neagesApi;
{

ing[] args) {

greater than 0

'
g | access token

i-Version

ot specified,
the defa

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.LineageDtoLink result =
apiInstance.lineagesGetAll(page
System.out.println(
result);
) {
System.err.println(
sApi#lineagesGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

default to 25)

c)

(optional)

-US)


the defa

le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
LineagesApi *apiInstance = [[Li

neagesApi alloc] init];
// Get data for Lineage entries
[apiInstance lineagesGetAllWith
:pageNumber
pageSize:pageSize
sortType:sortType
ge
culture:culture
filters:filters
completionHandler
: ^(HateoasCollectionResponse.L
ineageDtoLink output, NSError*
error) {
if
(output) {
if
(error) {
}];





SS TOKEN"
var api = new JenkonRestApiV1.L
ineagesApi()

than or equal to 0

0

var opts = {
oken
-Language
,
the defa
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {
ata);
};
api.lineagesGetAll(pageNumber,
ack);
using System;
namespace Example
public class lineagesGetAll

Example
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew LineagesApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get data for

Lineage entries
HateoasCollecti
onResponse.LineageDtoLink resul
t = apiInstance.lineagesGetAll(
apiVersion, culture, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling LineagesAp
i.lineagesGetAll: " + e.Message
);
<?php
/autoload.php');

ent\Api\LineagesApi();

an or equal to 0

for 'Descending'
en
anguage
the defa
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
$result = $api_instance->li
neagesGetAll($pageNumber, $page
Size, $sortType, $authorization
, $acceptLanguage, $apiVersion,
$culture, $filters);
print_r($result);

g LineagesApi->lineagesGetAll:
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Lineage
sApi;

S_TOKEN';
Client::LineagesApi->new();

than or equal to 0

0
oken
-Language
,
the defa
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>lineagesGetAll(pageNumber => $
ze, sortType => $sortType, auth
orization => $authorization, ac
ceptLanguage => $acceptLanguage
, apiVersion => $apiVersion, cu
lture => $culture, filters => $
filters);
};
if ($@) {

g LineagesApi->lineagesGetAll:
$@\n";

atement
import time

ApiException

'
class
api_instance = swagger_client.L
ineagesApi()


efault to 25)
)
(optional)
US)
l) (default to 1.0)

the defa
ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get data for Lineage entr

ies
.lineages_get_all(pageNumber, p
ageSize, sortType, authorizatio
n=authorization, acceptLanguage
=acceptLanguage, apiVersion=api
Version, culture=culture, filte
rs=filters)

ng LineagesApi->lineagesGetAll:
%s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer

Required
sortType* String

'Descending'
Required
culture String

filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
LineageDto with Hateos Link
property.
Link:
string
Link to full lineage information.
Code:
string
Code.
Description:
string
Description
Enrolling:
boolean
Flag for enrolling lineage
EnrollingLineage:
string
The enrolling lineage associated with
this lineage, may be null. If set, this
lineage is used when processing
holding tanks and autoplacement.
RootActivityCenter:
string
The activity center at the root of the
lineage.
MaxWidth:
integer (int32)
Maximum width of the first level
downline, or -1 if there is no limit.
RootMaxWidth:
integer (int32)
Maximum width of the root node
TerminateInPlace:
boolean
Flag indicating terminated activity
centers do not alter sponsorship
}
]
}
lineagesGetLineageByCo
de
Get data for a lineage entry
/api/Lineages/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Lineages/{code}?cultu
re="
;
*;
neagesApi;
import java.util.*;
{

ing[] args) {
ient();

uth2

("oauth2");

ple; // String | The Lineage Co
de to retrieve
g | access token
i-Version

ot specified,
the defa
try {
LineageDto result =
apiInstance.lineagesGetLineageB
yCode(code, authorization, acce
);
System.out.println(
result);
) {
System.err.println(
sApi#lineagesGetLineageByCode")
;
e.printStackTrace()
;
}
neagesApi;

{

ing[] args) {

de to retrieve
g | access token

i-Version

ot specified,
the defa
try {
LineageDto result =
apiInstance.lineagesGetLineageB
yCode(code, authorization, acce
);
System.out.println(
result);
) {
System.err.println(
sApi#lineagesGetLineageByCode")
;
e.printStackTrace()
;


R_ACCESS_TOKEN"];

The Lineage Code to retrieve
(optional)

-US)


the defa

// Get data for a lineage entry
[apiInstance lineagesGetLineage
ByCodeWith:code
ge
culture:culture
completionHandler
: ^(LineageDto output, NSError*
error) {
if
(output) {
if
(error) {
}];





SS TOKEN"
ineagesApi()

ring} The Lineage Code to retri
eve
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.lineagesGetLineageByCode(co
using System;
namespace Example
public class lineagesGetLin

eageByCodeExample
public void main()
{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew LineagesApi();
var code = code_exa

mple; // String | The Lineage
Code to retrieve
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get data for

a lineage entry
LineageDto resu
lt = apiInstance.lineagesGetLin
eageByCode(code, authorization,
ture);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.lineagesGetLineageByCode: " +
e.Message );
<?php
/autoload.php');


| The Lineage Code to retrieve
en
anguage
the defa
try {
neagesGetLineageByCode($code, $
print_r($result);

g LineagesApi->lineagesGetLinea
geByCode: ', $e->getMessage(),
PHP_EOL;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';

ng | The Lineage Code to retrie
ve
oken
-Language
,
the defa
eval {
>lineagesGetLineageByCode(code
=> $code, authorization => $aut
apiVersion, culture => $culture
);
};
if ($@) {

geByCode: $@\n";

atement
import time

ApiException

'

class
ineagesApi()

(optional)
US)
l) (default to 1.0)
the defa
try:
# Get data for a lineage en

try
.lineages_get_lineage_by_code(c
ode, authorization=authorizatio
e, apiVersion=apiVersion, cultu
re=culture)

ng LineagesApi->lineagesGetLine
ageByCode: %s\n" % e)
Parameters
Path parameters
Name Description
code* String

Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String

Responses
Status: 200 - OK
• Schema
{
LineageDto.
Code:
string
Code.
Description:
string
Description
Enrolling:
boolean
Flag for enrolling lineage
EnrollingLineage:
string
The enrolling lineage associated with
this lineage, may be null. If set, this
lineage is used when processing
holding tanks and autoplacement.
RootActivityCenter:
string
The activity center at the root of the
lineage.
MaxWidth:
integer (int32)
Maximum width of the first level
RootMaxWidth:
integer (int32)
Maximum width of the root node
TerminateInPlace:
boolean
Flag indicating terminated activity
centers do not alter sponsorship
}
lineagesGetLineagesByA
ccount
Get data for Lineage entries of a
specific Account
/api/Accounts/{accountCode}/Lin
eages
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

}/Lineages"
;
*;
neagesApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");
The Account Code.
g | access token

i-Version
try {
CollectionResponse.
LineageAccountLinksDto result =
apiInstance.lineagesGetLineages
ByAccount(accountCode, authoriz
on);
System.out.println(
result);
) {
System.err.println(
sApi#lineagesGetLineagesByAccou
nt");
e.printStackTrace()
;
neagesApi;
{

ing[] args) {
The Account Code.
g | access token

i-Version
try {
CollectionResponse.
LineageAccountLinksDto result =
apiInstance.lineagesGetLineages
ByAccount(accountCode, authoriz
on);
System.out.println(
result);
) {
System.err.println(
sApi#lineagesGetLineagesByAccou
nt");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

de_example; // The Account Code
.

(optional)

-US)

// Get data for Lineage entries

of a specific Account
[apiInstance lineagesGetLineage
sByAccountWith:accountCode
ge
completionHandler
: ^(CollectionResponse.LineageA
ccountLinksDto output, NSError*
error) {
if
(output) {
if
(error) {

}
}];





SS TOKEN"

ineagesApi()

xample; // {String} The Account
Code.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.lineagesGetLineagesByAccoun
t(accountCode, opts, callback);
using System;
namespace Example
public class lineagesGetLin

eagesByAccountExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew LineagesApi();
var accountCode = a
| The Account Code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get data for

Lineage entries of a specific A
ccount
CollectionRespo
nse.LineageAccountLinksDto resu
lt = apiInstance.lineagesGetLin
eagesByAccount(accountCode, aut
Version);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.lineagesGetLineagesByAccount:
" + e.Message );
}
<?php
/autoload.php');


de.
en
anguage
try {
neagesGetLineagesByAccount($acc
ountCode, $authorization, $acce
print_r($result);

gesByAccount: ', $e->getMessage
(), PHP_EOL;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';
xample; # String | The Account
Code.
oken
-Language
eval {
>lineagesGetLineagesByAccount(a
ccountCode => $accountCode, aut
};
if ($@) {

gesByAccount: $@\n";

atement
import time

ApiException

'

class
ineagesApi()
le # String | The Account Code.
(optional)
US)
l) (default to 1.0)
try:
# Get data for Lineage entr

ies of a specific Account
.lineages_get_lineages_by_accou
nt(accountCode, authorization=a
sion)

ng LineagesApi->lineagesGetLine
agesByAccount: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
The Account Code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
Mediator
TotalCount:
integer (int32)
Total count
Items:
[
Items
{
LineageAccountLinksDto.
Lineage:
string
Lineage Code.
LineageLink:
string
Link to lineage information.
DownlineLink:
string
Link to downline Sponsor
information.
UplineLink:
string
Link to upline Sponsor information.
}
]
}
lineagesGetSponsorsByA
ccountDownline
Get data for Sponsor entries of a
specific Account in the specified
Lineage
eages/{lineageCode}/Downline
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

}/Lineages/{lineageCode}/Downli
ne?pageNumber=&pageSize=&sortTy
pe="
;
*;
neagesApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");
The Account Code.
String lineageCode = li
neageCode_example; // String |
The Lineage Code.

greater than 0

'
g | access token

i-Version
try {
HateoasCollectionRe
sponse.SponsorLinksDto result =
apiInstance.lineagesGetSponsors
ByAccountDownline(accountCode,
lineageCode, pageNumber, pageSi
System.out.println(
result);
) {
System.err.println(
sApi#lineagesGetSponsorsByAccou
ntDownline");
e.printStackTrace()
;
neagesApi;

{

ing[] args) {
The Account Code.
The Lineage Code.

greater than 0

'
g | access token

i-Version
try {
HateoasCollectionRe
sponse.SponsorLinksDto result =
apiInstance.lineagesGetSponsors
ByAccountDownline(accountCode,
lineageCode, pageNumber, pageSi
System.out.println(
result);
) {
System.err.println(
ntDownline");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

.
String *lineageCode = lineageCo

de_example; // The Lineage Code
.

default to 25)

c)

(optional)

-US)


// Get data for Sponsor entries

of a specific Account in the sp
ecified Lineage
[apiInstance lineagesGetSponsor
sByAccountDownlineWith:accountC
ode
lineageCode:lineageCode
pageSize:pageSize
sortType:sortType
ge
completionHandler
ponsorLinksDto output, NSError*
error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

ineagesApi()

Code.
var lineageCode = lineageCode_e

xample; // {String} The Lineage
Code.

than or equal to 0

0
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.lineagesGetSponsorsByAccoun
tDownline(accountCode, lineageC
ode, pageNumber, pageSize, sort
Type, opts, callback);
using System;
namespace Example
public class lineagesGetSpo

nsorsByAccountDownlineExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew LineagesApi();
var accountCode = a
| The Account Code.
var lineageCode = l
ineageCode_example; // String
| The Lineage Code.
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
{
// Get data for
Sponsor entries of a specific A
ccount in the specified Lineage
HateoasCollecti
onResponse.SponsorLinksDto resu
lt = apiInstance.lineagesGetSpo
nsorsByAccountDownline(accountC
ode, lineageCode, pageNumber, p
ageSize, sortType, authorizatio
n, acceptLanguage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.lineagesGetSponsorsByAccountD
ownline: " + e.Message );
<?php
/autoload.php');

de.
$lineageCode = lineageCode_exam
de.

an or equal to 0

for 'Descending'
en
anguage
try {
neagesGetSponsorsByAccountDownl
ine($accountCode, $lineageCode,
$pageNumber, $pageSize, $sortTy
pe, $authorization, $acceptLang
uage, $apiVersion);
print_r($result);

g LineagesApi->lineagesGetSpons
orsByAccountDownline: ', $e->ge
tMessage(), PHP_EOL;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';
Code.
my $lineageCode = lineageCode_e
xample; # String | The Lineage
Code.

than or equal to 0

0
oken
-Language
eval {
>lineagesGetSponsorsByAccountDo
wnline(accountCode => $accountC
ode, lineageCode => $lineageCod
e, pageNumber => $pageNumber, p
ageSize => $pageSize, sortType
=> $sortType, authorization =>
=> $apiVersion);
};
if ($@) {

orsByAccountDownline: $@\n";

atement
import time

ApiException

'
class
ineagesApi()
lineageCode = lineageCode_examp
le # String | The Lineage Code.


efault to 25)
)
(optional)
US)
l) (default to 1.0)
try:
# Get data for Sponsor entr
ies of a specific Account in th
e specified Lineage
.lineages_get_sponsors_by_accou
nt_downline(accountCode, lineag
eCode, pageNumber, pageSize, so
rtType, authorization=authoriza

ng LineagesApi->lineagesGetSpon
sorsByAccountDownline: %s\n" %
e)
Parameters
Path parameters
Name Description
accountCode* String
The Account Code.
Required
lineageCode* String
The Lineage Code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Account:
string
Account Code.
AccountLink:
string
Link to account information.
DownlineLink:
string
information.
UplineLink:
string
}
]
}
lineagesGetSponsorsByA
ccountUpline
Get data for Sponsor entry of a
specific Account in the specified
Lineage
eages/{lineageCode}/Upline
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

}/Lineages/{lineageCode}/Upline
"
;
*;
neagesApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");
The Account Code.
The Lineage Code.
g | access token

i-Version
try {
SponsorLinksDto res
ult = apiInstance.lineagesGetSp
onsorsByAccountUpline(accountCo
de, lineageCode, authorization,
System.out.println(
result);
) {
System.err.println(
ntUpline");
e.printStackTrace()
;
neagesApi;

{

ing[] args) {
The Account Code.
The Lineage Code.
g | access token

i-Version
try {
SponsorLinksDto res
ult = apiInstance.lineagesGetSp
onsorsByAccountUpline(accountCo
de, lineageCode, authorization,
System.out.println(
result);
) {
System.err.println(
ntUpline");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];

.

de_example; // The Lineage Code
.

(optional)

-US)

// Get data for Sponsor entry o

f a specific Account in the spe
cified Lineage
[apiInstance lineagesGetSponsor
sByAccountUplineWith:accountCod
e
ge
completionHandler
: ^(SponsorLinksDto output, NSE
rror* error) {
if
(output) {
if
(error) {
}
}];





SS TOKEN"

ineagesApi()

Code.

xample; // {String} The Lineage
Code.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.lineagesGetSponsorsByAccoun
tUpline(accountCode, lineageCod
e, opts, callback);
using System;
namespace Example
public class lineagesGetSpo

nsorsByAccountUplineExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew LineagesApi();
var accountCode = a
| The Account Code.
var lineageCode = l
| The Lineage Code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get data for

Sponsor entry of a specific Acc
ount in the specified Lineage
SponsorLinksDto
result = apiInstance.lineagesGe
tSponsorsByAccountUpline(accoun
tCode, lineageCode, authorizati
;
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.lineagesGetSponsorsByAccountU
pline: " + e.Message );
<?php
/autoload.php');


de.
de.
en
anguage
try {
neagesGetSponsorsByAccountUplin
e($accountCode, $lineageCode, $
$apiVersion);
print_r($result);

orsByAccountUpline: ', $e->getM
essage(), PHP_EOL;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';
Code.
xample; # String | The Lineage
Code.
oken
-Language
eval {
>lineagesGetSponsorsByAccountUp
line(accountCode => $accountCod
e, lineageCode => $lineageCode,
);
};
if ($@) {

orsByAccountUpline: $@\n";

atement
import time

ApiException

'

class
ineagesApi()
le # String | The Lineage Code.
(optional)
US)
l) (default to 1.0)
try:
# Get data for Sponsor entr

y of a specific Account in the
specified Lineage
.lineages_get_sponsors_by_accou
nt_upline(accountCode, lineageC

ng LineagesApi->lineagesGetSpon
sorsByAccountUpline: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
The Account Code.
Required
lineageCode* String
The Lineage Code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
Account:
string
Account Code.
AccountLink:
string
Link to account information.
DownlineLink:
string
information.
UplineLink:
string
}
lineagesPatchSponsorAs
ync
Change a Lineage sponsorship entry
eages/{lineageCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Accounts/{accountCo
de}/Lineages/{lineageCode}"
;
*;
neagesApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");
The account code
The lineage to join
LineageAccountPatchDto
lineageAccountPatch = ; // Line
ageAccountPatchDto | The {Linea
geAccountPatchDto} data to crea
te
g | access token
i-Version
try {
Object result = api

Instance.lineagesPatchSponsorAs
ync(accountCode, lineageCode, l
ineageAccountPatch, authorizati
;
System.out.println(
result);
) {
System.err.println(
sApi#lineagesPatchSponsorAsync"
);
e.printStackTrace()
;
neagesApi;

{
ing[] args) {
The account code
The lineage to join
LineageAccountPatchDto
lineageAccountPatch = ; // Line
ageAccountPatchDto | The {Linea
geAccountPatchDto} data to crea
te
g | access token

i-Version
try {
Object result = api

Instance.lineagesPatchSponsorAs
ync(accountCode, lineageCode, l
ineageAccountPatch, authorizati
;
System.out.println(
result);
) {
System.err.println(
sApi#lineagesPatchSponsorAsync"
);
e.printStackTrace()
;


R_ACCESS_TOKEN"];


de_example; // The lineage to j
oin
LineageAccountPatchDto *lineage
AccountPatch = ; // The {Lineag
eAccountPatchDto} data to creat
e
(optional)

-US)


// Change a Lineage sponsorship

entry
[apiInstance lineagesPatchSpons
orAsyncWith:accountCode
lineageAccountPatch:lineage
AccountPatch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"

ineagesApi()
code

xample; // {String} The lineage
to join
var lineageAccountPatch = ; //
{LineageAccountPatchDto} The {L
ineageAccountPatchDto} data to
create
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.lineagesPatchSponsorAsync(a
ccountCode, lineageCode, lineag
eAccountPatch, opts, callback);
using System;
namespace Example
public class lineagesPatchS

ponsorAsyncExample
public void main()
{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew LineagesApi();
var accountCode = a
| The account code
var lineageCode = l
| The lineage to join
var lineageAccountP
atch = new LineageAccountPatchD
to(); // LineageAccountPatchDto
| The {LineageAccountPatchDto}
data to create
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Change a Lin
eage sponsorship entry
Object result =
apiInstance.lineagesPatchSponso
rAsync(accountCode, lineageCode
, lineageAccountPatch, authoriz
on);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.lineagesPatchSponsorAsync: "
+ e.Message );
<?php
/autoload.php');

de
ple; // String | The lineage to
join
$lineageAccountPatch = ; // Lin
eageAccountPatchDto | The {Line
ageAccountPatchDto} data to cre
ate
en
anguage
try {
neagesPatchSponsorAsync($accoun
tCode, $lineageCode, $lineageAc
countPatch, $authorization, $ac
ceptLanguage, $apiVersion);
print_r($result);

g LineagesApi->lineagesPatchSpo
nsorAsync: ', $e->getMessage(),
PHP_EOL;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';
code
xample; # String | The lineage
to join
my $lineageAccountPatch = WWW::
SwaggerClient::Object::LineageA
ccountPatchDto->new(); # Lineag
eAccountPatchDto | The {Lineage
AccountPatchDto} data to create
oken
-Language
eval {
>lineagesPatchSponsorAsync(acco
untCode => $accountCode, lineag
eCode => $lineageCode, lineageA
ccountPatch => $lineageAccountP
atch, authorization => $authori
ersion);
};
if ($@) {
g LineagesApi->lineagesPatchSpo
nsorAsync: $@\n";

atement
import time

ApiException

'

class
ineagesApi()
le # String | The lineage to jo
in
lineageAccountPatch = # Lineag
eAccountPatchDto | The {Lineage
AccountPatchDto} data to create
(optional)
US)
l) (default to 1.0)
try:
# Change a Lineage sponsors

hip entry
.lineages_patch_sponsor_async(a
ccountCode, lineageCode, lineag
eAccountPatch, authorization=au
thorization, acceptLanguage=acc
eptLanguage, apiVersion=apiVers
ion)

ng LineagesApi->lineagesPatchSp
onsorAsync: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
The account code
Required
lineageCode* String
The lineage to join
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
lineageAccountPatch LineageAccountPatchDto {
*
LineageAccountPatchDto for APIs that will change a
Sponsor.
Required: Sponsor
Sponsor:
Sponsor string minLength:1 maxLength:50
}
Responses
Status: 200 - OK
• Schema
{
}
lineagesPostSponsorAsy
nc
Create a Lineage sponsorship entry
eages/{lineageCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

e}/Lineages/{lineageCode}"
;
*;
neagesApi;
import java.util.*;

{

ing[] args) {
ient();
uth2

("oauth2");
The account code
The lineage to join
LineageAccountPostDto l
ineageAccountPost = ; // Lineag
eAccountPostDto | The {LineageA
ccountPostDto} data to create
g | access token

i-Version
try {
Object result = api
Instance.lineagesPostSponsorAsy
nc(accountCode, lineageCode, li
neageAccountPost, authorization
System.out.println(
result);
) {
System.err.println(
sApi#lineagesPostSponsorAsync")
;
e.printStackTrace()
;
neagesApi;

{

ing[] args) {
The account code
The lineage to join
LineageAccountPostDto l
ineageAccountPost = ; // Lineag
eAccountPostDto | The {LineageA
g | access token

i-Version
try {
Object result = api

Instance.lineagesPostSponsorAsy
nc(accountCode, lineageCode, li
neageAccountPost, authorization
System.out.println(
result);
) {
System.err.println(
sApi#lineagesPostSponsorAsync")
;
e.printStackTrace()
;


R_ACCESS_TOKEN"];


de_example; // The lineage to j
oin
LineageAccountPostDto *lineageA
ccountPost = ; // The {LineageA

(optional)

-US)

// Create a Lineage sponsorship

entry
[apiInstance lineagesPostSponso
rAsyncWith:accountCode
lineageAccountPost:lineageA
ccountPost
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"

ineagesApi()

code

xample; // {String} The lineage
to join
var lineageAccountPost = ; // {
LineageAccountPostDto} The {Lin
eageAccountPostDto} data to cre
ate
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.lineagesPostSponsorAsync(ac
countCode, lineageCode, lineage
AccountPost, opts, callback);
using System;
namespace Example
public class lineagesPostSp

onsorAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew LineagesApi();
var accountCode = a
| The account code
var lineageCode = l
| The lineage to join
var lineageAccountP
ost = new LineageAccountPostDto
(); // LineageAccountPostDto |
The {LineageAccountPostDto} dat
a to create
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a Lin
eage sponsorship entry
Object result =
apiInstance.lineagesPostSponsor
Async(accountCode, lineageCode,
lineageAccountPost, authorizati
;
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.lineagesPostSponsorAsync: " +
e.Message );
<?php
/autoload.php');

de
ple; // String | The lineage to
join
$lineageAccountPost = ; // Line
ageAccountPostDto | The {Lineag
eAccountPostDto} data to create
en
anguage
try {
neagesPostSponsorAsync($account
Code, $lineageCode, $lineageAcc
ountPost, $authorization, $acce
print_r($result);

g LineagesApi->lineagesPostSpon
sorAsync: ', $e->getMessage(),
PHP_EOL;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';
code
xample; # String | The lineage
to join
my $lineageAccountPost = WWW::S
waggerClient::Object::LineageAc
countPostDto->new(); # LineageA
ccountPostDto | The {LineageAcc
ountPostDto} data to create
oken
-Language
eval {
>lineagesPostSponsorAsync(accou
ntCode => $accountCode, lineage
Code => $lineageCode, lineageAc
countPost => $lineageAccountPos
t, authorization => $authorizat
ion);
};
if ($@) {

g LineagesApi->lineagesPostSpon
sorAsync: $@\n";

atement
import time

ApiException

'

class
ineagesApi()
le # String | The lineage to jo
in
lineageAccountPost = # Lineage
AccountPostDto | The {LineageAc
countPostDto} data to create
(optional)
US)
l) (default to 1.0)
try:
# Create a Lineage sponsors

hip entry
.lineages_post_sponsor_async(ac
countCode, lineageCode, lineage
AccountPost, authorization=auth
orization, acceptLanguage=accep
tLanguage, apiVersion=apiVersio
n)

ng LineagesApi->lineagesPostSpo
nsorAsync: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
The account code
Required
lineageCode* String
The lineage to join
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
lineageAccountPost LineageAccountPostDto {
*
LineageAccountPostDto for APIs that will add a Sponsor.
Required: Sponsor
Sponsor:
Sponsor string minLength:1 maxLength:50
}
Responses
Status: 200 - OK
• Schema
{
}
Offers
offersGetAll
Get all offers
/api/Offers
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Offers?pageNumber=&pa
geSize=&sortType="
;
*;
import io.swagger.client.api.Of
fersApi;
import java.util.*;
public class OffersApiExample {

ing[] args) {
ient();

uth2

("oauth2");
OffersApi apiInstance =
new OffersApi();

greater than 0

'
g | access token

i-Version
try {
HateoasCollectionRe
sponse.OfferDto result = apiIns
tance.offersGetAll(pageNumber,
;
System.out.println(
result);
) {
System.err.println(
"Exception when calling OffersA
pi#offersGetAll");
e.printStackTrace()
;
fersApi;

ing[] args) {
new OffersApi();

greater than 0

'
g | access token

i-Version
try {
HateoasCollectionRe
sponse.OfferDto result = apiIns
tance.offersGetAll(pageNumber,
;
System.out.println(
result);
) {
System.err.println(
pi#offersGetAll");
e.printStackTrace()
;

R_ACCESS_TOKEN"];


default to 25)

c)

(optional)

-US)

OffersApi *apiInstance = [[Offe

rsApi alloc] init];
// Get all offers
[apiInstance offersGetAllWith:p
ageNumber
pageSize:pageSize
sortType:sortType
ge
completionHandler
: ^(HateoasCollectionResponse.O
fferDto output, NSError* error)
{
if
(output) {
if
(error) {
}];




SS TOKEN"
var api = new JenkonRestApiV1.O

ffersApi()

than or equal to 0

0

var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.offersGetAll(pageNumber, pa
geSize, sortType, opts, callbac
k);
using System;
namespace Example
public class offersGetAllEx

ample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew OffersApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;
var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get all offe

rs
HateoasCollecti
onResponse.OfferDto result = ap
iInstance.offersGetAll(pageNumb
ion);
Debug.WriteLine
(result);
}
catch (Exception e)
Debug.Print("Ex
ception when calling OffersApi.
offersGetAll: " + e.Message );
<?php
/autoload.php');


ent\Api\OffersApi();

an or equal to 0
for 'Descending'
en
anguage
try {
$result = $api_instance->of
fersGetAll($pageNumber, $pageSi
ze, $sortType, $authorization,
print_r($result);

g OffersApi->offersGetAll: ', $
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::OffersA
pi;

S_TOKEN';
Client::OffersApi->new();

than or equal to 0

0
oken
-Language
eval {
>offersGetAll(pageNumber => $pa
geNumber, pageSize => $pageSize
, sortType => $sortType, author
};
if ($@) {

g OffersApi->offersGetAll: $@\n
";

atement
import time

ApiException

'

class
api_instance = swagger_client.O
ffersApi()


efault to 25)
)
(optional)
US)
l) (default to 1.0)
try:
# Get all offers
.offers_get_all(pageNumber, pag
eSize, sortType, authorization=
rsion)

ng OffersApi->offersGetAll: %s\
n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Offer
ActivityCenter:
string
Activity center
Code:
string
Code
Country:
string
Country
Currency:
string
Currency
Product:
string
Product
StartDate:
string (date-time)
Start date
EndDate:
string (date-time)
End date
PriceType:
string
Price type
Price:
number (double)
Price
TaxBase:
number (double)
Tax base
CreditBase:
number (double)
Credit base
TaxInclusive:
boolean
Tax inclusive
Discountable:
boolean
Discountable
ReferentialPrice:
number (double)
Referential price
Flag1:
boolean
Flag1
PriceVolume:
[
Price volume
{
Offer volume
VolumeCode:
maxLength:50
Amount:
(ex)minimum:true
}
]
}
]
}
offersGetByCode
Get offer by code
/api/Offers/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Offers/{code}"
;
*;
fersApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new OffersApi();
ple; // String | Offer code
g | access token

i-Version
try {
OfferDto result = a
piInstance.offersGetByCode(code
, apiVersion);
System.out.println(
result);
) {
System.err.println(
pi#offersGetByCode");
e.printStackTrace()
;
}
fersApi;

ing[] args) {
new OffersApi();

ple; // String | Offer code
g | access token

i-Version
try {
OfferDto result = a
piInstance.offersGetByCode(code
, apiVersion);
System.out.println(
result);
) {
System.err.println(
pi#offersGetByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

Offer code

(optional)

-US)

rsApi alloc] init];
// Get offer by code
[apiInstance offersGetByCodeWit
h:code
ge
completionHandler
: ^(OfferDto output, NSError* e
rror) {
if
(output) {
if
(error) {
}];




SS TOKEN"

ffersApi()

ring} Offer code
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.offersGetByCode(code, opts,
callback);
using System;
namespace Example
public class offersGetByCod

eExample
{
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew OffersApi();
var code = code_exa

mple; // String | Offer code
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
{
// Get offer by
code
OfferDto result
= apiInstance.offersGetByCode(c
age, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
offersGetByCode: " + e.Message
);
<?php
/autoload.php');



| Offer code
en
anguage
try {
fersGetByCode($code, $authoriza
ion);
print_r($result);

g OffersApi->offersGetByCode: '
}
?>
use Data::Dumper;
ration;
pi;

S_TOKEN';

ng | Offer code
oken
-Language
eval {
>offersGetByCode(code => $code,
);
};
if ($@) {

g OffersApi->offersGetByCode: $
@\n";

atement
import time

ApiException

'
class
ffersApi()

Offer code
(optional)
US)
l) (default to 1.0)
try:
# Get offer by code
.offers_get_by_code(code, autho
ion=apiVersion)

ng OffersApi->offersGetByCode:
%s\n" % e)
Parameters
Path parameters
Name Description
code* String
Offer code
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
Offer
ActivityCenter:
string
Activity center
Code:
string
Code
Country:
string
Country
Currency:
string
Currency
Product:
string
Product
StartDate:
string (date-time)
Start date
EndDate:
string (date-time)
End date
PriceType:
string
Price type
Price:
number (double)
Price
TaxBase:
number (double)
Tax base
CreditBase:
number (double)
Credit base
TaxInclusive:
boolean
Tax inclusive
Discountable:
boolean
Discountable
ReferentialPrice:
number (double)
Referential price
Flag1:
boolean
Flag1
PriceVolume:
[
Price volume
{
Offer volume
VolumeCode:
maxLength:50
Amount:
(ex)minimum:true
}
]
}
offersPatch
Update a subset of offer's properties
/api/Offers/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Offers/{code}"
;
*;
fersApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new OffersApi();

ple; // String |
OfferPatch offerPatch =
; // OfferPatch |
g | access token

i-Version
try {
Object result = api
Instance.offersPatch(code, offe
rPatch, authorization, acceptLa
System.out.println(
result);
) {
System.err.println(
pi#offersPatch");
e.printStackTrace()
;
fersApi;

ing[] args) {
new OffersApi();

ple; // String |
OfferPatch offerPatch =
; // OfferPatch |
g | access token

i-Version
try {
Object result = api

Instance.offersPatch(code, offe
rPatch, authorization, acceptLa
System.out.println(
result);
) {
System.err.println(
pi#offersPatch");
e.printStackTrace()
;
}

R_ACCESS_TOKEN"];
OfferPatch *offerPatch = ; //

(optional)

-US)


rsApi alloc] init];
// Update a subset of offer's p

roperties
[apiInstance offersPatchWith:co
de
offerPatch:offerPatch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

ffersApi()

ring}
var offerPatch = ; // {OfferPat

ch}
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

ata);
};
api.offersPatch(code, offerPatc
h, opts, callback);
using System;
namespace Example
public class offersPatchExa

mple
public void main()

{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew OffersApi();
var code = code_exa

mple; // String |
var offerPatch = ne
w OfferPatch(); // OfferPatch |
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
{
// Update a sub
set of offer's properties
Object result =
apiInstance.offersPatch(code, o
fferPatch, authorization, accep
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
offersPatch: " + e.Message );
<?php
/autoload.php');


|
$offerPatch = ; // OfferPatch |
en
anguage
try {
fersPatch($code, $offerPatch, $
$apiVersion);
print_r($result);

g OffersApi->offersPatch: ', $e
->getMessage(), PHP_EOL;
?>
use Data::Dumper;
ration;
pi;

S_TOKEN';

ng |
my $offerPatch = WWW::SwaggerCl
ient::Object::OfferPatch->new()
; # OfferPatch |
oken
-Language
eval {
>offersPatch(code => $code, off
erPatch => $offerPatch, authori
piVersion => $apiVersion);
};
if ($@) {

g OffersApi->offersPatch: $@\n"
;

atement
import time

ApiException

'
class
ffersApi()
offerPatch = # OfferPatch |
(optional)
US)
l) (default to 1.0)
try:
# Update a subset of offer'

s properties
.offers_patch(code, offerPatch,
ng OffersApi->offersPatch: %s\n
" % e)
Parameters
Path parameters
Name Description
code* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
offerPatch * OfferPatch {
Subset of properties to update an offer

PriceType:
PriceType string minLength:1 maxLength:50
Country:
Country string minLength:1 maxLength:50
Currency:
Currency string minLength:1 maxLength:50
Price:
Price number (double) (ex)minimum:true
StartDate:
EndDate:
TaxBase:
TaxBase number (double) (ex)minimum:true
CreditBase:
CreditBase number (double) (ex)minimum:true
TaxInclusive:
TaxInclusive boolean
Discountable:
Discountable boolean
ReferentialPrice:
ReferentialPrice boolean
Flag1:
Flag1 boolean
PriceVolume:
PriceVolume[
{
VolumeCode:
VolumeCode string minLength:1 maxLength:50
Amount:
Amount number (double) (ex)minimum:true
}
]
}
Responses
Status: 200 - OK
• Schema
{
}
offersPost
Create a new offer
/api/Offers
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Offers"
;
*;
fersApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new OffersApi();
OfferPost offer = ; //
OfferPost | Offer values
g | access token

i-Version
try {
apiInstance.offersP
ost(offer, authorization, accep
) {
System.err.println(
pi#offersPost");
e.printStackTrace()
;
fersApi;

ing[] args) {
new OffersApi();
OfferPost offer = ; //
OfferPost | Offer values
g | access token

i-Version
try {
apiInstance.offersP
ost(offer, authorization, accep
) {
System.err.println(
pi#offersPost");
e.printStackTrace()
;

R_ACCESS_TOKEN"];
OfferPost *offer = ; // Offer v

alues

(optional)

-US)


rsApi alloc] init];
// Create a new offer
[apiInstance offersPostWith:off
er
ge
completionHandler
if
(error) {
}];





SS TOKEN"

ffersApi()
var offer = ; // {OfferPost} Of

fer values
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

cessfully.');
};
api.offersPost(offer, opts, cal

lback);
using System;
namespace Example
public class offersPostExam

ple
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew OffersApi();
var offer = new Off

erPost(); // OfferPost | Offer
values
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a new
offer
apiInstance.off
ersPost(offer, authorization, a
catch (Exception e)
Debug.Print("Ex
offersPost: " + e.Message );
<?php
/autoload.php');


$offer = ; // OfferPost | Offer

values
en
anguage
try {
$api_instance->offersPost($
offer, $authorization, $acceptL

g OffersApi->offersPost: ', $e-
?>
use Data::Dumper;
ration;
pi;

S_TOKEN';
my $offer = WWW::SwaggerClient:
:Object::OfferPost->new(); # Of
ferPost | Offer values
oken
-Language
eval {
$api_instance->offersPost(o
ffer => $offer, authorization =
> $authorization, acceptLanguag
e => $acceptLanguage, apiVersio
n => $apiVersion);
};
if ($@) {

g OffersApi->offersPost: $@\n";

atement
import time

ApiException

'
class
ffersApi()
offer = # OfferPost | Offer va

lues
(optional)
US)
l) (default to 1.0)
try:
# Create a new offer
api_instance.offers_post(of
fer, authorization=authorizatio

ng OffersApi->offersPost: %s\n"
% e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
offer * {
Model to create an offer.

Required:
Code,Country,Currency,Price,PriceType,Product,StartDate,TaxBase
Code:
Code string minLength:1 maxLength:50
Product:
Product string minLength:1 maxLength:50
Currency:
Country:
PriceType:
ActivityCenter:
Price:
Price number (double)
TaxBase:
TaxBase number (double)
CreditBase:
CreditBase number (double)
StartDate:
EndDate:
ReferentialPrice:
ReferentialPrice number (double)
TaxInclusive:
TaxInclusive boolean
Flag1:
Flag1 boolean
Discountable:
Discountable boolean
PriceVolume:
PriceVolume[
{
VolumeCode:
VolumeCode string minLength:1 maxLength:50
Amount:
Amount number (double) (ex)minimum:true
}
]
}
Responses

header with the new
resource
Orders
ordersGetAll
Get all orders for a specific account.
/api/Accounts/{accountCode}/Ord
ers
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

}/Orders?pageNumber=&pageSize=&
sortType=&culture=&filters="
;
*;
import io.swagger.client.api.Or
dersApi;
import java.util.*;
public class OrdersApiExample {

ing[] args) {
ient();

uth2

("oauth2");
OrdersApi apiInstance =
new OrdersApi();
Account code.

greater than 0

'
g | access token

i-Version

ot specified,
the defa

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.OrderSummaryDto result =
apiInstance.ordersGetAll(accoun
tCode, pageNumber, pageSize, so
rtType, authorization, acceptLa
nguage, apiVersion, culture, fi
lters);
System.out.println(
result);
) {
System.err.println(
"Exception when calling OrdersA
pi#ordersGetAll");
e.printStackTrace()
;
}
dersApi;

ing[] args) {
new OrdersApi();
Account code.

greater than 0

'
g | access token

i-Version

ot specified,
the defa

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.OrderSummaryDto result =
apiInstance.ordersGetAll(accoun
tCode, pageNumber, pageSize, so
rtType, authorization, acceptLa
nguage, apiVersion, culture, fi
lters);
System.out.println(
result);
) {
System.err.println(
pi#ordersGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];



default to 25)

c)

(optional)

-US)


the defa
le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
OrdersApi *apiInstance = [[Orde

rsApi alloc] init];
// Get all orders for a specifi

c account.
[apiInstance ordersGetAllWith:a
ccountCode
pageSize:pageSize
sortType:sortType
ge
culture:culture
filters:filters
completionHandler
: ^(HateoasCollectionResponse.O
rderSummaryDto output, NSError*
error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

rdersApi()

e.

than or equal to 0

0

var opts = {
oken
-Language
,
the defa
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.ordersGetAll(accountCode, p
ageNumber, pageSize, sortType,
opts, callback);
using System;
namespace Example
public class ordersGetAllEx

ample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew OrdersApi();
var accountCode = a
| Account code.
var pageNumber = 56
0 (default to 1)
var pageSize = 56;
var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get all orde

rs for a specific account.
HateoasCollecti
onResponse.OrderSummaryDto resu
lt = apiInstance.ordersGetAll(a
ccountCode, pageNumber, pageSiz
e, sortType, authorization, acc
eptLanguage, apiVersion, cultur
e, filters);
Debug.WriteLine
(result);
}
catch (Exception e)
Debug.Print("Ex
ception when calling OrdersApi.
ordersGetAll: " + e.Message );
<?php
/autoload.php');


ent\Api\OrdersApi();

an or equal to 0
for 'Descending'
en
anguage
the defa
String | # Filters
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
$result = $api_instance->or
dersGetAll($accountCode, $pageN
umber, $pageSize, $sortType, $a
$apiVersion, $culture, $filters
);
print_r($result);

g OrdersApi->ordersGetAll: ', $
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::OrdersA
pi;
S_TOKEN';
Client::OrdersApi->new();
.

than or equal to 0

0
oken
-Language
,
the defa
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>ordersGetAll(accountCode => $a
ccountCode, pageNumber => $page
Number, pageSize => $pageSize,
sortType => $sortType, authoriz
iVersion => $apiVersion, cultur
e => $culture, filters => $filt
ers);
};
if ($@) {

g OrdersApi->ordersGetAll: $@\n
";

atement
import time

ApiException

'
class
rdersApi()


efault to 25)
)
(optional)
US)
l) (default to 1.0)

the defa

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get all orders for a spec

ific account.
.orders_get_all(accountCode, pa
ture, filters=filters)

ng OrdersApi->ordersGetAll: %s\
n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
culture String

filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Simplified Order Dto for the Get All
method.
Number:
string
Order number.
Type:
string
Order type.
Date:
string (date-time)
Order date.
Event:
string
Order event.
TotalAmount:
number (double)
Order total amount.
TotalCurrency:
string
Order total currency.
Status:
string
Order status.
CustomerId:
string
Order customer ID.
CustomerName:
string
Order customer name.
Application:
string
Order application.
User:
string
Order user.
OrderDetails:
string
Hateoas reference to the order
details.
}
]
}
ordersGetOrderByCode
Get data for an Order entry.
/api/Orders/{orderCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
44356/api/Orders/{orderCode}?cu
lture="
;
*;
dersApi;
import java.util.*;

ing[] args) {
ient();

uth2
("oauth2");
new OrdersApi();
String orderCode = orde

rCode_example; // String | Orde
r code.
g | access token

i-Version

ot specified,
the defa
try {
OrderDto result = a
piInstance.ordersGetOrderByCode
(orderCode, authorization, acce
);
System.out.println(
result);
) {
System.err.println(
pi#ordersGetOrderByCode");
e.printStackTrace()
;
dersApi;

ing[] args) {
new OrdersApi();

r code.
g | access token

i-Version

ot specified,
the defa
try {
OrderDto result = a
piInstance.ordersGetOrderByCode
(orderCode, authorization, acce
);
System.out.println(
result);
) {
System.err.println(
pi#ordersGetOrderByCode");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];
String *orderCode = orderCode_e

xample; // Order code.

(optional)

-US)


the defa
rsApi alloc] init];
// Get data for an Order entry.
[apiInstance ordersGetOrderByCo
deWith:orderCode
ge
culture:culture
completionHandler
: ^(OrderDto output, NSError* e
rror) {
if
(output) {
if
(error) {
}];




SS TOKEN"

rdersApi()
var orderCode = orderCode_examp

le; // {String} Order code.
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.ordersGetOrderByCode(orderC
ode, opts, callback);
using System;
namespace Example
public class ordersGetOrder

ByCodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew OrdersApi();
var orderCode = ord

erCode_example; // String | Or
der code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get data for

an Order entry.
OrderDto result
= apiInstance.ordersGetOrderByC
ode(orderCode, authorization, a
cceptLanguage, apiVersion, cult
ure);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ordersGetOrderByCode: " + e.Mes
sage );
}
<?php
/autoload.php');


$orderCode = orderCode_example;
// String | Order code.
en
anguage
the defa
try {
$result = $api_instance->or
dersGetOrderByCode($orderCode,
print_r($result);

g OrdersApi->ordersGetOrderByCo
de: ', $e->getMessage(), PHP_EO
L;
?>
use Data::Dumper;
ration;
pi;

S_TOKEN';
my $orderCode = orderCode_examp
le; # String | Order code.
oken
-Language
,
the defa
eval {
>ordersGetOrderByCode(orderCode
=> $orderCode, authorization =>
=> $apiVersion, culture => $cul
ture);
};
if ($@) {

g OrdersApi->ordersGetOrderByCo
de: $@\n";

atement
import time

ApiException

'

class
rdersApi()
orderCode = orderCode_example #
String | Order code.
(optional)
US)
l) (default to 1.0)

the defa
try:
# Get data for an Order ent

ry.
.orders_get_order_by_code(order
Code, authorization=authorizati
on, acceptLanguage=acceptLangua
ge, apiVersion=apiVersion, cult
ure=culture)
ng OrdersApi->ordersGetOrderByC
ode: %s\n" % e)
Parameters
Path parameters
Name Description
orderCode* String
Order code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String
Responses
Status: 200 - OK
• Schema
{
Order
OrderNumber:
string
Activity center
InvoiceNumber:
string
Invoice Number
DistributorCode:
string
Distributor Code
DistributorName:
string
Distributor Name
CustomerName:
string
Customer Name
ReasonCode:
string
Reason Code
OrderType:
string
Order Type
EffectiveDate:
string (date-time)
Effective Date
ExpectedDeliveryDays:
string
Expected Delivery Days
EventCode:
string
Event Code
CurrentStatus:
string
Current Status
OrderComments:
[
Order Comments
{
Order Note Dto.
Note:
string
Note.
External:
boolean
External.
NoteType:
string
Note Type.
}
]
OrderMessages:
[
Order Messages
string
]
ShippingInformation:
{
Shipping Information Dto
ShipToName:
string
Name for Shipping
Address:
AddressDto {
Address Dto.
Required: Country
Line1:
Line1 string
Line2:
Line2 string
Country:
Country string
PostalCode:
PostalCode string
City:
City string
County:
County string
StateProvince:
}
ShipToPhone:
string
Ship To Phone
ShippingMethod:
string
Shipping Method / Carrier
}
OrderStatuses:
[
Order Statuses (Sales Order Life
Cycle)
{
Order Status Dto
StatusCode:
string
Status Code
StatusDescription:
string
Status Description
StatusDate:
string (date-time)
Status Date
}
]
Payments:
[
Payments
{
Payment Dto
PaymentType:
string
Payment Type
Name:
string
Payment Name
Reference:
string
Reference
Date:
string (date-time)
Date
Amount:
number (double)
Amount
PaymentStatus:
string
Payment Status
}
]
Items:
[
Items
{
Order Item Dto.
ProductCode:
string
Product Code.
Quantity:
integer (int32)
Quantity.
Description:
string
Description.
string
Incentive Description.
BackOrder:
string
Back Order.
ExpectedDate:
string (date-time)
Expected Date.
PriceType:
string
Price Type.
UnitPrice:
number (double)
Unit Price.
ExtendedPrice:
number (double)
Extended Price.
Discount:
number (double)
Discount.
Subtotal:
number (double)
Subtotal.
}
]
Totals:
{
Totals Dto.
Subtotal:
number (double)
Subtotal.
SubtotalDiscount:
number (double)
Subtotal Discount.
Discount:
number (double)
Discount.
OrderNet:
number (double)
Order Net.
Tax:
number (double)
Tax.
Freight:
number (double)
Freight.
OrderTotal:
number (double)
Order Total.
}
Volumes:
[
Volumes
{
Volume Dto
Code:
string
Volume Code
Description:
string
Description
Amount:
number (double)
Amount
Currency:
string
Currency
}
]
Shipments:
[
Shipments
{
Shipment Dto
Reference:
string
Reference
CarrierMethod:
string
Carrier Method
ShipDate:
string (date-time)
Ship Date
Warehouse:
string
Warehouse
Items:
[
Shipment Items
{
Shipment Item Dto
Product:
string
Product.
StockNumber:
string
Stock Number.
Quantity:
integer (int32)
Quantity.
ActualQuantity:
integer (int32)
Actual Quantity.
TrackingCode:
string
Tracking Code.
}
]
}
]
Incentives:
[
Incentives
{
Order Incentive Dto.
string
Incentive Description.
Earned:
string
Earned.
Used:
string
Used.
}
]
}
ordersPost
Create a new sales order
/api/Orders
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Orders"
;
*;
dersApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new OrdersApi();
OrderPost order = ; //
OrderPost | Order
g | access token

i-Version
try {
apiInstance.ordersP
ost(order, authorization, accep
) {
System.err.println(
pi#ordersPost");
e.printStackTrace()
;
dersApi;

ing[] args) {
new OrdersApi();
OrderPost order = ; //
OrderPost | Order
g | access token
i-Version
try {
apiInstance.ordersP
ost(order, authorization, accep
) {
System.err.println(
pi#ordersPost");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
OrderPost *order = ; // Order

(optional)

-US)


rsApi alloc] init];
// Create a new sales order
[apiInstance ordersPostWith:ord
er
ge
completionHandler
if
(error) {
}
}];





SS TOKEN"

rdersApi()
var order = ; // {OrderPost} Or

der
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

cessfully.');
};
api.ordersPost(order, opts, cal

lback);
using System;
namespace Example
{
public class ordersPostExam
ple
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew OrdersApi();
var order = new Ord

erPost(); // OrderPost | Order
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a new
sales order
apiInstance.ord
ersPost(order, authorization, a
catch (Exception e)
Debug.Print("Ex
ordersPost: " + e.Message );
<?php
/autoload.php');

$order = ; // OrderPost | Order
en
anguage
try {
$api_instance->ordersPost($
order, $authorization, $acceptL

g OrdersApi->ordersPost: ', $e-
?>
use Data::Dumper;
ration;
pi;

S_TOKEN';
my $order = WWW::SwaggerClient:
:Object::OrderPost->new(); # Or
derPost | Order
oken
-Language
eval {
$api_instance->ordersPost(o
rder => $order, authorization =
n => $apiVersion);
};
if ($@) {

g OrdersApi->ordersPost: $@\n";

atement
import time

ApiException

'

class
rdersApi()
order = # OrderPost | Order
(optional)
US)
l) (default to 1.0)
try:
# Create a new sales order
api_instance.orders_post(or
der, authorization=authorizatio

ng OrdersApi->ordersPost: %s\n"
% e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
order OrderPost {
*
Order Post Request Model
Required:
Account,Carrier,Country,Currency,Items,OrderType,Reference,SalesOrderStatus,ShippingM
Reference:
Reference string minLength:1 maxLength:50
Country:
Currency:
Account:
ActivityCenter:
OrderType:
OrderType string minLength:1 maxLength:50
SalesOrderStatus:
SalesOrderStatus string minLength:1 maxLength:50
FreightTax:
FreightTax number (double)
Freight:
Freight number (double)
Payments:
Payments[
OrderPayment {
Sales Order Payment.
Required: Date,PaymentMethod,PaymentType
PaymentType:
PaymentType string minLength:1 maxLength:50
PaymentMethod:
PaymentMethod string minLength:1 maxLength:50
Date:
Date string (date-time)
CardType:
CardType string minLength:1 maxLength:32
MaskedCardNumber:
MaskedCardNumber string minLength:1 maxLength:32
NameOnCard:
NameOnCard string minLength:1 maxLength:128
ExpirationYear:
ExpirationYear string minLength:1 maxLength:16
ExpirationMonth:
ExpirationMonth string minLength:1 maxLength:16
AuthCode:
AuthCode string minLength:1 maxLength:32
PayerId:
PayerId string minLength:1 maxLength:256
Reference:
Reference string minLength:1 maxLength:64
ResponseMessage:
ResponseMessage string minLength:1 maxLength:256
ResponseNumber:
ResponseNumber string minLength:1 maxLength:32
AuthenticationDate:
AuthenticationDate string (date-time)
Amount:
}
]
Items:
Items[
OrderItemPost {
Order item.
Required: PriceType,Product,Quantity,Warehouse
Product:
PriceType:
Quantity:
Quantity integer (int32)
Warehouse:
Warehouse string minLength:1 maxLength:32
Price:
Price number (double)
Plan:
Plan string minLength:1 maxLength:50
Rule:
Rule string minLength:1 maxLength:50
IncentiveCode:
IncentiveCode string minLength:1 maxLength:50
AdvertisementOriginCode string minLength:1 maxLength:50
CityTaxApplied:
CityTaxApplied boolean
CityTaxPercentage:
CityTaxPercentage number (double)
CountyTaxApplied:
CountyTaxApplied boolean
CountyTaxPercentage:
CountyTaxPercentage number (double)
LocalTaxApplied:
LocalTaxApplied boolean
LocalTaxPercentage:
LocalTaxPercentage number (double)
StateTaxApplied:
StateTaxApplied boolean
StateTaxPercentage:
StateTaxPercentage number (double)
CountryTaxApplied:
CountryTaxApplied boolean
CountryTaxPercentage:
CountryTaxPercentage number (double)
OtherTaxApplied:
OtherTaxApplied boolean
OtherTaxPercentage:
OtherTaxPercentage number (double)
CityTax:
CityTax number (double)
CountyTax:
CountyTax number (double)
LocalTax:
LocalTax number (double)
StateTax:
StateTax number (double)
CountryTax:
CountryTax number (double)
OtherTax:
OtherTax number (double)
}
]
Carrier:
Carrier string minLength:1 maxLength:50
ShippingMethod:
ShippingMethod string minLength:1 maxLength:50
ShippingAddress:
{
Required: Country
Line1:
Line1 string
Line2:
Line2 string
Country:
Country string
PostalCode:
PostalCode string
City:
City string
County:
County string
StateProvince:
}
ShippingName:
ShippingName string minLength:1 maxLength:200
ShippingPhone:
ShippingPhone string minLength:1 maxLength:50
ShippingEmail:
ShippingEmail string minLength:1 maxLength:255
ShippingComments:
ShippingComments string minLength:1
FinishUser:
FinishUser string minLength:1 maxLength:50
CityTax:
CityTax number (double)
CountyTax:
CountyTax number (double)
LocalTax:
LocalTax number (double)
StateTax:
StateTax number (double)
CountryTax:
CountryTax number (double)
OtherTax:
OtherTax number (double)
}
Responses

header with the new
resource
ProductQuantityLimits
productQuantityLimitsG
etAll
Get data for Product Quantity Limit
entries
/api/ProductQuantityLimits
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/ProductQuantityLimits
?keys=&pageNumber=&pageSize=&so
rtType=&filters="
;
*;
import io.swagger.client.api.Pr
oductQuantityLimitsApi;
import java.util.*;
public class ProductQuantityLim

itsApiExample {

ing[] args) {
ient();

uth2

("oauth2");
ProductQuantityLimitsAp
i apiInstance = new ProductQuan
tityLimitsApi();

greater than 0

'
array[Object] keys = ;
// array[Object] | List of Keys
(Product, PriceType)
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.ProductQuantityLimitDto
result = apiInstance.productQua
ntityLimitsGetAll(pageNumber, p
ageSize, sortType, keys, author
sion, filters);
System.out.println(
result);
) {
System.err.println(
"Exception when calling Product
QuantityLimitsApi#productQuanti
tyLimitsGetAll");
e.printStackTrace()
;

itsApiExample {

ing[] args) {
tityLimitsApi();

greater than 0

'
// array[Object] | List of Keys
(Product, PriceType)
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.ProductQuantityLimitDto
result = apiInstance.productQua
ntityLimitsGetAll(pageNumber, p
ageSize, sortType, keys, author
sion, filters);
System.out.println(
result);
) {
System.err.println(
tyLimitsGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];


default to 25)

c)
array[Object] *keys = ; // List

of Keys (Product, PriceType) (o
ptional)
(optional)

-US)


le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
ProductQuantityLimitsApi *apiIn
stance = [[ProductQuantityLimit
sApi alloc] init];
// Get data for Product Quantit

y Limit entries
[apiInstance productQuantityLim
itsGetAllWith:pageNumber
pageSize:pageSize
sortType:sortType
keys:keys
ge
filters:filters
completionHandler
: ^(HateoasCollectionResponse.P
roductQuantityLimitDto output,
NSError* error) {
if
(output) {
if
(error) {
}];





SS TOKEN"
var api = new JenkonRestApiV1.P

roductQuantityLimitsApi()

than or equal to 0

0
var opts = {
'keys': , // {array[Object]}
List of Keys (Product, PriceTyp
e)
oken
-Language
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.productQuantityLimitsGetAll
, opts, callback);
using System;
namespace Example
public class productQuantit

yLimitsGetAllExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ProductQuantityLimitsApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var keys = new arra

y[Object](); // array[Object] |
List of Keys (Product, PriceTyp
e) (optional)
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get data for

Product Quantity Limit entries
HateoasCollecti
onResponse.ProductQuantityLimit
Dto result = apiInstance.produc
tQuantityLimitsGetAll(pageNumbe
r, pageSize, sortType, keys, au
iVersion, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling ProductQua
ntityLimitsApi.productQuantityL
imitsGetAll: " + e.Message );
}
}
<?php
/autoload.php');


ent\Api\ProductQuantityLimitsAp
i();

an or equal to 0

for 'Descending'
$keys = ; // array[Object] | Li
st of Keys (Product, PriceType)
en
anguage
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
$result = $api_instance->pr
oductQuantityLimitsGetAll($page
Number, $pageSize, $sortType, $
keys, $authorization, $acceptLa
nguage, $apiVersion, $filters);
print_r($result);

g ProductQuantityLimitsApi->pro
ductQuantityLimitsGetAll: ', $e
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Product
QuantityLimitsApi;

S_TOKEN';
Client::ProductQuantityLimitsAp
i->new();
than or equal to 0

0
my $keys = []; # array[Object]

| List of Keys (Product, PriceT
ype)
oken
-Language
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>productQuantityLimitsGetAll(pa
geNumber => $pageNumber, pageSi
ze => $pageSize, sortType => $s
ortType, keys => $keys, authori
piVersion => $apiVersion, filte
rs => $filters);
};
if ($@) {

ductQuantityLimitsGetAll: $@\n"
;

atement
import time

ApiException

'

class
api_instance = swagger_client.P


efault to 25)
)
keys = # array[Object] | List

of Keys (Product, PriceType) (o
ptional)
(optional)
US)
l) (default to 1.0)

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get data for Product Quan

tity Limit entries
.product_quantity_limits_get_al
l(pageNumber, pageSize, sortTyp
e, keys=keys, authorization=aut
horization, acceptLanguage=acce
ptLanguage, apiVersion=apiVersi
on, filters=filters)

ng ProductQuantityLimitsApi->pr
oductQuantityLimitsGetAll: %s\n
" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
keys array[Object]
List of Keys (Product, PriceType)
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Product Quantity Limit Dto.
Product:
string
Product code.
PriceType:
string
Price type code.
QuantityLimit:
integer (int32)
Quantity Limit
LifetimeQuantityLimit:
integer (int32)
Lifetime quantity limit.
PeriodLimitCalendar:
string
Period limit calendar code.
PeriodLimit:
integer (int32)
Period limit.
}
]
}
productQuantityLimitsP
atch
Patch a Product Quantity Limit entry
/api/ProductQuantityLimits/{pro
ductCode}/{priceTypeCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/ProductQuantityLimi
ts/{productCode}/{priceTypeCode
}"
;
*;
import java.util.*;
itsApiExample {

ing[] args) {
ient();

uth2

("oauth2");
tityLimitsApi();
String productCode = pr
oductCode_example; // String |
The Product Code of the entry t
o patch
String priceTypeCode =
priceTypeCode_example; // Strin
g | The Price Type of the entry
to patch
ProductQuantityLimitPat
ch patch = ; // ProductQuantity
LimitPatch | The subset of Prod
uct Quantity Limit fields to pa
tch
g | access token

i-Version
try {
Object result = api

Instance.productQuantityLimitsP
atch(productCode, priceTypeCode
, patch, authorization, acceptL
System.out.println(
result);
) {
System.err.println(
tyLimitsPatch");
e.printStackTrace()
;
}
}

itsApiExample {

ing[] args) {
tityLimitsApi();
String productCode = pr
oductCode_example; // String |
o patch
String priceTypeCode =
priceTypeCode_example; // Strin
g | The Price Type of the entry
to patch
ProductQuantityLimitPat
ch patch = ; // ProductQuantity
LimitPatch | The subset of Prod
uct Quantity Limit fields to pa
tch
g | access token
i-Version
try {
Object result = api

Instance.productQuantityLimitsP
atch(productCode, priceTypeCode
, patch, authorization, acceptL
System.out.println(
result);
) {
System.err.println(
tyLimitsPatch");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
String *productCode = productCo

de_example; // The Product Code
of the entry to patch
String *priceTypeCode = priceTy

peCode_example; // The Price Ty
pe of the entry to patch
ProductQuantityLimitPatch *patc
h = ; // The subset of Product
Quantity Limit fields to patch

(optional)

-US)

sApi alloc] init];
// Patch a Product Quantity Lim

it entry
itsPatchWith:productCode
priceTypeCode:priceTypeCode
patch:patch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

var productCode = productCode_e

xample; // {String} The Product
var priceTypeCode = priceTypeCo

de_example; // {String} The Pri
ce Type of the entry to patch
var patch = ; // {ProductQuanti

tyLimitPatch} The subset of Pro
duct Quantity Limit fields to p
atch
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.productQuantityLimitsPatch(
productCode, priceTypeCode, pat
ch, opts, callback);
using System;
namespace Example

yLimitsPatchExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var productCode = p
roductCode_example; // String
| The Product Code of the entry
to patch
var priceTypeCode =
priceTypeCode_example; // Stri
ng | The Price Type of the entr
y to patch
var patch = new Pro

ductQuantityLimitPatch(); // Pr
oductQuantityLimitPatch | The s
ubset of Product Quantity Limit
fields to patch
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch a Prod
uct Quantity Limit entry
Object result =
apiInstance.productQuantityLimi
tsPatch(productCode, priceTypeC
ode, patch, authorization, acce
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
imitsPatch: " + e.Message );
<?php
/autoload.php');


i();
$productCode = productCode_exam
ple; // String | The Product Co
de of the entry to patch
$priceTypeCode = priceTypeCode_
example; // String | The Price
Type of the entry to patch
$patch = ; // ProductQuantityLi
mitPatch | The subset of Produc
t Quantity Limit fields to patc
h
en
anguage
try {
oductQuantityLimitsPatch($produ
ctCode, $priceTypeCode, $patch,
, $apiVersion);
print_r($result);

ductQuantityLimitsPatch: ', $e-
?>
use Data::Dumper;
ration;
QuantityLimitsApi;

S_TOKEN';
i->new();
my $productCode = productCode_e
xample; # String | The Product
my $priceTypeCode = priceTypeCo
de_example; # String | The Pric
e Type of the entry to patch
my $patch = WWW::SwaggerClient:
:Object::ProductQuantityLimitPa
tch->new(); # ProductQuantityLi
mitPatch | The subset of Produc
t Quantity Limit fields to patc
h
oken
-Language
eval {
>productQuantityLimitsPatch(pro
ductCode => $productCode, price
TypeCode => $priceTypeCode, pat
ch => $patch, authorization =>
=> $apiVersion);
};
if ($@) {

ductQuantityLimitsPatch: $@\n";

atement
import time

ApiException

'

class
productCode = productCode_examp
le # String | The Product Code
of the entry to patch
priceTypeCode = priceTypeCode_e
xample # String | The Price Typ
e of the entry to patch
patch = # ProductQuantityLimit
Patch | The subset of Product Q
uantity Limit fields to patch
(optional)
US)
l) (default to 1.0)
try:
# Patch a Product Quantity

Limit entry
.product_quantity_limits_patch(
productCode, priceTypeCode, pat
ch, authorization=authorization
, apiVersion=apiVersion)

oductQuantityLimitsPatch: %s\n"
% e)
Parameters
Path parameters
Name Description
productCode* String
The Product Code of the entry to patch
Required
priceTypeCode* String
The Price Type of the entry to patch
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
patch * {
Product quantity limit patch model.

QuantityLimit:
QuantityLimit integer (ex)minimum:true
LifetimeQuantityLimit integer (ex)minimum:true
PeriodLimitCalendar string minLength:1 maxLength:50
PeriodLimit:
PeriodLimit integer (ex)minimum:true
}
Responses
Status: 200 - OK
• Schema
{
}
productQuantityLimitsP
ostAsync
Create a Product Quantity Limit entry
/api/ProductQuantityLimits
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/ProductQuantityLimit
s"
;
*;
import java.util.*;

itsApiExample {

ing[] args) {
ient();

uth2

("oauth2");
tityLimitsApi();
ProductQuantityLimitDto
productQuantityLimit = ; // Pro
ductQuantityLimitDto | The {pro
ductQuantityLimit} data to cre
ate
g | access token

i-Version
try {
ProductQuantityLimi
tDto result = apiInstance.produ
ctQuantityLimitsPostAsync(produ
ctQuantityLimit, authorization,
System.out.println(
result);
) {
System.err.println(
tyLimitsPostAsync");
e.printStackTrace()
;
}

itsApiExample {

ing[] args) {
tityLimitsApi();
ProductQuantityLimitDto
productQuantityLimit = ; // Pro
ductQuantityLimitDto | The {pro
ductQuantityLimit} data to cre
ate
g | access token

i-Version
try {
ProductQuantityLimi
tDto result = apiInstance.produ
ctQuantityLimitsPostAsync(produ
ctQuantityLimit, authorization,
System.out.println(
result);
) {
System.err.println(
tyLimitsPostAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
ProductQuantityLimitDto *produc
tQuantityLimit = ; // The {prod
uctQuantityLimit} data to crea
te

(optional)
-US)

sApi alloc] init];
// Create a Product Quantity Li

mit entry
itsPostAsyncWith:productQuantit
yLimit
ge
completionHandler
: ^(ProductQuantityLimitDto out
put, NSError* error) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"

var productQuantityLimit = ; //
{ProductQuantityLimitDto} The {
productQuantityLimit} data to
create
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.productQuantityLimitsPostAs
ync(productQuantityLimit, opts,
callback);
using System;
namespace Example

yLimitsPostAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
var productQuantity
Limit = new ProductQuantityLimi
tDto(); // ProductQuantityLimit
Dto | The {productQuantityLimit
} data to create
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a Pro
duct Quantity Limit entry
ProductQuantity
LimitDto result = apiInstance.p
roductQuantityLimitsPostAsync(p
roductQuantityLimit, authorizat
);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
imitsPostAsync: " + e.Message )
;
}
}
<?php
/autoload.php');


i();
$productQuantityLimit = ; // Pr
oductQuantityLimitDto | The {pr
oductQuantityLimit} data to cr
eate
en
anguage
try {
oductQuantityLimitsPostAsync($p
roductQuantityLimit, $authoriza
ion);
print_r($result);

ductQuantityLimitsPostAsync: ',
?>
use Data::Dumper;
ration;
QuantityLimitsApi;

S_TOKEN';
i->new();
my $productQuantityLimit = WWW:
:SwaggerClient::Object::Product
QuantityLimitDto->new(); # Prod
uctQuantityLimitDto | The {prod
uctQuantityLimit} data to crea
te
oken
-Language
eval {
>productQuantityLimitsPostAsync
(productQuantityLimit => $produ
ctQuantityLimit, authorization
on => $apiVersion);
};
if ($@) {

ductQuantityLimitsPostAsync: $@
\n";

atement
import time

ApiException

'

class
productQuantityLimit = # Produ
ctQuantityLimitDto | The {produ
ctQuantityLimit} data to creat
e
(optional)
US)
l) (default to 1.0)
try:
# Create a Product Quantity

Limit entry
.product_quantity_limits_post_a
sync(productQuantityLimit, auth
orization=authorization, accept
Language=acceptLanguage, apiVer
sion=apiVersion)

oductQuantityLimitsPostAsync: %
s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
productQuantityLimit {
*
Product:
string
Product code.
PriceType:
string
Price type code.
QuantityLimit:
integer (int32)
Quantity Limit
integer (int32)
string
PeriodLimit:
integer (int32)
Period limit.
}
Responses
Status: 200 - OK
• Schema
{
Product:
string
Product code.
PriceType:
string
Price type code.
QuantityLimit:
integer (int32)
Quantity Limit
integer (int32)
string
PeriodLimit:
integer (int32)
Period limit.
}
Products
productsGetAll
Get data for Product entries
/api/Products
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Products?searchCriter
ia=&productType=&onlyActive=&pa
geNumber=&pageSize=&sortType=&c
ulture="
;
*;
oductsApi;
import java.util.*;
public class ProductsApiExample

{

ing[] args) {
ient();

uth2

("oauth2");
ProductsApi apiInstance
= new ProductsApi();

greater than 0
'
String searchCriteria =
searchCriteria_example; // Stri
ng | The criteria to use for se
arching. It searches by code an
d name/description
String productType = pr
oductType_example; // String |
Value to filter results by the
Product Type
Boolean onlyActive = tr
ue; // Boolean | Value to show
only active products or all of
them in the results
g | access token

i-Version

ot specified,
the defa
try {
HateoasCollectionRe
sponse.ProductDto result = apiI
nstance.productsGetAll(pageNumb
er, pageSize, sortType, searchC
riteria, productType, onlyActiv
e, authorization, acceptLanguag
e, apiVersion, culture);
System.out.println(
result);
) {
System.err.println(
sApi#productsGetAll");
e.printStackTrace()
;
oductsApi;

{

ing[] args) {

greater than 0

'
String searchCriteria =
searchCriteria_example; // Stri
ng | The criteria to use for se
arching. It searches by code an
d name/description
String productType = pr
oductType_example; // String |
Value to filter results by the
Product Type
Boolean onlyActive = tr
them in the results
g | access token
i-Version

ot specified,
the defa
try {
HateoasCollectionRe
sponse.ProductDto result = apiI
nstance.productsGetAll(pageNumb
er, pageSize, sortType, searchC
riteria, productType, onlyActiv
e, apiVersion, culture);
System.out.println(
result);
) {
System.err.println(
sApi#productsGetAll");
e.printStackTrace()
;
}

R_ACCESS_TOKEN"];


default to 25)

c)
String *searchCriteria = search

Criteria_example; // The criter
ia to use for searching. It sea
rches by code and name/descript
ion (optional)
String *productType = productTy

pe_example; // Value to filter
results by the Product Type (op
tional)
Boolean *onlyActive = true; //

Value to show only active produ
cts or all of them in the resul
ts (optional)

(optional)

-US)


the defa
ProductsApi *apiInstance = [[Pr

oductsApi alloc] init];
// Get data for Product entries
[apiInstance productsGetAllWith
:pageNumber
pageSize:pageSize
sortType:sortType
searchCriteria:searchCriter
ia
productType:productType
onlyActive:onlyActive
ge
culture:culture
completionHandler
: ^(HateoasCollectionResponse.P
roductDto output, NSError* erro
r) {
if
(output) {
if
(error) {
}];




SS TOKEN"

roductsApi()

than or equal to 0

0

var opts = {
'searchCriteria': searchCrite
ria_example, // {String} The cr
iteria to use for searching. It
searches by code and name/descr
iption
'productType': productType_ex
ample, // {String} Value to fil
ter results by the Product Type
'onlyActive': true, // {Boole

an} Value to show only active p
roducts or all of them in the r
esults
oken
-Language
the defa
};

data, response) {
if (error) {
} else {
ata);
};
api.productsGetAll(pageNumber,
ack);
using System;
namespace Example
public class productsGetAll

Example
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ProductsApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var searchCriteria
= searchCriteria_example; // S
tring | The criteria to use for
searching. It searches by code
and name/description (optional)
var productType = p
roductType_example; // String
| Value to filter results by th
e Product Type (optional)
var onlyActive = tr
them in the results (optional)
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get data for

Product entries
HateoasCollecti
onResponse.ProductDto result =
apiInstance.productsGetAll(page
Number, pageSize, sortType, sea
rchCriteria, productType, onlyA
ctive, authorization, acceptLan
Debug.WriteLine
(result);
catch (Exception e)
{
Debug.Print("Ex
ception when calling ProductsAp
i.productsGetAll: " + e.Message
);
<?php
/autoload.php');


ent\Api\ProductsApi();

an or equal to 0

for 'Descending'
$searchCriteria = searchCriteri
a_example; // String | The crit
eria to use for searching. It s
earches by code and name/descri
ption
$productType = productType_exam
ple; // String | Value to filte
r results by the Product Type
$onlyActive = true; // Boolean

| Value to show only active pro
ducts or all of them in the res
ults
en
anguage
the defa
try {
oductsGetAll($pageNumber, $page
Size, $sortType, $searchCriteri
a, $productType, $onlyActive, $
print_r($result);

g ProductsApi->productsGetAll:
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';
Client::ProductsApi->new();
than or equal to 0

0
my $searchCriteria = searchCrit
eria_example; # String | The cr
iteria to use for searching. It
searches by code and name/descr
iption
my $productType = productType_e
xample; # String | Value to fil
ter results by the Product Type
my $onlyActive = true; # Boolea

n | Value to show only active p
roducts or all of them in the r
esults
oken
-Language
,
the defa
eval {
>productsGetAll(pageNumber => $
ze, sortType => $sortType, sear
chCriteria => $searchCriteria,
productType => $productType, on
lyActive => $onlyActive, author
apiVersion => $apiVersion, cult
ure => $culture);
};
if ($@) {

g ProductsApi->productsGetAll:
$@\n";

atement
import time
ApiException

'

class
roductsApi()


efault to 25)
)
searchCriteria = searchCriteria
_example # String | The criteri
a to use for searching. It sear
ches by code and name/descripti
on (optional)
productType = productType_examp
le # String | Value to filter r
esults by the Product Type (opt
ional)
onlyActive = true # Boolean | V

alue to show only active produc
ts or all of them in the result
s (optional)
(optional)
US)
l) (default to 1.0)

the defa
try:
# Get data for Product entr

ies
.products_get_all(pageNumber, p
ageSize, sortType, searchCriter
ia=searchCriteria, productType=
productType, onlyActive=onlyAct
ive, authorization=authorizatio
re=culture)

ng ProductsApi->productsGetAll:
%s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
searchCriteria String
The criteria to use for searching. It searches by code and
name/description
productType String
Value to filter results by the Product Type
onlyActive Boolean
Value to show only active products or all of them in the results
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
culture String

Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Product.
Code:
string
Product Code.
Name:
string
Name.
Description:
string
Description.
ProductType:
string
Product Type.
Active:
boolean
Active?.
TaxType:
string
Tax Type.
Countries:
[
Product Countries.
string
]
CategoryCodes:
[
Product Categories.
string
]
InventoryCode:
string
Inventory Code. pack/fee may not
have inventory.
ProductResources:
[
Product resources.
{
Type Resource (ResourceModel with
type)
Required: Culture,Type,Value
Culture:
Culture string minLength:1
maxLength:50
Value:
Value string
Type:
Type string minLength:1
maxLength:50
}
]
ProductAlternateCodes:
[
Product alternate codes.
{
Product Alternate Code
AlternateCode:
AlternateCode string minLength:1
maxLength:50
AlternateCodeType:
AlternateCodeType string
}
]
Products:
[
Product components (kit/packs
support).
ProductComponentDto {
Product component.
Required:
Percentage,PriceType,Product,Quan
tity
Product:
Product string minLength:1
maxLength:50
Quantity:
Quantity integer (ex)minimum:true
Percentage:
Percentage number
(ex)minimum:true
PriceType:
PriceType string minLength:1
maxLength:50
}
]
ShowImageInCart:
boolean
Indicates whether or not the
product's image will appear in carts.
}
]
}
productsGetByProductCo
de
Get data for a Product entry
/api/Products/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Products/{code}?cultu
re="
;
*;
oductsApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");

de to retrieve
g | access token

i-Version

ot specified,
the defa
try {
ProductDto result =
apiInstance.productsGetByProduc
tCode(code, authorization, acce
);
System.out.println(
result);
) {
System.err.println(
sApi#productsGetByProductCode")
;
e.printStackTrace()
;
oductsApi;

{

ing[] args) {

de to retrieve
g | access token

i-Version

ot specified,
the defa
try {
ProductDto result =
apiInstance.productsGetByProduc
tCode(code, authorization, acce
);
System.out.println(
result);
) {
System.err.println(
sApi#productsGetByProductCode")
;
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];

The Product Code to retrieve

(optional)

-US)


the defa
// Get data for a Product entry
[apiInstance productsGetByProdu
ctCodeWith:code
ge
culture:culture
completionHandler
: ^(ProductDto output, NSError*
error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

roductsApi()

ring} The Product Code to retri
eve
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.productsGetByProductCode(co
using System;
namespace Example
public class productsGetByP

roductCodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ProductsApi();
var code = code_exa

mple; // String | The Product
Code to retrieve
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get data for

a Product entry
ProductDto resu
lt = apiInstance.productsGetByP
roductCode(code, authorization,
ture);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.productsGetByProductCode: " +
e.Message );
}
<?php
/autoload.php');



| The Product Code to retrieve
en
anguage
the defa
try {
oductsGetByProductCode($code, $
print_r($result);

g ProductsApi->productsGetByPro
ductCode: ', $e->getMessage(),
PHP_EOL;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';

ng | The Product Code to retrie
ve
oken
-Language
,
the defa
eval {
>productsGetByProductCode(code
=> $code, authorization => $aut
apiVersion, culture => $culture
);
};
if ($@) {

g ProductsApi->productsGetByPro
ductCode: $@\n";

atement
import time

ApiException

'

class
roductsApi()

(optional)
US)
l) (default to 1.0)

the defa
try:
# Get data for a Product en

try
.products_get_by_product_code(c
re=culture)

ng ProductsApi->productsGetByPr
oductCode: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String
Responses
Status: 200 - OK
• Schema
{
Product.
Code:
string
Product Code.
Name:
string
Name.
Description:
string
Description.
ProductType:
string
Product Type.
Active:
boolean
Active?.
TaxType:
string
Tax Type.
Countries:
[
Product Countries.
string
]
CategoryCodes:
[
Product Categories.
string
]
InventoryCode:
string
Inventory Code. pack/fee may not
have inventory.
ProductResources:
[
Product resources.
{
Type Resource (ResourceModel with
type)
Culture:
maxLength:50
Value:
Value string
Type:
Type string minLength:1
maxLength:50
}
]
[
{
AlternateCode:
AlternateCode string minLength:1
maxLength:50
AlternateCodeType:
AlternateCodeType string
}
]
Products:
[
Product components (kit/packs
support).
Product component.
Required:
Percentage,PriceType,Product,Quan
tity
Product:
Product string minLength:1
maxLength:50
Quantity:
Percentage:
Percentage number
(ex)minimum:true
PriceType:
PriceType string minLength:1
maxLength:50
}
]
ShowImageInCart:
boolean
Indicates whether or not the
product's image will appear in carts.
}
productsPatchAsync
Patch a Product entry
Provide only the fields to modify
/api/Products/{code}
Usage and SDK
Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Products/{code}"
;
*;
oductsApi;
import java.util.*;

{
ing[] args) {
ient();

uth2

("oauth2");

ProductPatch productPat
ch = ; // ProductPatch | The su
bset of Product fields to patch
g | access token
i-Version
try {
Object result = api

Instance.productsPatchAsync(cod
e, productPatch, authorization,
System.out.println(
result);
) {
System.err.println(
sApi#productsPatchAsync");
e.printStackTrace()
;
oductsApi;

{

ing[] args) {

ProductPatch productPat
ch = ; // ProductPatch | The su
bset of Product fields to patch
g | access token

i-Version
try {
Object result = api

Instance.productsPatchAsync(cod
e, productPatch, authorization,
System.out.println(
result);
) {
System.err.println(
sApi#productsPatchAsync");
e.printStackTrace()
;
}


R_ACCESS_TOKEN"];

o patch
ProductPatch *productPatch = ;
// The subset of Product fields
to patch

(optional)

-US)

// Patch a Product entry
[apiInstance productsPatchAsync
With:code
productPatch:productPatch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

roductsApi()

ring} The Product Code of the e
ntry to patch
var productPatch = ; // {Produc

tPatch} The subset of Product f
ields to patch
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.productsPatchAsync(code, pr
oductPatch, opts, callback);
using System;
namespace Example
public class productsPatchA

syncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ProductsApi();
var code = code_exa

mple; // String | The Product
var productPatch =
new ProductPatch(); // ProductP
atch | The subset of Product fi
elds to patch
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch a Prod
uct entry
Object result =
apiInstance.productsPatchAsync(
code, productPatch, authorizati
;
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.productsPatchAsync: " + e.Mes
sage );
}
}
<?php
/autoload.php');



| The Product Code of the entry
to patch
$productPatch = ; // ProductPat
ch | The subset of Product fiel
ds to patch
en
anguage
try {
oductsPatchAsync($code, $produc
tPatch, $authorization, $accept
Language, $apiVersion);
print_r($result);

g ProductsApi->productsPatchAsy
nc: ', $e->getMessage(), PHP_EO
L;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';
ng | The Product Code of the en
try to patch
my $productPatch = WWW::Swagger
Client::Object::ProductPatch->n
ew(); # ProductPatch | The subs
et of Product fields to patch
oken
-Language
eval {
>productsPatchAsync(code => $co
de, productPatch => $productPat
ch, authorization => $authoriza
sion);
};
if ($@) {

g ProductsApi->productsPatchAsy
nc: $@\n";
}

atement
import time

ApiException

'

class
roductsApi()

o patch
productPatch = # ProductPatch
| The subset of Product fields
to patch
(optional)
US)
l) (default to 1.0)
try:
# Patch a Product entry
.products_patch_async(code, pro
ductPatch, authorization=author

ng ProductsApi->productsPatchAs
ync: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
The Product Code of the entry to patch
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
productPatch * {
Subset of properties to patch a Product.

Active:
Active boolean
TaxType:
TaxType string minLength:1 maxLength:50
Countries:
Countries[
string minLength:1 maxLength:2
]
CategoryCodes:
CategoryCodes[
]
ProductAlternateCodes[
{
AlternateCode:
AlternateCode string minLength:1 maxLength:50
AlternateCodeType:
AlternateCodeType string minLength:1 maxLength:50
}
]
Products:
Products[
{
Required: Percentage,PriceType,Product,Quantity
Product:
Quantity:
Percentage:
Percentage number (ex)minimum:true
PriceType:
}
]
ShowImageInCart:
ShowImageInCart boolean
}
Responses
Status: 200 - OK
• Schema
{
}
productsPostAsync
Create an Product entry
/api/Products
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Products"
;
*;
oductsApi;
import java.util.*;
{

ing[] args) {
ient();

uth2

("oauth2");
ProductDto product = ;
// ProductDto | The {Product}
data to create
g | access token
i-Version
try {
array[ProductDto] r
esult = apiInstance.productsPos
tAsync(product, authorization,
System.out.println(
result);
) {
System.err.println(
sApi#productsPostAsync");
e.printStackTrace()
;
oductsApi;

{

ing[] args) {
ProductDto product = ;
// ProductDto | The {Product}
data to create
g | access token

i-Version
try {
array[ProductDto] r
esult = apiInstance.productsPos
tAsync(product, authorization,
System.out.println(
result);
) {
System.err.println(
sApi#productsPostAsync");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];
ProductDto *product = ; // The

{Product} data to create

(optional)

-US)


// Create an Product entry

[apiInstance productsPostAsyncW
ith:product
ge
completionHandler
: ^(array[ProductDto] output, N
SError* error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

roductsApi()
var product = ; // {ProductDto}

The {Product} data to create
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {
ata);
};
api.productsPostAsync(product,
opts, callback);
using System;
namespace Example
public class productsPostAs

yncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ProductsApi();
var product = new P

roductDto(); // ProductDto | Th
e {Product} data to create
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create an Pr
oduct entry
array[ProductDt
o] result = apiInstance.product
sPostAsync(product, authorizati
;
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
i.productsPostAsync: " + e.Mess
age );
<?php
/autoload.php');


$product = ; // ProductDto | Th
e {Product} data to create
en
anguage
try {
oductsPostAsync($product, $auth
iVersion);
print_r($result);

g ProductsApi->productsPostAsyn
c: ', $e->getMessage(), PHP_EOL
;
?>
use Data::Dumper;
ration;
sApi;

S_TOKEN';
my $product = WWW::SwaggerClien
t::Object::ProductDto->new(); #
ProductDto | The {Product} dat
a to create
oken
-Language
eval {
>productsPostAsync(product => $
product, authorization => $auth
piVersion);
};
if ($@) {

g ProductsApi->productsPostAsyn
c: $@\n";

atement
import time

ApiException

'

class
roductsApi()
product = # ProductDto | The {
Product} data to create
(optional)
US)
l) (default to 1.0)
try:
# Create an Product entry
.products_post_async(product, a
Version=apiVersion)

ng ProductsApi->productsPostAsy
nc: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
product * {
Product.
Code:
string
Product Code.
Name:
string
Name.
Description:
string
Description.
ProductType:
string
Product Type.
Active:
boolean
Active?.
TaxType:
string
Tax Type.
Countries:
[
Product Countries.
string
]
CategoryCodes:
[
Product Categories.
string
]
InventoryCode:
string
Inventory Code. pack/fee may not have inventory.
ProductResources:
[
Product resources.
{
Type Resource (ResourceModel with type)
Culture:
Culture string minLength:1 maxLength:50
Value:
Value string
Type:
Type string minLength:1 maxLength:50
}
]
[
{
AlternateCode:
AlternateCode string minLength:1 maxLength:50
AlternateCodeType:
AlternateCodeType string minLength:1 maxLength:50
}
]
Products:
[
Product components (kit/packs support).
Product component.
Required: Percentage,PriceType,Product,Quantity
Product:
Quantity:
Percentage:
Percentage number (ex)minimum:true
PriceType:
}
]
ShowImageInCart:
boolean
Indicates whether or not the product's image will appear in
carts.
}
Responses
Status: 200 - OK
• Schema
[
undefined
]
Resources
resourcesDeleteByCode
Delete a non-default resource entry
/api/Resources/{context}/{name}
/{property}/{resourceSet}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

st:44356/api/Resources/{context
}/{name}/{property}/{resourceSe
t}?culture="
;
*;
import io.swagger.client.api.Re
sourcesApi;
import java.util.*;
public class ResourcesApiExampl

e {

ing[] args) {
ient();

uth2

("oauth2");
ResourcesApi apiInstanc
e = new ResourcesApi();
String context = contex

t_example; // String | Context
String name = name_exam

ple; // String | Name
String property = prope
rty_example; // String | Proper
ty
String resourceSet = re
sourceSet_example; // String |
Resource Set
g | access token

i-Version

ot specified,
the defa
try {
Object result = api

Instance.resourcesDeleteByCode(
context, name, property, resour
ceSet, authorization, acceptLan
System.out.println(
result);
) {
System.err.println(
"Exception when calling Resourc
esApi#resourcesDeleteByCode");
e.printStackTrace()
;
sourcesApi;

e {

ing[] args) {



ty
Resource Set
g | access token

i-Version

ot specified,
the defa
try {
Object result = api

Instance.resourcesDeleteByCode(
context, name, property, resour
ceSet, authorization, acceptLan
System.out.println(
result);
) {
System.err.println(
esApi#resourcesDeleteByCode");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];
String *context = context_examp

le; // Context
String *name = name_example; //

Name
String *property = property_exa

mple; // Property
String *resourceSet = resourceS

et_example; // Resource Set

(optional)

-US)

the defa
ResourcesApi *apiInstance = [[R

esourcesApi alloc] init];
// Delete a non-default resourc

e entry
[apiInstance resourcesDeleteByC
odeWith:context
name:name
property:property
resourceSet:resourceSet
ge
culture:culture
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"
var api = new JenkonRestApiV1.R

esourcesApi()
var context = context_example;

// {String} Context
var name = name_example; // {St
ring} Name
var property = property_example

; // {String} Property
var resourceSet = resourceSet_e

xample; // {String} Resource Se
t
var opts = {
oken
-Language
the defa
};
data, response) {
if (error) {
} else {

ata);
};
api.resourcesDeleteByCode(conte
xt, name, property, resourceSet
, opts, callback);
using System;
namespace Example
public class resourcesDelet

eByCodeExample
{
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ResourcesApi();
var context = conte

xt_example; // String | Contex
t
var name = name_exa

mple; // String | Name
var property = prop

erty_example; // String | Prop
erty
var resourceSet = r
esourceSet_example; // String
| Resource Set
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Delete a non
-default resource entry
Object result =
apiInstance.resourcesDeleteByCo
de(context, name, property, res
ourceSet, authorization, accept
Language, apiVersion, culture);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling ResourcesA
pi.resourcesDeleteByCode: " + e
.Message );
}
<?php
/autoload.php');


ent\Api\ResourcesApi();
$context = context_example; //
String | Context
$name = name_example; // String

| Name
$property = property_example; /
/ String | Property
$resourceSet = resourceSet_exam
ple; // String | Resource Set
en
anguage
the defa
try {
$result = $api_instance->re
sourcesDeleteByCode($context, $
name, $property, $resourceSet,
print_r($result);

g ResourcesApi->resourcesDelete
ByCode: ', $e->getMessage(), PH
P_EOL;
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Resourc
esApi;

S_TOKEN';
Client::ResourcesApi->new();
my $context = context_example;
# String | Context
my $name = name_example; # Stri

ng | Name
my $property = property_example
; # String | Property
my $resourceSet = resourceSet_e
xample; # String | Resource Set
oken
-Language
,
the defa
eval {
>resourcesDeleteByCode(context
=> $context, name => $name, pro
perty => $property, resourceSet
=> $resourceSet, authorization
on => $apiVersion, culture => $
culture);
};
if ($@) {

g ResourcesApi->resourcesDelete
ByCode: $@\n";

atement
import time

ApiException

'

class
api_instance = swagger_client.R
esourcesApi()
context = context_example # Str

ing | Context
name = name_example # String |

Name
property = property_example # S
tring | Property
resourceSet = resourceSet_examp
le # String | Resource Set
(optional)
US)
l) (default to 1.0)
the defa
try:
# Delete a non-default reso

urce entry
.resources_delete_by_code(conte
, authorization=authorization,
culture)

ng ResourcesApi->resourcesDelet
eByCode: %s\n" % e)
Parameters
Path parameters
Name Description
context* String
Context
Required
name* String
Name
Required
property* String
Property
Required
resourceSet* String
Resource Set
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String

Responses
Status: 200 - OK
• Schema
{
}
resourcesGetAll
Get all filtered resources
/api/Resources
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Resources?context=&na
me=&property=&resourceSet=&valu
e=&pageNumber=&pageSize=&sortTy
pe=&culture="
;
*;
sourcesApi;
import java.util.*;

e {

ing[] args) {
ient();
uth2

("oauth2");

greater than 0

'

search criteria

ple; // String | Name search cr
iteria

ty search criteria
ResourceSet search criteria
String value = value_ex

ample; // String | Value search
criteria
g | access token

i-Version

ot specified,
the defa
try {
HateoasCollectionRe
sponse.ResourceDto result = api
Instance.resourcesGetAll(pageNu
mber, pageSize, sortType, conte
, value, authorization, acceptL
anguage, apiVersion, culture);
System.out.println(
result);
) {
System.err.println(
esApi#resourcesGetAll");
e.printStackTrace()
;
sourcesApi;

e {

ing[] args) {

greater than 0

'

search criteria

ple; // String | Name search cr
iteria

ty search criteria
String value = value_ex

ample; // String | Value search
criteria
g | access token

i-Version

ot specified,
the defa
try {
HateoasCollectionRe
sponse.ResourceDto result = api
Instance.resourcesGetAll(pageNu
mber, pageSize, sortType, conte
, value, authorization, acceptL
System.out.println(
result);
) {
System.err.println(
esApi#resourcesGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];


default to 25)

c)

le; // Context search criteria
(optional)

Name search criteria (optional)

mple; // Property search criter
ia (optional)

et_example; // ResourceSet sear
ch criteria (optional)
String *value = value_example;

// Value search criteria (optio
nal)

(optional)
-US)


the defa

// Get all filtered resources
[apiInstance resourcesGetAllWit
h:pageNumber
pageSize:pageSize
sortType:sortType
context:context
name:name
property:property
value:value
ge
culture:culture
completionHandler
: ^(HateoasCollectionResponse.R
esourceDto output, NSError* err
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

esourcesApi()

than or equal to 0

0

var opts = {
'context': context_example, /
/ {String} Context search crite
ria
'name': name_example, // {Str

ing} Name search criteria
'property': property_example,
// {String} Property search cri
teria
'resourceSet': resourceSet_ex
ample, // {String} ResourceSet
search criteria
'value': value_example, // {S
tring} Value search criteria
oken
-Language
the defa
};

data, response) {
if (error) {
} else {
ata);
};
api.resourcesGetAll(pageNumber,
ack);
using System;
namespace Example
public class resourcesGetAl

lExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ResourcesApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var context = conte

t search criteria (optional)
var name = name_exa

mple; // String | Name search
criteria (optional)
var property = prop

erty search criteria (optional)
var resourceSet = r
| ResourceSet search criteria (
optional)
var value = value_e
xample; // String | Value sear
ch criteria (optional)
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get all filt

ered resources
HateoasCollecti
onResponse.ResourceDto result =
apiInstance.resourcesGetAll(pag
eNumber, pageSize, sortType, co
ntext, name, property, resource
Set, value, authorization, acce
);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
pi.resourcesGetAll: " + e.Messa
ge );
<?php
/autoload.php');


an or equal to 0

for 'Descending'
String | Context search criteri
a

| Name search criteria
/ String | Property search crit
eria
ple; // String | ResourceSet se
arch criteria
$value = value_example; // Stri

ng | Value search criteria
en
anguage
the defa
try {
sourcesGetAll($pageNumber, $pag
eSize, $sortType, $context, $na
me, $property, $resourceSet, $v
alue, $authorization, $acceptLa
nguage, $apiVersion, $culture);
print_r($result);

g ResourcesApi->resourcesGetAll
?>
use Data::Dumper;
ration;
esApi;
S_TOKEN';

than or equal to 0

0
# String | Context search crite
ria

ng | Name search criteria
; # String | Property search cr
iteria
xample; # String | ResourceSet
search criteria
my $value = value_example; # St
ring | Value search criteria
oken
-Language
,
the defa
eval {
>resourcesGetAll(pageNumber =>
ize, sortType => $sortType, con
text => $context, name => $name
, property => $property, resour
ceSet => $resourceSet, value =>
$value, authorization => $autho
iVersion, culture => $culture);
};
if ($@) {
g ResourcesApi->resourcesGetAll
: $@\n";

atement
import time

ApiException

'

class
esourcesApi()


efault to 25)
)

ing | Context search criteria (
optional)

Name search criteria (optional)
tring | Property search criteri
a (optional)
le # String | ResourceSet searc
h criteria (optional)
value = value_example # String

| Value search criteria (option
al)
(optional)
US)
l) (default to 1.0)

the defa
try:
# Get all filtered resource

s
.resources_get_all(pageNumber,
pageSize, sortType, context=con
text, name=name, property=prope
rty, resourceSet=resourceSet, v
alue=value, authorization=autho
rization, acceptLanguage=accept
Language, apiVersion=apiVersion
, culture=culture)

ng ResourcesApi->resourcesGetAl
l: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
context String
Context search criteria
name String
Name search criteria
property String
Property search criteria
resourceSet String
value String
Value search criteria
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
culture String

Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Context:
string
Context
Name:
string
Name
Property:
string
Property
Culture:
string
Culture
ResourceSet:
string
ResourceSet
Value:
string
ResourceSet
}
]
}
resourcesGetByKey
Get resource by key
(Context.Name.Property).
/{property}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Resources/{context}/{
name}/{property}?defaultWhenNot
Found=&resourceSet=&culture="
;
*;
sourcesApi;
import java.util.*;

e {

ing[] args) {
ient();

uth2

("oauth2");

t_example; // String | Context.
ple; // String | Name.

ty.
Boolean defaultWhenNotF
ound = true; // Boolean | Flag
that indicates if a default val
ue should be returned if resour
ce not found in the DB.
Resource Set (if not specified
"default" will be used).
g | access token

i-Version

ot specified,
the defa
try {
ResourceDto result
= apiInstance.resourcesGetByKey
(context, name, property, defau
ltWhenNotFound, resourceSet, au
iVersion, culture);
System.out.println(
result);
) {
System.err.println(
esApi#resourcesGetByKey");
e.printStackTrace()
;
sourcesApi;

e {

ing[] args) {

t_example; // String | Context.
ple; // String | Name.

ty.
Boolean defaultWhenNotF
ce not found in the DB.
Resource Set (if not specified
"default" will be used).
g | access token

i-Version

ot specified,
the defa
try {
ResourceDto result
= apiInstance.resourcesGetByKey
(context, name, property, defau
ltWhenNotFound, resourceSet, au
iVersion, culture);
System.out.println(
result);
) {
System.err.println(
esApi#resourcesGetByKey");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

le; // Context.
Name.

mple; // Property.
Boolean *defaultWhenNotFound =
true; // Flag that indicates if
a default value should be retur
ned if resource not found in th
e DB. (optional) (default to fa
lse)

et_example; // Resource Set (if
not specified "default" will be
used). (optional) (default to d
efault)

(optional)

-US)


the defa
// Get resource by key (Context

.Name.Property).
[apiInstance resourcesGetByKeyW
ith:context
name:name
property:property
defaultWhenNotFound:default
WhenNotFound
ge
culture:culture
completionHandler
: ^(ResourceDto output, NSError
* error) {
if
(output) {
if
(error) {
}];





SS TOKEN"

esourcesApi()

// {String} Context.

ring} Name.
; // {String} Property.
var opts = {
'defaultWhenNotFound': true,
// {Boolean} Flag that indicate
s if a default value should be
returned if resource not found
in the DB.
'resourceSet': resourceSet_ex
ample, // {String} Resource Set
(if not specified "default" wil
l be used).
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.resourcesGetByKey(context,
name, property, opts, callback)
;
using System;
namespace Example
public class resourcesGetBy

KeyExample
public void main()
{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ResourcesApi();
var context = conte

t.
var name = name_exa

mple; // String | Name.
var property = prop

erty.
var defaultWhenNotF
ce not found in the DB. (option
al) (default to false)
var resourceSet = r
| Resource Set (if not specifie
d "default" will be used). (opt
ional) (default to default)
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get resource
by key (Context.Name.Property).
ResourceDto res
ult = apiInstance.resourcesGetB
yKey(context, name, property, d
efaultWhenNotFound, resourceSet
, apiVersion, culture);
Debug.WriteLine
(result);
catch (Exception e)
{
Debug.Print("Ex
pi.resourcesGetByKey: " + e.Mes
sage );
<?php
/autoload.php');


String | Context.

| Name.
/ String | Property.
$defaultWhenNotFound = true; //
Boolean | Flag that indicates i
f a default value should be ret
urned if resource not found in
the DB.
ple; // String | Resource Set (
if not specified "default" will
be used).
en
anguage
the defa
try {
sourcesGetByKey($context, $name
, $property, $defaultWhenNotFou
nd, $resourceSet, $authorizatio
, $culture);
print_r($result);

g ResourcesApi->resourcesGetByK
ey: ', $e->getMessage(), PHP_EO
L;
?>
use Data::Dumper;
ration;
esApi;

S_TOKEN';
# String | Context.

ng | Name.
; # String | Property.
my $defaultWhenNotFound = true;
# Boolean | Flag that indicates
if a default value should be re
turned if resource not found in
the DB.
(if not specified "default" wil
l be used).
oken
-Language
,
the defa
eval {
>resourcesGetByKey(context => $
context, name => $name, propert
y => $property, defaultWhenNotF
ound => $defaultWhenNotFound, r
esourceSet => $resourceSet, aut
ulture => $culture);
};
if ($@) {

g ResourcesApi->resourcesGetByK
ey: $@\n";

atement
import time

ApiException

'

class
esourcesApi()

ing | Context.

Name.
tring | Property.
defaultWhenNotFound = true # Bo
olean | Flag that indicates if
a default value should be retur
ned if resource not found in th
e DB. (optional) (default to fa
lse)
le # String | Resource Set (if
not specified "default" will be
used). (optional) (default to d
efault)
(optional)
US)
l) (default to 1.0)

the defa
try:
# Get resource by key (Cont

ext.Name.Property).
.resources_get_by_key(context,
name, property, defaultWhenNotF
ound=defaultWhenNotFound, resou
rceSet=resourceSet, authorizati
iVersion, culture=culture)

ng ResourcesApi->resourcesGetBy
Key: %s\n" % e)
Parameters
Path parameters
Name Description
context* String
Context.
Required
name* String
Name.
Required
property* String
Property.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
defaultWhenNotFound Boolean
Flag that indicates if a default value should be returned if

resource not found in the DB.
resourceSet String
Resource Set (if not specified "default" will be used).

culture String
Culture, not required, but if present, it must be a valid

culture. If not specified, the default culture will be used.
Responses
Status: 200 - OK
• Schema
{
Context:
string
Context
Name:
string
Name
Property:
string
Property
Culture:
string
Culture
ResourceSet:
string
ResourceSet
Value:
string
ResourceSet
}
resourcesPatch
Update the value of a non-default
resource
/{property}/{resourceSet}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Resources/{context}
/{name}/{property}/{resourceSet
}?culture="
;
*;
sourcesApi;
import java.util.*;

e {

ing[] args) {
ient();

uth2

("oauth2");


ty
Resource Set
ResourcePatch value = ;
// ResourcePatch | The resource
value
g | access token

i-Version

ot specified,
the defa
try {
Object result = api

Instance.resourcesPatch(context
, name, property, resourceSet,
value, authorization, acceptLan
System.out.println(
result);
) {
System.err.println(
esApi#resourcesPatch");
e.printStackTrace()
;
sourcesApi;

e {

ing[] args) {



ty
Resource Set
ResourcePatch value = ;
// ResourcePatch | The resource
value
g | access token

i-Version

ot specified,
the defa
try {
Object result = api

Instance.resourcesPatch(context
, name, property, resourceSet,
value, authorization, acceptLan
System.out.println(
result);
) {
System.err.println(
esApi#resourcesPatch");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

le; // Context

Name

mple; // Property

et_example; // Resource Set
ResourcePatch *value = ; // The

resource value
(optional)

-US)


the defa

// Update the value of a non-de

fault resource
[apiInstance resourcesPatchWith
:context
name:name
property:property
value:value
ge
culture:culture
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

esourcesApi()

// {String} Context

ring} Name

; // {String} Property
var resourceSet = resourceSet_e

xample; // {String} Resource Se
t
var value = ; // {ResourcePatch

} The resource value
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.resourcesPatch(context, nam
e, property, resourceSet, value
, opts, callback);
using System;
namespace Example
public class resourcesPatch

Example
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ResourcesApi();
var context = conte

t
var name = name_exa

mple; // String | Name
var property = prop

erty
var resourceSet = r
| Resource Set
var value = new Res

ourcePatch(); // ResourcePatch
| The resource value
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Update the v
alue of a non-default resource
Object result =
apiInstance.resourcesPatch(cont
ext, name, property, resourceSe
t, value, authorization, accept
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
pi.resourcesPatch: " + e.Messag
e );
<?php
/autoload.php');


String | Context

| Name
/ String | Property
ple; // String | Resource Set
$value = ; // ResourcePatch | T
he resource value
en
anguage
the defa
try {
sourcesPatch($context, $name, $
property, $resourceSet, $value,
print_r($result);

g ResourcesApi->resourcesPatch:
?>
use Data::Dumper;
ration;
esApi;

S_TOKEN';
# String | Context

ng | Name
; # String | Property
my $value = WWW::SwaggerClient:
:Object::ResourcePatch->new();
# ResourcePatch | The resource
value
oken
-Language
,
the defa
eval {
>resourcesPatch(context => $con
text, name => $name, property =
> $property, resourceSet => $re
sourceSet, value => $value, aut
ulture => $culture);
};
if ($@) {

g ResourcesApi->resourcesPatch:
$@\n";

atement
import time

ApiException

'

class
esourcesApi()

ing | Context

Name
tring | Property
le # String | Resource Set
value = # ResourcePatch | The

resource value
(optional)
US)
l) (default to 1.0)
the defa
try:
# Update the value of a non

-default resource
.resources_patch(context, name,
property, resourceSet, value, a
ture)

ng ResourcesApi->resourcesPatch
: %s\n" % e)
Parameters
Path parameters
Name Description
context* String
Context
Required
name* String
Name
Required
property* String
Property
Required
resourceSet* String
Resource Set
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
value * {
Value to update for a resource

Value:
Value string
}
Query parameters
Name Description
culture String

Responses
Status: 200 - OK
• Schema
{
}
resourcesPost
Create a new resource
/api/Resources
Usage and SDK
Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Resources"
;
*;
sourcesApi;
import java.util.*;

e {
ing[] args) {
ient();

uth2

("oauth2");
ResourceDto resource =
; // ResourceDto | Resource val
ues
g | access token

i-Version
try {
apiInstance.resourc
esPost(resource, authorization,
) {
System.err.println(
esApi#resourcesPost");
e.printStackTrace()
;
sourcesApi;

e {

ing[] args) {
ResourceDto resource =
; // ResourceDto | Resource val
ues
g | access token

i-Version
try {
apiInstance.resourc
esPost(resource, authorization,
) {
System.err.println(
esApi#resourcesPost");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
ResourceDto *resource = ; // Re
source values

(optional)

-US)


// Create a new resource
[apiInstance resourcesPostWith:
resource
ge
completionHandler
if
(error) {
}];





SS TOKEN"

esourcesApi()
var resource = ; // {ResourceDt

o} Resource values
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

cessfully.');
};
api.resourcesPost(resource, opt
s, callback);
using System;
namespace Example
public class resourcesPostE

xample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ResourcesApi();
var resource = new

ResourceDto(); // ResourceDto |
Resource values
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a new
resource
apiInstance.res
ourcesPost(resource, authorizat
);
catch (Exception e)
Debug.Print("Ex
pi.resourcesPost: " + e.Message
);
<?php
/autoload.php');


$resource = ; // ResourceDto |
Resource values
en
anguage
try {
$api_instance->resourcesPos
t($resource, $authorization, $a

g ResourcesApi->resourcesPost:
?>
use Data::Dumper;
ration;
esApi;

S_TOKEN';
my $resource = WWW::SwaggerClie
nt::Object::ResourceDto->new();
# ResourceDto | Resource values
oken
-Language
eval {
$api_instance->resourcesPos
t(resource => $resource, author
};
if ($@) {

g ResourcesApi->resourcesPost:
$@\n";

atement
import time

ApiException

'

class
esourcesApi()
resource = # ResourceDto | Res

ource values
(optional)
US)
l) (default to 1.0)
try:
# Create a new resource
api_instance.resources_post
(resource, authorization=author
ng ResourcesApi->resourcesPost:
%s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
resource * {
Context:
string
Context
Name:
string
Name
Property:
string
Property
Culture:
string
Culture
ResourceSet:
string
ResourceSet
Value:
string
ResourceSet
}
Responses

header with the new
resource
Shipments
shipmentsConfirmSelect
ed
Ship Confirm Selected Packslips.
/api/Shipments/ConfirmSelected
Usage and SDK
Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Shipments/ConfirmSel
ected"
;
*;
import io.swagger.client.api.Sh
ipmentsApi;
import java.util.*;
public class ShipmentsApiExampl

e {
ing[] args) {
ient();

uth2

("oauth2");
ShipmentsApi apiInstanc
e = new ShipmentsApi();
ConfirmShipmentsModel m
odel = ; // ConfirmShipmentsMod
el |
g | access token

i-Version
try {
apiInstance.shipmen
tsConfirmSelected(model, author
sion);
) {
System.err.println(
"Exception when calling Shipmen
tsApi#shipmentsConfirmSelected"
);
e.printStackTrace()
;
ipmentsApi;

e {

ing[] args) {
ConfirmShipmentsModel m
odel = ; // ConfirmShipmentsMod
el |
g | access token

i-Version
try {
apiInstance.shipmen
tsConfirmSelected(model, author
sion);
) {
System.err.println(
tsApi#shipmentsConfirmSelected"
);
e.printStackTrace()
;

R_ACCESS_TOKEN"];
ConfirmShipmentsModel *model =
; //

(optional)

-US)

ShipmentsApi *apiInstance = [[S

hipmentsApi alloc] init];
// Ship Confirm Selected Packsl

ips.
[apiInstance shipmentsConfirmSe
lectedWith:model
ge
completionHandler
if
(error) {
}];





SS TOKEN"
var api = new JenkonRestApiV1.S

hipmentsApi()
var model = ; // {ConfirmShipme
ntsModel}
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

cessfully.');
};
api.shipmentsConfirmSelected(mo
del, opts, callback);
using System;
namespace Example
public class shipmentsConfi

rmSelectedExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ShipmentsApi();
var model = new Con

firmShipmentsModel(); // Confir
mShipmentsModel |
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Ship Confirm
Selected Packslips.
apiInstance.shi
pmentsConfirmSelected(model, au
iVersion);
catch (Exception e)
Debug.Print("Ex
ception when calling ShipmentsA
pi.shipmentsConfirmSelected: "
+ e.Message );
}
}
<?php
/autoload.php');


ent\Api\ShipmentsApi();
$model = ; // ConfirmShipmentsM
odel |
en
anguage
try {
$api_instance->shipmentsCon
firmSelected($model, $authoriza
ion);

g ShipmentsApi->shipmentsConfir
mSelected: ', $e->getMessage(),
PHP_EOL;
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Shipmen
tsApi;

S_TOKEN';
Client::ShipmentsApi->new();
:Object::ConfirmShipmentsModel-
>new(); # ConfirmShipmentsModel
|
oken
-Language
eval {
firmSelected(model => $model, a
};
if ($@) {

mSelected: $@\n";

atement
import time

ApiException

'

class
api_instance = swagger_client.S
hipmentsApi()
model = # ConfirmShipmentsMode
l |
(optional)
US)
l) (default to 1.0)
try:
# Ship Confirm Selected Pac

kslips.
api_instance.shipments_conf
irm_selected(model, authorizati
iVersion)

ng ShipmentsApi->shipmentsConfi
rmSelected: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
model * ConfirmShipmentsModel {
ConfirmShipmentsModel.
Required: ShipDate,Warehouse
Warehouse:
ShipDate:
ShipDate string (date)
Carrier:
Carrier string minLength:1 maxLength:50
ShippingMethod:
ShippingMethod string minLength:1 maxLength:50
StartDate:
StartDate string (date)
EndDate:
EndDate string (date)
Batch:
Batch string minLength:1 maxLength:50
}
Responses
Status: 200 - OK
shipmentsConfirmSingle
ByOrder
Ship Confirm a Single Packslip.
/api/Orders/{orderCode}/Shipmen
ts/{shipmentCode}/ConfirmSingle
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Orders/{orderCode}/S
hipments/{shipmentCode}/Confirm
Single"
;
*;
ipmentsApi;
import java.util.*;

e {

ing[] args) {
ient();
uth2

("oauth2");

rCode_example; // String |
String shipmentCode = s
hipmentCode_example; // String
|
ShipmentModel shipmentM
odel = ; // ShipmentModel |
g | access token

i-Version
try {
apiInstance.shipmen
tsConfirmSingleByOrder(orderCod
e, shipmentCode, shipmentModel,
apiVersion);
) {
System.err.println(
tsApi#shipmentsConfirmSingleByO
rder");
e.printStackTrace()
;
ipmentsApi;

e {

ing[] args) {

rCode_example; // String |
String shipmentCode = s
hipmentCode_example; // String
|
g | access token

i-Version
try {
apiInstance.shipmen
tsConfirmSingleByOrder(orderCod
e, shipmentCode, shipmentModel,
apiVersion);
) {
System.err.println(
tsApi#shipmentsConfirmSingleByO
rder");
e.printStackTrace()
;

R_ACCESS_TOKEN"];

xample; //
String *shipmentCode = shipment

Code_example; //
ShipmentModel *shipmentModel =
; //

(optional)

-US)


// Ship Confirm a Single Packsl

ip.
[apiInstance shipmentsConfirmSi
ngleByOrderWith:orderCode
shipmentCode:shipmentCode
shipmentModel:shipmentModel
ge
completionHandler
if
(error) {
}];




SS TOKEN"

hipmentsApi()

le; // {String}
var shipmentCode = shipmentCode

var shipmentModel = ; // {Shipm

entModel}
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

cessfully.');
};
api.shipmentsConfirmSingleByOrd
er(orderCode, shipmentCode, shi
pmentModel, opts, callback);
using System;
namespace Example

rmSingleByOrderExample
public void main()

{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ShipmentsApi();
var orderCode = ord

erCode_example; // String |
var shipmentCode =
shipmentCode_example; // Strin
g |
var shipmentModel =
new ShipmentModel(); // Shipmen
tModel |
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Ship Confirm
a Single Packslip.
apiInstance.shi
pmentsConfirmSingleByOrder(orde
rCode, shipmentCode, shipmentMo
age, apiVersion);
catch (Exception e)
Debug.Print("Ex
pi.shipmentsConfirmSingleByOrde
r: " + e.Message );
<?php
/autoload.php');


// String |
$shipmentCode = shipmentCode_ex
ample; // String |
$shipmentModel = ; // ShipmentM
odel |
en
anguage
try {
firmSingleByOrder($orderCode, $
shipmentCode, $shipmentModel, $
$apiVersion);

mSingleByOrder: ', $e->getMessa
ge(), PHP_EOL;
?>
use Data::Dumper;
ration;
tsApi;

S_TOKEN';
le; # String |
my $shipmentCode = shipmentCode
my $shipmentModel = WWW::Swagge
rClient::Object::ShipmentModel-
>new(); # ShipmentModel |
oken
-Language
eval {
firmSingleByOrder(orderCode =>
$orderCode, shipmentCode => $sh
ipmentCode, shipmentModel => $s
hipmentModel, authorization =>
=> $apiVersion);
};
if ($@) {

mSingleByOrder: $@\n";

atement
import time

ApiException

'

class
hipmentsApi()
String |
shipmentCode = shipmentCode_exa
mple # String |
shipmentModel = # ShipmentMode
l |
(optional)
US)
l) (default to 1.0)
try:
# Ship Confirm a Single Pac
kslip.
irm_single_by_order(orderCode,
shipmentCode, shipmentModel, au
ersion=apiVersion)

rmSingleByOrder: %s\n" % e)
Parameters
Path parameters
Name Description
orderCode* String
Required
shipmentCode* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
shipmentModel * ShipmentModel {
ShipmentModel.
Required: ShipmentDate,TotalQuantityShipped
ShipmentDate:
ShipmentDate string (date)
TotalQuantityShipped:
TotalQuantityShipped integer (int32)
Items:
Items[
ShipmentItemModel {
ShipmentItemModel.
Required: Product,ShipQuantities
Product:
ShipQuantities:
ShipQuantities integer (int32)
}
]
}
Responses
Status: 200 - OK
shipmentsConfirmSingle
ByPackslip
Ship Confirm a Single Packslip.
/api/Shipments/{code}/ConfirmSi
ngle
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Shipments/{code}/Con
firmSingle"
;
*;
ipmentsApi;
import java.util.*;

e {

ing[] args) {
ient();

uth2

("oauth2");

ple; // String |
g | access token

i-Version
try {
apiInstance.shipmen
tsConfirmSingleByPackslip(code,
shipmentModel, authorization, a
) {
System.err.println(
tsApi#shipmentsConfirmSingleByP
ackslip");
e.printStackTrace()
;
ipmentsApi;
e {

ing[] args) {

ple; // String |
g | access token

i-Version
try {
apiInstance.shipmen
tsConfirmSingleByPackslip(code,
shipmentModel, authorization, a
) {
System.err.println(
tsApi#shipmentsConfirmSingleByP
ackslip");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
ShipmentModel *shipmentModel =
; //

(optional)

-US)

// Ship Confirm a Single Packsl

ip.
[apiInstance shipmentsConfirmSi
ngleByPackslipWith:code
shipmentModel:shipmentModel
ge
completionHandler
if
(error) {
}];




SS TOKEN"

hipmentsApi()

ring}
var shipmentModel = ; // {Shipm

entModel}
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

cessfully.');
};
api.shipmentsConfirmSingleByPac
kslip(code, shipmentModel, opts
, callback);
using System;
namespace Example

rmSingleByPackslipExample
{
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ShipmentsApi();
var code = code_exa

mple; // String |
var shipmentModel =
new ShipmentModel(); // Shipmen
tModel |
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Ship Confirm
a Single Packslip.
apiInstance.shi
pmentsConfirmSingleByPackslip(c
ode, shipmentModel, authorizati
;
catch (Exception e)
Debug.Print("Ex
pi.shipmentsConfirmSingleByPack
slip: " + e.Message );
<?php
/autoload.php');



|
$shipmentModel = ; // ShipmentM
odel |
en
anguage
try {
firmSingleByPackslip($code, $sh
ipmentModel, $authorization, $a

mSingleByPackslip: ', $e->getMe
ssage(), PHP_EOL;
}
?>
use Data::Dumper;
ration;
tsApi;

S_TOKEN';

ng |
my $shipmentModel = WWW::Swagge
rClient::Object::ShipmentModel-
>new(); # ShipmentModel |
oken
-Language
eval {
firmSingleByPackslip(code => $c
ode, shipmentModel => $shipment
Model, authorization => $author
Version);
};
if ($@) {

mSingleByPackslip: $@\n";

atement
import time

ApiException

'
class
hipmentsApi()
shipmentModel = # ShipmentMode
l |
(optional)
US)
l) (default to 1.0)
try:
# Ship Confirm a Single Pac

kslip.
irm_single_by_packslip(code, sh
ipmentModel, authorization=auth
n)
rmSingleByPackslip: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
shipmentModel * ShipmentModel {
ShipmentModel.
Required: ShipmentDate,TotalQuantityShipped
ShipmentDate:
ShipmentDate string (date)
TotalQuantityShipped:
TotalQuantityShipped integer (int32)
Items:
Items[
ShipmentItemModel {
ShipmentItemModel.
Required: Product,ShipQuantities
Product:
ShipQuantities:
ShipQuantities integer (int32)
}
]
}
Responses
Status: 200 - OK
shipmentsGetAll
Get all the shipments.
/api/Shipments
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Shipments?pageNumber=
&pageSize=&sortType=&filters="
;
*;
ipmentsApi;
import java.util.*;

e {

ing[] args) {
ient();
uth2

("oauth2");

greater than 0

'
g | access token

i-Version
s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.ShipmentDetail result =
apiInstance.shipmentsGetAll(pag
iVersion, filters);
System.out.println(
result);
) {
System.err.println(
tsApi#shipmentsGetAll");
e.printStackTrace()
;
ipmentsApi;

e {

ing[] args) {

greater than 0

'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.ShipmentDetail result =
apiInstance.shipmentsGetAll(pag
iVersion, filters);
System.out.println(
result);
) {
System.err.println(
tsApi#shipmentsGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

default to 25)

c)

(optional)

-US)


le; // # Filters
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)

// Get all the shipments.
[apiInstance shipmentsGetAllWit
h:pageNumber
pageSize:pageSize
sortType:sortType
ge
filters:filters
completionHandler
hipmentDetail output, NSError*
error) {
if
(output) {
if
(error) {
}];





SS TOKEN"

hipmentsApi()
than or equal to 0

0

var opts = {
oken
-Language
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.shipmentsGetAll(pageNumber,
ack);
using System;
namespace Example
public class shipmentsGetAl

lExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ShipmentsApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;
var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get all the

shipments.
HateoasCollecti
onResponse.ShipmentDetail resul
t = apiInstance.shipmentsGetAll
, apiVersion, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
pi.shipmentsGetAll: " + e.Messa
ge );
}
}
<?php
/autoload.php');



an or equal to 0

for 'Descending'
en
anguage
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
$result = $api_instance->sh
ipmentsGetAll($pageNumber, $pag
eSize, $sortType, $authorizatio
, $filters);
print_r($result);

g ShipmentsApi->shipmentsGetAll
?>
use Data::Dumper;
ration;
tsApi;

S_TOKEN';

than or equal to 0

0
oken
-Language
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>shipmentsGetAll(pageNumber =>
e, apiVersion => $apiVersion, f
ilters => $filters);
};
if ($@) {

g ShipmentsApi->shipmentsGetAll
: $@\n";

atement
import time

ApiException

'
class
hipmentsApi()


efault to 25)
)
(optional)
US)
l) (default to 1.0)

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get all the shipments.
.shipments_get_all(pageNumber,
iVersion, filters=filters)

ng ShipmentsApi->shipmentsGetAl
l: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
ShipmentDto.
Code:
string
Shipment code.
SalesOrder:
string
Sales Order Code.
ShipDate:
string (date-time)
Ship Date.
Reference:
string
Reference.
TransacionDate:
string (date-time)
Transaction Date
ShipEmployee:
string
Ship Employee.
Warehouse:
string
Warehouse.
CarrierMethod:
string
CarrierMethod.
Finalized:
boolean
Finalized.
RequiresBackOrder:
boolean
Requires Back Order.
IsBackOrder:
boolean
Is Back Order.
Items:
[
Items.
{
ShipmentItemDto.
Code:
string
Code.
QuantityShipped:
integer (int32)
Quantity Shipped.
OriginalQuantityShipped:
integer (int32)
Original Quantity Shipped.
InventoryShipped:
integer (int32)
Inventory Shipped.
BackorderExpected:
string
Backorder Expected.
TrackingNumbers:
string
Tracking Numbers.
OutOfBox:
boolean
Out Of Box.
LotInfos:
[
Lot Information.
{
ShipmentItemLotInfoDto.
LotNumber:
string
Lot Number.
QuantityShipped:
integer (int32)
Quantity of shipment items in this lot.
}
]
}
]
}
]
}
shipmentsGetByCode
Get a shipment by code.
/api/Shipments/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Shipments/{code}"
;
*;
ipmentsApi;
import java.util.*;

e {

ing[] args) {
ient();

uth2

("oauth2");

ple; // String | Code.
g | access token

i-Version
try {
ShipmentDetail resu
lt = apiInstance.shipmentsGetBy
System.out.println(
result);
) {
System.err.println(
tsApi#shipmentsGetByCode");
e.printStackTrace()
;
ipmentsApi;

e {

ing[] args) {

ple; // String | Code.
g | access token

i-Version
try {
ShipmentDetail resu
lt = apiInstance.shipmentsGetBy
System.out.println(
result);
) {
System.err.println(
tsApi#shipmentsGetByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

Code.

(optional)

-US)


// Get a shipment by code.
[apiInstance shipmentsGetByCode
With:code
ge
completionHandler
: ^(ShipmentDetail output, NSEr
ror* error) {
if
(output) {
if
(error) {
}];





SS TOKEN"

hipmentsApi()
ring} Code.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.shipmentsGetByCode(code, op
ts, callback);
using System;
namespace Example
public class shipmentsGetBy

CodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ShipmentsApi();
var code = code_exa

mple; // String | Code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get a shipme
nt by code.
ShipmentDetail
result = apiInstance.shipmentsG
etByCode(code, authorization, a
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
pi.shipmentsGetByCode: " + e.Me
ssage );
}
}
<?php
/autoload.php');



| Code.
en
anguage
try {
ipmentsGetByCode($code, $author
ersion);
print_r($result);

g ShipmentsApi->shipmentsGetByC
OL;
?>
use Data::Dumper;
ration;
tsApi;

S_TOKEN';

ng | Code.
oken
-Language
eval {
>shipmentsGetByCode(code => $co
sion);
};
if ($@) {

g ShipmentsApi->shipmentsGetByC
ode: $@\n";

atement
import time
ApiException

'

class
hipmentsApi()

Code.
(optional)
US)
l) (default to 1.0)
try:
# Get a shipment by code.

.shipments_get_by_code(code, au
ersion=apiVersion)

ng ShipmentsApi->shipmentsGetBy
Code: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
ShipmentDto.
Code:
string
Shipment code.
SalesOrder:
string
Sales Order Code.
ShipDate:
string (date-time)
Ship Date.
Reference:
string
Reference.
TransacionDate:
string (date-time)
Transaction Date
ShipEmployee:
string
Ship Employee.
Warehouse:
string
Warehouse.
CarrierMethod:
string
CarrierMethod.
Finalized:
boolean
Finalized.
RequiresBackOrder:
boolean
Requires Back Order.
IsBackOrder:
boolean
Is Back Order.
Items:
[
Items.
{
ShipmentItemDto.
Code:
string
Code.
QuantityShipped:
integer (int32)
Quantity Shipped.
OriginalQuantityShipped:
integer (int32)
Original Quantity Shipped.
InventoryShipped:
integer (int32)
Inventory Shipped.
BackorderExpected:
string
Backorder Expected.
TrackingNumbers:
string
Tracking Numbers.
OutOfBox:
boolean
Out Of Box.
LotInfos:
[
Lot Information.
{
ShipmentItemLotInfoDto.
LotNumber:
string
Lot Number.
QuantityShipped:
integer (int32)
Quantity of shipment items in this lot.
}
]
}
]
}
shipmentsPost
Create a shipment.
/api/Shipments
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Shipments"
;
*;
ipmentsApi;
import java.util.*;

e {

ing[] args) {
ient();

uth2
("oauth2");
CreateShipmentModel shi
pment = ; // CreateShipmentMode
l |
g | access token

i-Version
try {
Object result = api

Instance.shipmentsPost(shipment
, apiVersion);
System.out.println(
result);
) {
System.err.println(
tsApi#shipmentsPost");
e.printStackTrace()
;
ipmentsApi;

e {

ing[] args) {
CreateShipmentModel shi
pment = ; // CreateShipmentMode
l |
g | access token
i-Version
try {
Object result = api

Instance.shipmentsPost(shipment
, apiVersion);
System.out.println(
result);
) {
System.err.println(
tsApi#shipmentsPost");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
CreateShipmentModel *shipment =
; //

(optional)

-US)


// Create a shipment.
[apiInstance shipmentsPostWith:
shipment
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"

hipmentsApi()
var shipment = ; // {CreateShip

mentModel}
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.shipmentsPost(shipment, opt
s, callback);
using System;
namespace Example
public class shipmentsPostE

xample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew ShipmentsApi();
var shipment = new

CreateShipmentModel(); // Creat
eShipmentModel |
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a shi
pment.
Object result =
apiInstance.shipmentsPost(shipm
ent, authorization, acceptLangu
age, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
pi.shipmentsPost: " + e.Message
);
}
}
<?php
/autoload.php');


$shipment = ; // CreateShipment
Model |
en
anguage
try {
ipmentsPost($shipment, $authori
zation, $acceptLanguage, $apiVe
rsion);
print_r($result);

g ShipmentsApi->shipmentsPost:
?>
use Data::Dumper;
ration;
tsApi;

S_TOKEN';
my $shipment = WWW::SwaggerClie
nt::Object::CreateShipmentModel
->new(); # CreateShipmentModel
|
oken
-Language
eval {
>shipmentsPost(shipment => $shi
pment, authorization => $author
Version);
};
if ($@) {

g ShipmentsApi->shipmentsPost:
$@\n";

atement
import time
ApiException

'

class
hipmentsApi()
shipment = # CreateShipmentMod
el |
(optional)
US)
l) (default to 1.0)
try:
# Create a shipment.
.shipments_post(shipment, autho
ion=apiVersion)

ng ShipmentsApi->shipmentsPost:
%s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
shipment * CreateShipmentModel {
CreateShipmentModel
Required: Type,Warehouse
Type:
Type string
Enum: SalesOrder , Date , Backorder
Warehouse:
SalesOrder:
SalesOrder string minLength:1 maxLength:50
StartDate:
EndDate:
}
Responses
Status: 200 - OK
• Schema
{
}
SponsorRules
sponsorRulesGetByAccou
ntCode
Get by account code
/api/SponsorRules/{accountCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/SponsorRules/{account
Code}"
;
*;
import io.swagger.client.api.Sp
onsorRulesApi;
import java.util.*;
public class SponsorRulesApiExa
mple {

ing[] args) {
ient();

uth2

("oauth2");
SponsorRulesApi apiInst
ance = new SponsorRulesApi();
Account code
g | access token
i-Version
try {
ResponseSponsorRule
s result = apiInstance.sponsorR
ulesGetByAccountCode(accountCod
e, apiVersion);
System.out.println(
result);
) {
System.err.println(
"Exception when calling Sponsor
RulesApi#sponsorRulesGetByAccou
ntCode");
e.printStackTrace()
;
onsorRulesApi;

mple {
ing[] args) {
Account code
g | access token

i-Version
try {
ResponseSponsorRule
s result = apiInstance.sponsorR
ulesGetByAccountCode(accountCod
e, apiVersion);
System.out.println(
result);
) {
System.err.println(
RulesApi#sponsorRulesGetByAccou
ntCode");
e.printStackTrace()
;
}


R_ACCESS_TOKEN"];

de_example; // Account code

(optional)

-US)

SponsorRulesApi *apiInstance =
[[SponsorRulesApi alloc] init];
// Get by account code
[apiInstance sponsorRulesGetByA
ccountCodeWith:accountCode
ge
completionHandler
: ^(ResponseSponsorRules output
, NSError* error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

ponsorRulesApi()

e
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.sponsorRulesGetByAccountCod
e(accountCode, opts, callback);
using System;
namespace Example
public class sponsorRulesGe

tByAccountCodeExample
public void main()
{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew SponsorRulesApi();
var accountCode = a
| Account code
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get by accou
nt code
ResponseSponsor
Rules result = apiInstance.spon
sorRulesGetByAccountCode(accoun
guage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling SponsorRul
esApi.sponsorRulesGetByAccountC
ode: " + e.Message );
<?php
/autoload.php');

ent\Api\SponsorRulesApi();
ple; // String | Account code
en
anguage
try {
$result = $api_instance->sp
onsorRulesGetByAccountCode($acc
ountCode, $authorization, $acce
print_r($result);

g SponsorRulesApi->sponsorRules
GetByAccountCode: ', $e->getMes
sage(), PHP_EOL;
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Sponsor
RulesApi;

S_TOKEN';
Client::SponsorRulesApi->new();
oken
-Language
eval {
>sponsorRulesGetByAccountCode(a
ccountCode => $accountCode, aut
};
if ($@) {

GetByAccountCode: $@\n";

atement
import time

ApiException

'

class
ponsorRulesApi()
le # String | Account code
(optional)
US)
l) (default to 1.0)
try:
# Get by account code
.sponsor_rules_get_by_account_c
ode(accountCode, authorization=
rsion)

ng SponsorRulesApi->sponsorRule
sGetByAccountCode: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Account code
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
Response Sponsor Rules
SponsorInformation:
{
Sponsor Information
AccountCode:
string
Account Code
PostCode:
string
Post Code
FirstName:
string
First Name
LastName:
string
Last Name
}
SponsorRules:
[
Sponsor Rules
{
Sponsor Rule
Country:
string
Country
AccountTypes:
[
Account Types
string
]
}
]
}
sponsorRulesGetByCount
ryPostcodeName
Get by country postcode or/and
name
/api/SponsorRules
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/SponsorRules?countryC
ode=&postalCode=&firstName=&las
tName=&pageNumber=&pageSize=&so
rtType="
;
*;
onsorRulesApi;
import java.util.*;

mple {

ing[] args) {
ient();

uth2

("oauth2");

greater than 0
'
String countryCode = co
untryCode_example; // String |
String postalCode = pos

talCode_example; // String |
String firstName = firs

tName_example; // String |
String lastName = lastN

ame_example; // String |
g | access token

i-Version
try {
HateoasCollectionRe
sponse.ResponseSponsorRules res
ult = apiInstance.sponsorRulesG
etByCountryPostcodeName(pageNum
ber, pageSize, sortType, countr
yCode, postalCode, firstName, l
astName, authorization, acceptL
System.out.println(
result);
) {
System.err.println(
RulesApi#sponsorRulesGetByCount
ryPostcodeName");
e.printStackTrace()
;
onsorRulesApi;

mple {

ing[] args) {

greater than 0
'
String countryCode = co
untryCode_example; // String |
String postalCode = pos

talCode_example; // String |
String firstName = firs

tName_example; // String |
String lastName = lastN

ame_example; // String |
g | access token

i-Version
try {
HateoasCollectionRe
sponse.ResponseSponsorRules res
ult = apiInstance.sponsorRulesG
etByCountryPostcodeName(pageNum
ber, pageSize, sortType, countr
yCode, postalCode, firstName, l
astName, authorization, acceptL
System.out.println(
result);
) {
System.err.println(
RulesApi#sponsorRulesGetByCount
ryPostcodeName");
e.printStackTrace()
;


R_ACCESS_TOKEN"];


default to 25)

c)
String *countryCode = countryCo

de_example; // (optional)
String *postalCode = postalCode

_example; // (optional)
String *firstName = firstName_e

xample; // (optional)
String *lastName = lastName_exa

mple; // (optional)

(optional)

-US)

SponsorRulesApi *apiInstance =
[[SponsorRulesApi alloc] init];
// Get by country postcode or/a

nd name
[apiInstance sponsorRulesGetByC
ountryPostcodeNameWith:pageNumb
er
pageSize:pageSize
sortType:sortType
countryCode:countryCode
postalCode:postalCode
firstName:firstName
lastName:lastName
ge
completionHandler
: ^(HateoasCollectionResponse.R
esponseSponsorRules output, NSE
rror* error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

ponsorRulesApi()

than or equal to 0

0

var opts = {
'countryCode': countryCode_ex
ample, // {String}
'postalCode': postalCode_exam
ple, // {String}
'firstName': firstName_exampl
e, // {String}
'lastName': lastName_example,
// {String}
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.sponsorRulesGetByCountryPos
tcodeName(pageNumber, pageSize,
sortType, opts, callback);
using System;
namespace Example
public class sponsorRulesGe

tByCountryPostcodeNameExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew SponsorRulesApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var countryCode = c
ountryCode_example; // String
| (optional)
var postalCode = po
stalCode_example; // String |
(optional)
var firstName = fir

stName_example; // String | (
optional)
var lastName = last

Name_example; // String | (op
tional)
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get by count
ry postcode or/and name
HateoasCollecti
onResponse.ResponseSponsorRules
result = apiInstance.sponsorRul
esGetByCountryPostcodeName(page
Number, pageSize, sortType, cou
ntryCode, postalCode, firstName
, lastName, authorization, acce
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling SponsorRul
esApi.sponsorRulesGetByCountryP
ostcodeName: " + e.Message );
}
}
<?php
/autoload.php');


ent\Api\SponsorRulesApi();

an or equal to 0

for 'Descending'
$countryCode = countryCode_exam
ple; // String |
$postalCode = postalCode_exampl
e; // String |
$firstName = firstName_example;
// String |
$lastName = lastName_example; /
/ String |
en
anguage
try {
$result = $api_instance->sp
onsorRulesGetByCountryPostcodeN
ame($pageNumber, $pageSize, $so
rtType, $countryCode, $postalCo
de, $firstName, $lastName, $aut
horization, $acceptLanguage, $a
piVersion);
print_r($result);

GetByCountryPostcodeName: ', $e
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Sponsor
RulesApi;

S_TOKEN';
Client::SponsorRulesApi->new();

than or equal to 0

0
my $countryCode = countryCode_e
xample; # String |
my $postalCode = postalCode_exa
mple; # String |
my $firstName = firstName_examp
le; # String |
my $lastName = lastName_example
; # String |
oken
-Language
eval {
>sponsorRulesGetByCountryPostco
deName(pageNumber => $pageNumbe
r, pageSize => $pageSize, sortT
ype => $sortType, countryCode =
> $countryCode, postalCode => $
postalCode, firstName => $first
Name, lastName => $lastName, au
thorization => $authorization,
};
if ($@) {

GetByCountryPostcodeName: $@\n"
;
}
atement
import time

ApiException

'

class
ponsorRulesApi()


efault to 25)
)
countryCode = countryCode_examp
le # String | (optional)
postalCode = postalCode_example
# String | (optional)
firstName = firstName_example #
String | (optional)
lastName = lastName_example # S
tring | (optional)
(optional)
US)
l) (default to 1.0)
try:
# Get by country postcode o

r/and name
.sponsor_rules_get_by_country_p
ostcode_name(pageNumber, pageSi
ze, sortType, countryCode=count
ryCode, postalCode=postalCode,
firstName=firstName, lastName=l
astName, authorization=authoriz

ng SponsorRulesApi->sponsorRule
sGetByCountryPostcodeName: %s\n
" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
countryCode String
postalCode String
firstName String
lastName String
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Response Sponsor Rules
SponsorInformation:
{
Sponsor Information
AccountCode:
string
Account Code
PostCode:
string
Post Code
FirstName:
string
First Name
LastName:
string
Last Name
}
SponsorRules:
[
Sponsor Rules
{
Sponsor Rule
Country:
string
Country
AccountTypes:
[
Account Types
string
]
}
]
}
]
}
Stocks
stocksGetAll
Get data for Stock entries
/api/Stocks
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Stocks?keys=&pageNumb
er=&pageSize=&sortType="
;
*;
import io.swagger.client.api.St
ocksApi;
import java.util.*;
public class StocksApiExample {

ing[] args) {
ient();
uth2

("oauth2");
StocksApi apiInstance =
new StocksApi();

greater than 0

'
// array[Object] | Stock keys
g | access token
i-Version
try {
HateoasCollectionRe
sponse.StockDto result = apiIns
tance.stocksGetAll(pageNumber,
pageSize, sortType, keys, autho
rsion);
System.out.println(
result);
) {
System.err.println(
"Exception when calling StocksA
pi#stocksGetAll");
e.printStackTrace()
;
ocksApi;

ing[] args) {
new StocksApi();

greater than 0

'
// array[Object] | Stock keys
g | access token

i-Version
try {
HateoasCollectionRe
sponse.StockDto result = apiIns
tance.stocksGetAll(pageNumber,
pageSize, sortType, keys, autho
rsion);
System.out.println(
result);
) {
System.err.println(
pi#stocksGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];


default to 25)
c)
array[Object] *keys = ; // Stoc

k keys (optional)

(optional)

-US)

StocksApi *apiInstance = [[Stoc

ksApi alloc] init];
// Get data for Stock entries
[apiInstance stocksGetAllWith:p
ageNumber
pageSize:pageSize
sortType:sortType
keys:keys
ge
completionHandler
tockDto output, NSError* error)
{
if
(output) {
if
(error) {
}];




SS TOKEN"

tocksApi()

than or equal to 0

0

var opts = {
'keys': , // {array[Object]}
Stock keys
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.stocksGetAll(pageNumber, pa
geSize, sortType, opts, callbac
k);
using System;
namespace Example
{
public class stocksGetAllEx

ample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew StocksApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var keys = new arra
y[Object](); // array[Object] |
Stock keys (optional)
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get data for

Stock entries
HateoasCollecti
onResponse.StockDto result = ap
iInstance.stocksGetAll(pageNumb
er, pageSize, sortType, keys, a
piVersion);
Debug.WriteLine
(result);
catch (Exception e)
{
Debug.Print("Ex
ception when calling StocksApi.
stocksGetAll: " + e.Message );
<?php
/autoload.php');


ent\Api\StocksApi();

an or equal to 0

for 'Descending'
$keys = ; // array[Object] | St
ock keys
en
anguage
try {
$result = $api_instance->st
ocksGetAll($pageNumber, $pageSi
ze, $sortType, $keys, $authoriz
ation, $acceptLanguage, $apiVer
sion);
print_r($result);

g StocksApi->stocksGetAll: ', $
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::StocksA
pi;

S_TOKEN';
Client::StocksApi->new();

than or equal to 0

0
my $keys = []; # array[Object]

| Stock keys
oken
-Language
eval {
>stocksGetAll(pageNumber => $pa
geNumber, pageSize => $pageSize
, sortType => $sortType, keys =
> $keys, authorization => $auth
piVersion);
};
if ($@) {

g StocksApi->stocksGetAll: $@\n
";

atement
import time

ApiException

'

class
tocksApi()


efault to 25)
)
keys = # array[Object] | Stock

keys (optional)
(optional)
US)
l) (default to 1.0)
try:
# Get data for Stock entrie

s
.stocks_get_all(pageNumber, pag
eSize, sortType, keys=keys, aut
rsion=apiVersion)

ng StocksApi->stocksGetAll: %s\
n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
keys array[Object]
Stock keys
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Stock Dto.
Warehouse:
string
Warehouse.
Inventory:
string
Inventory.
StartingQuantity:
integer (int32)
StartingQuantity.
BackOrderDate:
string (date-time)
BackOrderDate.
BackOrder:
boolean
BackOrder.
TrackQuantity:
boolean
TrackQuantity.
Bay:
string
Bay.
Bin:
string
Bin.
BackOrderAllowed:
boolean
Back Order Allowed.
StandardCost:
number (double)
Standard Cost.
string
Standard Cost Currency.
ReorderAmount:
integer (int32)
Reorder amount..
RegularStockAmount:
integer (int32)
Regular Stock Amount.
Active:
boolean
Active.
}
]
}
stocksPatchAsync
Patch a Stock entry
/api/Stocks
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Stocks?inventoryCod
e=&warehouseCode="
;
*;
ocksApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new StocksApi();
String inventoryCode =
inventoryCode_example; // Strin
g | The Inventory Code of the e
ntry to patch
String warehouseCode =
warehouseCode_example; // Strin
g | The Warehouse Code of the e
ntry to patch
StockPatch stockPatch =
; // StockPatch | The subset of
Stock fields to patch
g | access token

i-Version
try {
Object result = api

Instance.stocksPatchAsync(inven
toryCode, warehouseCode, stockP
uage, apiVersion);
System.out.println(
result);
) {
System.err.println(
pi#stocksPatchAsync");
e.printStackTrace()
;
}
}
ocksApi;

ing[] args) {
new StocksApi();
String inventoryCode =
inventoryCode_example; // Strin
g | The Inventory Code of the e
ntry to patch
String warehouseCode =
warehouseCode_example; // Strin
g | The Warehouse Code of the e
ntry to patch
StockPatch stockPatch =
; // StockPatch | The subset of
g | access token

i-Version
try {
Object result = api

Instance.stocksPatchAsync(inven
toryCode, warehouseCode, stockP
uage, apiVersion);
System.out.println(
result);
) {
System.err.println(
pi#stocksPatchAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
String *inventoryCode = invento
ryCode_example; // The Inventor
y Code of the entry to patch
String *warehouseCode = warehou

seCode_example; // The Warehous
e Code of the entry to patch
StockPatch *stockPatch = ; // T
he subset of Stock fields to pa
tch

(optional)

-US)


ksApi alloc] init];
// Patch a Stock entry
[apiInstance stocksPatchAsyncWi
th:inventoryCode
warehouseCode:warehouseCode
stockPatch:stockPatch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

tocksApi()
var inventoryCode = inventoryCo

de_example; // {String} The Inv
entory Code of the entry to pat
ch
var warehouseCode = warehouseCo

de_example; // {String} The War
ehouse Code of the entry to pat
ch
var stockPatch = ; // {StockPat

ch} The subset of Stock fields
to patch
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.stocksPatchAsync(inventoryC
ode, warehouseCode, stockPatch,
opts, callback);
using System;
namespace Example
{
public class stocksPatchAsy
ncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew StocksApi();
var inventoryCode =
inventoryCode_example; // Stri
ng | The Inventory Code of the
entry to patch
var warehouseCode =
warehouseCode_example; // Stri
ng | The Warehouse Code of the
entry to patch
var stockPatch = ne
w StockPatch(); // StockPatch |
The subset of Stock fields to p
atch
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch a Stoc
k entry
Object result =
apiInstance.stocksPatchAsync(in
ventoryCode, warehouseCode, sto
ckPatch, authorization, acceptL
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
stocksPatchAsync: " + e.Message
);
}
}
<?php
/autoload.php');


$inventoryCode = inventoryCode_
example; // String | The Invent
ory Code of the entry to patch
$warehouseCode = warehouseCode_
example; // String | The Wareho
use Code of the entry to patch
$stockPatch = ; // StockPatch |
The subset of Stock fields to p
atch
en
anguage
try {
ocksPatchAsync($inventoryCode,
$warehouseCode, $stockPatch, $a
$apiVersion);
print_r($result);

g StocksApi->stocksPatchAsync:
?>
use Data::Dumper;
ration;
pi;

S_TOKEN';
my $inventoryCode = inventoryCo
de_example; # String | The Inve
ntory Code of the entry to patc
h
my $warehouseCode = warehouseCo
de_example; # String | The Ware
house Code of the entry to patc
h
my $stockPatch = WWW::SwaggerCl
ient::Object::StockPatch->new()
; # StockPatch | The subset of
oken
-Language
eval {
>stocksPatchAsync(inventoryCode
=> $inventoryCode, warehouseCod
e => $warehouseCode, stockPatch
=> $stockPatch, authorization =
n => $apiVersion);
};
if ($@) {

g StocksApi->stocksPatchAsync:
$@\n";

atement
import time

ApiException

'

class
tocksApi()
inventoryCode = inventoryCode_e
xample # String | The Inventory
warehouseCode = warehouseCode_e
xample # String | The Warehouse
stockPatch = # StockPatch | Th
e subset of Stock fields to pat
ch
(optional)
US)
l) (default to 1.0)
try:
# Patch a Stock entry
.stocks_patch_async(inventoryCo
de, warehouseCode, stockPatch,
ng StocksApi->stocksPatchAsync:
%s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
stockPatch * StockPatch {
Stock Patch.
BackOrderDate:
BackOrderDate string (date-time)
BackOrder:
BackOrder boolean
TrackQuantity:
TrackQuantity boolean
Bay:
Bay string minLength:1 maxLength:50
Bin:
Bin string minLength:1 maxLength:50
BackOrderAllowed:
BackOrderAllowed boolean
StandardCost:
MoneyModel {
Money.
Amount:
Amount number
Currency:
Currency string
}
ReorderAmount:
ReorderAmount integer (ex)minimum:true
RegularStockAmount:
RegularStockAmount integer (ex)minimum:true
Active:
Active boolean
}
Query parameters
Name Description
inventoryCode* String
The Inventory Code of the entry to patch
Required
warehouseCode* String
The Warehouse Code of the entry to patch
Required
Responses
Status: 200 - OK
• Schema
{
}
stocksPostAdjustmentsA
sync
Create a Stock Adjustment entry
/api/Stocks/Adjustments
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Stocks/Adjustments"
;
*;
ocksApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new StocksApi();
StockAdjustment stockAd
justment = ; // StockAdjustment
| The {Stock} adjustment data t
o create
g | access token

i-Version
try {
Object result = api

Instance.stocksPostAdjustmentsA
sync(stockAdjustment, authoriza
n);
System.out.println(
result);
) {
System.err.println(
pi#stocksPostAdjustmentsAsync")
;
e.printStackTrace()
;
}
}
ocksApi;

ing[] args) {
new StocksApi();
StockAdjustment stockAd
justment = ; // StockAdjustment
| The {Stock} adjustment data t
o create
g | access token

i-Version
try {
Object result = api

Instance.stocksPostAdjustmentsA
sync(stockAdjustment, authoriza
n);
System.out.println(
result);
) {
System.err.println(
pi#stocksPostAdjustmentsAsync")
;
e.printStackTrace()
;


R_ACCESS_TOKEN"];
StockAdjustment *stockAdjustmen
t = ; // The {Stock} adjustment
data to create

(optional)
-US)


ksApi alloc] init];
// Create a Stock Adjustment en

try
[apiInstance stocksPostAdjustme
ntsAsyncWith:stockAdjustment
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"

tocksApi()
var stockAdjustment = ; // {Sto

ckAdjustment} The {Stock} adjus
tment data to create
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.stocksPostAdjustmentsAsync(
stockAdjustment, opts, callback
);
using System;
namespace Example
public class stocksPostAdju

stmentsAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew StocksApi();
var stockAdjustment
= new StockAdjustment(); // Sto
ckAdjustment | The {Stock} adju
stment data to create
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a Sto
ck Adjustment entry
Object result =
apiInstance.stocksPostAdjustmen
tsAsync(stockAdjustment, author
sion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
stocksPostAdjustmentsAsync: " +
e.Message );
}
<?php
/autoload.php');


$stockAdjustment = ; // StockAd
justment | The {Stock} adjustme
nt data to create
en
anguage
try {
ocksPostAdjustmentsAsync($stock
Adjustment, $authorization, $ac
print_r($result);

g StocksApi->stocksPostAdjustme
ntsAsync: ', $e->getMessage(),
PHP_EOL;
?>
use Data::Dumper;
ration;
pi;

S_TOKEN';
my $stockAdjustment = WWW::Swag
gerClient::Object::StockAdjustm
ent->new(); # StockAdjustment |
The {Stock} adjustment data to
create
oken
-Language
eval {
>stocksPostAdjustmentsAsync(sto
ckAdjustment => $stockAdjustmen
t, authorization => $authorizat
ion);
};
if ($@) {

g StocksApi->stocksPostAdjustme
ntsAsync: $@\n";

atement
import time
ApiException

'

class
tocksApi()
stockAdjustment = # StockAdjus
tment | The {Stock} adjustment
data to create
(optional)
US)
l) (default to 1.0)
try:
# Create a Stock Adjustment
entry
.stocks_post_adjustments_async(
stockAdjustment, authorization=
rsion)

ng StocksApi->stocksPostAdjustm
entsAsync: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
stockAdjustment * {
Stock Adjustment
Required: ActivityCode,DocumentNumber,Warehouse
ActivityCode:
ActivityCode string minLength:1 maxLength:50
Comment:
Comment string minLength:1 maxLength:4000
DocumentNumber:
DocumentNumber string minLength:1 maxLength:50
Warehouse:
Items:
Items[
StockAdjustmentItem {
Stock Adjustment Item
Required: Adjustment,Inventory
Adjustment:
Adjustment integer
Inventory:
Inventory string minLength:1 maxLength:50
}
]
}
Responses
Status: 200 - OK
• Schema
{
}
stocksPostAsync
Create a Stock entry
/api/Stocks
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Stocks"
;
*;
ocksApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new StocksApi();
StockDto stock = ; // S
tockDto | The {Stock} data to c
reate
g | access token

i-Version
try {
Object result = api

Instance.stocksPostAsync(stock,
apiVersion);
System.out.println(
result);
) {
System.err.println(
pi#stocksPostAsync");
e.printStackTrace()
;
ocksApi;

ing[] args) {
new StocksApi();
StockDto stock = ; // S
tockDto | The {Stock} data to c
reate
g | access token

i-Version
try {
Object result = api

Instance.stocksPostAsync(stock,
apiVersion);
System.out.println(
result);
) {
System.err.println(
pi#stocksPostAsync");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];
StockDto *stock = ; // The {Sto

ck} data to create

(optional)

-US)


ksApi alloc] init];
// Create a Stock entry

[apiInstance stocksPostAsyncWit
h:stock
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

tocksApi()
var stock = ; // {StockDto} The

{Stock} data to create
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {
ata);
};
api.stocksPostAsync(stock, opts
, callback);
using System;
namespace Example
public class stocksPostAsyn

cExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew StocksApi();
var stock = new Sto

ckDto(); // StockDto | The {Sto
ck} data to create
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a Sto
ck entry
Object result =
apiInstance.stocksPostAsync(sto
ck, authorization, acceptLangua
ge, apiVersion);
Debug.WriteLine
(result);
}
catch (Exception e)
Debug.Print("Ex
stocksPostAsync: " + e.Message
);
<?php
/autoload.php');


$stock = ; // StockDto | The {S

tock} data to create
en
anguage
try {
ocksPostAsync($stock, $authoriz
sion);
print_r($result);

g StocksApi->stocksPostAsync: '
?>
use Data::Dumper;
ration;
pi;
S_TOKEN';
my $stock = WWW::SwaggerClient:
:Object::StockDto->new(); # Sto
ckDto | The {Stock} data to cre
ate
oken
-Language
eval {
>stocksPostAsync(stock => $stoc
k, authorization => $authorizat
ion);
};
if ($@) {

g StocksApi->stocksPostAsync: $
@\n";

atement
import time

ApiException

'

class
tocksApi()
stock = # StockDto | The {Stoc

k} data to create
(optional)
US)
l) (default to 1.0)
try:
# Create a Stock entry
.stocks_post_async(stock, autho
ion=apiVersion)

ng StocksApi->stocksPostAsync:
%s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
stock * {
Stock Dto.
Warehouse:
string
Warehouse.
Inventory:
string
Inventory.
StartingQuantity:
integer (int32)
StartingQuantity.
BackOrderDate:
string (date-time)
BackOrderDate.
BackOrder:
boolean
BackOrder.
TrackQuantity:
boolean
TrackQuantity.
Bay:
string
Bay.
Bin:
string
Bin.
BackOrderAllowed:
boolean
Back Order Allowed.
StandardCost:
number (double)
Standard Cost.
string
Standard Cost Currency.
ReorderAmount:
integer (int32)
Reorder amount..
RegularStockAmount:
integer (int32)
Regular Stock Amount.
Active:
boolean
Active.
}
Responses
Status: 200 - OK
• Schema
{
}
Tasks
tasksGetAll
Get all tasks for a specific account.
/api/Accounts/{accountCode}/Tas
ks
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

}/Tasks?pageNumber=&pageSize=&s
ortType=&filters="
;
*;
import io.swagger.client.api.Ta
sksApi;
import java.util.*;
public class TasksApiExample {

ing[] args) {
ient();

uth2

("oauth2");
TasksApi apiInstance =
new TasksApi();
account code.

greater than 0

'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.TaskDto result = apiInst
ance.tasksGetAll(accountCode, p
apiVersion, filters);
System.out.println(
result);
) {
System.err.println(
"Exception when calling TasksAp
i#tasksGetAll");
e.printStackTrace()
;
sksApi;

ing[] args) {
new TasksApi();
account code.

greater than 0

'
g | access token

i-Version
s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.TaskDto result = apiInst
ance.tasksGetAll(accountCode, p
apiVersion, filters);
System.out.println(
result);
) {
System.err.println(
i#tasksGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

de_example; // account code.


default to 25)
c)

(optional)

-US)


le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
TasksApi *apiInstance = [[Tasks

Api alloc] init];
// Get all tasks for a specific

account.
[apiInstance tasksGetAllWith:ac
countCode
pageSize:pageSize
sortType:sortType
ge
filters:filters
completionHandler
: ^(HateoasCollectionResponse.T
askDto output, NSError* error)
{
if
(output) {
}
if
(error) {
}];





SS TOKEN"
var api = new JenkonRestApiV1.T

asksApi()

xample; // {String} account cod
e.
than or equal to 0

0

var opts = {
oken
-Language
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.tasksGetAll(accountCode, pa
geNumber, pageSize, sortType, o
pts, callback);
using System;
namespace Example
public class tasksGetAllExa

mple
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew TasksApi();
var accountCode = a
| account code.
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var filters = filte

ers
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get all task

s for a specific account.
HateoasCollecti
onResponse.TaskDto result = api
Instance.tasksGetAll(accountCod
e, pageNumber, pageSize, sortTy
pe, authorization, acceptLangua
ge, apiVersion, filters);
Debug.WriteLine
(result);
catch (Exception e)
{
Debug.Print("Ex
ception when calling TasksApi.t
asksGetAll: " + e.Message );
<?php
/autoload.php');


ent\Api\TasksApi();
ple; // String | account code.

an or equal to 0

for 'Descending'
en
anguage
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
$result = $api_instance->ta
sksGetAll($accountCode, $pageNu
mber, $pageSize, $sortType, $au
apiVersion, $filters);
print_r($result);

g TasksApi->tasksGetAll: ', $e-
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::TasksAp
i;

S_TOKEN';
Client::TasksApi->new();
xample; # String | account code
.

than or equal to 0

0
oken
-Language
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>tasksGetAll(accountCode => $ac
countCode, pageNumber => $pageN
umber, pageSize => $pageSize, s
ortType => $sortType, authoriza
Version => $apiVersion, filters
=> $filters);
};
if ($@) {

g TasksApi->tasksGetAll: $@\n";

atement
import time

ApiException

'

class
api_instance = swagger_client.T
asksApi()
le # String | account code.


efault to 25)
)
(optional)
US)
l) (default to 1.0)

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get all tasks for a speci

fic account.
.tasks_get_all(accountCode, pag
ersion=apiVersion, filters=filt
ers)

ng TasksApi->tasksGetAll: %s\n"
% e)
Parameters
Path parameters
Name Description
accountCode* String
account code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Task Dto
Code:
string
Task Code
Account:
string
Account Code
Summary:
string
Task summary
Details:
string
Task Details
Source:
string
Task source
Created:
string (date-time)
Task created date
Read:
string (date-time)
Task read date
Completed:
string (date-time)
Task completed date
}
]
}
tasksGetByCode
Get specific task for a specific task
code.
/api/Tasks/{taskCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Tasks/{taskCode}"
;
*;
sksApi;
import java.util.*;

ing[] args) {
ient();

uth2

("oauth2");
new TasksApi();
String taskCode = taskC

ode_example; // String | task c
ode.
g | access token

i-Version
try {
TaskDto result = ap
iInstance.tasksGetByCode(taskCo
ge, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#tasksGetByCode");
e.printStackTrace()
;
sksApi;

ing[] args) {
new TasksApi();
String taskCode = taskC

ode_example; // String | task c
ode.
g | access token

i-Version
try {
TaskDto result = ap
iInstance.tasksGetByCode(taskCo
ge, apiVersion);
System.out.println(
result);
) {
System.err.println(
i#tasksGetByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
String *taskCode = taskCode_exa

mple; // task code.

(optional)

-US)

Api alloc] init];
// Get specific task for a spec

ific task code.
[apiInstance tasksGetByCodeWith
:taskCode
ge
completionHandler
: ^(TaskDto output, NSError* er
ror) {
if
(output) {
if
(error) {
}];




SS TOKEN"

asksApi()
var taskCode = taskCode_example

; // {String} task code.
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

ata);
};
api.tasksGetByCode(taskCode, op
ts, callback);
using System;
namespace Example
public class tasksGetByCode

Example
public void main()

{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew TasksApi();
var taskCode = task

Code_example; // String | task
code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get specific
task for a specific task code.
TaskDto result
= apiInstance.tasksGetByCode(ta
skCode, authorization, acceptLa
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
asksGetByCode: " + e.Message );
<?php
/autoload.php');

ent\Api\TasksApi();
$taskCode = taskCode_example; /
/ String | task code.
en
anguage
try {
sksGetByCode($taskCode, $author
ersion);
print_r($result);

g TasksApi->tasksGetByCode: ',
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
my $taskCode = taskCode_example
; # String | task code.
oken
-Language
eval {
>tasksGetByCode(taskCode => $ta
skCode, authorization => $autho
iVersion);
};
if ($@) {

g TasksApi->tasksGetByCode: $@\
n";

atement
import time

ApiException

'

class
asksApi()
taskCode = taskCode_example # S
tring | task code.
(optional)
US)
l) (default to 1.0)
try:
# Get specific task for a s

pecific task code.
.tasks_get_by_code(taskCode, au
ersion=apiVersion)

ng TasksApi->tasksGetByCode: %s
\n" % e)
Parameters
Path parameters
Name Description
taskCode* String
task code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
Task Dto
Code:
string
Task Code
Account:
string
Account Code
Summary:
string
Task summary
Details:
string
Task Details
Source:
string
Task source
Created:
string (date-time)
Task created date
Read:
string (date-time)
Task read date
Completed:
string (date-time)
Task completed date
}
tasksPost
Create a new task.
/api/Tasks
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Tasks"
;
*;
sksApi;
import java.util.*;

ing[] args) {
ient();
uth2

("oauth2");
new TasksApi();
TaskModel model = ; //
TaskModel | Task model.
g | access token

i-Version
try {
Object result = api

Instance.tasksPost(model, autho
rsion);
System.out.println(
result);
) {
System.err.println(
i#tasksPost");
e.printStackTrace()
;
sksApi;

ing[] args) {
new TasksApi();
TaskModel model = ; //
TaskModel | Task model.
g | access token

i-Version
try {
Object result = api

Instance.tasksPost(model, autho
rsion);
System.out.println(
result);
) {
System.err.println(
i#tasksPost");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
TaskModel *model = ; // Task mo

del.
(optional)

-US)


Api alloc] init];
// Create a new task.
[apiInstance tasksPostWith:mode
l
ge
completionHandler
or) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"

asksApi()
var model = ; // {TaskModel} Ta

sk model.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.tasksPost(model, opts, call

back);
using System;
namespace Example
public class tasksPostExamp

le
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew TasksApi();
var model = new Tas

kModel(); // TaskModel | Task m
odel.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a new
task.
Object result =
apiInstance.tasksPost(model, au
iVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
asksPost: " + e.Message );
}
<?php
/autoload.php');


ent\Api\TasksApi();
$model = ; // TaskModel | Task

model.
en
anguage
try {
sksPost($model, $authorization,
print_r($result);

g TasksApi->tasksPost: ', $e->g
etMessage(), PHP_EOL;
?>
use Data::Dumper;
ration;
i;

S_TOKEN';
:Object::TaskModel->new(); # Ta
skModel | Task model.
oken
-Language
eval {
>tasksPost(model => $model, aut
};
if ($@) {

g TasksApi->tasksPost: $@\n";

atement
import time

ApiException

'

class
asksApi()
model = # TaskModel | Task mod

el.
(optional)
US)
l) (default to 1.0)
try:
# Create a new task.
.tasks_post(model, authorizatio
n=authorization, acceptLanguage
=acceptLanguage, apiVersion=api
Version)

ng TasksApi->tasksPost: %s\n" %
e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
model * TaskModel {
Task post request, new task

Required: Account,Created,Source,Summary
Account:
Summary:
Summary string minLength:1 maxLength:255
Details:
Details string
Source:
Source string minLength:1 maxLength:50
Created:
Created string (date-time)
Read:
Read string (date-time)
Completed:
Completed string (date-time)
}
Responses
Status: 200 - OK
• Schema
{
}
Tickets
ticketsGetAll
Get data for Ticket entries
/api/Tickets
Usage and SDK
Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Tickets?pageNumber=&p
ageSize=&sortType=&culture=&fil
ters="
;
*;
import io.swagger.client.api.Ti
cketsApi;
import java.util.*;
public class TicketsApiExample

{
ing[] args) {
ient();

uth2

("oauth2");
TicketsApi apiInstance
= new TicketsApi();

greater than 0

'
s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
g | access token

i-Version
ot specified,
the defa
try {
HateoasCollectionRe
sponse.TicketDtoLink result = a
piInstance.ticketsGetAll(pageNu
mber, pageSize, sortType, filte
rs, authorization, acceptLangua
ge, apiVersion, culture);
System.out.println(
result);
) {
System.err.println(
"Exception when calling Tickets
Api#ticketsGetAll");
e.printStackTrace()
;
cketsApi;
{

ing[] args) {
= new TicketsApi();

greater than 0

'

s
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
g | access token

i-Version

ot specified,
the defa
try {
HateoasCollectionRe
piInstance.ticketsGetAll(pageNu
mber, pageSize, sortType, filte
rs, authorization, acceptLangua
ge, apiVersion, culture);
System.out.println(
result);
) {
System.err.println(
Api#ticketsGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];


default to 25)
c)

le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |

(optional)

-US)

the defa
TicketsApi *apiInstance = [[Tic

ketsApi alloc] init];
// Get data for Ticket entries
[apiInstance ticketsGetAllWith:
pageNumber
pageSize:pageSize
sortType:sortType
filters:filters
ge
culture:culture
completionHandler
icketDtoLink output, NSError* e
rror) {
if
(output) {
if
(error) {
}];





SS TOKEN"

icketsApi()
than or equal to 0

0

var filters = filters_example;

// {String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {
ata);
};
api.ticketsGetAll(pageNumber, p
ageSize, sortType, filters, opt
s, callback);
using System;
namespace Example
public class ticketsGetAllE

xample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew TicketsApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get data for

Ticket entries
HateoasCollecti
onResponse.TicketDtoLink result
= apiInstance.ticketsGetAll(pag
eNumber, pageSize, sortType, fi
lters, authorization, acceptLan
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling TicketsApi
.ticketsGetAll: " + e.Message )
;
<?php
/autoload.php');

ent\Api\TicketsApi();

an or equal to 0

for 'Descending'
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
en
anguage
the defa
try {
$result = $api_instance->ti
cketsGetAll($pageNumber, $pageS
ize, $sortType, $filters, $auth
iVersion, $culture);
print_r($result);

g TicketsApi->ticketsGetAll: ',
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Tickets
Api;

S_TOKEN';
Client::TicketsApi->new();

than or equal to 0

0
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
oken
-Language
,
the defa
eval {
>ticketsGetAll(pageNumber => $p
ageNumber, pageSize => $pageSiz
e, sortType => $sortType, filte
rs => $filters, authorization =
n => $apiVersion, culture => $c
ulture);
};
if ($@) {

g TicketsApi->ticketsGetAll: $@
\n";

atement
import time

ApiException

'
class
icketsApi()


efault to 25)
)

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
US)
l) (default to 1.0)

the defa
try:
# Get data for Ticket entri

es
.tickets_get_all(pageNumber, pa
geSize, sortType, filters, auth
sion=apiVersion, culture=cultur
e)

ng TicketsApi->ticketsGetAll: %
s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer

Required
sortType* String

'Descending'
Required
culture String

filters* String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Required
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
TicketDto with Hateos Link property.
Link:
string
Link to full ticket information.
Code:
string
Code.
User:
string
The user the ticket is for.
Account:
string
The account the ticket is from.
AccountName:
string
Account name
TicketType:
string
Ticket Type
TicketTypeDescription:
string
Ticket Type Description
TicketStatus:
string
Ticket Status
TicketStatusDescription:
string
Ticket Status Description
TicketDate:
string (date-time)
This is the date provided by the
integration system. It takes priority
over CreatedDate . If there is no
integration system, this is the same
value as CreatedDate
CreatedDate:
string (date-time)
This is the date the ticket was
created by j6. If there is an
integration system, TicketDate takes
priority. If there is no integration,
TicketDate holds the same value.
Either way, use TicketDate
ContactDate:
string (date-time)
This is the date the customer
contacted our client.
Description:
string
Description, or Title, of the ticket.
ReasonCodeType:
string
Reason Code Type
ReasonCodeCategory:
string
Reason Code Category
ReasonCodeNumber:
string
Reason Code Number
ReasonCodeDescription:
string
Reason Code Description
TicketNotes:
[
Entered notes
{
TicketDto.
Code:
string
Note Code.
User:
string
The User that entered the note.
NoteDate:
string (date-time)
Date of the note.
ModifiedDate:
string (date-time)
Date of the last modification.
Note:
string
Note text.
}
]
}
]
}
ticketsGetByAccount
Get data for Ticket entries of a
specific Account
/api/Accounts/{accountCode}/Tic
kets
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

}/Tickets?pageNumber=&pageSize=
&sortType=&culture="
;
*;
cketsApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");
= new TicketsApi();
The Account Code.

greater than 0

'
g | access token

i-Version

ot specified,
the defa
try {
HateoasCollectionRe
piInstance.ticketsGetByAccount(
re);
System.out.println(
result);
) {
System.err.println(
Api#ticketsGetByAccount");
e.printStackTrace()
;
cketsApi;

{

ing[] args) {
= new TicketsApi();
The Account Code.

greater than 0

'
g | access token

i-Version

ot specified,
the defa
try {
HateoasCollectionRe
piInstance.ticketsGetByAccount(
re);
System.out.println(
result);
) {
System.err.println(
Api#ticketsGetByAccount");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

.

default to 25)

c)

(optional)

-US)


the defa

// Get data for Ticket entries
of a specific Account
[apiInstance ticketsGetByAccoun
tWith:accountCode
pageSize:pageSize
sortType:sortType
ge
culture:culture
completionHandler
icketDtoLink output, NSError* e
rror) {
if
(output) {
if
(error) {
}
}];





SS TOKEN"

icketsApi()

Code.

than or equal to 0

0
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {
ata);
};
api.ticketsGetByAccount(account
Code, pageNumber, pageSize, sor
tType, opts, callback);
using System;
namespace Example
public class ticketsGetByAc

countExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew TicketsApi();
var accountCode = a
| The Account Code.
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu
f not specified,
the defa
try
// Get data for

Ticket entries of a specific Ac
count
HateoasCollecti
onResponse.TicketDtoLink result
= apiInstance.ticketsGetByAccou
nt(accountCode, pageNumber, pag
eSize, sortType, authorization,
ture);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
.ticketsGetByAccount: " + e.Mes
sage );
}
}
<?php
/autoload.php');


de.

an or equal to 0

for 'Descending'
en
anguage
the defa
try {
cketsGetByAccount($accountCode,
uage, $apiVersion, $culture);
print_r($result);

g TicketsApi->ticketsGetByAccou
nt: ', $e->getMessage(), PHP_EO
L;
?>
use Data::Dumper;
ration;
Api;

S_TOKEN';
Code.

than or equal to 0

0
oken
-Language
,
the defa
eval {
>ticketsGetByAccount(accountCod
e => $accountCode, pageNumber =
> $pageNumber, pageSize => $pag
eSize, sortType => $sortType, a
ge, apiVersion => $apiVersion,
culture => $culture);
};
if ($@) {

g TicketsApi->ticketsGetByAccou
nt: $@\n";
}
atement
import time

ApiException

'

class
icketsApi()


efault to 25)
)
(optional)
US)
l) (default to 1.0)

the defa
try:
# Get data for Ticket entri

es of a specific Account
.tickets_get_by_account(account
tType, authorization=authorizat
age, apiVersion=apiVersion, cul
ture=culture)

ng TicketsApi->ticketsGetByAcco
unt: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
The Account Code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
culture String

Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
TicketDto with Hateos Link property.
Link:
string
Link to full ticket information.
Code:
string
Code.
User:
string
Account:
string
AccountName:
string
Account name
TicketType:
string
Ticket Type
string
TicketStatus:
string
Ticket Status
string
TicketDate:
string (date-time)
CreatedDate:
string (date-time)
ContactDate:
string (date-time)
Description:
string
ReasonCodeType:
string
Reason Code Type
ReasonCodeCategory:
string
ReasonCodeNumber:
string
Reason Code Number
string
TicketNotes:
[
Entered notes
{
TicketDto.
Code:
string
Note Code.
User:
string
NoteDate:
string (date-time)
Date of the note.
ModifiedDate:
string (date-time)
Note:
string
Note text.
}
]
}
]
}
ticketsGetTicketByCode
Get data for a ticket entry
/api/Tickets/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Tickets/{code}?cultur
e="
;
*;
cketsApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");
= new TicketsApi();

ple; // String | The Ticket Cod
e to retrieve
g | access token

i-Version

ot specified,
the defa
try {
TicketDto result =
apiInstance.ticketsGetTicketByC
System.out.println(
result);
) {
System.err.println(
Api#ticketsGetTicketByCode");
e.printStackTrace()
;
}
cketsApi;

{

ing[] args) {
= new TicketsApi();

e to retrieve
g | access token

i-Version

ot specified,
the defa
try {
TicketDto result =
apiInstance.ticketsGetTicketByC
System.out.println(
result);
) {
System.err.println(
Api#ticketsGetTicketByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

The Ticket Code to retrieve
(optional)

-US)


the defa

// Get data for a ticket entry
[apiInstance ticketsGetTicketBy
CodeWith:code
ge
culture:culture
completionHandler
: ^(TicketDto output, NSError*
error) {
if
(output) {
if
(error) {
}];





SS TOKEN"
icketsApi()

ring} The Ticket Code to retrie
ve
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.ticketsGetTicketByCode(code
, opts, callback);
using System;
namespace Example
public class ticketsGetTick

etByCodeExample
public void main()
{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew TicketsApi();
var code = code_exa

mple; // String | The Ticket C
ode to retrieve
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get data for

a ticket entry
TicketDto resul
t = apiInstance.ticketsGetTicke
re);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
.ticketsGetTicketByCode: " + e.
Message );
<?php
/autoload.php');


| The Ticket Code to retrieve
en
anguage
the defa
try {
cketsGetTicketByCode($code, $au
apiVersion, $culture);
print_r($result);

g TicketsApi->ticketsGetTicketB
_EOL;
?>
use Data::Dumper;
ration;
Api;

S_TOKEN';

ng | The Ticket Code to retriev
e
oken
-Language
,
the defa
eval {
>ticketsGetTicketByCode(code =>
$code, authorization => $author
Version, culture => $culture);
};
if ($@) {

g TicketsApi->ticketsGetTicketB
yCode: $@\n";

atement
import time

ApiException

'

class
icketsApi()

(optional)
US)
l) (default to 1.0)
the defa
try:
# Get data for a ticket ent

ry
.tickets_get_ticket_by_code(cod
culture)

ng TicketsApi->ticketsGetTicket
ByCode: %s\n" % e)
Parameters
Path parameters
Name Description
code* String

Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String

Responses
Status: 200 - OK
• Schema
{
TicketDto.
Code:
string
Code.
User:
string
Account:
string
AccountName:
string
Account name
TicketType:
string
Ticket Type
string
TicketStatus:
string
Ticket Status
string
TicketDate:
string (date-time)
CreatedDate:
string (date-time)
ContactDate:
string (date-time)
Description:
string
ReasonCodeType:
string
Reason Code Type
ReasonCodeCategory:
string
ReasonCodeNumber:
string
Reason Code Number
string
TicketNotes:
[
Entered notes
{
TicketDto.
Code:
string
Note Code.
User:
string
NoteDate:
string (date-time)
Date of the note.
ModifiedDate:
string (date-time)
Note:
string
Note text.
}
]
}
ticketsPatchAsync
Patch a Ticket entry
/api/Tickets/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Tickets/{code}"
;
*;
cketsApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");
= new TicketsApi();

TicketPatch ticketPatch
= ; // TicketPatch | The subset
of Ticket fields to patch
g | access token

i-Version
try {
Object result = api

Instance.ticketsPatchAsync(code
, ticketPatch, authorization, a
System.out.println(
result);
) {
System.err.println(
Api#ticketsPatchAsync");
e.printStackTrace()
;
}
cketsApi;

{

ing[] args) {
= new TicketsApi();

TicketPatch ticketPatch
= ; // TicketPatch | The subset
g | access token

i-Version
try {
Object result = api

Instance.ticketsPatchAsync(code
, ticketPatch, authorization, a
System.out.println(
result);
) {
System.err.println(
Api#ticketsPatchAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
The Ticket Code of the entry to
patch
TicketPatch *ticketPatch = ; //
The subset of Ticket fields to
patch

(optional)

-US)


// Patch a Ticket entry
[apiInstance ticketsPatchAsyncW
ith:code
ticketPatch:ticketPatch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"
icketsApi()

ring} The Ticket Code of the en
try to patch
var ticketPatch = ; // {TicketP

atch} The subset of Ticket fiel
ds to patch
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {
ata);
};
api.ticketsPatchAsync(code, tic
ketPatch, opts, callback);
using System;
namespace Example
public class ticketsPatchAs

yncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew TicketsApi();
var code = code_exa

mple; // String | The Ticket C
var ticketPatch = n
ew TicketPatch(); // TicketPatc
h | The subset of Ticket fields
to patch
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch a Tick
et entry
Object result =
apiInstance.ticketsPatchAsync(c
ode, ticketPatch, authorization
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
.ticketsPatchAsync: " + e.Messa
ge );
<?php
/autoload.php');


| The Ticket Code of the entry
to patch
$ticketPatch = ; // TicketPatch
| The subset of Ticket fields t
o patch
en
anguage
try {
cketsPatchAsync($code, $ticketP
atch, $authorization, $acceptLa
nguage, $apiVersion);
print_r($result);

g TicketsApi->ticketsPatchAsync
?>
use Data::Dumper;
ration;
Api;

S_TOKEN';

ng | The Ticket Code of the ent
ry to patch
my $ticketPatch = WWW::SwaggerC
lient::Object::TicketPatch->new
(); # TicketPatch | The subset
oken
-Language
eval {
>ticketsPatchAsync(code => $cod
e, ticketPatch => $ticketPatch,
);
};
if ($@) {

g TicketsApi->ticketsPatchAsync
: $@\n";

atement
import time

ApiException

'

class
icketsApi()

The Ticket Code of the entry to
patch
ticketPatch = # TicketPatch |
The subset of Ticket fields to
patch
(optional)
US)
l) (default to 1.0)
try:
# Patch a Ticket entry
.tickets_patch_async(code, tick
etPatch, authorization=authoriz

ng TicketsApi->ticketsPatchAsyn
c: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
The Ticket Code of the entry to patch
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
ticketPatch * TicketPatch {
Ticket Patch.
User:
User string minLength:1 maxLength:50
Account:
TicketType:
TicketType string minLength:1 maxLength:50
TicketStatus:
TicketStatus string minLength:1 maxLength:50
TicketDate:
TicketDate string (date-time)
Description:
ReasonCodeType:
ReasonCodeType string minLength:1 maxLength:255
ReasonCodeCategory:
ReasonCodeCategory string minLength:1 maxLength:255
ReasonCodeNumber:
ReasonCodeNumber string minLength:1 maxLength:255
Note:
Note string minLength:1
}
Responses
Status: 200 - OK
• Schema
{
}
ticketsPostAsync
Create a Ticket entry
/api/Tickets
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Tickets"
;
*;
cketsApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");
= new TicketsApi();
TicketPostDto ticketPos
t = ; // TicketPostDto | The {T
icketPostDto} data to create
g | access token

i-Version
try {
Object result = api

Instance.ticketsPostAsync(ticke
tPost, authorization, acceptLan
guage, apiVersion);
System.out.println(
result);
) {
System.err.println(
Api#ticketsPostAsync");
e.printStackTrace()
;
cketsApi;

{
ing[] args) {
= new TicketsApi();
TicketPostDto ticketPos
t = ; // TicketPostDto | The {T
icketPostDto} data to create
g | access token

i-Version
try {
Object result = api

Instance.ticketsPostAsync(ticke
tPost, authorization, acceptLan
guage, apiVersion);
System.out.println(
result);
) {
System.err.println(
Api#ticketsPostAsync");
e.printStackTrace()
;
}


R_ACCESS_TOKEN"];
TicketPostDto *ticketPost = ; /
/ The {TicketPostDto} data to c
reate

(optional)

-US)


// Create a Ticket entry
[apiInstance ticketsPostAsyncWi
th:ticketPost
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

icketsApi()
var ticketPost = ; // {TicketPo

stDto} The {TicketPostDto} data
to create
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.ticketsPostAsync(ticketPost
, opts, callback);
using System;
namespace Example
public class ticketsPostAsy

ncExample
public void main()
{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew TicketsApi();
var ticketPost = ne
w TicketPostDto(); // TicketPos
tDto | The {TicketPostDto} data
to create
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a Tic
ket entry
Object result =
apiInstance.ticketsPostAsync(ti
cketPost, authorization, accept
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
.ticketsPostAsync: " + e.Messag
e );
<?php
/autoload.php');

$ticketPost = ; // TicketPostDt
o | The {TicketPostDto} data to
create
en
anguage
try {
cketsPostAsync($ticketPost, $au
apiVersion);
print_r($result);

g TicketsApi->ticketsPostAsync:
?>
use Data::Dumper;
ration;
Api;

S_TOKEN';
my $ticketPost = WWW::SwaggerCl
ient::Object::TicketPostDto->ne
w(); # TicketPostDto | The {Tic
ketPostDto} data to create
oken
-Language
eval {
>ticketsPostAsync(ticketPost =>
$ticketPost, authorization => $
> $apiVersion);
};
if ($@) {

g TicketsApi->ticketsPostAsync:
$@\n";

atement
import time

ApiException

'

class
icketsApi()
ticketPost = # TicketPostDto |
The {TicketPostDto} data to cre
ate
(optional)
US)
l) (default to 1.0)
try:
# Create a Ticket entry
.tickets_post_async(ticketPost,

ng TicketsApi->ticketsPostAsync
: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
ticketPost TicketPostDto {
*
TicketPostDto for APIs that specify the Account.
Required:
Account,ReasonCodeCategory,ReasonCodeNumber,ReasonCodeType,TicketType
Account:
Code:
TicketType:
Description:
ReasonCodeType:
ReasonCodeCategory:
ReasonCodeNumber:
Note:
}
Responses
Status: 200 - OK
• Schema
{
}
ticketsPostTicksForAcc
ountAsync
Create a Ticket entry
/api/Accounts/{accountCode}/Tic
kets
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

e}/Tickets"
;
*;
cketsApi;
import java.util.*;

{

ing[] args) {
ient();
uth2

("oauth2");
= new TicketsApi();
The account the ticket is from
TicketAccountPostDto ti
cketAccountPost = ; // TicketAc
countPostDto | The {TicketAccou
ntPostDto} data to create
g | access token

i-Version
try {
Object result = api

Instance.ticketsPostTicksForAcc
ountAsync(accountCode, ticketAc
countPost, authorization, accep
System.out.println(
result);
) {
System.err.println(
Api#ticketsPostTicksForAccountA
sync");
e.printStackTrace()
;
cketsApi;

{

ing[] args) {
= new TicketsApi();
TicketAccountPostDto ti
cketAccountPost = ; // TicketAc
g | access token

i-Version
try {
Object result = api

Instance.ticketsPostTicksForAcc
ountAsync(accountCode, ticketAc
countPost, authorization, accep
System.out.println(
result);
) {
System.err.println(
Api#ticketsPostTicksForAccountA
sync");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];

de_example; // The account the
ticket is from
TicketAccountPostDto *ticketAcc
ountPost = ; // The {TicketAcco
untPostDto} data to create

(optional)

-US)


// Create a Ticket entry
[apiInstance ticketsPostTicksFo
rAccountAsyncWith:accountCode
ticketAccountPost:ticketAcc
ountPost
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

icketsApi()

the ticket is from
var ticketAccountPost = ; // {T
icketAccountPostDto} The {Ticke
tAccountPostDto} data to create
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.ticketsPostTicksForAccountA
sync(accountCode, ticketAccount
Post, opts, callback);
using System;
namespace Example
{
public class ticketsPostTic

ksForAccountAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew TicketsApi();
var accountCode = a
| The account the ticket is fro
m
var ticketAccountPo
st = new TicketAccountPostDto()
; // TicketAccountPostDto | The
{TicketAccountPostDto} data to
create
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a Tic
ket entry
Object result =
apiInstance.ticketsPostTicksFor
AccountAsync(accountCode, ticke
tAccountPost, authorization, ac
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
.ticketsPostTicksForAccountAsyn
c: " + e.Message );
}
}
<?php
/autoload.php');


ple; // String | The account th
e ticket is from
$ticketAccountPost = ; // Ticke
tAccountPostDto | The {TicketAc
countPostDto} data to create
en
anguage
try {
cketsPostTicksForAccountAsync($
accountCode, $ticketAccountPost
ge, $apiVersion);
print_r($result);

g TicketsApi->ticketsPostTicksF
orAccountAsync: ', $e->getMessa
ge(), PHP_EOL;
?>
use Data::Dumper;
ration;
Api;

S_TOKEN';
the ticket is from
my $ticketAccountPost = WWW::Sw
aggerClient::Object::TicketAcco
untPostDto->new(); # TicketAcco
untPostDto | The {TicketAccount
PostDto} data to create
oken
-Language
eval {
>ticketsPostTicksForAccountAsyn
c(accountCode => $accountCode,
ticketAccountPost => $ticketAcc
ountPost, authorization => $aut
apiVersion);
};
if ($@) {

g TicketsApi->ticketsPostTicksF
orAccountAsync: $@\n";
}

atement
import time

ApiException

'

class
icketsApi()
le # String | The account the t
icket is from
ticketAccountPost = # TicketAc
(optional)
US)
l) (default to 1.0)
try:
# Create a Ticket entry
.tickets_post_ticks_for_account
_async(accountCode, ticketAccou
ntPost, authorization=authoriza

ng TicketsApi->ticketsPostTicks
ForAccountAsync: %s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String

Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
ticketAccountPost TicketAccountPostDto {
*
TicketAccountPostDto for APIs that will automatically add the Account.
Required:
ReasonCodeCategory,ReasonCodeNumber,ReasonCodeType,TicketType
Code:
TicketType:
Description:
ReasonCodeType:
ReasonCodeCategory:
ReasonCodeNumber:
Note:
}
Responses
Status: 200 - OK
• Schema
{
}
Uplines
uplinesGetAsync
Get uplines by account code and
lineage code
/api/Uplines/{accountCode}/{lin
eageCode}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Uplines/{accountCode}
/{lineageCode}"
;
*;
import io.swagger.client.api.Up
linesApi;
import java.util.*;
public class UplinesApiExample

{

ing[] args) {
ient();
uth2

("oauth2");
UplinesApi apiInstance
= new UplinesApi();
Account code
Lineage code
g | access token

i-Version
try {
array[UplineDto] re
sult = apiInstance.uplinesGetAs
ync(accountCode, lineageCode, a
piVersion);
System.out.println(
result);
) {
System.err.println(
"Exception when calling Uplines
Api#uplinesGetAsync");
e.printStackTrace()
;
import io.swagger.client.api.Up
linesApi;
public class UplinesApiExample

{

ing[] args) {
UplinesApi apiInstance
= new UplinesApi();
Account code
Lineage code
g | access token

i-Version
try {
array[UplineDto] re
sult = apiInstance.uplinesGetAs
ync(accountCode, lineageCode, a
piVersion);
System.out.println(
result);
) {
System.err.println(
"Exception when calling Uplines
Api#uplinesGetAsync");
e.printStackTrace()
;

R_ACCESS_TOKEN"];

de_example; // Account code

de_example; // Lineage code

(optional)

-US)

UplinesApi *apiInstance = [[Upl

inesApi alloc] init];
// Get uplines by account code

and lineage code
[apiInstance uplinesGetAsyncWit
h:accountCode
ge
completionHandler
: ^(array[UplineDto] output, NS
Error* error) {
if
(output) {
if
(error) {
}];




SS TOKEN"
var api = new JenkonRestApiV1.U

plinesApi()

e

xample; // {String} Lineage cod
e
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

ata);
};
api.uplinesGetAsync(accountCode
, lineageCode, opts, callback);
using System;
namespace Example
public class uplinesGetAsyn

cExample
public void main()

{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew UplinesApi();
var accountCode = a
| Account code
var lineageCode = l
| Lineage code
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
{
// Get uplines
by account code and lineage cod
e
array[UplineDto
] result = apiInstance.uplinesG
etAsync(accountCode, lineageCod
e, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling UplinesApi
.uplinesGetAsync: " + e.Message
);
<?php
/autoload.php');

ent\Api\UplinesApi();
ple; // String | Account code
ple; // String | Lineage code
en
anguage
try {
$result = $api_instance->up
linesGetAsync($accountCode, $li
neageCode, $authorization, $acc
print_r($result);

g UplinesApi->uplinesGetAsync:
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Uplines
Api;

S_TOKEN';
Client::UplinesApi->new();
xample; # String | Lineage code
oken
-Language
eval {
>uplinesGetAsync(accountCode =>
$accountCode, lineageCode => $l
ineageCode, authorization => $a
$apiVersion);
};
if ($@) {

g UplinesApi->uplinesGetAsync:
$@\n";

atement
import time

ApiException

'

class
api_instance = swagger_client.U
plinesApi()
le # String | Account code
le # String | Lineage code
(optional)
US)
l) (default to 1.0)
try:
# Get uplines by account co

de and lineage code
.uplines_get_async(accountCode,
lineageCode, authorization=auth
n)

ng UplinesApi->uplinesGetAsync:
%s\n" % e)
Parameters
Path parameters
Name Description
accountCode* String
Account code
Required
lineageCode* String
Lineage code
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
[
undefined
]
Volumes
volumesGetAll
Get all volumes.
/api/Volumes
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Volumes?pageNumber=&p
ageSize=&sortType=&filters="
;
*;
import io.swagger.client.api.Vo
lumesApi;
import java.util.*;
public class VolumesApiExample

{

ing[] args) {
ient();

uth2

("oauth2");
VolumesApi apiInstance
= new VolumesApi();

greater than 0

'
g | access token
i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.VolumeDto result = apiIn
stance.volumesGetAll(pageNumber
n, filters);
System.out.println(
result);
) {
System.err.println(
"Exception when calling Volumes
Api#volumesGetAll");
e.printStackTrace()
;
lumesApi;

{

ing[] args) {
= new VolumesApi();

greater than 0
'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.VolumeDto result = apiIn
stance.volumesGetAll(pageNumber
n, filters);
System.out.println(
result);
) {
System.err.println(
Api#volumesGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

default to 25)

c)

(optional)

-US)


le; // # Filters
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
VolumesApi *apiInstance = [[Vol

umesApi alloc] init];
// Get all volumes.
[apiInstance volumesGetAllWith:
pageNumber
pageSize:pageSize
sortType:sortType
ge
filters:filters
completionHandler
: ^(HateoasCollectionResponse.V
olumeDto output, NSError* error
) {
if
(output) {
if
(error) {
}];





SS TOKEN"
var api = new JenkonRestApiV1.V

olumesApi()
than or equal to 0

0

var opts = {
oken
-Language
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.volumesGetAll(pageNumber, p
ageSize, sortType, opts, callba
ck);
using System;
namespace Example
public class volumesGetAllE

xample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew VolumesApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var filters = filte

ers
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get all volu

mes.
HateoasCollecti
onResponse.VolumeDto result = a
piInstance.volumesGetAll(pageNu
mber, pageSize, sortType, autho
rsion, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling VolumesApi
.volumesGetAll: " + e.Message )
;
}
<?php
/autoload.php');


ent\Api\VolumesApi();

an or equal to 0

for 'Descending'
en
anguage
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
$result = $api_instance->vo
lumesGetAll($pageNumber, $pageS
ize, $sortType, $authorization,
filters);
print_r($result);

g VolumesApi->volumesGetAll: ',
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Volumes
Api;

S_TOKEN';
Client::VolumesApi->new();

than or equal to 0
0
oken
-Language
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>volumesGetAll(pageNumber => $p
e, sortType => $sortType, autho
apiVersion => $apiVersion, filt
ers => $filters);
};
if ($@) {

g VolumesApi->volumesGetAll: $@
\n";

atement
import time

ApiException

'

class
api_instance = swagger_client.V
olumesApi()


efault to 25)
)
(optional)
US)
l) (default to 1.0)
ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get all volumes.
.volumes_get_all(pageNumber, pa
geSize, sortType, authorization
ersion, filters=filters)

ng VolumesApi->volumesGetAll: %
s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
Volume Dto.
Code:
string
Volume code.
ActivityCenter:
string
The activity center that receives
credit for the transaction. In previous
versions of j6, this was an Account
field.
BaseVolumes:
[
The components of the transaction
that specify what amounts of actual
volume are associated with this
transaction - for instance, $50 of
commission-able volume, $75 of
qualifying volume, $100 retail
volume.
{
BaseVolumeDto.
Volume:
string
Base volume type.
Amount:
MoneyModel {
Money.
Amount:
Currency:
}
}
]
VolumeType:
string
An identifying code that determines
how this transaction should be
processed by the system. For
example, if volumes from sales at a
conference should be treated
differently from volumes from a web
site. In previous versions of j6, this
was known as VolumeType.
CreationDate:
string (date-time)
The date on which the transaction
was received by j6.
VolumeDate:
string (date-time)
The date on which the volume event
(sales order, e.g.) occurred.
Country:
string
The country in which the event
occurred.
Model:
boolean
True if this is for modeling purposes
only, should be false for real volume.
Hold:
boolean
True if this transaction should not be
processed at this time, should be
false to be available to process
immediately.
Adjusts:
string
The Code of another volume
transaction that this volume
transaction is an adjustment for.
Only applies if this is an adjustment.
EffectiveDate:
string (date-time)
The date on which the volume can
be considered for commissions. This
may be later than the volume date if
the volume date falls in a closed
period, but it cannot be earlier than
the volume date.
ChangeDate:
string (date-time)
The date on which this volume (or its
base volumes) were modified.
Notes:
string
Notes related to the Volume. These
could appear on statements.
InternalComments:
string
Internal Comments related to the
Volume. These are for employee use
only.
Independent:
boolean
Independent volume is not
adjustable.
}
]
}
volumesGetAllByOrder
Get all volumes by order code.
/api/Orders/{orderCode}/volumes
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Orders/{orderCode}/vo
lumes?pageNumber=&pageSize=&sor
tType=&filters="
;
*;
lumesApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");
= new VolumesApi();

r code.

greater than 0

'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.SalesOrderVolumeSummaryD
to result = apiInstance.volumes
GetAllByOrder(orderCode, pageNu
rsion, filters);
System.out.println(
result);
) {
System.err.println(
Api#volumesGetAllByOrder");
e.printStackTrace()
;
lumesApi;

{

ing[] args) {
= new VolumesApi();

r code.

greater than 0

'
g | access token

i-Version

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.SalesOrderVolumeSummaryD
to result = apiInstance.volumes
GetAllByOrder(orderCode, pageNu
rsion, filters);
System.out.println(
result);
) {
System.err.println(
Api#volumesGetAllByOrder");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
xample; // Order code.


default to 25)

c)

(optional)

-US)


le; // # Filters
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)

// Get all volumes by order cod

e.
[apiInstance volumesGetAllByOrd
erWith:orderCode
pageSize:pageSize
sortType:sortType
ge
filters:filters
completionHandler
alesOrderVolumeSummaryDto outpu
t, NSError* error) {
if
(output) {
if
(error) {
}];





SS TOKEN"
olumesApi()

le; // {String} Order code.

than or equal to 0

0

var opts = {
oken
-Language
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
}
};
api.volumesGetAllByOrder(orderC
ode, pageNumber, pageSize, sort
Type, opts, callback);
using System;
namespace Example
public class volumesGetAllB

yOrderExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew VolumesApi();
var orderCode = ord

erCode_example; // String | Or
der code.
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var filters = filte

ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get all volu

mes by order code.
HateoasCollecti
onResponse.SalesOrderVolumeSumm
aryDto result = apiInstance.vol
umesGetAllByOrder(orderCode, pa
piVersion, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
.volumesGetAllByOrder: " + e.Me
ssage );
<?php
/autoload.php');


// String | Order code.

an or equal to 0

for 'Descending'
en
anguage
String | # Filters
**Example:**
**SQL equivalent:**
Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
lumesGetAllByOrder($orderCode,
uage, $apiVersion, $filters);
print_r($result);

g VolumesApi->volumesGetAllByOr
der: ', $e->getMessage(), PHP_E
OL;
?>
use Data::Dumper;
ration;
Api;
S_TOKEN';
le; # String | Order code.

than or equal to 0

0
oken
-Language
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>volumesGetAllByOrder(orderCode
=> $orderCode, pageNumber => $p
e, sortType => $sortType, autho
apiVersion => $apiVersion, filt
ers => $filters);
};
if ($@) {
g VolumesApi->volumesGetAllByOr
der: $@\n";

atement
import time

ApiException

'

class
olumesApi()
String | Order code.

efault to 25)
)
(optional)
US)
l) (default to 1.0)

ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get all volumes by order

code.
.volumes_get_all_by_order(order
tType, authorization=authorizat
age, apiVersion=apiVersion, fil
ters=filters)

ng VolumesApi->volumesGetAllByO
rder: %s\n" % e)
Parameters
Path parameters
Name Description
orderCode* String
Order code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer
Required
sortType* String

'Descending'
Required
filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
SalesOrderVolumeSummary Dto.
Code:
string
Code.
Description:
string
Description.
Hide:
boolean
Hide.
Amount:
number (double)
Amount.
Currency:
string
Currency.
PriceTypeDescription:
string
Price type description.
}
]
}
volumesGetByCode
Get volume by code.
/api/Volumes/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Volumes/{code}"
;
*;
lumesApi;
import java.util.*;

{

ing[] args) {
ient();

uth2

("oauth2");
= new VolumesApi();

ple; // String | Volume code.
g | access token

i-Version
try {
Object result = api

Instance.volumesGetByCode(code,
apiVersion);
System.out.println(
result);
) {
System.err.println(
Api#volumesGetByCode");
e.printStackTrace()
;
lumesApi;
{

ing[] args) {
= new VolumesApi();

g | access token

i-Version
try {
Object result = api

Instance.volumesGetByCode(code,
apiVersion);
System.out.println(
result);
) {
System.err.println(
Api#volumesGetByCode");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

Volume code.

(optional)

-US)

// Get volume by code.
[apiInstance volumesGetByCodeWi
th:code
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

olumesApi()

ring} Volume code.
var opts = {
oken
-Language
};
data, response) {
if (error) {
} else {

ata);
};
api.volumesGetByCode(code, opts
, callback);
using System;
namespace Example
public class volumesGetByCo

deExample
public void main()

{
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew VolumesApi();
var code = code_exa

mple; // String | Volume code.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Get volume b
y code.
Object result =
apiInstance.volumesGetByCode(co
ge, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
.volumesGetByCode: " + e.Messag
e );
<?php
/autoload.php');


| Volume code.
en
anguage
try {
lumesGetByCode($code, $authoriz
sion);
print_r($result);

g VolumesApi->volumesGetByCode:
?>
use Data::Dumper;
ration;
Api;

S_TOKEN';

ng | Volume code.
oken
-Language
eval {
>volumesGetByCode(code => $code
on);
};
if ($@) {

g VolumesApi->volumesGetByCode:
$@\n";

atement
import time

ApiException

'

class
olumesApi()

Volume code.
(optional)
US)
l) (default to 1.0)
try:
# Get volume by code.
.volumes_get_by_code(code, auth
sion=apiVersion)

ng VolumesApi->volumesGetByCode
: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Volume code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Responses
Status: 200 - OK
• Schema
{
}
volumesPatch
Patch an existing volume.
/api/Volumes/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Volumes/{code}"
;
*;
lumesApi;
import java.util.*;
{

ing[] args) {
ient();

uth2

("oauth2");
= new VolumesApi();

VolumePatch model = ; /
/ VolumePatch | Volume model.
g | access token
i-Version
try {
Object result = api

Instance.volumesPatch(code, mod
el, authorization, acceptLangua
ge, apiVersion);
System.out.println(
result);
) {
System.err.println(
Api#volumesPatch");
e.printStackTrace()
;
lumesApi;

{

ing[] args) {
= new VolumesApi();

VolumePatch model = ; /
/ VolumePatch | Volume model.
g | access token

i-Version
try {
Object result = api

Instance.volumesPatch(code, mod
el, authorization, acceptLangua
ge, apiVersion);
System.out.println(
result);
) {
System.err.println(
Api#volumesPatch");
e.printStackTrace()
;
}
}


R_ACCESS_TOKEN"];

Volume code.
VolumePatch *model = ; // Volum

e model.

(optional)

-US)


// Patch an existing volume.
[apiInstance volumesPatchWith:c
ode
model:model
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];




SS TOKEN"

olumesApi()

ring} Volume code.
var model = ; // {VolumePatch}

Volume model.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.volumesPatch(code, model, o
pts, callback);
using System;
namespace Example
public class volumesPatchEx

ample
{
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew VolumesApi();
var code = code_exa

mple; // String | Volume code.
var model = new Vol

umePatch(); // VolumePatch | Vo
lume model.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch an exi
sting volume.
Object result =
apiInstance.volumesPatch(code,
model, authorization, acceptLan
guage, apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
.volumesPatch: " + e.Message );
<?php
/autoload.php');



| Volume code.
$model = ; // VolumePatch | Vol

ume model.
en
anguage
try {
lumesPatch($code, $model, $auth
iVersion);
print_r($result);

g VolumesApi->volumesPatch: ',
}
?>
use Data::Dumper;
ration;
Api;

S_TOKEN';

ng | Volume code.
:Object::VolumePatch->new(); #
VolumePatch | Volume model.
oken
-Language
eval {
>volumesPatch(code => $code, mo
del => $model, authorization =>
=> $apiVersion);
};
if ($@) {

g VolumesApi->volumesPatch: $@\
n";

atement
import time

ApiException

'

class
olumesApi()

Volume code.
model = # VolumePatch | Volume

model.
(optional)
US)
l) (default to 1.0)
try:
# Patch an existing volume.
.volumes_patch(code, model, aut
rsion=apiVersion)

ng VolumesApi->volumesPatch: %s
\n" % e)
Parameters
Path parameters
Name Description
code* String
Volume code.
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
model * VolumePatch {
Subset of properties to patch a volume.

Required: Hold
Hold:
Hold boolean
InternalComments:
Notes:
Notes string maxLength:255
}
Responses
Status: 200 - OK
• Schema
{
}
volumesPost
Create a new volume.
/api/Volumes
Usage and SDK
Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Volumes"
;
*;
lumesApi;
import java.util.*;

{
ing[] args) {
ient();

uth2

("oauth2");
= new VolumesApi();
VolumePost model = ; //
VolumePost | Volume model.
g | access token

i-Version
try {
Object result = api
Instance.volumesPost(model, aut
Version);
System.out.println(
result);
) {
System.err.println(
Api#volumesPost");
e.printStackTrace()
;
lumesApi;

{

ing[] args) {
= new VolumesApi();
VolumePost model = ; //
VolumePost | Volume model.
g | access token

i-Version
try {
Object result = api

Instance.volumesPost(model, aut
Version);
System.out.println(
result);
) {
System.err.println(
Api#volumesPost");
e.printStackTrace()
;

R_ACCESS_TOKEN"];
VolumePost *model = ; // Volume

model.

(optional)

-US)


// Create a new volume.
[apiInstance volumesPostWith:mo
del
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"
olumesApi()
var model = ; // {VolumePost} V

olume model.
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.volumesPost(model, opts, ca
llback);
using System;
namespace Example
public class volumesPostExa

mple
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew VolumesApi();
var model = new Vol
umePost(); // VolumePost | Volu
me model.
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a new
volume.
Object result =
apiInstance.volumesPost(model,
apiVersion);
Debug.WriteLine
(result);
catch (Exception e)
{
Debug.Print("Ex
.volumesPost: " + e.Message );
<?php
/autoload.php');


$model = ; // VolumePost | Volu

me model.
en
anguage
try {
lumesPost($model, $authorizatio
);
print_r($result);

g VolumesApi->volumesPost: ', $
?>
use Data::Dumper;
ration;
Api;

S_TOKEN';
:Object::VolumePost->new(); # V
olumePost | Volume model.
oken
-Language
eval {
>volumesPost(model => $model, a
};
if ($@) {

g VolumesApi->volumesPost: $@\n
";

atement
import time

ApiException

'

class
olumesApi()
model = # VolumePost | Volume

model.
(optional)
US)
l) (default to 1.0)
try:
# Create a new volume.
.volumes_post(model, authorizat
piVersion)

ng VolumesApi->volumesPost: %s\
n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
model * VolumePost {
Volume Post Request, new volume or adjust exsiting volume .

Required:
ActivityCenter,Code,Country,EffectiveDate,VolumeDate,VolumeType
Code:
Adjusts:
Adjusts string maxLength:50
Reference original volume record for adjustments.
ActivityCenter:
The Account code of an existing Account.
Country:
EffectiveDate:
VolumeDate:
VolumeDate string (date-time)
InternalComments:
Notes:
Notes string maxLength:255
Model:
Model boolean
Hold:
Hold boolean
VolumeType:
VolumeType string minLength:1 maxLength:50
BaseVolumes:
BaseVolumes[ (0..∞) ♦
BaseVolumeRequest {
BaseVolumeRequest.
Required: Amount,Volume
Volume:
Volume string minLength:1 maxLength:50
Amount:
{
Amount:
Currency:
}
}
]
}
Responses
Status: 200 - OK
• Schema
{
}
Warehouses
warehousesGetAll
Get data for Warehouse entries
/api/Warehouses
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

44356/api/Warehouses?pageNumber
=&pageSize=&sortType=&culture=&
filters="
;
*;
import io.swagger.client.api.Wa
rehousesApi;
import java.util.*;
public class WarehousesApiExamp

le {

ing[] args) {
ient();

uth2

("oauth2");
WarehousesApi apiInstan
ce = new WarehousesApi();

greater than 0

'
g | access token
i-Version

ot specified,
the defa

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.WarehouseDto result = ap
iInstance.warehousesGetAll(page
System.out.println(
result);
) {
System.err.println(
"Exception when calling Warehou
sesApi#warehousesGetAll");
e.printStackTrace()
;
rehousesApi;

le {

ing[] args) {

greater than 0

'
g | access token

i-Version

ot specified,
the defa

s
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
HateoasCollectionRe
sponse.WarehouseDto result = ap
iInstance.warehousesGetAll(page
System.out.println(
result);
) {
System.err.println(
sesApi#warehousesGetAll");
e.printStackTrace()
;


R_ACCESS_TOKEN"];


default to 25)

c)

(optional)
-US)


the defa

le; // # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
WarehousesApi *apiInstance = [[
WarehousesApi alloc] init];
// Get data for Warehouse entri

es
[apiInstance warehousesGetAllWi
th:pageNumber
pageSize:pageSize
sortType:sortType
ge
culture:culture
filters:filters
completionHandler
: ^(HateoasCollectionResponse.W
arehouseDto output, NSError* er
ror) {
if
(output) {
}
if
(error) {
}];





SS TOKEN"
var api = new JenkonRestApiV1.W

arehousesApi()

than or equal to 0
0

var opts = {
oken
-Language
,
the defa
{String} # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
};

data, response) {
if (error) {
} else {

ata);
};
api.warehousesGetAll(pageNumber
, pageSize, sortType, opts, cal
lback);
using System;
namespace Example
public class warehousesGetA

llExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew WarehousesApi();
var pageNumber = 56
0 (default to 1)
var pageSize = 56;

var sortType = sort

var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
var filters = filte
ers
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try
// Get data for

Warehouse entries
HateoasCollecti
onResponse.WarehouseDto result
= apiInstance.warehousesGetAll(
apiVersion, culture, filters);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
ception when calling Warehouses
Api.warehousesGetAll: " + e.Mes
sage );
<?php
/autoload.php');

ent\Api\WarehousesApi();

an or equal to 0

for 'Descending'
en
anguage
the defa
String | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
try {
$result = $api_instance->wa
rehousesGetAll($pageNumber, $pa
geSize, $sortType, $authorizati
n, $culture, $filters);
print_r($result);

g WarehousesApi->warehousesGetA
L;
?>
use Data::Dumper;
ration;
use WWW::SwaggerClient::Warehou
sesApi;

S_TOKEN';
Client::WarehousesApi->new();

than or equal to 0

0
oken
-Language
,
the defa
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
eval {
>warehousesGetAll(pageNumber =>
ulture => $culture, filters =>
$filters);
};
if ($@) {

g WarehousesApi->warehousesGetA
ll: $@\n";

atement
import time

ApiException

'
class
api_instance = swagger_client.W
arehousesApi()


efault to 25)
)
(optional)
US)
l) (default to 1.0)

the defa
ing | # Filters
**Example:**
**SQL equivalent:**

Date == '20200607')
me |
| ------------------ | ----- |
------ | ------ | ---- | ------
-- |
| Equal |**==** |
✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
| LessThan |**<** |
✓ | ✘ | ✘ | ✓ |
✓ | ✘ | ✘ | ✓ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
✘ | ✓ | ✘ | ✘ |
(optional)
try:
# Get data for Warehouse en

tries
.warehouses_get_all(pageNumber,
iVersion, culture=culture, filt
ers=filters)

ng WarehousesApi->warehousesGet
All: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
pageNumber* Integer
Required
pageSize* Integer

Required
sortType* String

'Descending'
Required
culture String

filters String
-------- | ----- | ------ | ------ | ---- | -------- | | Equal |**==** | ✓ | ✓ |
|**<=** | ✓ | ✘ | ✘ | ✓ | | Contains |**~=** | ✘ | ✓ | ✘ | ✘ | |
|**│=** | ✘ | ✓ | ✘ | ✘ | | NotEndsWith |**!│=**| ✘ | ✓ | ✘ | ✘ |
Responses
Status: 200 - OK
• Schema
{
PageNumber:
integer (int32)
Page number
PageSize:
integer (int32)
Page size
TotalCount:
integer (int32)
Total count
First:
string
First page url
Previous:
string
exist
Next:
string
Last:
string
Last page url
Items:
[
Items
{
WarehouseDto.
Code:
string
Code.
Name:
string
Code.
Countries:
[
Countries.
string
]
ActivityCenter:
string
FulfillmentWarehouse:
string
Fulfillment Warehouse.
FromWarehouse:
string
From Warehouse.
Resources:
[
Resources.
ResourceModel {
Resource Model
Required: Culture,Value
Culture:
maxLength:50
Value:
Value string
}
]
Active:
boolean
Active.
Line1:
string
Line1.
Line2:
string
Line2.
PostalCode:
string
Postal Code.
City:
string
City.
StateProvince:
string
StateProvince.
Country:
string
Country.
WarehouseType:
string
Warehouse Type.
}
]
}
warehousesGetByCode
Get data for a warehouse entry
/api/Warehouses/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python
44356/api/Warehouses/{code}?cul
ture="
;
*;
rehousesApi;
import java.util.*;

le {

ing[] args) {
ient();

uth2
("oauth2");

ode to retrieve
g | access token

i-Version

ot specified,
the defa
try {
WarehouseDto result
= apiInstance.warehousesGetByCo
System.out.println(
result);
) {
System.err.println(
sesApi#warehousesGetByCode");
e.printStackTrace()
;
rehousesApi;

le {

ing[] args) {

ode to retrieve
g | access token

i-Version

ot specified,
the defa
try {
WarehouseDto result
= apiInstance.warehousesGetByCo
System.out.println(
result);
) {
System.err.println(
sesApi#warehousesGetByCode");
e.printStackTrace()
;
}

R_ACCESS_TOKEN"];


(optional)

-US)


the defa
// Get data for a warehouse ent

ry
[apiInstance warehousesGetByCod
eWith:code
ge
culture:culture
completionHandler
: ^(WarehouseDto output, NSErro
r* error) {
if
(output) {
if
(error) {
}];




SS TOKEN"

arehousesApi()

ring} The Category Code to retr
ieve
var opts = {
oken
-Language
the defa
};

data, response) {
if (error) {
} else {

ata);
};
api.warehousesGetByCode(code, o
pts, callback);
using System;
namespace Example
public class warehousesGetB

yCodeExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew WarehousesApi();
var code = code_exa

Code to retrieve
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
var culture = cultu

f not specified,
the defa
try
// Get data for

a warehouse entry
WarehouseDto re
sult = apiInstance.warehousesGe
re);
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
Api.warehousesGetByCode: " + e.
Message );
}
<?php
/autoload.php');



| The Category Code to retrieve
en
anguage
the defa
try {
rehousesGetByCode($code, $autho
Version, $culture);
print_r($result);

g WarehousesApi->warehousesGetB
_EOL;
?>
use Data::Dumper;
ration;
sesApi;

S_TOKEN';

ng | The Category Code to retri
eve
oken
-Language
,
the defa
eval {
>warehousesGetByCode(code => $c
rsion, culture => $culture);
};
if ($@) {

g WarehousesApi->warehousesGetB
yCode: $@\n";

atement
import time

ApiException

'

class
arehousesApi()
(optional)
US)
l) (default to 1.0)

the defa
try:
# Get data for a warehouse

entry
.warehouses_get_by_code(code, a
ture)
ng WarehousesApi->warehousesGet
ByCode: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Query parameters
Name Description
culture String
Responses
Status: 200 - OK
• Schema
{
WarehouseDto.
Code:
string
Code.
Name:
string
Code.
Countries:
[
Countries.
string
]
ActivityCenter:
string
string
FromWarehouse:
string
From Warehouse.
Resources:
[
Resources.
ResourceModel {
Resource Model
Culture:
maxLength:50
Value:
Value string
}
]
Active:
boolean
Active.
Line1:
string
Line1.
Line2:
string
Line2.
PostalCode:
string
Postal Code.
City:
string
City.
StateProvince:
string
StateProvince.
Country:
string
Country.
WarehouseType:
string
Warehouse Type.
}
warehousesPatchAsync
Patch a Warehouse entry
/api/Warehouses/{code}
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

t:44356/api/Warehouses/{code}"
;
*;
rehousesApi;
import java.util.*;

le {

ing[] args) {
ient();

uth2

("oauth2");

ple; // String | The Warehouse
WarehousePatch warehous
ePatch = ; // WarehousePatch |
The subset of Warehouse fields
to patch
g | access token

i-Version
try {
Object result = api

Instance.warehousesPatchAsync(c
ode, warehousePatch, authorizat
);
System.out.println(
result);
) {
System.err.println(
sesApi#warehousesPatchAsync");
e.printStackTrace()
;
}
}
rehousesApi;

le {

ing[] args) {

ple; // String | The Warehouse
WarehousePatch warehous
ePatch = ; // WarehousePatch |
The subset of Warehouse fields
to patch
g | access token

i-Version
try {
Object result = api
Instance.warehousesPatchAsync(c
ode, warehousePatch, authorizat
);
System.out.println(
result);
) {
System.err.println(
sesApi#warehousesPatchAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];

The Warehouse Code of the entry
to patch
WarehousePatch *warehousePatch
= ; // The subset of Warehouse
fields to patch

(optional)

-US)

// Patch a Warehouse entry
[apiInstance warehousesPatchAsy
ncWith:code
warehousePatch:warehousePat
ch
ge
completionHandler
or) {
if
(output) {
if
(error) {
}];





SS TOKEN"

arehousesApi()
ring} The Warehouse Code of the
entry to patch
var warehousePatch = ; // {Ware

housePatch} The subset of Wareh
ouse fields to patch
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
}
};
api.warehousesPatchAsync(code,
warehousePatch, opts, callback)
;
using System;
namespace Example
public class warehousesPatc

hAsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew WarehousesApi();
var code = code_exa

mple; // String | The Warehous
e Code of the entry to patch
var warehousePatch
= new WarehousePatch(); // Ware
housePatch | The subset of Ware
house fields to patch
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Patch a Ware
house entry
Object result =
apiInstance.warehousesPatchAsyn
c(code, warehousePatch, authori
ion);
Debug.WriteLine
(result);
}
catch (Exception e)
Debug.Print("Ex
Api.warehousesPatchAsync: " + e
.Message );
<?php
/autoload.php');



| The Warehouse Code of the ent
ry to patch
$warehousePatch = ; // Warehous
ePatch | The subset of Warehous
e fields to patch
en
anguage
try {
rehousesPatchAsync($code, $ware
housePatch, $authorization, $ac
print_r($result);

g WarehousesApi->warehousesPatc
hAsync: ', $e->getMessage(), PH
P_EOL;
?>
use Data::Dumper;
ration;
sesApi;

S_TOKEN';

ng | The Warehouse Code of the
entry to patch
my $warehousePatch = WWW::Swagg
erClient::Object::WarehousePatc
h->new(); # WarehousePatch | Th
e subset of Warehouse fields to
patch
oken
-Language
eval {
>warehousesPatchAsync(code => $
code, warehousePatch => $wareho
usePatch, authorization => $aut
apiVersion);
};
if ($@) {

g WarehousesApi->warehousesPatc
hAsync: $@\n";

atement
import time

ApiException

'
class
arehousesApi()

The Warehouse Code of the entry
to patch
warehousePatch = # WarehousePa
tch | The subset of Warehouse f
ields to patch
(optional)
US)
l) (default to 1.0)
try:
# Patch a Warehouse entry
.warehouses_patch_async(code, w
arehousePatch, authorization=au
thorization, acceptLanguage=acc
eptLanguage, apiVersion=apiVers
ion)
ng WarehousesApi->warehousesPat
chAsync: %s\n" % e)
Parameters
Path parameters
Name Description
code* String
The Warehouse Code of the entry to patch
Required
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
warehousePatch * WarehousePatch {
Warehouse Patch.
Name:
Name string minLength:1 maxLength:50
Countries:
Countries[
]
ActivityCenter:
FulfillmentWarehouse string minLength:1 maxLength:50
FromWarehouse:
FromWarehouse string minLength:1 maxLength:50
Resources:
Resources[
{
Culture:
Value:
Value string
}
]
Active:
Active boolean
Line1:
Line1 string minLength:1 maxLength:255
Line2:
Line2 string minLength:1 maxLength:255
PostalCode:
PostalCode string minLength:1 maxLength:255
City:
City string minLength:1 maxLength:255
StateProvince:
StateProvince string minLength:1 maxLength:255
Country:
}
Responses
Status: 200 - OK
• Schema
{
}
warehousesPostAsync
Create a Warehouse entry
/api/Warehouses
Usage and SDK

Samples
• Curl
• Java
• Android
• Obj-C
• JavaScript
• C#
• PHP
• Perl
• Python

:44356/api/Warehouses"
;
*;
rehousesApi;
import java.util.*;

le {

ing[] args) {
ient();

uth2

("oauth2");
WarehouseDto warehouse
= ; // WarehouseDto | The {Ware
house} data to create
g | access token

i-Version
try {
Object result = api

Instance.warehousesPostAsync(wa
rehouse, authorization, acceptL
System.out.println(
result);
) {
System.err.println(
sesApi#warehousesPostAsync");
e.printStackTrace()
;
}
rehousesApi;

le {

ing[] args) {
WarehouseDto warehouse
= ; // WarehouseDto | The {Ware
house} data to create
g | access token

i-Version
try {
Object result = api

Instance.warehousesPostAsync(wa
rehouse, authorization, acceptL
System.out.println(
result);
) {
System.err.println(
sesApi#warehousesPostAsync");
e.printStackTrace()
;


R_ACCESS_TOKEN"];
WarehouseDto *warehouse = ; //
The {Warehouse} data to create

(optional)

-US)
// Create a Warehouse entry
[apiInstance warehousesPostAsyn
cWith:warehouse
ge
completionHandler
or) {
if
(output) {
if
(error) {
}
}];





SS TOKEN"

arehousesApi()
var warehouse = ; // {Warehouse

Dto} The {Warehouse} data to cr
eate
var opts = {
oken
-Language
};

data, response) {
if (error) {
} else {

ata);
};
api.warehousesPostAsync(warehou
se, opts, callback);
using System;
namespace Example
{
public class warehousesPost
AsyncExample
public void main()
// Configure OAuth2
oauth2
Configuration.Defau
OKEN";
var apiInstance = n
ew WarehousesApi();
var warehouse = new

WarehouseDto(); // WarehouseDto
| The {Warehouse} data to creat
e
var authorization =
var acceptLanguage
var apiVersion = ap
t to 1.0)
try
// Create a War
ehouse entry
Object result =
apiInstance.warehousesPostAsync
(warehouse, authorization, acce
Debug.WriteLine
(result);
catch (Exception e)
Debug.Print("Ex
Api.warehousesPostAsync: " + e.
Message );
<?php
/autoload.php');

$warehouse = ; // WarehouseDto
| The {Warehouse} data to creat
e
en
anguage
try {
rehousesPostAsync($warehouse, $
$apiVersion);
print_r($result);

g WarehousesApi->warehousesPost
_EOL;
?>
use Data::Dumper;
ration;
sesApi;

S_TOKEN';
my $warehouse = WWW::SwaggerCli
ent::Object::WarehouseDto->new(
); # WarehouseDto | The {Wareho
use} data to create
oken
-Language
eval {
>warehousesPostAsync(warehouse
=> $warehouse, authorization =>
=> $apiVersion);
};
if ($@) {

g WarehousesApi->warehousesPost
Async: $@\n";

atement
import time

ApiException

'

class
arehousesApi()
warehouse = # WarehouseDto | T
he {Warehouse} data to create
(optional)
US)
l) (default to 1.0)
try:
# Create a Warehouse entry
.warehouses_post_async(warehous
ng WarehousesApi->warehousesPos
tAsync: %s\n" % e)
Parameters
Header parameters
Name Description
access token
Accept-Language
Api-Version String
Api-Version
Body parameters
Name Description
warehouse * {
WarehouseDto.
Code:
string
Code.
Name:
string
Code.
Countries:
[
Countries.
string
]
ActivityCenter:
string
string
FromWarehouse:
string
From Warehouse.
Resources:
[
Resources.
ResourceModel {
Resource Model
Culture:
Value:
Value string
}
]
Active:
boolean
Active.
Line1:
string
Line1.
Line2:
string
Line2.
PostalCode:
string
Postal Code.
City:
string
City.
StateProvince:
string
StateProvince.
Country:
string
Country.
WarehouseType:
string
Warehouse Type.
}
Responses
Status: 200 - OK
• Schema
{
}

JoT API v2.1

Uploaded by

Copyright:

Available Formats

You might also like

JoT API v2.1

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

JoT API v2.1

Uploaded by

Copyright:

Available Formats

API Summary

Jenkon REST API

Usage and SDK

curl -X DELETE "https://localho

public class AccountDocumentNot

public static void main(Str

// Configure OAuth2 acc

OAuth oauth2 = (OAuth)

Object result = api

public class AccountDocumentNot

String apiVersion = api

Object result = api

Configuration *apiConfig = [Con

// Configure OAuth2 access toke

String *accountCode = accountCo

String *documentCode = document

String *authorization = authori

String *apiVersion = apiVersion

// Get account notes by documen

NSLog(@"Error: %@", error);

var JenkonRestApiV1 = require('

var defaultClient = JenkonRestA

// Configure OAuth2 access toke

var oauth2 = defaultClient.auth

oauth2.accessToken = "YOUR ACCE

var api = new JenkonRestApiV1.A

var accountCode = accountCode_e

var notesCodes = ; // {array[St

var callback = function(error,

console.log('API called suc

public class notesDeleteNot

public void main()

// Configure OAuth2 access toke

$api_instance = new Swagger\Cli

} catch (Exception $e) {

echo 'Exception when callin

# Configure OAuth2 access token

warn "Exception when callin

from __future__ import print_st

from swagger_client.rest import

from pprint import pprint

# create an instance of the API

# Get account notes by docu

print("Exception when calli

Usage and SDK

curl -X GET "https://localhost:

public class AccountDocumentNot

public static void main(Str

// Configure OAuth2 acc

OAuth oauth2 = (OAuth)

Integer pageSize = 56;

String sortType = sortT

String apiVersion = api

String filters = filter

public class AccountDocumentNot

public static void main(Str

Integer pageSize = 56;

String sortType = sortT

from future import print_st

from future import print_st