# ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverApi

All URIs are relative to *http://localhost/gemini-web/rest*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createStockGoodsHandoverOrderPosition**](StockGoodsHandoverApi.md#createStockGoodsHandoverOrderPosition) | **POST** /stock-goods-handover/order-positions | insert resource
[**deleteStockGoodsHandoverOrderPosition**](StockGoodsHandoverApi.md#deleteStockGoodsHandoverOrderPosition) | **DELETE** /stock-goods-handover/order-positions/{id} | delete resource
[**getAllStockGoodsHandoverOrderPositions**](StockGoodsHandoverApi.md#getAllStockGoodsHandoverOrderPositions) | **GET** /stock-goods-handover/order-positions | get list of resources
[**getAllStockGoodsHandoverTransactionPositions**](StockGoodsHandoverApi.md#getAllStockGoodsHandoverTransactionPositions) | **GET** /stock-goods-handover/transaction-positions | get list of resources
[**getSingleStockGoodsHandoverOrderPosition**](StockGoodsHandoverApi.md#getSingleStockGoodsHandoverOrderPosition) | **GET** /stock-goods-handover/order-positions/{id} | get resource
[**getSingleStockGoodsHandoverTransactionPosition**](StockGoodsHandoverApi.md#getSingleStockGoodsHandoverTransactionPosition) | **GET** /stock-goods-handover/transaction-positions/{id} | get resource
[**updatePartialStockGoodsHandoverOrderPosition**](StockGoodsHandoverApi.md#updatePartialStockGoodsHandoverOrderPosition) | **POST** /stock-goods-handover/order-positions/{id} | perform a partial update of the resource
[**updateStockGoodsHandoverOrderPosition**](StockGoodsHandoverApi.md#updateStockGoodsHandoverOrderPosition) | **PUT** /stock-goods-handover/order-positions/{id} | update resource


<a name="createStockGoodsHandoverOrderPosition"></a>
# **createStockGoodsHandoverOrderPosition**
> StockGoodsHandoverOrderPositionJson createStockGoodsHandoverOrderPosition(body, opts)

insert resource

Inserts a single resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

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

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverApi();

var body = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverOrderPositionJson(); // StockGoodsHandoverOrderPositionJson | The item to insert.

var opts = { 
  'transactionId': "transactionId_example", // String | A unique transaction ID used for idempotent inserts.
  'expand': "expand_example", // String | Expandable properties:stock,order,position
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createStockGoodsHandoverOrderPosition(body, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**StockGoodsHandoverOrderPositionJson**](StockGoodsHandoverOrderPositionJson.md)| The item to insert. | 
 **transactionId** | **String**| A unique transaction ID used for idempotent inserts. | [optional] 
 **expand** | **String**| Expandable properties:stock,order,position | [optional] 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

[**StockGoodsHandoverOrderPositionJson**](StockGoodsHandoverOrderPositionJson.md)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="deleteStockGoodsHandoverOrderPosition"></a>
# **deleteStockGoodsHandoverOrderPosition**
> deleteStockGoodsHandoverOrderPosition(id, opts)

delete resource

Deletes a single resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

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

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverApi();

var id = 789; // Number | The ID of the resource.

var opts = { 
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteStockGoodsHandoverOrderPosition(id, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the resource. | 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

null (empty response body)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="getAllStockGoodsHandoverOrderPositions"></a>
# **getAllStockGoodsHandoverOrderPositions**
> StockGoodsHandoverOrderPositionRestResultPage getAllStockGoodsHandoverOrderPositions(opts)

get list of resources

Gets a list of resources.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

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

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverApi();

var opts = { 
  'limit': 56, // Number | An integer which is the limit (max number) of returned records (used for pagination).
  'offset': 56, // Number | An integer (< list-size-1) that is the offset of the first record to transmit (used for pagination).
  'page': 56, // Number | An integer that designates the pagenumber of the first record to transmit (used for pagination).
  'stockId': 789, // Number | The ID of the stock.
  'orderId': 789, // Number | The ID of the goods handover order.
  'positionId': 789, // Number | The ID of the goods handover order position.
  'expand': "expand_example", // String | Expandable properties:stock,order,position
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getAllStockGoodsHandoverOrderPositions(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **limit** | **Number**| An integer which is the limit (max number) of returned records (used for pagination). | [optional] 
 **offset** | **Number**| An integer (&lt; list-size-1) that is the offset of the first record to transmit (used for pagination). | [optional] 
 **page** | **Number**| An integer that designates the pagenumber of the first record to transmit (used for pagination). | [optional] 
 **stockId** | **Number**| The ID of the stock. | [optional] 
 **orderId** | **Number**| The ID of the goods handover order. | [optional] 
 **positionId** | **Number**| The ID of the goods handover order position. | [optional] 
 **expand** | **String**| Expandable properties:stock,order,position | [optional] 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

[**StockGoodsHandoverOrderPositionRestResultPage**](StockGoodsHandoverOrderPositionRestResultPage.md)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="getAllStockGoodsHandoverTransactionPositions"></a>
# **getAllStockGoodsHandoverTransactionPositions**
> StockGoodsHandoverTransactionPositionRestResultPage getAllStockGoodsHandoverTransactionPositions(opts)

get list of resources

Gets a list of resources.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

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

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverApi();

var opts = { 
  'limit': 56, // Number | An integer which is the limit (max number) of returned records (used for pagination).
  'offset': 56, // Number | An integer (< list-size-1) that is the offset of the first record to transmit (used for pagination).
  'page': 56, // Number | An integer that designates the pagenumber of the first record to transmit (used for pagination).
  'stockMovementTransactionPositionId': 789, // Number | The ID of the stock movement transaction position.
  'transactionId': 789, // Number | The ID of the goods handover transaction.
  'positionId': 789, // Number | The ID of the goods handover transaction position.
  'expand': "expand_example", // String | Expandable properties:transaction,position,stockMovementTransactionPosition
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getAllStockGoodsHandoverTransactionPositions(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **limit** | **Number**| An integer which is the limit (max number) of returned records (used for pagination). | [optional] 
 **offset** | **Number**| An integer (&lt; list-size-1) that is the offset of the first record to transmit (used for pagination). | [optional] 
 **page** | **Number**| An integer that designates the pagenumber of the first record to transmit (used for pagination). | [optional] 
 **stockMovementTransactionPositionId** | **Number**| The ID of the stock movement transaction position. | [optional] 
 **transactionId** | **Number**| The ID of the goods handover transaction. | [optional] 
 **positionId** | **Number**| The ID of the goods handover transaction position. | [optional] 
 **expand** | **String**| Expandable properties:transaction,position,stockMovementTransactionPosition | [optional] 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

[**StockGoodsHandoverTransactionPositionRestResultPage**](StockGoodsHandoverTransactionPositionRestResultPage.md)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="getSingleStockGoodsHandoverOrderPosition"></a>
# **getSingleStockGoodsHandoverOrderPosition**
> StockGoodsHandoverOrderPositionJson getSingleStockGoodsHandoverOrderPosition(id, opts)

get resource

Gets a single resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

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

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverApi();

var id = 789; // Number | The ID of the resource.

var opts = { 
  'expand': "expand_example", // String | Expandable properties:stock,order,position
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getSingleStockGoodsHandoverOrderPosition(id, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the resource. | 
 **expand** | **String**| Expandable properties:stock,order,position | [optional] 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

[**StockGoodsHandoverOrderPositionJson**](StockGoodsHandoverOrderPositionJson.md)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="getSingleStockGoodsHandoverTransactionPosition"></a>
# **getSingleStockGoodsHandoverTransactionPosition**
> StockGoodsHandoverTransactionPositionJson getSingleStockGoodsHandoverTransactionPosition(id, opts)

get resource

Gets a single resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

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

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverApi();

var id = 789; // Number | The ID of the resource.

var opts = { 
  'expand': "expand_example", // String | Expandable properties:transaction,position,stockMovementTransactionPosition
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getSingleStockGoodsHandoverTransactionPosition(id, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the resource. | 
 **expand** | **String**| Expandable properties:transaction,position,stockMovementTransactionPosition | [optional] 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

[**StockGoodsHandoverTransactionPositionJson**](StockGoodsHandoverTransactionPositionJson.md)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="updatePartialStockGoodsHandoverOrderPosition"></a>
# **updatePartialStockGoodsHandoverOrderPosition**
> updatePartialStockGoodsHandoverOrderPosition(id, body, opts)

perform a partial update of the resource

Updates only the given values of an existing resource.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

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

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverApi();

var id = 789; // Number | The ID of the item.

var body = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.JsonNode(); // JsonNode | The partial JSON containing the fields of the item that should be updated.

var opts = { 
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updatePartialStockGoodsHandoverOrderPosition(id, body, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the item. | 
 **body** | [**JsonNode**](JsonNode.md)| The partial JSON containing the fields of the item that should be updated. | 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

null (empty response body)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="updateStockGoodsHandoverOrderPosition"></a>
# **updateStockGoodsHandoverOrderPosition**
> updateStockGoodsHandoverOrderPosition(id, body, opts)

update resource

Updates an item with the given ID. The request body has to contain the whole data-object since this is a full update operation.

### Example
```javascript
var ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail = require('this_is_the_documentation_of_the_rest_interfaces_provided_by_nts_retail');
var defaultClient = ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.ApiClient.instance;

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

var apiInstance = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverApi();

var id = 789; // Number | The ID of the resource.

var body = new ThisIsTheDocumentationOfTheRestInterfacesProvidedByNtsRetail.StockGoodsHandoverOrderPositionJson(); // StockGoodsHandoverOrderPositionJson | The resource to update.

var opts = { 
  'shortToken': "shortToken_example" // String | A temporary short token which can be used as an alternative to the JWT.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updateStockGoodsHandoverOrderPosition(id, body, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Number**| The ID of the resource. | 
 **body** | [**StockGoodsHandoverOrderPositionJson**](StockGoodsHandoverOrderPositionJson.md)| The resource to update. | 
 **shortToken** | **String**| A temporary short token which can be used as an alternative to the JWT. | [optional] 

### Return type

null (empty response body)

### Authorization

[gemini_auth](../README.md#gemini_auth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json