SHARK WMS RESTAPI Version 1.3

Articles

articleRenamePut

Rename an article.

Rename an article. This is used to rename an article number. The new article number must not exist.


/articleRename

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://restapi.sharkwms.com/1.3/articleRename?articleNumber=articleNumber_example&newArticleNumber=newArticleNumber_example&owner=owner_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        String articleNumber = articleNumber_example; // String | Specify the article number to find. A procent sign can be used for pattern matching.
        String newArticleNumber = newArticleNumber_example; // String | Specify the new article number.
        String owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.

        try {
            apiInstance.articleRenamePut(articleNumber, newArticleNumber, owner);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleRenamePut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String articleNumber = new String(); // String | Specify the article number to find. A procent sign can be used for pattern matching.
final String newArticleNumber = new String(); // String | Specify the new article number.
final String owner = new String(); // String | For sites with multiple owners of the articles, specify the actually owner.

try {
    final result = await api_instance.articleRenamePut(articleNumber, newArticleNumber, owner);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleRenamePut: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        String articleNumber = articleNumber_example; // String | Specify the article number to find. A procent sign can be used for pattern matching.
        String newArticleNumber = newArticleNumber_example; // String | Specify the new article number.
        String owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.

        try {
            apiInstance.articleRenamePut(articleNumber, newArticleNumber, owner);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleRenamePut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
String *articleNumber = articleNumber_example; // Specify the article number to find. A procent sign can be used for pattern matching. (optional) (default to null)
String *newArticleNumber = newArticleNumber_example; // Specify the new article number. (optional) (default to null)
String *owner = owner_example; // For sites with multiple owners of the articles, specify the actually owner. (optional) (default to null)

// Rename an article.
[apiInstance articleRenamePutWith:articleNumber
    newArticleNumber:newArticleNumber
    owner:owner
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.ArticlesApi()
var opts = {
  'articleNumber': articleNumber_example, // {String} Specify the article number to find. A procent sign can be used for pattern matching.
  'newArticleNumber': newArticleNumber_example, // {String} Specify the new article number.
  'owner': owner_example // {String} For sites with multiple owners of the articles, specify the actually owner.
};

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

namespace Example
{
    public class articleRenamePutExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleNumber = articleNumber_example;  // String | Specify the article number to find. A procent sign can be used for pattern matching. (optional)  (default to null)
            var newArticleNumber = newArticleNumber_example;  // String | Specify the new article number. (optional)  (default to null)
            var owner = owner_example;  // String | For sites with multiple owners of the articles, specify the actually owner. (optional)  (default to null)

            try {
                // Rename an article.
                apiInstance.articleRenamePut(articleNumber, newArticleNumber, owner);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleRenamePut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleNumber = articleNumber_example; // String | Specify the article number to find. A procent sign can be used for pattern matching.
$newArticleNumber = newArticleNumber_example; // String | Specify the new article number.
$owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.

try {
    $api_instance->articleRenamePut($articleNumber, $newArticleNumber, $owner);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleRenamePut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleNumber = articleNumber_example; # String | Specify the article number to find. A procent sign can be used for pattern matching.
my $newArticleNumber = newArticleNumber_example; # String | Specify the new article number.
my $owner = owner_example; # String | For sites with multiple owners of the articles, specify the actually owner.

eval {
    $api_instance->articleRenamePut(articleNumber => $articleNumber, newArticleNumber => $newArticleNumber, owner => $owner);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleRenamePut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleNumber = articleNumber_example # String | Specify the article number to find. A procent sign can be used for pattern matching. (optional) (default to null)
newArticleNumber = newArticleNumber_example # String | Specify the new article number. (optional) (default to null)
owner = owner_example # String | For sites with multiple owners of the articles, specify the actually owner. (optional) (default to null)

try:
    # Rename an article.
    api_instance.article_rename_put(articleNumber=articleNumber, newArticleNumber=newArticleNumber, owner=owner)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleRenamePut: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleNumber = articleNumber_example; // String
    let newArticleNumber = newArticleNumber_example; // String
    let owner = owner_example; // String

    let mut context = ArticlesApi::Context::default();
    let result = client.articleRenamePut(articleNumber, newArticleNumber, owner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
articleNumber
String
Specify the article number to find. A procent sign can be used for pattern matching.
newArticleNumber
String
Specify the new article number.
owner
String
For sites with multiple owners of the articles, specify the actually owner.

Responses


deleteArticle

Delete an article. It will actually not be deleted but marked as unusable.


/article

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://restapi.sharkwms.com/1.3/article?articleNumber=articleNumber_example&owner=owner_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        String articleNumber = articleNumber_example; // String | Specify the article number to find. A procent sign can be used for pattern matching.
        String owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.

        try {
            apiInstance.deleteArticle(articleNumber, owner);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#deleteArticle");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String articleNumber = new String(); // String | Specify the article number to find. A procent sign can be used for pattern matching.
final String owner = new String(); // String | For sites with multiple owners of the articles, specify the actually owner.

try {
    final result = await api_instance.deleteArticle(articleNumber, owner);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteArticle: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        String articleNumber = articleNumber_example; // String | Specify the article number to find. A procent sign can be used for pattern matching.
        String owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.

        try {
            apiInstance.deleteArticle(articleNumber, owner);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#deleteArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
String *articleNumber = articleNumber_example; // Specify the article number to find. A procent sign can be used for pattern matching. (optional) (default to null)
String *owner = owner_example; // For sites with multiple owners of the articles, specify the actually owner. (optional) (default to null)

[apiInstance deleteArticleWith:articleNumber
    owner:owner
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.ArticlesApi()
var opts = {
  'articleNumber': articleNumber_example, // {String} Specify the article number to find. A procent sign can be used for pattern matching.
  'owner': owner_example // {String} For sites with multiple owners of the articles, specify the actually owner.
};

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

namespace Example
{
    public class deleteArticleExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleNumber = articleNumber_example;  // String | Specify the article number to find. A procent sign can be used for pattern matching. (optional)  (default to null)
            var owner = owner_example;  // String | For sites with multiple owners of the articles, specify the actually owner. (optional)  (default to null)

            try {
                apiInstance.deleteArticle(articleNumber, owner);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.deleteArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleNumber = articleNumber_example; // String | Specify the article number to find. A procent sign can be used for pattern matching.
$owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.

try {
    $api_instance->deleteArticle($articleNumber, $owner);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->deleteArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleNumber = articleNumber_example; # String | Specify the article number to find. A procent sign can be used for pattern matching.
my $owner = owner_example; # String | For sites with multiple owners of the articles, specify the actually owner.

eval {
    $api_instance->deleteArticle(articleNumber => $articleNumber, owner => $owner);
};
if ($@) {
    warn "Exception when calling ArticlesApi->deleteArticle: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleNumber = articleNumber_example # String | Specify the article number to find. A procent sign can be used for pattern matching. (optional) (default to null)
owner = owner_example # String | For sites with multiple owners of the articles, specify the actually owner. (optional) (default to null)

try:
    api_instance.delete_article(articleNumber=articleNumber, owner=owner)
except ApiException as e:
    print("Exception when calling ArticlesApi->deleteArticle: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleNumber = articleNumber_example; // String
    let owner = owner_example; // String

    let mut context = ArticlesApi::Context::default();
    let result = client.deleteArticle(articleNumber, owner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
articleNumber
String
Specify the article number to find. A procent sign can be used for pattern matching.
owner
String
For sites with multiple owners of the articles, specify the actually owner.

Responses


searchArticle

Search for one or more articles.

Get information about the specified article(s). Returns the relevant information.


/article

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/article?articleNumber=articleNumber_example&owner=owner_example&page=8.14&pageSize=8.14"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        String articleNumber = articleNumber_example; // String | Specify the article number to find. A procent sign can be used for pattern matching.
        String owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

        try {
            array[MasterDataJS] result = apiInstance.searchArticle(articleNumber, owner, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#searchArticle");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String articleNumber = new String(); // String | Specify the article number to find. A procent sign can be used for pattern matching.
final String owner = new String(); // String | For sites with multiple owners of the articles, specify the actually owner.
final BigDecimal page = new BigDecimal(); // BigDecimal | Page number if the response is paged.
final BigDecimal pageSize = new BigDecimal(); // BigDecimal | Number of returned rows in the response set.

try {
    final result = await api_instance.searchArticle(articleNumber, owner, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchArticle: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        String articleNumber = articleNumber_example; // String | Specify the article number to find. A procent sign can be used for pattern matching.
        String owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

        try {
            array[MasterDataJS] result = apiInstance.searchArticle(articleNumber, owner, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#searchArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
String *articleNumber = articleNumber_example; // Specify the article number to find. A procent sign can be used for pattern matching. (optional) (default to null)
String *owner = owner_example; // For sites with multiple owners of the articles, specify the actually owner. (optional) (default to null)
BigDecimal *page = 8.14; // Page number if the response is paged. (optional) (default to null)
BigDecimal *pageSize = 8.14; // Number of returned rows in the response set. (optional) (default to null)

// Search for one or more articles.
[apiInstance searchArticleWith:articleNumber
    owner:owner
    page:page
    pageSize:pageSize
              completionHandler: ^(array[MasterDataJS] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.ArticlesApi()
var opts = {
  'articleNumber': articleNumber_example, // {String} Specify the article number to find. A procent sign can be used for pattern matching.
  'owner': owner_example, // {String} For sites with multiple owners of the articles, specify the actually owner.
  'page': 8.14, // {BigDecimal} Page number if the response is paged.
  'pageSize': 8.14 // {BigDecimal} Number of returned rows in the response set.
};

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

namespace Example
{
    public class searchArticleExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleNumber = articleNumber_example;  // String | Specify the article number to find. A procent sign can be used for pattern matching. (optional)  (default to null)
            var owner = owner_example;  // String | For sites with multiple owners of the articles, specify the actually owner. (optional)  (default to null)
            var page = 8.14;  // BigDecimal | Page number if the response is paged. (optional)  (default to null)
            var pageSize = 8.14;  // BigDecimal | Number of returned rows in the response set. (optional)  (default to null)

            try {
                // Search for one or more articles.
                array[MasterDataJS] result = apiInstance.searchArticle(articleNumber, owner, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.searchArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleNumber = articleNumber_example; // String | Specify the article number to find. A procent sign can be used for pattern matching.
$owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.
$page = 8.14; // BigDecimal | Page number if the response is paged.
$pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

try {
    $result = $api_instance->searchArticle($articleNumber, $owner, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->searchArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleNumber = articleNumber_example; # String | Specify the article number to find. A procent sign can be used for pattern matching.
my $owner = owner_example; # String | For sites with multiple owners of the articles, specify the actually owner.
my $page = 8.14; # BigDecimal | Page number if the response is paged.
my $pageSize = 8.14; # BigDecimal | Number of returned rows in the response set.

eval {
    my $result = $api_instance->searchArticle(articleNumber => $articleNumber, owner => $owner, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->searchArticle: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleNumber = articleNumber_example # String | Specify the article number to find. A procent sign can be used for pattern matching. (optional) (default to null)
owner = owner_example # String | For sites with multiple owners of the articles, specify the actually owner. (optional) (default to null)
page = 8.14 # BigDecimal | Page number if the response is paged. (optional) (default to null)
pageSize = 8.14 # BigDecimal | Number of returned rows in the response set. (optional) (default to null)

try:
    # Search for one or more articles.
    api_response = api_instance.search_article(articleNumber=articleNumber, owner=owner, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->searchArticle: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleNumber = articleNumber_example; // String
    let owner = owner_example; // String
    let page = 8.14; // BigDecimal
    let pageSize = 8.14; // BigDecimal

    let mut context = ArticlesApi::Context::default();
    let result = client.searchArticle(articleNumber, owner, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
articleNumber
String
Specify the article number to find. A procent sign can be used for pattern matching.
owner
String
For sites with multiple owners of the articles, specify the actually owner.
page
BigDecimal
Page number if the response is paged.
pageSize
BigDecimal
Number of returned rows in the response set.

Responses


updateArticle

Add or update master data for articles.

Master data is basic information about the articles. The most important information is the article number and description, but other information can be transferred as well. SHARK will create new articles and update the description, when met in an imported order, but the Master Data allows more information and will also work if SHARK is used with the Manual Transactions (transactions with no host-orders), this could be the case in an initial store process, where goods are moved from old locations into SHARK without orders.


/article

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://restapi.sharkwms.com/1.3/article" \
 -d '[ {
  "owner" : "",
  "alternativeArticleNumber2" : "NEVER",
  "description" : "Screwdriver",
  "batchNumberRequired" : false,
  "description2" : "",
  "packages" : [ {
    "unit" : "unit",
    "depth" : 0.1,
    "ean" : "ean",
    "qty" : 1.0,
    "name" : "P1",
    "width" : 0.1,
    "weight" : 1.5,
    "height" : 0.1
  }, {
    "unit" : "unit",
    "depth" : 0.1,
    "ean" : "ean",
    "qty" : 1.0,
    "name" : "P1",
    "width" : 0.1,
    "weight" : 1.5,
    "height" : 0.1
  } ],
  "description1" : "",
  "erpcount" : 0.8008281904610115,
  "unit" : "unit",
  "userFields" : [ {
    "parameterType" : "TEXT",
    "parameterName" : "parameterName",
    "parameterValue" : "parameterValue"
  }, {
    "parameterType" : "TEXT",
    "parameterName" : "parameterName",
    "parameterValue" : "parameterValue"
  } ],
  "ean" : "",
  "serialNumberRequired" : "NEVER",
  "articleNumber" : "ART001",
  "markForDeletion" : false,
  "locationTypes" : [ {
    "qty" : 563737.5381880015,
    "name" : "name"
  }, {
    "qty" : 563737.5381880015,
    "name" : "name"
  } ],
  "pickingRate" : "pickingRate",
  "replenishment" : [ {
    "zone" : "zone",
    "locationStrategy" : "FLOATING",
    "replenishmentQty" : 0.5962133916683182,
    "packageName" : "P1",
    "ReplenishmentFrom" : "ReplenishmentFrom",
    "maxQty" : 0.14658129805029452,
    "minQty" : 0.6027456183070403
  }, {
    "zone" : "zone",
    "locationStrategy" : "FLOATING",
    "replenishmentQty" : 0.5962133916683182,
    "packageName" : "P1",
    "ReplenishmentFrom" : "ReplenishmentFrom",
    "maxQty" : 0.14658129805029452,
    "minQty" : 0.6027456183070403
  } ],
  "alternativeArticleNumber1" : "NEVER",
  "locationstrategy" : "FLOATING",
  "eanNumbers" : [ {
    "ean" : "ean",
    "qty" : 1.2302135886934766,
    "description" : "description"
  }, {
    "ean" : "ean",
    "qty" : 1.2302135886934766,
    "description" : "description"
  } ],
  "group" : "group",
  "misc" : {
    "misc1" : "misc1",
    "misc3" : "misc3",
    "misc10" : "misc10",
    "misc2" : "misc2",
    "misc5" : "misc5",
    "misc4" : "misc4",
    "misc7" : "misc7",
    "misc6" : "misc6",
    "misc9" : "misc9",
    "misc8" : "misc8"
  }
}, {
  "owner" : "",
  "alternativeArticleNumber2" : "NEVER",
  "description" : "Screwdriver",
  "batchNumberRequired" : false,
  "description2" : "",
  "packages" : [ {
    "unit" : "unit",
    "depth" : 0.1,
    "ean" : "ean",
    "qty" : 1.0,
    "name" : "P1",
    "width" : 0.1,
    "weight" : 1.5,
    "height" : 0.1
  }, {
    "unit" : "unit",
    "depth" : 0.1,
    "ean" : "ean",
    "qty" : 1.0,
    "name" : "P1",
    "width" : 0.1,
    "weight" : 1.5,
    "height" : 0.1
  } ],
  "description1" : "",
  "erpcount" : 0.8008281904610115,
  "unit" : "unit",
  "userFields" : [ {
    "parameterType" : "TEXT",
    "parameterName" : "parameterName",
    "parameterValue" : "parameterValue"
  }, {
    "parameterType" : "TEXT",
    "parameterName" : "parameterName",
    "parameterValue" : "parameterValue"
  } ],
  "ean" : "",
  "serialNumberRequired" : "NEVER",
  "articleNumber" : "ART001",
  "markForDeletion" : false,
  "locationTypes" : [ {
    "qty" : 563737.5381880015,
    "name" : "name"
  }, {
    "qty" : 563737.5381880015,
    "name" : "name"
  } ],
  "pickingRate" : "pickingRate",
  "replenishment" : [ {
    "zone" : "zone",
    "locationStrategy" : "FLOATING",
    "replenishmentQty" : 0.5962133916683182,
    "packageName" : "P1",
    "ReplenishmentFrom" : "ReplenishmentFrom",
    "maxQty" : 0.14658129805029452,
    "minQty" : 0.6027456183070403
  }, {
    "zone" : "zone",
    "locationStrategy" : "FLOATING",
    "replenishmentQty" : 0.5962133916683182,
    "packageName" : "P1",
    "ReplenishmentFrom" : "ReplenishmentFrom",
    "maxQty" : 0.14658129805029452,
    "minQty" : 0.6027456183070403
  } ],
  "alternativeArticleNumber1" : "NEVER",
  "locationstrategy" : "FLOATING",
  "eanNumbers" : [ {
    "ean" : "ean",
    "qty" : 1.2302135886934766,
    "description" : "description"
  }, {
    "ean" : "ean",
    "qty" : 1.2302135886934766,
    "description" : "description"
  } ],
  "group" : "group",
  "misc" : {
    "misc1" : "misc1",
    "misc3" : "misc3",
    "misc10" : "misc10",
    "misc2" : "misc2",
    "misc5" : "misc5",
    "misc4" : "misc4",
    "misc7" : "misc7",
    "misc6" : "misc6",
    "misc9" : "misc9",
    "misc8" : "misc8"
  }
} ]'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        MasterDataListJS masterDataListJS = ; // MasterDataListJS | 

        try {
            apiInstance.updateArticle(masterDataListJS);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#updateArticle");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final MasterDataListJS masterDataListJS = new MasterDataListJS(); // MasterDataListJS | 

try {
    final result = await api_instance.updateArticle(masterDataListJS);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateArticle: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        MasterDataListJS masterDataListJS = ; // MasterDataListJS | 

        try {
            apiInstance.updateArticle(masterDataListJS);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#updateArticle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
MasterDataListJS *masterDataListJS = ; //  (optional)

// Add or update master data for articles.
[apiInstance updateArticleWith:masterDataListJS
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.ArticlesApi()
var opts = {
  'masterDataListJS':  // {MasterDataListJS} 
};

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

namespace Example
{
    public class updateArticleExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var masterDataListJS = new MasterDataListJS(); // MasterDataListJS |  (optional) 

            try {
                // Add or update master data for articles.
                apiInstance.updateArticle(masterDataListJS);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.updateArticle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$masterDataListJS = ; // MasterDataListJS | 

try {
    $api_instance->updateArticle($masterDataListJS);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->updateArticle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $masterDataListJS = WWW::OPenAPIClient::Object::MasterDataListJS->new(); # MasterDataListJS | 

eval {
    $api_instance->updateArticle(masterDataListJS => $masterDataListJS);
};
if ($@) {
    warn "Exception when calling ArticlesApi->updateArticle: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
masterDataListJS =  # MasterDataListJS |  (optional)

try:
    # Add or update master data for articles.
    api_instance.update_article(masterDataListJS=masterDataListJS)
except ApiException as e:
    print("Exception when calling ArticlesApi->updateArticle: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let masterDataListJS = ; // MasterDataListJS

    let mut context = ArticlesApi::Context::default();
    let result = client.updateArticle(masterDataListJS, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
masterDataListJS

Responses


Inventory

inspectionGet

Get all items in inspection (Not yet fully functional)

Return a list of all locations with articles stored waiting for inspection.


/inspection

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/inspection?page=8.14&pageSize=8.14"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InventoryApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InventoryApi apiInstance = new InventoryApi();
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

        try {
            LocationListJS result = apiInstance.inspectionGet(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#inspectionGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final BigDecimal page = new BigDecimal(); // BigDecimal | Page number if the response is paged.
final BigDecimal pageSize = new BigDecimal(); // BigDecimal | Number of returned rows in the response set.

try {
    final result = await api_instance.inspectionGet(page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->inspectionGet: $e\n');
}

import org.openapitools.client.api.InventoryApi;

public class InventoryApiExample {
    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

        try {
            LocationListJS result = apiInstance.inspectionGet(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#inspectionGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InventoryApi *apiInstance = [[InventoryApi alloc] init];
BigDecimal *page = 8.14; // Page number if the response is paged. (optional) (default to null)
BigDecimal *pageSize = 8.14; // Number of returned rows in the response set. (optional) (default to null)

// Get all items in inspection  (Not yet fully functional)
[apiInstance inspectionGetWith:page
    pageSize:pageSize
              completionHandler: ^(LocationListJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.InventoryApi()
var opts = {
  'page': 8.14, // {BigDecimal} Page number if the response is paged.
  'pageSize': 8.14 // {BigDecimal} Number of returned rows in the response set.
};

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

namespace Example
{
    public class inspectionGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InventoryApi();
            var page = 8.14;  // BigDecimal | Page number if the response is paged. (optional)  (default to null)
            var pageSize = 8.14;  // BigDecimal | Number of returned rows in the response set. (optional)  (default to null)

            try {
                // Get all items in inspection  (Not yet fully functional)
                LocationListJS result = apiInstance.inspectionGet(page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InventoryApi.inspectionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InventoryApi();
$page = 8.14; // BigDecimal | Page number if the response is paged.
$pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

try {
    $result = $api_instance->inspectionGet($page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->inspectionGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InventoryApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InventoryApi->new();
my $page = 8.14; # BigDecimal | Page number if the response is paged.
my $pageSize = 8.14; # BigDecimal | Number of returned rows in the response set.

eval {
    my $result = $api_instance->inspectionGet(page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryApi->inspectionGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InventoryApi()
page = 8.14 # BigDecimal | Page number if the response is paged. (optional) (default to null)
pageSize = 8.14 # BigDecimal | Number of returned rows in the response set. (optional) (default to null)

try:
    # Get all items in inspection  (Not yet fully functional)
    api_response = api_instance.inspection_get(page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->inspectionGet: %s\n" % e)
extern crate InventoryApi;

pub fn main() {
    let page = 8.14; // BigDecimal
    let pageSize = 8.14; // BigDecimal

    let mut context = InventoryApi::Context::default();
    let result = client.inspectionGet(page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
BigDecimal
Page number if the response is paged.
pageSize
BigDecimal
Number of returned rows in the response set.

Responses


inspectionPut

Maintain articles that was stored for inspection. Default is release stock that was locked until quality inspection has been fullfilled. Can also be used to reject inspected articles, by setting the passed flag to false.


/inspection

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/inspection?article=article_example&location=location_example&qty=8.14&action=action_example&batchNumber=batchNumber_example&owner=owner_example&orderNumber=orderNumber_example&serialNumber=serialNumber_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InventoryApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InventoryApi apiInstance = new InventoryApi();
        String article = article_example; // String | The article number.
        String action = action_example; // String | What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available.
        String orderNumber = orderNumber_example; // String | This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles.
        String location = location_example; // String | Optionally support for specifying a specific location where the articles are stored.
        BigDecimal qty = 8.14; // BigDecimal | This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value.
        String batchNumber = batchNumber_example; // String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
        String owner = owner_example; // String | Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock.
        String serialNumber = serialNumber_example; // String | Optional serial number (only one can be specified). So far not supported.

        try {
            LocationListJS result = apiInstance.inspectionPut(article, action, orderNumber, location, qty, batchNumber, owner, serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#inspectionPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String article = new String(); // String | The article number.
final String action = new String(); // String | What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available.
final String orderNumber = new String(); // String | This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles.
final String location = new String(); // String | Optionally support for specifying a specific location where the articles are stored.
final BigDecimal qty = new BigDecimal(); // BigDecimal | This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value.
final String batchNumber = new String(); // String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
final String owner = new String(); // String | Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock.
final String serialNumber = new String(); // String | Optional serial number (only one can be specified). So far not supported.

try {
    final result = await api_instance.inspectionPut(article, action, orderNumber, location, qty, batchNumber, owner, serialNumber);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->inspectionPut: $e\n');
}

import org.openapitools.client.api.InventoryApi;

public class InventoryApiExample {
    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        String article = article_example; // String | The article number.
        String action = action_example; // String | What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available.
        String orderNumber = orderNumber_example; // String | This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles.
        String location = location_example; // String | Optionally support for specifying a specific location where the articles are stored.
        BigDecimal qty = 8.14; // BigDecimal | This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value.
        String batchNumber = batchNumber_example; // String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
        String owner = owner_example; // String | Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock.
        String serialNumber = serialNumber_example; // String | Optional serial number (only one can be specified). So far not supported.

        try {
            LocationListJS result = apiInstance.inspectionPut(article, action, orderNumber, location, qty, batchNumber, owner, serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#inspectionPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InventoryApi *apiInstance = [[InventoryApi alloc] init];
String *article = article_example; // The article number. (default to null)
String *action = action_example; // What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available. (default to null)
String *orderNumber = orderNumber_example; // This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles. (default to null)
String *location = location_example; // Optionally support for specifying a specific location where the articles are stored. (optional) (default to null)
BigDecimal *qty = 8.14; // This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value. (optional) (default to null)
String *batchNumber = batchNumber_example; // Batch numbers for inventoring orders are actually not supported and will be ignored if specified. (optional) (default to null)
String *owner = owner_example; // Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock. (optional) (default to null)
String *serialNumber = serialNumber_example; // Optional serial number (only one can be specified). So far not supported. (optional) (default to null)

// Maintain articles that was stored for inspection. Default is release stock that was locked until quality inspection has been fullfilled. Can also be used to reject inspected articles, by setting the passed flag to false.
[apiInstance inspectionPutWith:article
    action:action
    orderNumber:orderNumber
    location:location
    qty:qty
    batchNumber:batchNumber
    owner:owner
    serialNumber:serialNumber
              completionHandler: ^(LocationListJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.InventoryApi()
var article = article_example; // {String} The article number.
var action = action_example; // {String} What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available.
var orderNumber = orderNumber_example; // {String} This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles.
var opts = {
  'location': location_example, // {String} Optionally support for specifying a specific location where the articles are stored.
  'qty': 8.14, // {BigDecimal} This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value.
  'batchNumber': batchNumber_example, // {String} Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
  'owner': owner_example, // {String} Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock.
  'serialNumber': serialNumber_example // {String} Optional serial number (only one can be specified). So far not supported.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.inspectionPut(article, action, orderNumber, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class inspectionPutExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InventoryApi();
            var article = article_example;  // String | The article number. (default to null)
            var action = action_example;  // String | What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available. (default to null)
            var orderNumber = orderNumber_example;  // String | This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles. (default to null)
            var location = location_example;  // String | Optionally support for specifying a specific location where the articles are stored. (optional)  (default to null)
            var qty = 8.14;  // BigDecimal | This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value. (optional)  (default to null)
            var batchNumber = batchNumber_example;  // String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified. (optional)  (default to null)
            var owner = owner_example;  // String | Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock. (optional)  (default to null)
            var serialNumber = serialNumber_example;  // String | Optional serial number (only one can be specified). So far not supported. (optional)  (default to null)

            try {
                // Maintain articles that was stored for inspection. Default is release stock that was locked until quality inspection has been fullfilled. Can also be used to reject inspected articles, by setting the passed flag to false.
                LocationListJS result = apiInstance.inspectionPut(article, action, orderNumber, location, qty, batchNumber, owner, serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InventoryApi.inspectionPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InventoryApi();
$article = article_example; // String | The article number.
$action = action_example; // String | What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available.
$orderNumber = orderNumber_example; // String | This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles.
$location = location_example; // String | Optionally support for specifying a specific location where the articles are stored.
$qty = 8.14; // BigDecimal | This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value.
$batchNumber = batchNumber_example; // String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
$owner = owner_example; // String | Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock.
$serialNumber = serialNumber_example; // String | Optional serial number (only one can be specified). So far not supported.

try {
    $result = $api_instance->inspectionPut($article, $action, $orderNumber, $location, $qty, $batchNumber, $owner, $serialNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->inspectionPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InventoryApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InventoryApi->new();
my $article = article_example; # String | The article number.
my $action = action_example; # String | What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available.
my $orderNumber = orderNumber_example; # String | This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles.
my $location = location_example; # String | Optionally support for specifying a specific location where the articles are stored.
my $qty = 8.14; # BigDecimal | This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value.
my $batchNumber = batchNumber_example; # String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
my $owner = owner_example; # String | Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock.
my $serialNumber = serialNumber_example; # String | Optional serial number (only one can be specified). So far not supported.

eval {
    my $result = $api_instance->inspectionPut(article => $article, action => $action, orderNumber => $orderNumber, location => $location, qty => $qty, batchNumber => $batchNumber, owner => $owner, serialNumber => $serialNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryApi->inspectionPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InventoryApi()
article = article_example # String | The article number. (default to null)
action = action_example # String | What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available. (default to null)
orderNumber = orderNumber_example # String | This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles. (default to null)
location = location_example # String | Optionally support for specifying a specific location where the articles are stored. (optional) (default to null)
qty = 8.14 # BigDecimal | This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value. (optional) (default to null)
batchNumber = batchNumber_example # String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified. (optional) (default to null)
owner = owner_example # String | Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock. (optional) (default to null)
serialNumber = serialNumber_example # String | Optional serial number (only one can be specified). So far not supported. (optional) (default to null)

try:
    # Maintain articles that was stored for inspection. Default is release stock that was locked until quality inspection has been fullfilled. Can also be used to reject inspected articles, by setting the passed flag to false.
    api_response = api_instance.inspection_put(article, action, orderNumber, location=location, qty=qty, batchNumber=batchNumber, owner=owner, serialNumber=serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->inspectionPut: %s\n" % e)
extern crate InventoryApi;

pub fn main() {
    let article = article_example; // String
    let action = action_example; // String
    let orderNumber = orderNumber_example; // String
    let location = location_example; // String
    let qty = 8.14; // BigDecimal
    let batchNumber = batchNumber_example; // String
    let owner = owner_example; // String
    let serialNumber = serialNumber_example; // String

    let mut context = InventoryApi::Context::default();
    let result = client.inspectionPut(article, action, orderNumber, location, qty, batchNumber, owner, serialNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
article*
String
The article number.
Required
location
String
Optionally support for specifying a specific location where the articles are stored.
qty
BigDecimal
This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value.
action*
String
What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available.
Required
batchNumber
String
Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
owner
String
Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock.
orderNumber*
String
This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles.
Required
serialNumber
String
Optional serial number (only one can be specified). So far not supported.

Responses


locationsGet

Get all locations

Return a list of all locations including stock


/locations

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/locations?locationaddress=locationaddress_example&page=8.14&pageSize=8.14"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InventoryApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InventoryApi apiInstance = new InventoryApi();
        String locationaddress = locationaddress_example; // String | Optional location address to search for. A procent sign can be used for pattern matching.
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

        try {
            LocationListJS result = apiInstance.locationsGet(locationaddress, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#locationsGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String locationaddress = new String(); // String | Optional location address to search for. A procent sign can be used for pattern matching.
final BigDecimal page = new BigDecimal(); // BigDecimal | Page number if the response is paged.
final BigDecimal pageSize = new BigDecimal(); // BigDecimal | Number of returned rows in the response set.

try {
    final result = await api_instance.locationsGet(locationaddress, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->locationsGet: $e\n');
}

import org.openapitools.client.api.InventoryApi;

public class InventoryApiExample {
    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        String locationaddress = locationaddress_example; // String | Optional location address to search for. A procent sign can be used for pattern matching.
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

        try {
            LocationListJS result = apiInstance.locationsGet(locationaddress, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#locationsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InventoryApi *apiInstance = [[InventoryApi alloc] init];
String *locationaddress = locationaddress_example; // Optional location address to search for. A procent sign can be used for pattern matching. (optional) (default to null)
BigDecimal *page = 8.14; // Page number if the response is paged. (optional) (default to null)
BigDecimal *pageSize = 8.14; // Number of returned rows in the response set. (optional) (default to null)

// Get all locations
[apiInstance locationsGetWith:locationaddress
    page:page
    pageSize:pageSize
              completionHandler: ^(LocationListJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.InventoryApi()
var opts = {
  'locationaddress': locationaddress_example, // {String} Optional location address to search for. A procent sign can be used for pattern matching.
  'page': 8.14, // {BigDecimal} Page number if the response is paged.
  'pageSize': 8.14 // {BigDecimal} Number of returned rows in the response set.
};

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

namespace Example
{
    public class locationsGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InventoryApi();
            var locationaddress = locationaddress_example;  // String | Optional location address to search for. A procent sign can be used for pattern matching. (optional)  (default to null)
            var page = 8.14;  // BigDecimal | Page number if the response is paged. (optional)  (default to null)
            var pageSize = 8.14;  // BigDecimal | Number of returned rows in the response set. (optional)  (default to null)

            try {
                // Get all locations
                LocationListJS result = apiInstance.locationsGet(locationaddress, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InventoryApi.locationsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InventoryApi();
$locationaddress = locationaddress_example; // String | Optional location address to search for. A procent sign can be used for pattern matching.
$page = 8.14; // BigDecimal | Page number if the response is paged.
$pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

try {
    $result = $api_instance->locationsGet($locationaddress, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->locationsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InventoryApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InventoryApi->new();
my $locationaddress = locationaddress_example; # String | Optional location address to search for. A procent sign can be used for pattern matching.
my $page = 8.14; # BigDecimal | Page number if the response is paged.
my $pageSize = 8.14; # BigDecimal | Number of returned rows in the response set.

eval {
    my $result = $api_instance->locationsGet(locationaddress => $locationaddress, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryApi->locationsGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InventoryApi()
locationaddress = locationaddress_example # String | Optional location address to search for. A procent sign can be used for pattern matching. (optional) (default to null)
page = 8.14 # BigDecimal | Page number if the response is paged. (optional) (default to null)
pageSize = 8.14 # BigDecimal | Number of returned rows in the response set. (optional) (default to null)

try:
    # Get all locations
    api_response = api_instance.locations_get(locationaddress=locationaddress, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->locationsGet: %s\n" % e)
extern crate InventoryApi;

pub fn main() {
    let locationaddress = locationaddress_example; // String
    let page = 8.14; // BigDecimal
    let pageSize = 8.14; // BigDecimal

    let mut context = InventoryApi::Context::default();
    let result = client.locationsGet(locationaddress, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
locationaddress
String
Optional location address to search for. A procent sign can be used for pattern matching.
page
BigDecimal
Page number if the response is paged.
pageSize
BigDecimal
Number of returned rows in the response set.

Responses


lockBatchNumberPut

Lock stock by batch number

Lock or unlock locations by batch number. This might be used to avoid picking from a specific batch number, for example if the batch is expired.


/lockBatchNumber

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/lockBatchNumber?article=article_example&owner=owner_example&batchNumber=batchNumber_example&lock=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InventoryApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InventoryApi apiInstance = new InventoryApi();
        String article = article_example; // String | The article number.
        String batchNumber = batchNumber_example; // String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
        Boolean lock = true; // Boolean | Lock or unlock the locations.
        String owner = owner_example; // String | Optional owner of the article number.

        try {
            LocationListJS result = apiInstance.lockBatchNumberPut(article, batchNumber, lock, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#lockBatchNumberPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String article = new String(); // String | The article number.
final String batchNumber = new String(); // String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
final Boolean lock = new Boolean(); // Boolean | Lock or unlock the locations.
final String owner = new String(); // String | Optional owner of the article number.

try {
    final result = await api_instance.lockBatchNumberPut(article, batchNumber, lock, owner);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->lockBatchNumberPut: $e\n');
}

import org.openapitools.client.api.InventoryApi;

public class InventoryApiExample {
    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        String article = article_example; // String | The article number.
        String batchNumber = batchNumber_example; // String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
        Boolean lock = true; // Boolean | Lock or unlock the locations.
        String owner = owner_example; // String | Optional owner of the article number.

        try {
            LocationListJS result = apiInstance.lockBatchNumberPut(article, batchNumber, lock, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#lockBatchNumberPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InventoryApi *apiInstance = [[InventoryApi alloc] init];
String *article = article_example; // The article number. (default to null)
String *batchNumber = batchNumber_example; // Batch numbers for inventoring orders are actually not supported and will be ignored if specified. (default to null)
Boolean *lock = true; // Lock or unlock the locations. (default to null)
String *owner = owner_example; // Optional owner of the article number. (optional) (default to null)

// Lock stock by batch number
[apiInstance lockBatchNumberPutWith:article
    batchNumber:batchNumber
    lock:lock
    owner:owner
              completionHandler: ^(LocationListJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.InventoryApi()
var article = article_example; // {String} The article number.
var batchNumber = batchNumber_example; // {String} Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
var lock = true; // {Boolean} Lock or unlock the locations.
var opts = {
  'owner': owner_example // {String} Optional owner of the article number.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.lockBatchNumberPut(article, batchNumber, lock, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class lockBatchNumberPutExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InventoryApi();
            var article = article_example;  // String | The article number. (default to null)
            var batchNumber = batchNumber_example;  // String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified. (default to null)
            var lock = true;  // Boolean | Lock or unlock the locations. (default to null)
            var owner = owner_example;  // String | Optional owner of the article number. (optional)  (default to null)

            try {
                // Lock stock by batch number
                LocationListJS result = apiInstance.lockBatchNumberPut(article, batchNumber, lock, owner);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InventoryApi.lockBatchNumberPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InventoryApi();
$article = article_example; // String | The article number.
$batchNumber = batchNumber_example; // String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
$lock = true; // Boolean | Lock or unlock the locations.
$owner = owner_example; // String | Optional owner of the article number.

try {
    $result = $api_instance->lockBatchNumberPut($article, $batchNumber, $lock, $owner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->lockBatchNumberPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InventoryApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InventoryApi->new();
my $article = article_example; # String | The article number.
my $batchNumber = batchNumber_example; # String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
my $lock = true; # Boolean | Lock or unlock the locations.
my $owner = owner_example; # String | Optional owner of the article number.

eval {
    my $result = $api_instance->lockBatchNumberPut(article => $article, batchNumber => $batchNumber, lock => $lock, owner => $owner);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryApi->lockBatchNumberPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InventoryApi()
article = article_example # String | The article number. (default to null)
batchNumber = batchNumber_example # String | Batch numbers for inventoring orders are actually not supported and will be ignored if specified. (default to null)
lock = true # Boolean | Lock or unlock the locations. (default to null)
owner = owner_example # String | Optional owner of the article number. (optional) (default to null)

try:
    # Lock stock by batch number
    api_response = api_instance.lock_batch_number_put(article, batchNumber, lock, owner=owner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->lockBatchNumberPut: %s\n" % e)
extern crate InventoryApi;

pub fn main() {
    let article = article_example; // String
    let batchNumber = batchNumber_example; // String
    let lock = true; // Boolean
    let owner = owner_example; // String

    let mut context = InventoryApi::Context::default();
    let result = client.lockBatchNumberPut(article, batchNumber, lock, owner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
article*
String
The article number.
Required
owner
String
Optional owner of the article number.
batchNumber*
String
Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
Required
lock*
Boolean
Lock or unlock the locations.
Required

Responses


stockreportGet

Get a stock report from system.

Return a complete stock report as a snapshot when the call is received. If it is used to compare stock with and ERP system, it is important to avoid any stock movements while the report is generated.


/stockreport

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/stockreport?articleNumber=ART001&page=8.14&pageSize=8.14&detailed=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InventoryApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InventoryApi apiInstance = new InventoryApi();
        String articleNumber = ART001; // String | The specify an article number to return info for only this number.
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.
        Boolean detailed = true; // Boolean | If true, the report will include detailed location information and batch numbers. Note this will slow down
the response time significantly, especially for large stocks and timeouts is a risk.


        try {
            StockListJS result = apiInstance.stockreportGet(articleNumber, page, pageSize, detailed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#stockreportGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String articleNumber = new String(); // String | The specify an article number to return info for only this number.
final BigDecimal page = new BigDecimal(); // BigDecimal | Page number if the response is paged.
final BigDecimal pageSize = new BigDecimal(); // BigDecimal | Number of returned rows in the response set.
final Boolean detailed = new Boolean(); // Boolean | If true, the report will include detailed location information and batch numbers. Note this will slow down
the response time significantly, especially for large stocks and timeouts is a risk.


try {
    final result = await api_instance.stockreportGet(articleNumber, page, pageSize, detailed);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->stockreportGet: $e\n');
}

import org.openapitools.client.api.InventoryApi;

public class InventoryApiExample {
    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        String articleNumber = ART001; // String | The specify an article number to return info for only this number.
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.
        Boolean detailed = true; // Boolean | If true, the report will include detailed location information and batch numbers. Note this will slow down
the response time significantly, especially for large stocks and timeouts is a risk.


        try {
            StockListJS result = apiInstance.stockreportGet(articleNumber, page, pageSize, detailed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#stockreportGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InventoryApi *apiInstance = [[InventoryApi alloc] init];
String *articleNumber = ART001; // The specify an article number to return info for only this number. (optional) (default to null)
BigDecimal *page = 8.14; // Page number if the response is paged. (optional) (default to null)
BigDecimal *pageSize = 8.14; // Number of returned rows in the response set. (optional) (default to null)
Boolean *detailed = true; // If true, the report will include detailed location information and batch numbers. Note this will slow down
the response time significantly, especially for large stocks and timeouts is a risk.
 (optional) (default to false)

// Get a stock report from system.
[apiInstance stockreportGetWith:articleNumber
    page:page
    pageSize:pageSize
    detailed:detailed
              completionHandler: ^(StockListJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.InventoryApi()
var opts = {
  'articleNumber': ART001, // {String} The specify an article number to return info for only this number.
  'page': 8.14, // {BigDecimal} Page number if the response is paged.
  'pageSize': 8.14, // {BigDecimal} Number of returned rows in the response set.
  'detailed': true // {Boolean} If true, the report will include detailed location information and batch numbers. Note this will slow down
the response time significantly, especially for large stocks and timeouts is a risk.

};

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

namespace Example
{
    public class stockreportGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InventoryApi();
            var articleNumber = ART001;  // String | The specify an article number to return info for only this number. (optional)  (default to null)
            var page = 8.14;  // BigDecimal | Page number if the response is paged. (optional)  (default to null)
            var pageSize = 8.14;  // BigDecimal | Number of returned rows in the response set. (optional)  (default to null)
            var detailed = true;  // Boolean | If true, the report will include detailed location information and batch numbers. Note this will slow down
the response time significantly, especially for large stocks and timeouts is a risk.
 (optional)  (default to false)

            try {
                // Get a stock report from system.
                StockListJS result = apiInstance.stockreportGet(articleNumber, page, pageSize, detailed);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InventoryApi.stockreportGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InventoryApi();
$articleNumber = ART001; // String | The specify an article number to return info for only this number.
$page = 8.14; // BigDecimal | Page number if the response is paged.
$pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.
$detailed = true; // Boolean | If true, the report will include detailed location information and batch numbers. Note this will slow down
the response time significantly, especially for large stocks and timeouts is a risk.


try {
    $result = $api_instance->stockreportGet($articleNumber, $page, $pageSize, $detailed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->stockreportGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InventoryApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InventoryApi->new();
my $articleNumber = ART001; # String | The specify an article number to return info for only this number.
my $page = 8.14; # BigDecimal | Page number if the response is paged.
my $pageSize = 8.14; # BigDecimal | Number of returned rows in the response set.
my $detailed = true; # Boolean | If true, the report will include detailed location information and batch numbers. Note this will slow down
the response time significantly, especially for large stocks and timeouts is a risk.


eval {
    my $result = $api_instance->stockreportGet(articleNumber => $articleNumber, page => $page, pageSize => $pageSize, detailed => $detailed);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryApi->stockreportGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InventoryApi()
articleNumber = ART001 # String | The specify an article number to return info for only this number. (optional) (default to null)
page = 8.14 # BigDecimal | Page number if the response is paged. (optional) (default to null)
pageSize = 8.14 # BigDecimal | Number of returned rows in the response set. (optional) (default to null)
detailed = true # Boolean | If true, the report will include detailed location information and batch numbers. Note this will slow down
the response time significantly, especially for large stocks and timeouts is a risk.
 (optional) (default to false)

try:
    # Get a stock report from system.
    api_response = api_instance.stockreport_get(articleNumber=articleNumber, page=page, pageSize=pageSize, detailed=detailed)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->stockreportGet: %s\n" % e)
extern crate InventoryApi;

pub fn main() {
    let articleNumber = ART001; // String
    let page = 8.14; // BigDecimal
    let pageSize = 8.14; // BigDecimal
    let detailed = true; // Boolean

    let mut context = InventoryApi::Context::default();
    let result = client.stockreportGet(articleNumber, page, pageSize, detailed, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
articleNumber
String
The specify an article number to return info for only this number.
page
BigDecimal
Page number if the response is paged.
pageSize
BigDecimal
Number of returned rows in the response set.
detailed
Boolean
If true, the report will include detailed location information and batch numbers. Note this will slow down the response time significantly, especially for large stocks and timeouts is a risk.

Responses


Orders

confirm

Get acknowledgements from executed orders.

Returns information about order transactions that has been fullfilled or canceled. Confirmations are logged as documents with an ID number. Store the returned next id and use that for the next call. The confirmations can be generated at order, order line or at transaction level, depending on the configured confirmation mode.


/confirmation

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/confirmation?nextID=56&maxdocs=56&expandPartLists=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        Integer nextID = 56; // Integer | Return all confirmations from this ID and forward.
        Integer maxdocs = 56; // Integer | The maximum number of entries to return.
        Boolean expandPartLists = true; // Boolean | Set to true to return detailed information about part lists in the order.

        try {
            OrderConfirmationListJS result = apiInstance.confirm(nextID, maxdocs, expandPartLists);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#confirm");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer nextID = new Integer(); // Integer | Return all confirmations from this ID and forward.
final Integer maxdocs = new Integer(); // Integer | The maximum number of entries to return.
final Boolean expandPartLists = new Boolean(); // Boolean | Set to true to return detailed information about part lists in the order.

try {
    final result = await api_instance.confirm(nextID, maxdocs, expandPartLists);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->confirm: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        Integer nextID = 56; // Integer | Return all confirmations from this ID and forward.
        Integer maxdocs = 56; // Integer | The maximum number of entries to return.
        Boolean expandPartLists = true; // Boolean | Set to true to return detailed information about part lists in the order.

        try {
            OrderConfirmationListJS result = apiInstance.confirm(nextID, maxdocs, expandPartLists);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#confirm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
Integer *nextID = 56; // Return all confirmations from this ID and forward. (default to null)
Integer *maxdocs = 56; // The maximum number of entries to return. (optional) (default to null)
Boolean *expandPartLists = true; // Set to true to return detailed information about part lists in the order. (optional) (default to null)

// Get acknowledgements from executed orders.
[apiInstance confirmWith:nextID
    maxdocs:maxdocs
    expandPartLists:expandPartLists
              completionHandler: ^(OrderConfirmationListJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.OrdersApi()
var nextID = 56; // {Integer} Return all confirmations from this ID and forward.
var opts = {
  'maxdocs': 56, // {Integer} The maximum number of entries to return.
  'expandPartLists': true // {Boolean} Set to true to return detailed information about part lists in the order.
};

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

namespace Example
{
    public class confirmExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var nextID = 56;  // Integer | Return all confirmations from this ID and forward. (default to null)
            var maxdocs = 56;  // Integer | The maximum number of entries to return. (optional)  (default to null)
            var expandPartLists = true;  // Boolean | Set to true to return detailed information about part lists in the order. (optional)  (default to null)

            try {
                // Get acknowledgements from executed orders.
                OrderConfirmationListJS result = apiInstance.confirm(nextID, maxdocs, expandPartLists);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.confirm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$nextID = 56; // Integer | Return all confirmations from this ID and forward.
$maxdocs = 56; // Integer | The maximum number of entries to return.
$expandPartLists = true; // Boolean | Set to true to return detailed information about part lists in the order.

try {
    $result = $api_instance->confirm($nextID, $maxdocs, $expandPartLists);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->confirm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $nextID = 56; # Integer | Return all confirmations from this ID and forward.
my $maxdocs = 56; # Integer | The maximum number of entries to return.
my $expandPartLists = true; # Boolean | Set to true to return detailed information about part lists in the order.

eval {
    my $result = $api_instance->confirm(nextID => $nextID, maxdocs => $maxdocs, expandPartLists => $expandPartLists);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->confirm: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
nextID = 56 # Integer | Return all confirmations from this ID and forward. (default to null)
maxdocs = 56 # Integer | The maximum number of entries to return. (optional) (default to null)
expandPartLists = true # Boolean | Set to true to return detailed information about part lists in the order. (optional) (default to null)

try:
    # Get acknowledgements from executed orders.
    api_response = api_instance.confirm(nextID, maxdocs=maxdocs, expandPartLists=expandPartLists)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->confirm: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let nextID = 56; // Integer
    let maxdocs = 56; // Integer
    let expandPartLists = true; // Boolean

    let mut context = OrdersApi::Context::default();
    let result = client.confirm(nextID, maxdocs, expandPartLists, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
nextID*
Integer
Return all confirmations from this ID and forward.
Required
maxdocs
Integer
The maximum number of entries to return.
expandPartLists
Boolean
Set to true to return detailed information about part lists in the order.

Responses


order

Create a new order in SHARK.

Used to create all kind of orders in SHARK, like inbound, outbound and stock counting. The OrderTypeID defines the type of the order. Simple json example of an outbound order, orderTypeID=1 tells Shark it is an outbound order (pick) : ``` { "orderNumber": "ORDER001", "orderTypeID": 1, "orderline": [ { "articleNumber": "ARTICLE123", "qty": 1, }, { "articleNumber": "ARTICLE789", "qty": 3, } ] } ``` An inbound order (goods reception) would look like: ``` { "orderNumber": "PURCHASE001", "orderTypeID": 2, "orderline": [ { "articleNumber": "ARTICLE123", "qty": 100, } ] } ``` The same order format can also be used to request a stock counting with a list of article numbers: ``` { "orderNumber": "COUNTING001", "orderTypeID": 19, "orderline": [ { "articleNumber": "ARTICLE123" }, { "articleNumber": "ARTICLE789" } ] } ```


/order

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://restapi.sharkwms.com/1.3/order" \
 -d '{
  "owner" : "owner",
  "note" : "note",
  "orderNumber" : "ORD0001",
  "shipment" : "shipment",
  "deliveryTime" : "12:45:00",
  "orderTypeID" : 1,
  "priority" : 127,
  "partlist" : [ {
    "partlistline" : [ {
      "articleNumber" : "articleNumber",
      "qty" : 596213.1992415349,
      "lineNumber" : 1
    }, {
      "articleNumber" : "articleNumber",
      "qty" : 596213.1992415349,
      "lineNumber" : 1
    } ],
    "asSubOrder" : false,
    "qty" : 602745.4128158037,
    "storePickPartList" : false,
    "orderTypeID" : 9613.126243464114,
    "partListNumber" : "partListNumber"
  }, {
    "partlistline" : [ {
      "articleNumber" : "articleNumber",
      "qty" : 596213.1992415349,
      "lineNumber" : 1
    }, {
      "articleNumber" : "articleNumber",
      "qty" : 596213.1992415349,
      "lineNumber" : 1
    } ],
    "asSubOrder" : false,
    "qty" : 602745.4128158037,
    "storePickPartList" : false,
    "orderTypeID" : 9613.126243464114,
    "partListNumber" : "partListNumber"
  } ],
  "tour" : "tour",
  "orderline" : [ {
    "note" : "note",
    "auto" : false,
    "articleDescription" : "articleDescription",
    "serialNumbers" : [ {
      "number" : "number"
    }, {
      "number" : "number"
    } ],
    "batchDate" : "2000-01-23",
    "unit" : "unit",
    "articleNumber" : "articleNumber",
    "qty" : 80082.7389632821,
    "qualityInspection" : true,
    "reservation" : "reservation",
    "expireDate" : "2027-09-01",
    "location" : "location",
    "lineNumber" : 1,
    "targetZone" : "targetZone",
    "batchNumber" : "batchNumber",
    "misc" : {
      "misc1" : "misc1",
      "misc3" : "misc3",
      "misc10" : "misc10",
      "misc2" : "misc2",
      "misc5" : "misc5",
      "misc4" : "misc4",
      "misc7" : "misc7",
      "misc6" : "misc6",
      "misc9" : "misc9",
      "misc8" : "misc8"
    }
  }, {
    "note" : "note",
    "auto" : false,
    "articleDescription" : "articleDescription",
    "serialNumbers" : [ {
      "number" : "number"
    }, {
      "number" : "number"
    } ],
    "batchDate" : "2000-01-23",
    "unit" : "unit",
    "articleNumber" : "articleNumber",
    "qty" : 80082.7389632821,
    "qualityInspection" : true,
    "reservation" : "reservation",
    "expireDate" : "2027-09-01",
    "location" : "location",
    "lineNumber" : 1,
    "targetZone" : "targetZone",
    "batchNumber" : "batchNumber",
    "misc" : {
      "misc1" : "misc1",
      "misc3" : "misc3",
      "misc10" : "misc10",
      "misc2" : "misc2",
      "misc5" : "misc5",
      "misc4" : "misc4",
      "misc7" : "misc7",
      "misc6" : "misc6",
      "misc9" : "misc9",
      "misc8" : "misc8"
    }
  } ],
  "carrier" : "carrier",
  "userFields" : [ {
    "parameterType" : "TEXT",
    "parameterName" : "parameterName",
    "parameterValue" : "parameterValue"
  }, {
    "parameterType" : "TEXT",
    "parameterName" : "parameterName",
    "parameterValue" : "parameterValue"
  } ],
  "gate" : "gate",
  "deliveryDate" : "2025-05-02",
  "deliveryaddress" : [ {
    "addressLine8" : "addressLine8",
    "addressLine9" : "addressLine9",
    "addressLine10" : "addressLine10",
    "addressLine1" : "addressLine1",
    "addressLine2" : "addressLine2",
    "addressLine3" : "addressLine3",
    "addressLine4" : "addressLine4",
    "addressLine5" : "addressLine5",
    "addressLine6" : "addressLine6",
    "addressLine7" : "addressLine7"
  }, {
    "addressLine8" : "addressLine8",
    "addressLine9" : "addressLine9",
    "addressLine10" : "addressLine10",
    "addressLine1" : "addressLine1",
    "addressLine2" : "addressLine2",
    "addressLine3" : "addressLine3",
    "addressLine4" : "addressLine4",
    "addressLine5" : "addressLine5",
    "addressLine6" : "addressLine6",
    "addressLine7" : "addressLine7"
  } ],
  "deliveryNoteNumber" : "deliveryNoteNumber",
  "customer" : {
    "reference" : "reference",
    "zipCode" : "zipCode",
    "country" : "country",
    "city" : "city",
    "phone" : "phone",
    "street" : "street",
    "customerNumber" : "customerNumber",
    "customerName" : "customerName",
    "email" : "email"
  },
  "misc" : {
    "misc1" : "misc1",
    "misc3" : "misc3",
    "misc10" : "misc10",
    "misc2" : "misc2",
    "misc5" : "misc5",
    "misc4" : "misc4",
    "misc7" : "misc7",
    "misc6" : "misc6",
    "misc9" : "misc9",
    "misc8" : "misc8"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        OrderJS orderJS = ; // OrderJS | 

        try {
            apiInstance.order(orderJS);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#order");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final OrderJS orderJS = new OrderJS(); // OrderJS | 

try {
    final result = await api_instance.order(orderJS);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->order: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        OrderJS orderJS = ; // OrderJS | 

        try {
            apiInstance.order(orderJS);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#order");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
OrderJS *orderJS = ; //  (optional)

// Create a new order in SHARK.
[apiInstance orderWith:orderJS
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.OrdersApi()
var opts = {
  'orderJS':  // {OrderJS} 
};

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

namespace Example
{
    public class orderExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var orderJS = new OrderJS(); // OrderJS |  (optional) 

            try {
                // Create a new order in SHARK.
                apiInstance.order(orderJS);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.order: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$orderJS = ; // OrderJS | 

try {
    $api_instance->order($orderJS);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->order: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $orderJS = WWW::OPenAPIClient::Object::OrderJS->new(); # OrderJS | 

eval {
    $api_instance->order(orderJS => $orderJS);
};
if ($@) {
    warn "Exception when calling OrdersApi->order: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
orderJS =  # OrderJS |  (optional)

try:
    # Create a new order in SHARK.
    api_instance.order(orderJS=orderJS)
except ApiException as e:
    print("Exception when calling OrdersApi->order: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let orderJS = ; // OrderJS

    let mut context = OrdersApi::Context::default();
    let result = client.order(orderJS, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
orderJS

Order to add

Responses


orderDelete

Delete an order from SHARK

Delete an order from SHARK. This is only possible, if the order is not working. Actually the order is only cancelled, it will still exists, but is not visible. When the order is cancelled, it can be overwritten with a new order with same order number.


/order

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://restapi.sharkwms.com/1.3/order?orderNumber=ORD0001&deliveryNoteNumber=deliveryNoteNumber_example&orderTypeID=8.14&owner=owner_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = ORD0001; // String | Order Number
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
        BigDecimal orderTypeID = 8.14; // BigDecimal | Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK.
        String owner = owner_example; // String | Owner

        try {
            apiInstance.orderDelete(orderNumber, deliveryNoteNumber, orderTypeID, owner);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#orderDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String orderNumber = new String(); // String | Order Number
final String deliveryNoteNumber = new String(); // String | Delivery Note Number
final BigDecimal orderTypeID = new BigDecimal(); // BigDecimal | Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK.
final String owner = new String(); // String | Owner

try {
    final result = await api_instance.orderDelete(orderNumber, deliveryNoteNumber, orderTypeID, owner);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->orderDelete: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = ORD0001; // String | Order Number
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
        BigDecimal orderTypeID = 8.14; // BigDecimal | Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK.
        String owner = owner_example; // String | Owner

        try {
            apiInstance.orderDelete(orderNumber, deliveryNoteNumber, orderTypeID, owner);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#orderDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
String *orderNumber = ORD0001; // Order Number (default to null)
String *deliveryNoteNumber = deliveryNoteNumber_example; // Delivery Note Number (optional) (default to null)
BigDecimal *orderTypeID = 8.14; // Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK. (optional) (default to null)
String *owner = owner_example; // Owner (optional) (default to null)

// Delete an order from SHARK
[apiInstance orderDeleteWith:orderNumber
    deliveryNoteNumber:deliveryNoteNumber
    orderTypeID:orderTypeID
    owner:owner
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.OrdersApi()
var orderNumber = ORD0001; // {String} Order Number
var opts = {
  'deliveryNoteNumber': deliveryNoteNumber_example, // {String} Delivery Note Number
  'orderTypeID': 8.14, // {BigDecimal} Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK.
  'owner': owner_example // {String} Owner
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.orderDelete(orderNumber, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class orderDeleteExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var orderNumber = ORD0001;  // String | Order Number (default to null)
            var deliveryNoteNumber = deliveryNoteNumber_example;  // String | Delivery Note Number (optional)  (default to null)
            var orderTypeID = 8.14;  // BigDecimal | Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK. (optional)  (default to null)
            var owner = owner_example;  // String | Owner (optional)  (default to null)

            try {
                // Delete an order from SHARK
                apiInstance.orderDelete(orderNumber, deliveryNoteNumber, orderTypeID, owner);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.orderDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$orderNumber = ORD0001; // String | Order Number
$deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
$orderTypeID = 8.14; // BigDecimal | Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK.
$owner = owner_example; // String | Owner

try {
    $api_instance->orderDelete($orderNumber, $deliveryNoteNumber, $orderTypeID, $owner);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->orderDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $orderNumber = ORD0001; # String | Order Number
my $deliveryNoteNumber = deliveryNoteNumber_example; # String | Delivery Note Number
my $orderTypeID = 8.14; # BigDecimal | Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK.
my $owner = owner_example; # String | Owner

eval {
    $api_instance->orderDelete(orderNumber => $orderNumber, deliveryNoteNumber => $deliveryNoteNumber, orderTypeID => $orderTypeID, owner => $owner);
};
if ($@) {
    warn "Exception when calling OrdersApi->orderDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
orderNumber = ORD0001 # String | Order Number (default to null)
deliveryNoteNumber = deliveryNoteNumber_example # String | Delivery Note Number (optional) (default to null)
orderTypeID = 8.14 # BigDecimal | Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK. (optional) (default to null)
owner = owner_example # String | Owner (optional) (default to null)

try:
    # Delete an order from SHARK
    api_instance.order_delete(orderNumber, deliveryNoteNumber=deliveryNoteNumber, orderTypeID=orderTypeID, owner=owner)
except ApiException as e:
    print("Exception when calling OrdersApi->orderDelete: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let orderNumber = ORD0001; // String
    let deliveryNoteNumber = deliveryNoteNumber_example; // String
    let orderTypeID = 8.14; // BigDecimal
    let owner = owner_example; // String

    let mut context = OrdersApi::Context::default();
    let result = client.orderDelete(orderNumber, deliveryNoteNumber, orderTypeID, owner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
orderNumber*
String
Order Number
Required
deliveryNoteNumber
String
Delivery Note Number
orderTypeID
BigDecimal
Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK.
owner
String
Owner

Responses


orderStatusExtGet

Returns status of an order

Order status


/orderStatusExt

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/orderStatusExt?orderNumber=ORD0001&deliveryNoteNumber=deliveryNoteNumber_example&orderTypeID=56&owner=owner_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = ORD0001; // String | Order Number
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
        Integer orderTypeID = 56; // Integer | 
        String owner = owner_example; // String | Owner

        try {
            OrderStatusExtJS result = apiInstance.orderStatusExtGet(orderNumber, deliveryNoteNumber, orderTypeID, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#orderStatusExtGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String orderNumber = new String(); // String | Order Number
final String deliveryNoteNumber = new String(); // String | Delivery Note Number
final Integer orderTypeID = new Integer(); // Integer | 
final String owner = new String(); // String | Owner

try {
    final result = await api_instance.orderStatusExtGet(orderNumber, deliveryNoteNumber, orderTypeID, owner);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->orderStatusExtGet: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = ORD0001; // String | Order Number
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
        Integer orderTypeID = 56; // Integer | 
        String owner = owner_example; // String | Owner

        try {
            OrderStatusExtJS result = apiInstance.orderStatusExtGet(orderNumber, deliveryNoteNumber, orderTypeID, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#orderStatusExtGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
String *orderNumber = ORD0001; // Order Number (default to null)
String *deliveryNoteNumber = deliveryNoteNumber_example; // Delivery Note Number (optional) (default to null)
Integer *orderTypeID = 56; //  (optional) (default to null)
String *owner = owner_example; // Owner (optional) (default to null)

// Returns status of an order
[apiInstance orderStatusExtGetWith:orderNumber
    deliveryNoteNumber:deliveryNoteNumber
    orderTypeID:orderTypeID
    owner:owner
              completionHandler: ^(OrderStatusExtJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.OrdersApi()
var orderNumber = ORD0001; // {String} Order Number
var opts = {
  'deliveryNoteNumber': deliveryNoteNumber_example, // {String} Delivery Note Number
  'orderTypeID': 56, // {Integer} 
  'owner': owner_example // {String} Owner
};

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

namespace Example
{
    public class orderStatusExtGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var orderNumber = ORD0001;  // String | Order Number (default to null)
            var deliveryNoteNumber = deliveryNoteNumber_example;  // String | Delivery Note Number (optional)  (default to null)
            var orderTypeID = 56;  // Integer |  (optional)  (default to null)
            var owner = owner_example;  // String | Owner (optional)  (default to null)

            try {
                // Returns status of an order
                OrderStatusExtJS result = apiInstance.orderStatusExtGet(orderNumber, deliveryNoteNumber, orderTypeID, owner);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.orderStatusExtGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$orderNumber = ORD0001; // String | Order Number
$deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
$orderTypeID = 56; // Integer | 
$owner = owner_example; // String | Owner

try {
    $result = $api_instance->orderStatusExtGet($orderNumber, $deliveryNoteNumber, $orderTypeID, $owner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->orderStatusExtGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $orderNumber = ORD0001; # String | Order Number
my $deliveryNoteNumber = deliveryNoteNumber_example; # String | Delivery Note Number
my $orderTypeID = 56; # Integer | 
my $owner = owner_example; # String | Owner

eval {
    my $result = $api_instance->orderStatusExtGet(orderNumber => $orderNumber, deliveryNoteNumber => $deliveryNoteNumber, orderTypeID => $orderTypeID, owner => $owner);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->orderStatusExtGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
orderNumber = ORD0001 # String | Order Number (default to null)
deliveryNoteNumber = deliveryNoteNumber_example # String | Delivery Note Number (optional) (default to null)
orderTypeID = 56 # Integer |  (optional) (default to null)
owner = owner_example # String | Owner (optional) (default to null)

try:
    # Returns status of an order
    api_response = api_instance.order_status_ext_get(orderNumber, deliveryNoteNumber=deliveryNoteNumber, orderTypeID=orderTypeID, owner=owner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->orderStatusExtGet: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let orderNumber = ORD0001; // String
    let deliveryNoteNumber = deliveryNoteNumber_example; // String
    let orderTypeID = 56; // Integer
    let owner = owner_example; // String

    let mut context = OrdersApi::Context::default();
    let result = client.orderStatusExtGet(orderNumber, deliveryNoteNumber, orderTypeID, owner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
orderNumber*
String
Order Number
Required
deliveryNoteNumber
String
Delivery Note Number
orderTypeID
Integer
owner
String
Owner

Responses


orderStatusGet

Returns status of an order

Order status


/orderStatus

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/orderStatus?orderNumber=ORD0001&deliveryNoteNumber=deliveryNoteNumber_example&owner=owner_example&orderTypeID=8.14"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = ORD0001; // String | Order Number
        BigDecimal orderTypeID = 8.14; // BigDecimal | Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation.
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
        String owner = owner_example; // String | Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL.

        try {
            OrderStatusJS result = apiInstance.orderStatusGet(orderNumber, orderTypeID, deliveryNoteNumber, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#orderStatusGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String orderNumber = new String(); // String | Order Number
final BigDecimal orderTypeID = new BigDecimal(); // BigDecimal | Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation.
final String deliveryNoteNumber = new String(); // String | Delivery Note Number
final String owner = new String(); // String | Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL.

try {
    final result = await api_instance.orderStatusGet(orderNumber, orderTypeID, deliveryNoteNumber, owner);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->orderStatusGet: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = ORD0001; // String | Order Number
        BigDecimal orderTypeID = 8.14; // BigDecimal | Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation.
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
        String owner = owner_example; // String | Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL.

        try {
            OrderStatusJS result = apiInstance.orderStatusGet(orderNumber, orderTypeID, deliveryNoteNumber, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#orderStatusGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
String *orderNumber = ORD0001; // Order Number (default to null)
BigDecimal *orderTypeID = 8.14; // Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation. (default to null)
String *deliveryNoteNumber = deliveryNoteNumber_example; // Delivery Note Number (optional) (default to null)
String *owner = owner_example; // Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL. (optional) (default to null)

// Returns status of an order
[apiInstance orderStatusGetWith:orderNumber
    orderTypeID:orderTypeID
    deliveryNoteNumber:deliveryNoteNumber
    owner:owner
              completionHandler: ^(OrderStatusJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.OrdersApi()
var orderNumber = ORD0001; // {String} Order Number
var orderTypeID = 8.14; // {BigDecimal} Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation.
var opts = {
  'deliveryNoteNumber': deliveryNoteNumber_example, // {String} Delivery Note Number
  'owner': owner_example // {String} Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL.
};

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

namespace Example
{
    public class orderStatusGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var orderNumber = ORD0001;  // String | Order Number (default to null)
            var orderTypeID = 8.14;  // BigDecimal | Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation. (default to null)
            var deliveryNoteNumber = deliveryNoteNumber_example;  // String | Delivery Note Number (optional)  (default to null)
            var owner = owner_example;  // String | Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL. (optional)  (default to null)

            try {
                // Returns status of an order
                OrderStatusJS result = apiInstance.orderStatusGet(orderNumber, orderTypeID, deliveryNoteNumber, owner);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.orderStatusGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$orderNumber = ORD0001; // String | Order Number
$orderTypeID = 8.14; // BigDecimal | Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation.
$deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
$owner = owner_example; // String | Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL.

try {
    $result = $api_instance->orderStatusGet($orderNumber, $orderTypeID, $deliveryNoteNumber, $owner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->orderStatusGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $orderNumber = ORD0001; # String | Order Number
my $orderTypeID = 8.14; # BigDecimal | Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation.
my $deliveryNoteNumber = deliveryNoteNumber_example; # String | Delivery Note Number
my $owner = owner_example; # String | Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL.

eval {
    my $result = $api_instance->orderStatusGet(orderNumber => $orderNumber, orderTypeID => $orderTypeID, deliveryNoteNumber => $deliveryNoteNumber, owner => $owner);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->orderStatusGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
orderNumber = ORD0001 # String | Order Number (default to null)
orderTypeID = 8.14 # BigDecimal | Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation. (default to null)
deliveryNoteNumber = deliveryNoteNumber_example # String | Delivery Note Number (optional) (default to null)
owner = owner_example # String | Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL. (optional) (default to null)

try:
    # Returns status of an order
    api_response = api_instance.order_status_get(orderNumber, orderTypeID, deliveryNoteNumber=deliveryNoteNumber, owner=owner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->orderStatusGet: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let orderNumber = ORD0001; // String
    let orderTypeID = 8.14; // BigDecimal
    let deliveryNoteNumber = deliveryNoteNumber_example; // String
    let owner = owner_example; // String

    let mut context = OrdersApi::Context::default();
    let result = client.orderStatusGet(orderNumber, orderTypeID, deliveryNoteNumber, owner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
orderNumber*
String
Order Number
Required
deliveryNoteNumber
String
Delivery Note Number
owner
String
Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL.
orderTypeID*
BigDecimal
Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation.
Required

Responses


orderStatusPut

Change the order state to closed. Used to close an inbound or outbound order not yet fully processed.

Order status


/orderStatus

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/orderStatus?orderNumber=ORD0001&deliveryNoteNumber=deliveryNoteNumber_example&owner=owner_example&OrderTypeID=8.14&close=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = ORD0001; // String | Order Number
        BigDecimal orderTypeID = 8.14; // BigDecimal | 
        Boolean close = true; // Boolean | 
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
        String owner = owner_example; // String | Owner

        try {
            OrderStatusJS result = apiInstance.orderStatusPut(orderNumber, orderTypeID, close, deliveryNoteNumber, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#orderStatusPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String orderNumber = new String(); // String | Order Number
final BigDecimal orderTypeID = new BigDecimal(); // BigDecimal | 
final Boolean close = new Boolean(); // Boolean | 
final String deliveryNoteNumber = new String(); // String | Delivery Note Number
final String owner = new String(); // String | Owner

try {
    final result = await api_instance.orderStatusPut(orderNumber, orderTypeID, close, deliveryNoteNumber, owner);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->orderStatusPut: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = ORD0001; // String | Order Number
        BigDecimal orderTypeID = 8.14; // BigDecimal | 
        Boolean close = true; // Boolean | 
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
        String owner = owner_example; // String | Owner

        try {
            OrderStatusJS result = apiInstance.orderStatusPut(orderNumber, orderTypeID, close, deliveryNoteNumber, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#orderStatusPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
String *orderNumber = ORD0001; // Order Number (default to null)
BigDecimal *orderTypeID = 8.14; //  (default to null)
Boolean *close = true; //  (default to null)
String *deliveryNoteNumber = deliveryNoteNumber_example; // Delivery Note Number (optional) (default to null)
String *owner = owner_example; // Owner (optional) (default to null)

// Change the order state to closed. Used to close an inbound or outbound order not yet fully processed.
[apiInstance orderStatusPutWith:orderNumber
    orderTypeID:orderTypeID
    close:close
    deliveryNoteNumber:deliveryNoteNumber
    owner:owner
              completionHandler: ^(OrderStatusJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.OrdersApi()
var orderNumber = ORD0001; // {String} Order Number
var orderTypeID = 8.14; // {BigDecimal} 
var close = true; // {Boolean} 
var opts = {
  'deliveryNoteNumber': deliveryNoteNumber_example, // {String} Delivery Note Number
  'owner': owner_example // {String} Owner
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.orderStatusPut(orderNumber, orderTypeID, close, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class orderStatusPutExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var orderNumber = ORD0001;  // String | Order Number (default to null)
            var orderTypeID = 8.14;  // BigDecimal |  (default to null)
            var close = true;  // Boolean |  (default to null)
            var deliveryNoteNumber = deliveryNoteNumber_example;  // String | Delivery Note Number (optional)  (default to null)
            var owner = owner_example;  // String | Owner (optional)  (default to null)

            try {
                // Change the order state to closed. Used to close an inbound or outbound order not yet fully processed.
                OrderStatusJS result = apiInstance.orderStatusPut(orderNumber, orderTypeID, close, deliveryNoteNumber, owner);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.orderStatusPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$orderNumber = ORD0001; // String | Order Number
$orderTypeID = 8.14; // BigDecimal | 
$close = true; // Boolean | 
$deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number
$owner = owner_example; // String | Owner

try {
    $result = $api_instance->orderStatusPut($orderNumber, $orderTypeID, $close, $deliveryNoteNumber, $owner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->orderStatusPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $orderNumber = ORD0001; # String | Order Number
my $orderTypeID = 8.14; # BigDecimal | 
my $close = true; # Boolean | 
my $deliveryNoteNumber = deliveryNoteNumber_example; # String | Delivery Note Number
my $owner = owner_example; # String | Owner

eval {
    my $result = $api_instance->orderStatusPut(orderNumber => $orderNumber, orderTypeID => $orderTypeID, close => $close, deliveryNoteNumber => $deliveryNoteNumber, owner => $owner);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->orderStatusPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
orderNumber = ORD0001 # String | Order Number (default to null)
orderTypeID = 8.14 # BigDecimal |  (default to null)
close = true # Boolean |  (default to null)
deliveryNoteNumber = deliveryNoteNumber_example # String | Delivery Note Number (optional) (default to null)
owner = owner_example # String | Owner (optional) (default to null)

try:
    # Change the order state to closed. Used to close an inbound or outbound order not yet fully processed.
    api_response = api_instance.order_status_put(orderNumber, orderTypeID, close, deliveryNoteNumber=deliveryNoteNumber, owner=owner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->orderStatusPut: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let orderNumber = ORD0001; // String
    let orderTypeID = 8.14; // BigDecimal
    let close = true; // Boolean
    let deliveryNoteNumber = deliveryNoteNumber_example; // String
    let owner = owner_example; // String

    let mut context = OrdersApi::Context::default();
    let result = client.orderStatusPut(orderNumber, orderTypeID, close, deliveryNoteNumber, owner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
orderNumber*
String
Order Number
Required
deliveryNoteNumber
String
Delivery Note Number
owner
String
Owner
OrderTypeID*
BigDecimal
Required
close*
Boolean
Required

Responses


shipmentGet

Get a list of shipments.

Get a list of shipments. A shipment is a collection of orders that are shipped together. The shipment is created in SHARK and the Host system can use the shipment number to track the shipment.


/shipment

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/shipment?orderNumber=orderNumber_example&orderTypeID=8.14&deliveryNoteNumber=deliveryNoteNumber_example&owner=owner_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = orderNumber_example; // String | Order Number
        BigDecimal orderTypeID = 8.14; // BigDecimal | Page number if the response is paged.
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number.
        String owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.

        try {
            ShipmentListJS result = apiInstance.shipmentGet(orderNumber, orderTypeID, deliveryNoteNumber, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#shipmentGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String orderNumber = new String(); // String | Order Number
final BigDecimal orderTypeID = new BigDecimal(); // BigDecimal | Page number if the response is paged.
final String deliveryNoteNumber = new String(); // String | Delivery Note Number.
final String owner = new String(); // String | For sites with multiple owners of the articles, specify the actually owner.

try {
    final result = await api_instance.shipmentGet(orderNumber, orderTypeID, deliveryNoteNumber, owner);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->shipmentGet: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = orderNumber_example; // String | Order Number
        BigDecimal orderTypeID = 8.14; // BigDecimal | Page number if the response is paged.
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number.
        String owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.

        try {
            ShipmentListJS result = apiInstance.shipmentGet(orderNumber, orderTypeID, deliveryNoteNumber, owner);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#shipmentGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
String *orderNumber = orderNumber_example; // Order Number (default to null)
BigDecimal *orderTypeID = 8.14; // Page number if the response is paged. (default to null)
String *deliveryNoteNumber = deliveryNoteNumber_example; // Delivery Note Number. (optional) (default to null)
String *owner = owner_example; // For sites with multiple owners of the articles, specify the actually owner. (optional) (default to null)

// Get a list of shipments.
[apiInstance shipmentGetWith:orderNumber
    orderTypeID:orderTypeID
    deliveryNoteNumber:deliveryNoteNumber
    owner:owner
              completionHandler: ^(ShipmentListJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.OrdersApi()
var orderNumber = orderNumber_example; // {String} Order Number
var orderTypeID = 8.14; // {BigDecimal} Page number if the response is paged.
var opts = {
  'deliveryNoteNumber': deliveryNoteNumber_example, // {String} Delivery Note Number.
  'owner': owner_example // {String} For sites with multiple owners of the articles, specify the actually owner.
};

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

namespace Example
{
    public class shipmentGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var orderNumber = orderNumber_example;  // String | Order Number (default to null)
            var orderTypeID = 8.14;  // BigDecimal | Page number if the response is paged. (default to null)
            var deliveryNoteNumber = deliveryNoteNumber_example;  // String | Delivery Note Number. (optional)  (default to null)
            var owner = owner_example;  // String | For sites with multiple owners of the articles, specify the actually owner. (optional)  (default to null)

            try {
                // Get a list of shipments.
                ShipmentListJS result = apiInstance.shipmentGet(orderNumber, orderTypeID, deliveryNoteNumber, owner);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.shipmentGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$orderNumber = orderNumber_example; // String | Order Number
$orderTypeID = 8.14; // BigDecimal | Page number if the response is paged.
$deliveryNoteNumber = deliveryNoteNumber_example; // String | Delivery Note Number.
$owner = owner_example; // String | For sites with multiple owners of the articles, specify the actually owner.

try {
    $result = $api_instance->shipmentGet($orderNumber, $orderTypeID, $deliveryNoteNumber, $owner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->shipmentGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $orderNumber = orderNumber_example; # String | Order Number
my $orderTypeID = 8.14; # BigDecimal | Page number if the response is paged.
my $deliveryNoteNumber = deliveryNoteNumber_example; # String | Delivery Note Number.
my $owner = owner_example; # String | For sites with multiple owners of the articles, specify the actually owner.

eval {
    my $result = $api_instance->shipmentGet(orderNumber => $orderNumber, orderTypeID => $orderTypeID, deliveryNoteNumber => $deliveryNoteNumber, owner => $owner);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrdersApi->shipmentGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
orderNumber = orderNumber_example # String | Order Number (default to null)
orderTypeID = 8.14 # BigDecimal | Page number if the response is paged. (default to null)
deliveryNoteNumber = deliveryNoteNumber_example # String | Delivery Note Number. (optional) (default to null)
owner = owner_example # String | For sites with multiple owners of the articles, specify the actually owner. (optional) (default to null)

try:
    # Get a list of shipments.
    api_response = api_instance.shipment_get(orderNumber, orderTypeID, deliveryNoteNumber=deliveryNoteNumber, owner=owner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrdersApi->shipmentGet: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let orderNumber = orderNumber_example; // String
    let orderTypeID = 8.14; // BigDecimal
    let deliveryNoteNumber = deliveryNoteNumber_example; // String
    let owner = owner_example; // String

    let mut context = OrdersApi::Context::default();
    let result = client.shipmentGet(orderNumber, orderTypeID, deliveryNoteNumber, owner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
orderNumber*
String
Order Number
Required
orderTypeID*
BigDecimal
Page number if the response is paged.
Required
deliveryNoteNumber
String
Delivery Note Number.
owner
String
For sites with multiple owners of the articles, specify the actually owner.

Responses


startOrderPut

Start an order by Host control.

The normal way is that an order is started from Shark. This method allows an order to be started by a Host system.


/startOrder

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://restapi.sharkwms.com/1.3/startOrder?orderNumber=orderNumber_example&deliveryNoteNumber=deliveryNoteNumber_example&orderTypeID=56&workstation=workstation_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = orderNumber_example; // String | 
        Integer orderTypeID = 56; // Integer | 
        String workstation = workstation_example; // String | The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order.
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | 

        try {
            apiInstance.startOrderPut(orderNumber, orderTypeID, workstation, deliveryNoteNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#startOrderPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String orderNumber = new String(); // String | 
final Integer orderTypeID = new Integer(); // Integer | 
final String workstation = new String(); // String | The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order.
final String deliveryNoteNumber = new String(); // String | 

try {
    final result = await api_instance.startOrderPut(orderNumber, orderTypeID, workstation, deliveryNoteNumber);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->startOrderPut: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        String orderNumber = orderNumber_example; // String | 
        Integer orderTypeID = 56; // Integer | 
        String workstation = workstation_example; // String | The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order.
        String deliveryNoteNumber = deliveryNoteNumber_example; // String | 

        try {
            apiInstance.startOrderPut(orderNumber, orderTypeID, workstation, deliveryNoteNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#startOrderPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
String *orderNumber = orderNumber_example; //  (default to null)
Integer *orderTypeID = 56; //  (default to null)
String *workstation = workstation_example; // The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order. (default to null)
String *deliveryNoteNumber = deliveryNoteNumber_example; //  (optional) (default to null)

// Start an order by Host control.
[apiInstance startOrderPutWith:orderNumber
    orderTypeID:orderTypeID
    workstation:workstation
    deliveryNoteNumber:deliveryNoteNumber
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.OrdersApi()
var orderNumber = orderNumber_example; // {String} 
var orderTypeID = 56; // {Integer} 
var workstation = workstation_example; // {String} The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order.
var opts = {
  'deliveryNoteNumber': deliveryNoteNumber_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.startOrderPut(orderNumber, orderTypeID, workstation, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class startOrderPutExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var orderNumber = orderNumber_example;  // String |  (default to null)
            var orderTypeID = 56;  // Integer |  (default to null)
            var workstation = workstation_example;  // String | The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order. (default to null)
            var deliveryNoteNumber = deliveryNoteNumber_example;  // String |  (optional)  (default to null)

            try {
                // Start an order by Host control.
                apiInstance.startOrderPut(orderNumber, orderTypeID, workstation, deliveryNoteNumber);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.startOrderPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$orderNumber = orderNumber_example; // String | 
$orderTypeID = 56; // Integer | 
$workstation = workstation_example; // String | The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order.
$deliveryNoteNumber = deliveryNoteNumber_example; // String | 

try {
    $api_instance->startOrderPut($orderNumber, $orderTypeID, $workstation, $deliveryNoteNumber);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->startOrderPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $orderNumber = orderNumber_example; # String | 
my $orderTypeID = 56; # Integer | 
my $workstation = workstation_example; # String | The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order.
my $deliveryNoteNumber = deliveryNoteNumber_example; # String | 

eval {
    $api_instance->startOrderPut(orderNumber => $orderNumber, orderTypeID => $orderTypeID, workstation => $workstation, deliveryNoteNumber => $deliveryNoteNumber);
};
if ($@) {
    warn "Exception when calling OrdersApi->startOrderPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
orderNumber = orderNumber_example # String |  (default to null)
orderTypeID = 56 # Integer |  (default to null)
workstation = workstation_example # String | The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order. (default to null)
deliveryNoteNumber = deliveryNoteNumber_example # String |  (optional) (default to null)

try:
    # Start an order by Host control.
    api_instance.start_order_put(orderNumber, orderTypeID, workstation, deliveryNoteNumber=deliveryNoteNumber)
except ApiException as e:
    print("Exception when calling OrdersApi->startOrderPut: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let orderNumber = orderNumber_example; // String
    let orderTypeID = 56; // Integer
    let workstation = workstation_example; // String
    let deliveryNoteNumber = deliveryNoteNumber_example; // String

    let mut context = OrdersApi::Context::default();
    let result = client.startOrderPut(orderNumber, orderTypeID, workstation, deliveryNoteNumber, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
orderNumber*
String
Required
deliveryNoteNumber
String
orderTypeID*
Integer
Required
workstation*
String
The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order.
Required

Responses


subscribeConfirmPost

Subscribe to a webhook. (Not yet fully functional)

Subscribe to a webhook. Webhooks are user-defined HTTP callbacks. When a new confirmation is available in SHARK, it will post to the specified URL. Thereby polling can be avoided.


/subscribeConfirm

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://restapi.sharkwms.com/1.3/subscribeConfirm" \
 -d '{
  "includeContent" : false,
  "httpHeaderParameters" : [ {
    "values" : "values",
    "name" : "name"
  }, {
    "values" : "values",
    "name" : "name"
  } ],
  "type" : "ORDERCONFIRM",
  "url" : "http://localhost:1234/events"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        WebHook webHook = ; // WebHook | 

        try {
            apiInstance.subscribeConfirmPost(webHook);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#subscribeConfirmPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final WebHook webHook = new WebHook(); // WebHook | 

try {
    final result = await api_instance.subscribeConfirmPost(webHook);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->subscribeConfirmPost: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        WebHook webHook = ; // WebHook | 

        try {
            apiInstance.subscribeConfirmPost(webHook);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#subscribeConfirmPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
WebHook *webHook = ; //  (optional)

// Subscribe to a webhook.  (Not yet fully functional)
[apiInstance subscribeConfirmPostWith:webHook
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.OrdersApi()
var opts = {
  'webHook':  // {WebHook} 
};

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

namespace Example
{
    public class subscribeConfirmPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var webHook = new WebHook(); // WebHook |  (optional) 

            try {
                // Subscribe to a webhook.  (Not yet fully functional)
                apiInstance.subscribeConfirmPost(webHook);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.subscribeConfirmPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$webHook = ; // WebHook | 

try {
    $api_instance->subscribeConfirmPost($webHook);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->subscribeConfirmPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $webHook = WWW::OPenAPIClient::Object::WebHook->new(); # WebHook | 

eval {
    $api_instance->subscribeConfirmPost(webHook => $webHook);
};
if ($@) {
    warn "Exception when calling OrdersApi->subscribeConfirmPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
webHook =  # WebHook |  (optional)

try:
    # Subscribe to a webhook.  (Not yet fully functional)
    api_instance.subscribe_confirm_post(webHook=webHook)
except ApiException as e:
    print("Exception when calling OrdersApi->subscribeConfirmPost: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let webHook = ; // WebHook

    let mut context = OrdersApi::Context::default();
    let result = client.subscribeConfirmPost(webHook, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
webHook

Responses


subscribeOrderStateChangedPost

Get a post every time an order change the state. (Not yet fully functional)

Subscribe to a webhook. Webhooks are user-defined HTTP callbacks. When a new confirmation is available in SHARK, it will post to the specified URL. Thereby polling can be avoided.


/subscribeOrderStateChanged

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://restapi.sharkwms.com/1.3/subscribeOrderStateChanged" \
 -d '{
  "includeContent" : false,
  "type" : "ORDERCONFIRM",
  "url" : "http://localhost:1234/events"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrdersApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        OrdersApi apiInstance = new OrdersApi();
        WebHookStateChanged webHookStateChanged = ; // WebHookStateChanged | 

        try {
            apiInstance.subscribeOrderStateChangedPost(webHookStateChanged);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#subscribeOrderStateChangedPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final WebHookStateChanged webHookStateChanged = new WebHookStateChanged(); // WebHookStateChanged | 

try {
    final result = await api_instance.subscribeOrderStateChangedPost(webHookStateChanged);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->subscribeOrderStateChangedPost: $e\n');
}

import org.openapitools.client.api.OrdersApi;

public class OrdersApiExample {
    public static void main(String[] args) {
        OrdersApi apiInstance = new OrdersApi();
        WebHookStateChanged webHookStateChanged = ; // WebHookStateChanged | 

        try {
            apiInstance.subscribeOrderStateChangedPost(webHookStateChanged);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrdersApi#subscribeOrderStateChangedPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
OrdersApi *apiInstance = [[OrdersApi alloc] init];
WebHookStateChanged *webHookStateChanged = ; //  (optional)

// Get a post every time an order change the state. (Not yet fully functional)
[apiInstance subscribeOrderStateChangedPostWith:webHookStateChanged
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.OrdersApi()
var opts = {
  'webHookStateChanged':  // {WebHookStateChanged} 
};

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

namespace Example
{
    public class subscribeOrderStateChangedPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OrdersApi();
            var webHookStateChanged = new WebHookStateChanged(); // WebHookStateChanged |  (optional) 

            try {
                // Get a post every time an order change the state. (Not yet fully functional)
                apiInstance.subscribeOrderStateChangedPost(webHookStateChanged);
            } catch (Exception e) {
                Debug.Print("Exception when calling OrdersApi.subscribeOrderStateChangedPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OrdersApi();
$webHookStateChanged = ; // WebHookStateChanged | 

try {
    $api_instance->subscribeOrderStateChangedPost($webHookStateChanged);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->subscribeOrderStateChangedPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OrdersApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OrdersApi->new();
my $webHookStateChanged = WWW::OPenAPIClient::Object::WebHookStateChanged->new(); # WebHookStateChanged | 

eval {
    $api_instance->subscribeOrderStateChangedPost(webHookStateChanged => $webHookStateChanged);
};
if ($@) {
    warn "Exception when calling OrdersApi->subscribeOrderStateChangedPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OrdersApi()
webHookStateChanged =  # WebHookStateChanged |  (optional)

try:
    # Get a post every time an order change the state. (Not yet fully functional)
    api_instance.subscribe_order_state_changed_post(webHookStateChanged=webHookStateChanged)
except ApiException as e:
    print("Exception when calling OrdersApi->subscribeOrderStateChangedPost: %s\n" % e)
extern crate OrdersApi;

pub fn main() {
    let webHookStateChanged = ; // WebHookStateChanged

    let mut context = OrdersApi::Context::default();
    let result = client.subscribeOrderStateChangedPost(webHookStateChanged, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
webHookStateChanged

Responses


System

documentGet

Retrieve data from the SHARK document system.


/document

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/document?documentId=56&port=port_example&format=format_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemApi apiInstance = new SystemApi();
        Integer documentId = 56; // Integer | The ID of the document to retrieve. If not defined, the oldest, not yet document will be returned.

        String port = port_example; // String | The SHARK port from where the document will be read.
        String format = format_example; // String | The format in which the document should be returned. The native document format in SHARK is XML.


        try {
            _document_get_200_response result = apiInstance.documentGet(documentId, port, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#documentGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer documentId = new Integer(); // Integer | The ID of the document to retrieve. If not defined, the oldest, not yet document will be returned.

final String port = new String(); // String | The SHARK port from where the document will be read.
final String format = new String(); // String | The format in which the document should be returned. The native document format in SHARK is XML.


try {
    final result = await api_instance.documentGet(documentId, port, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->documentGet: $e\n');
}

import org.openapitools.client.api.SystemApi;

public class SystemApiExample {
    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        Integer documentId = 56; // Integer | The ID of the document to retrieve. If not defined, the oldest, not yet document will be returned.

        String port = port_example; // String | The SHARK port from where the document will be read.
        String format = format_example; // String | The format in which the document should be returned. The native document format in SHARK is XML.


        try {
            _document_get_200_response result = apiInstance.documentGet(documentId, port, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#documentGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemApi *apiInstance = [[SystemApi alloc] init];
Integer *documentId = 56; // The ID of the document to retrieve. If not defined, the oldest, not yet document will be returned.
 (optional) (default to null)
String *port = port_example; // The SHARK port from where the document will be read. (optional) (default to orderack)
String *format = format_example; // The format in which the document should be returned. The native document format in SHARK is XML.
 (optional) (default to JSON)

// Retrieve data from the SHARK document system.
[apiInstance documentGetWith:documentId
    port:port
    format:format
              completionHandler: ^(_document_get_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.SystemApi()
var opts = {
  'documentId': 56, // {Integer} The ID of the document to retrieve. If not defined, the oldest, not yet document will be returned.

  'port': port_example, // {String} The SHARK port from where the document will be read.
  'format': format_example // {String} The format in which the document should be returned. The native document format in SHARK is XML.

};

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

namespace Example
{
    public class documentGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemApi();
            var documentId = 56;  // Integer | The ID of the document to retrieve. If not defined, the oldest, not yet document will be returned.
 (optional)  (default to null)
            var port = port_example;  // String | The SHARK port from where the document will be read. (optional)  (default to orderack)
            var format = format_example;  // String | The format in which the document should be returned. The native document format in SHARK is XML.
 (optional)  (default to JSON)

            try {
                // Retrieve data from the SHARK document system.
                _document_get_200_response result = apiInstance.documentGet(documentId, port, format);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemApi.documentGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemApi();
$documentId = 56; // Integer | The ID of the document to retrieve. If not defined, the oldest, not yet document will be returned.

$port = port_example; // String | The SHARK port from where the document will be read.
$format = format_example; // String | The format in which the document should be returned. The native document format in SHARK is XML.


try {
    $result = $api_instance->documentGet($documentId, $port, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->documentGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemApi->new();
my $documentId = 56; # Integer | The ID of the document to retrieve. If not defined, the oldest, not yet document will be returned.

my $port = port_example; # String | The SHARK port from where the document will be read.
my $format = format_example; # String | The format in which the document should be returned. The native document format in SHARK is XML.


eval {
    my $result = $api_instance->documentGet(documentId => $documentId, port => $port, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemApi->documentGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemApi()
documentId = 56 # Integer | The ID of the document to retrieve. If not defined, the oldest, not yet document will be returned.
 (optional) (default to null)
port = port_example # String | The SHARK port from where the document will be read. (optional) (default to orderack)
format = format_example # String | The format in which the document should be returned. The native document format in SHARK is XML.
 (optional) (default to JSON)

try:
    # Retrieve data from the SHARK document system.
    api_response = api_instance.document_get(documentId=documentId, port=port, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->documentGet: %s\n" % e)
extern crate SystemApi;

pub fn main() {
    let documentId = 56; // Integer
    let port = port_example; // String
    let format = format_example; // String

    let mut context = SystemApi::Context::default();
    let result = client.documentGet(documentId, port, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
documentId
Integer
The ID of the document to retrieve. If not defined, the oldest, not yet document will be returned.
port
String
The SHARK port from where the document will be read.
format
String
The format in which the document should be returned. The native document format in SHARK is XML.

Responses


documentPost

Send data to the SHARK document system.


/document

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://restapi.sharkwms.com/1.3/document?port=port_example&format=format_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemApi apiInstance = new SystemApi();
        File body = BINARY_DATA_HERE; // File | 
        String port = port_example; // String | The port in Shark where the data will be uploaded.
        String format = format_example; // String | The format of the data.

        try {
            apiInstance.documentPost(body, port, format);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#documentPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final File body = new File(); // File | 
final String port = new String(); // String | The port in Shark where the data will be uploaded.
final String format = new String(); // String | The format of the data.

try {
    final result = await api_instance.documentPost(body, port, format);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->documentPost: $e\n');
}

import org.openapitools.client.api.SystemApi;

public class SystemApiExample {
    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        File body = BINARY_DATA_HERE; // File | 
        String port = port_example; // String | The port in Shark where the data will be uploaded.
        String format = format_example; // String | The format of the data.

        try {
            apiInstance.documentPost(body, port, format);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#documentPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemApi *apiInstance = [[SystemApi alloc] init];
File *body = BINARY_DATA_HERE; // 
String *port = port_example; // The port in Shark where the data will be uploaded. (optional) (default to null)
String *format = format_example; // The format of the data. (optional) (default to TEXT)

// Send data to the SHARK document system.
[apiInstance documentPostWith:body
    port:port
    format:format
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.SystemApi()
var body = BINARY_DATA_HERE; // {File} 
var opts = {
  'port': port_example, // {String} The port in Shark where the data will be uploaded.
  'format': format_example // {String} The format of the data.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.documentPost(body, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class documentPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemApi();
            var body = BINARY_DATA_HERE;  // File | 
            var port = port_example;  // String | The port in Shark where the data will be uploaded. (optional)  (default to null)
            var format = format_example;  // String | The format of the data. (optional)  (default to TEXT)

            try {
                // Send data to the SHARK document system.
                apiInstance.documentPost(body, port, format);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemApi.documentPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemApi();
$body = BINARY_DATA_HERE; // File | 
$port = port_example; // String | The port in Shark where the data will be uploaded.
$format = format_example; // String | The format of the data.

try {
    $api_instance->documentPost($body, $port, $format);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->documentPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemApi->new();
my $body = WWW::OPenAPIClient::Object::File->new(); # File | 
my $port = port_example; # String | The port in Shark where the data will be uploaded.
my $format = format_example; # String | The format of the data.

eval {
    $api_instance->documentPost(body => $body, port => $port, format => $format);
};
if ($@) {
    warn "Exception when calling SystemApi->documentPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemApi()
body = BINARY_DATA_HERE # File | 
port = port_example # String | The port in Shark where the data will be uploaded. (optional) (default to null)
format = format_example # String | The format of the data. (optional) (default to TEXT)

try:
    # Send data to the SHARK document system.
    api_instance.document_post(body, port=port, format=format)
except ApiException as e:
    print("Exception when calling SystemApi->documentPost: %s\n" % e)
extern crate SystemApi;

pub fn main() {
    let body = BINARY_DATA_HERE; // File
    let port = port_example; // String
    let format = format_example; // String

    let mut context = SystemApi::Context::default();
    let result = client.documentPost(body, port, format, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
body *

Query parameters
Name Description
port
String
The port in Shark where the data will be uploaded.
format
String
The format of the data.

Responses


flowPost

Data that will be used as input to the first flow action.


/flow

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://restapi.sharkwms.com/1.3/flow?name=name_example&datatype=datatype_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemApi apiInstance = new SystemApi();
        String name = name_example; // String | The name of the flow to execute
        File body = BINARY_DATA_HERE; // File | 
        String datatype = datatype_example; // String | Format of the uploaded data

        try {
            apiInstance.flowPost(name, body, datatype);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#flowPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | The name of the flow to execute
final File body = new File(); // File | 
final String datatype = new String(); // String | Format of the uploaded data

try {
    final result = await api_instance.flowPost(name, body, datatype);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->flowPost: $e\n');
}

import org.openapitools.client.api.SystemApi;

public class SystemApiExample {
    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        String name = name_example; // String | The name of the flow to execute
        File body = BINARY_DATA_HERE; // File | 
        String datatype = datatype_example; // String | Format of the uploaded data

        try {
            apiInstance.flowPost(name, body, datatype);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#flowPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemApi *apiInstance = [[SystemApi alloc] init];
String *name = name_example; // The name of the flow to execute (default to null)
File *body = BINARY_DATA_HERE; // 
String *datatype = datatype_example; // Format of the uploaded data (optional) (default to null)

// Data that will be used as input to the first flow action.
[apiInstance flowPostWith:name
    body:body
    datatype:datatype
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.SystemApi()
var name = name_example; // {String} The name of the flow to execute
var body = BINARY_DATA_HERE; // {File} 
var opts = {
  'datatype': datatype_example // {String} Format of the uploaded data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.flowPost(name, body, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class flowPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemApi();
            var name = name_example;  // String | The name of the flow to execute (default to null)
            var body = BINARY_DATA_HERE;  // File | 
            var datatype = datatype_example;  // String | Format of the uploaded data (optional)  (default to null)

            try {
                // Data that will be used as input to the first flow action.
                apiInstance.flowPost(name, body, datatype);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemApi.flowPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemApi();
$name = name_example; // String | The name of the flow to execute
$body = BINARY_DATA_HERE; // File | 
$datatype = datatype_example; // String | Format of the uploaded data

try {
    $api_instance->flowPost($name, $body, $datatype);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->flowPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemApi->new();
my $name = name_example; # String | The name of the flow to execute
my $body = WWW::OPenAPIClient::Object::File->new(); # File | 
my $datatype = datatype_example; # String | Format of the uploaded data

eval {
    $api_instance->flowPost(name => $name, body => $body, datatype => $datatype);
};
if ($@) {
    warn "Exception when calling SystemApi->flowPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemApi()
name = name_example # String | The name of the flow to execute (default to null)
body = BINARY_DATA_HERE # File | 
datatype = datatype_example # String | Format of the uploaded data (optional) (default to null)

try:
    # Data that will be used as input to the first flow action.
    api_instance.flow_post(name, body, datatype=datatype)
except ApiException as e:
    print("Exception when calling SystemApi->flowPost: %s\n" % e)
extern crate SystemApi;

pub fn main() {
    let name = name_example; // String
    let body = BINARY_DATA_HERE; // File
    let datatype = datatype_example; // String

    let mut context = SystemApi::Context::default();
    let result = client.flowPost(name, body, datatype, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
body *

Query parameters
Name Description
name*
String
The name of the flow to execute
Required
datatype
String
Format of the uploaded data

Responses


healthGet

Get general health information (Not yet fully functional)


/health

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/health"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemApi apiInstance = new SystemApi();

        try {
            HealthListJS result = apiInstance.healthGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#healthGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.healthGet();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->healthGet: $e\n');
}

import org.openapitools.client.api.SystemApi;

public class SystemApiExample {
    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();

        try {
            HealthListJS result = apiInstance.healthGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#healthGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemApi *apiInstance = [[SystemApi alloc] init];

// Get general health information (Not yet fully functional)
[apiInstance healthGetWithCompletionHandler: 
              ^(HealthListJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.SystemApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.healthGet(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class healthGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemApi();

            try {
                // Get general health information (Not yet fully functional)
                HealthListJS result = apiInstance.healthGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemApi.healthGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemApi();

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemApi->new();

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemApi()

try:
    # Get general health information (Not yet fully functional)
    api_response = api_instance.health_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->healthGet: %s\n" % e)
extern crate SystemApi;

pub fn main() {

    let mut context = SystemApi::Context::default();
    let result = client.healthGet(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


reportGet

Get a custom data report.

SHARK allows customized reports to be generated as views in the database. This call can be used to extract the report data, for example directly into an Excel spreadsheet [read more](https://doc.sharkwms.com/host_link_restapi/#reports).


/report

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/report?reportName=reportName_example&columns=columns_example&sort=sort_example&filter=filter_example&page=8.14&pageSize=8.14"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemApi apiInstance = new SystemApi();
        String reportName = reportName_example; // String | This is the name of the predefined report in the SHARK system.
        String columns = columns_example; // String | Optional list of comma separated column names to return. Default is all columns.
        String sort = sort_example; // String | Comma separated list of column names to order by.
        String filter = filter_example; // String | Filter for a single column. Format colname EQ/NEQ/GT/LT value.
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

        try {
            ReportDataListJS result = apiInstance.reportGet(reportName, columns, sort, filter, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#reportGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String reportName = new String(); // String | This is the name of the predefined report in the SHARK system.
final String columns = new String(); // String | Optional list of comma separated column names to return. Default is all columns.
final String sort = new String(); // String | Comma separated list of column names to order by.
final String filter = new String(); // String | Filter for a single column. Format colname EQ/NEQ/GT/LT value.
final BigDecimal page = new BigDecimal(); // BigDecimal | Page number if the response is paged.
final BigDecimal pageSize = new BigDecimal(); // BigDecimal | Number of returned rows in the response set.

try {
    final result = await api_instance.reportGet(reportName, columns, sort, filter, page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->reportGet: $e\n');
}

import org.openapitools.client.api.SystemApi;

public class SystemApiExample {
    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        String reportName = reportName_example; // String | This is the name of the predefined report in the SHARK system.
        String columns = columns_example; // String | Optional list of comma separated column names to return. Default is all columns.
        String sort = sort_example; // String | Comma separated list of column names to order by.
        String filter = filter_example; // String | Filter for a single column. Format colname EQ/NEQ/GT/LT value.
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

        try {
            ReportDataListJS result = apiInstance.reportGet(reportName, columns, sort, filter, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#reportGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemApi *apiInstance = [[SystemApi alloc] init];
String *reportName = reportName_example; // This is the name of the predefined report in the SHARK system. (default to null)
String *columns = columns_example; // Optional list of comma separated column names to return. Default is all columns. (optional) (default to null)
String *sort = sort_example; // Comma separated list of column names to order by. (optional) (default to null)
String *filter = filter_example; // Filter for a single column. Format colname EQ/NEQ/GT/LT value. (optional) (default to null)
BigDecimal *page = 8.14; // Page number if the response is paged. (optional) (default to null)
BigDecimal *pageSize = 8.14; // Number of returned rows in the response set. (optional) (default to null)

// Get a custom data report.
[apiInstance reportGetWith:reportName
    columns:columns
    sort:sort
    filter:filter
    page:page
    pageSize:pageSize
              completionHandler: ^(ReportDataListJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.SystemApi()
var reportName = reportName_example; // {String} This is the name of the predefined report in the SHARK system.
var opts = {
  'columns': columns_example, // {String} Optional list of comma separated column names to return. Default is all columns.
  'sort': sort_example, // {String} Comma separated list of column names to order by.
  'filter': filter_example, // {String} Filter for a single column. Format colname EQ/NEQ/GT/LT value.
  'page': 8.14, // {BigDecimal} Page number if the response is paged.
  'pageSize': 8.14 // {BigDecimal} Number of returned rows in the response set.
};

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

namespace Example
{
    public class reportGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemApi();
            var reportName = reportName_example;  // String | This is the name of the predefined report in the SHARK system. (default to null)
            var columns = columns_example;  // String | Optional list of comma separated column names to return. Default is all columns. (optional)  (default to null)
            var sort = sort_example;  // String | Comma separated list of column names to order by. (optional)  (default to null)
            var filter = filter_example;  // String | Filter for a single column. Format colname EQ/NEQ/GT/LT value. (optional)  (default to null)
            var page = 8.14;  // BigDecimal | Page number if the response is paged. (optional)  (default to null)
            var pageSize = 8.14;  // BigDecimal | Number of returned rows in the response set. (optional)  (default to null)

            try {
                // Get a custom data report.
                ReportDataListJS result = apiInstance.reportGet(reportName, columns, sort, filter, page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemApi.reportGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemApi();
$reportName = reportName_example; // String | This is the name of the predefined report in the SHARK system.
$columns = columns_example; // String | Optional list of comma separated column names to return. Default is all columns.
$sort = sort_example; // String | Comma separated list of column names to order by.
$filter = filter_example; // String | Filter for a single column. Format colname EQ/NEQ/GT/LT value.
$page = 8.14; // BigDecimal | Page number if the response is paged.
$pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

try {
    $result = $api_instance->reportGet($reportName, $columns, $sort, $filter, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->reportGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemApi->new();
my $reportName = reportName_example; # String | This is the name of the predefined report in the SHARK system.
my $columns = columns_example; # String | Optional list of comma separated column names to return. Default is all columns.
my $sort = sort_example; # String | Comma separated list of column names to order by.
my $filter = filter_example; # String | Filter for a single column. Format colname EQ/NEQ/GT/LT value.
my $page = 8.14; # BigDecimal | Page number if the response is paged.
my $pageSize = 8.14; # BigDecimal | Number of returned rows in the response set.

eval {
    my $result = $api_instance->reportGet(reportName => $reportName, columns => $columns, sort => $sort, filter => $filter, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemApi->reportGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemApi()
reportName = reportName_example # String | This is the name of the predefined report in the SHARK system. (default to null)
columns = columns_example # String | Optional list of comma separated column names to return. Default is all columns. (optional) (default to null)
sort = sort_example # String | Comma separated list of column names to order by. (optional) (default to null)
filter = filter_example # String | Filter for a single column. Format colname EQ/NEQ/GT/LT value. (optional) (default to null)
page = 8.14 # BigDecimal | Page number if the response is paged. (optional) (default to null)
pageSize = 8.14 # BigDecimal | Number of returned rows in the response set. (optional) (default to null)

try:
    # Get a custom data report.
    api_response = api_instance.report_get(reportName, columns=columns, sort=sort, filter=filter, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->reportGet: %s\n" % e)
extern crate SystemApi;

pub fn main() {
    let reportName = reportName_example; // String
    let columns = columns_example; // String
    let sort = sort_example; // String
    let filter = filter_example; // String
    let page = 8.14; // BigDecimal
    let pageSize = 8.14; // BigDecimal

    let mut context = SystemApi::Context::default();
    let result = client.reportGet(reportName, columns, sort, filter, page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
reportName*
String
This is the name of the predefined report in the SHARK system.
Required
columns
String
Optional list of comma separated column names to return. Default is all columns.
sort
String
Comma separated list of column names to order by.
filter
String
Filter for a single column. Format colname EQ/NEQ/GT/LT value.
page
BigDecimal
Page number if the response is paged.
pageSize
BigDecimal
Number of returned rows in the response set.

Responses


statisticsGet

Get statistic information


/statistics

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://restapi.sharkwms.com/1.3/statistics?page=8.14&pageSize=8.14"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemApi apiInstance = new SystemApi();
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

        try {
            StatisticListJS result = apiInstance.statisticsGet(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#statisticsGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final BigDecimal page = new BigDecimal(); // BigDecimal | Page number if the response is paged.
final BigDecimal pageSize = new BigDecimal(); // BigDecimal | Number of returned rows in the response set.

try {
    final result = await api_instance.statisticsGet(page, pageSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->statisticsGet: $e\n');
}

import org.openapitools.client.api.SystemApi;

public class SystemApiExample {
    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        BigDecimal page = 8.14; // BigDecimal | Page number if the response is paged.
        BigDecimal pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

        try {
            StatisticListJS result = apiInstance.statisticsGet(page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#statisticsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemApi *apiInstance = [[SystemApi alloc] init];
BigDecimal *page = 8.14; // Page number if the response is paged. (optional) (default to null)
BigDecimal *pageSize = 8.14; // Number of returned rows in the response set. (optional) (default to null)

// Get statistic information
[apiInstance statisticsGetWith:page
    pageSize:pageSize
              completionHandler: ^(StatisticListJS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.SystemApi()
var opts = {
  'page': 8.14, // {BigDecimal} Page number if the response is paged.
  'pageSize': 8.14 // {BigDecimal} Number of returned rows in the response set.
};

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

namespace Example
{
    public class statisticsGetExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemApi();
            var page = 8.14;  // BigDecimal | Page number if the response is paged. (optional)  (default to null)
            var pageSize = 8.14;  // BigDecimal | Number of returned rows in the response set. (optional)  (default to null)

            try {
                // Get statistic information
                StatisticListJS result = apiInstance.statisticsGet(page, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemApi.statisticsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemApi();
$page = 8.14; // BigDecimal | Page number if the response is paged.
$pageSize = 8.14; // BigDecimal | Number of returned rows in the response set.

try {
    $result = $api_instance->statisticsGet($page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->statisticsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemApi->new();
my $page = 8.14; # BigDecimal | Page number if the response is paged.
my $pageSize = 8.14; # BigDecimal | Number of returned rows in the response set.

eval {
    my $result = $api_instance->statisticsGet(page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemApi->statisticsGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemApi()
page = 8.14 # BigDecimal | Page number if the response is paged. (optional) (default to null)
pageSize = 8.14 # BigDecimal | Number of returned rows in the response set. (optional) (default to null)

try:
    # Get statistic information
    api_response = api_instance.statistics_get(page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->statisticsGet: %s\n" % e)
extern crate SystemApi;

pub fn main() {
    let page = 8.14; // BigDecimal
    let pageSize = 8.14; // BigDecimal

    let mut context = SystemApi::Context::default();
    let result = client.statisticsGet(page, pageSize, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
BigDecimal
Page number if the response is paged.
pageSize
BigDecimal
Number of returned rows in the response set.

Responses


uploadPost

Upload file data to Shark.


/upload

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://restapi.sharkwms.com/1.3/upload?port=port_example&file=file_example&report=report_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemApi apiInstance = new SystemApi();
        File body = BINARY_DATA_HERE; // File | 
        String port = port_example; // String | The port in Shark where the data will be uploaded.
        String file = file_example; // String | Upload the content as a file.
        String report = report_example; // String | Upload an error report

        try {
            apiInstance.uploadPost(body, port, file, report);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#uploadPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final File body = new File(); // File | 
final String port = new String(); // String | The port in Shark where the data will be uploaded.
final String file = new String(); // String | Upload the content as a file.
final String report = new String(); // String | Upload an error report

try {
    final result = await api_instance.uploadPost(body, port, file, report);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->uploadPost: $e\n');
}

import org.openapitools.client.api.SystemApi;

public class SystemApiExample {
    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        File body = BINARY_DATA_HERE; // File | 
        String port = port_example; // String | The port in Shark where the data will be uploaded.
        String file = file_example; // String | Upload the content as a file.
        String report = report_example; // String | Upload an error report

        try {
            apiInstance.uploadPost(body, port, file, report);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#uploadPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemApi *apiInstance = [[SystemApi alloc] init];
File *body = BINARY_DATA_HERE; // 
String *port = port_example; // The port in Shark where the data will be uploaded. (optional) (default to null)
String *file = file_example; // Upload the content as a file. (optional) (default to null)
String *report = report_example; // Upload an error report (optional) (default to null)

// Upload file data to Shark.
[apiInstance uploadPostWith:body
    port:port
    file:file
    report:report
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.SystemApi()
var body = BINARY_DATA_HERE; // {File} 
var opts = {
  'port': port_example, // {String} The port in Shark where the data will be uploaded.
  'file': file_example, // {String} Upload the content as a file.
  'report': report_example // {String} Upload an error report
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.uploadPost(body, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemApi();
            var body = BINARY_DATA_HERE;  // File | 
            var port = port_example;  // String | The port in Shark where the data will be uploaded. (optional)  (default to null)
            var file = file_example;  // String | Upload the content as a file. (optional)  (default to null)
            var report = report_example;  // String | Upload an error report (optional)  (default to null)

            try {
                // Upload file data to Shark.
                apiInstance.uploadPost(body, port, file, report);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemApi.uploadPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemApi();
$body = BINARY_DATA_HERE; // File | 
$port = port_example; // String | The port in Shark where the data will be uploaded.
$file = file_example; // String | Upload the content as a file.
$report = report_example; // String | Upload an error report

try {
    $api_instance->uploadPost($body, $port, $file, $report);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->uploadPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemApi;

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemApi->new();
my $body = WWW::OPenAPIClient::Object::File->new(); # File | 
my $port = port_example; # String | The port in Shark where the data will be uploaded.
my $file = file_example; # String | Upload the content as a file.
my $report = report_example; # String | Upload an error report

eval {
    $api_instance->uploadPost(body => $body, port => $port, file => $file, report => $report);
};
if ($@) {
    warn "Exception when calling SystemApi->uploadPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemApi()
body = BINARY_DATA_HERE # File | 
port = port_example # String | The port in Shark where the data will be uploaded. (optional) (default to null)
file = file_example # String | Upload the content as a file. (optional) (default to null)
report = report_example # String | Upload an error report (optional) (default to null)

try:
    # Upload file data to Shark.
    api_instance.upload_post(body, port=port, file=file, report=report)
except ApiException as e:
    print("Exception when calling SystemApi->uploadPost: %s\n" % e)
extern crate SystemApi;

pub fn main() {
    let body = BINARY_DATA_HERE; // File
    let port = port_example; // String
    let file = file_example; // String
    let report = report_example; // String

    let mut context = SystemApi::Context::default();
    let result = client.uploadPost(body, port, file, report, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
body *

Query parameters
Name Description
port
String
The port in Shark where the data will be uploaded.
file
String
Upload the content as a file.
report
String
Upload an error report

Responses


XML

xmlPost

Post SHARK standard XML.

This allows existing SHARK XML files to be posted, using the REST API (Not yet fully functional)


/xml

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://restapi.sharkwms.com/1.3/xml" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.XMLApi;

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

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

        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        XMLApi apiInstance = new XMLApi();
        String body = body_example; // String | 

        try {
            apiInstance.xmlPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling XMLApi#xmlPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String body = new String(); // String | 

try {
    final result = await api_instance.xmlPost(body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->xmlPost: $e\n');
}

import org.openapitools.client.api.XMLApi;

public class XMLApiExample {
    public static void main(String[] args) {
        XMLApi apiInstance = new XMLApi();
        String body = body_example; // String | 

        try {
            apiInstance.xmlPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling XMLApi#xmlPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
XMLApi *apiInstance = [[XMLApi alloc] init];
String *body = body_example; //  (optional)

// Post SHARK standard XML.
[apiInstance xmlPostWith:body
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var SharkWmsRestapiVersion13 = require('shark_wms_restapi_version_1_3');
var defaultClient = SharkWmsRestapiVersion13.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new SharkWmsRestapiVersion13.XMLApi()
var opts = {
  'body': body_example // {String} 
};

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

namespace Example
{
    public class xmlPostExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new XMLApi();
            var body = body_example;  // String |  (optional) 

            try {
                // Post SHARK standard XML.
                apiInstance.xmlPost(body);
            } catch (Exception e) {
                Debug.Print("Exception when calling XMLApi.xmlPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\XMLApi();
$body = body_example; // String | 

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::XMLApi->new();
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

eval {
    $api_instance->xmlPost(body => $body);
};
if ($@) {
    warn "Exception when calling XMLApi->xmlPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.XMLApi()
body = body_example # String |  (optional)

try:
    # Post SHARK standard XML.
    api_instance.xml_post(body=body)
except ApiException as e:
    print("Exception when calling XMLApi->xmlPost: %s\n" % e)
extern crate XMLApi;

pub fn main() {
    let body = body_example; // String

    let mut context = XMLApi::Context::default();
    let result = client.xmlPost(body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
body

Responses