NetilionApiDocumentation.DeliveryApi

All URIs are relative to https://localhost/v1

Method	HTTP request	Description
addAssetsToDelivery	POST /deliveries/{delivery_id}/assets	Add assets to a delivery
addDocumentsToDelivery	POST /deliveries/{delivery_id}/documents	Add documents to a delivery
addPurchaseOrdersToDelivery	POST /deliveries/{delivery_id}/purchase_orders	Add all purchase oders to a delivery
createDelivery	POST /deliveries	Create a new delivery
deleteDelivery	DELETE /deliveries/{id}	Delete a delivery
getAssetsOfDelivery	GET /deliveries/{delivery_id}/assets	Get all assets of one delivery
getDeliveries	GET /deliveries	Get a range of deliveries
getDeliveryById	GET /deliveries/{id}	Get a single delivery
getDeliveryIdStatus	GET /deliveries/{delivery_id}/status	Get the status of the specific delivery
getDocumentsOfDelivery	GET /deliveries/{delivery_id}/documents	Get all documents of one delivery
getPurchaseOrdersOfDelivery	GET /deliveries/{delivery_id}/purchase_orders	Get all purchase orders of one delivery
removeAssetsFromDelivery	DELETE /deliveries/{delivery_id}/assets	Remove assets from a delivery
removeDocumentsFromDelivery	DELETE /deliveries/{delivery_id}/documents	Remove documents from a delivery
removePurchaseOrdersFromDelivery	DELETE /deliveries/{delivery_id}/purchase_orders	Remove purchase orders from a delivery
replaceAssetsOfDelivery	PATCH /deliveries/{delivery_id}/assets	Replace the assets of a delivery
replaceDocumentsOfDelivery	PATCH /deliveries/{delivery_id}/documents	Replace the documents of a delivery
replacePurchaseOrdersOfDelivery	PATCH /deliveries/{delivery_id}/purchase_orders	Replace the purchase orders of a delivery
updateDelivery	PATCH /deliveries/{id}	Update a delivery

addAssetsToDelivery

addAssetsToDelivery(deliveryId, body)

Add assets to a delivery

Add one or more assets to a delivery.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | Id of the delivery to which the assets will be added

var body = new NetilionApiDocumentation.AssetIDs(); // AssetIDs | Resources that shall be added.

apiInstance.addAssetsToDelivery(deliveryId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	Id of the delivery to which the assets will be added
body	AssetIDs	Resources that shall be added.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

addDocumentsToDelivery

addDocumentsToDelivery(deliveryId, body)

Add documents to a delivery

Add one or more documents to a delivery.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | Id of the delivery to which the documents will be added

var body = new NetilionApiDocumentation.DocumentIDs(); // DocumentIDs | Resources that shall be added.

apiInstance.addDocumentsToDelivery(deliveryId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	Id of the delivery to which the documents will be added
body	DocumentIDs	Resources that shall be added.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

addPurchaseOrdersToDelivery

addPurchaseOrdersToDelivery(deliveryId, body)

Add all purchase oders to a delivery

Add one or more all purchase oders to a delivery.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | Id of the delivery to which the all purchase oders will be added

var body = new NetilionApiDocumentation.PurchaseOrderIDs(); // PurchaseOrderIDs | Resources that shall be added.

apiInstance.addPurchaseOrdersToDelivery(deliveryId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	Id of the delivery to which the all purchase oders will be added
body	PurchaseOrderIDs	Resources that shall be added.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

createDelivery

DeliveryResponse createDelivery(body)

Create a new delivery

Delivery must have a name, number, sender, receiver and a status.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var body = new NetilionApiDocumentation.DeliveryRequest(); // DeliveryRequest | Delivery to create

apiInstance.createDelivery(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DeliveryRequest	Delivery to create

Return type

DeliveryResponse

Authorization

API-Key, Authentication

HTTP request headers

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

deleteDelivery

deleteDelivery(id)

Delete a delivery

Delete a specific resource in your accessible scope, identified by the id in the URL.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var id = 789; // Number | Id of the delivery to delete

apiInstance.deleteDelivery(id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	Number	Id of the delivery to delete

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

getAssetsOfDelivery

AssetsResponse getAssetsOfDelivery(deliveryId, opts)

Get all assets of one delivery

Returns a list of all assets that are available in your scope. You can apply query parameters in the request to get a filtered list. If the query has no matches, the response will show an empty array. Possible include values: ```status, tenant, parent, pictures, product, product.manufacturer, product.pictures, product.status, product.categories, product.categories.parent, specifications, specifications[key1,key2], product.tenant, product.manufacturer.tenant, status.tenant, instrumentations ```

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | The resource defined in the URL

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'include': "include_example", // String | Comma separated list of objects to include in response
  'serialNumber': "serialNumber_example", // String | Filter accepts `*` as wildcard
  'productId': "productId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'categoryId': "categoryId_example", // String | One or multiple ids (comma list). By adding `+` after the id, the filter considers the given category and all its children (e.g. 3+).
  'parentId': "parentId_example", // String | One or multiple ids (comma list). \"null\" to retrieve all objects without parent, \"!null\" for all objects with parent.
  'manufacturerId': "manufacturerId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'statusId': "statusId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'statusCode': "statusCode_example", // String | Filter accepts `*` as wildcard
  'productionDate': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'productionDateFrom': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'productionDateTo': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'specificationsKey': "specificationsKey_example", // String | Filter accepts `*` as wildcard (if used as single specifications filter), supports comma list of keys in connection with specifications_value filter
  'specificationsValue': "specificationsValue_example", // String | Filter accepts `*` as wildcard, supports comma list of values in connection with specifications_key filter. Does not work for vectors
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `id`, `serial_number`, `created_at` or `updated_at`, `last_seen_at`, add `-` as a prefix for descending order. Default value is `id`
};
apiInstance.getAssetsOfDelivery(deliveryId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	The resource defined in the URL
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
include	String	Comma separated list of objects to include in response	[optional]
serialNumber	String	Filter accepts `*` as wildcard	[optional]
productId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
categoryId	String	One or multiple ids (comma list). By adding `+` after the id, the filter considers the given category and all its children (e.g. 3+).	[optional]
parentId	String	One or multiple ids (comma list). "null" to retrieve all objects without parent, "!null" for all objects with parent.	[optional]
manufacturerId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
statusId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
statusCode	String	Filter accepts `*` as wildcard	[optional]
productionDate	Date	Expected date format is YYYY-MM-DD	[optional]
productionDateFrom	Date	Expected date format is YYYY-MM-DD	[optional]
productionDateTo	Date	Expected date format is YYYY-MM-DD	[optional]
specificationsKey	String	Filter accepts `*` as wildcard (if used as single specifications filter), supports comma list of keys in connection with specifications_value filter	[optional]
specificationsValue	String	Filter accepts `*` as wildcard, supports comma list of values in connection with specifications_key filter. Does not work for vectors	[optional]
orderBy	String	Order result by attribute value, accepts `id`, `serial_number`, `created_at` or `updated_at`, `last_seen_at`, add `-` as a prefix for descending order. Default value is `id`	[optional]

Return type

AssetsResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getDeliveries

DeliveriesResponse getDeliveries(opts)

Get a range of deliveries

Returns a list of deliveries in your accessible scope. If the query has no matches, the response is an empty list. Only deliveries on which the user has the can_read permission are loaded

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  '_number': "_number_example", // String | Filter accepts `*` as wildcard
  'name': "name_example", // String | Filter accepts `*` as wildcard
  'statusId': "statusId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'dateOfShipment': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'dateOfShipmentFrom': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'dateOfShipmentTo': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'senderId': "senderId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'receiverId': "receiverId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`
};
apiInstance.getDeliveries(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
_number	String	Filter accepts `*` as wildcard	[optional]
name	String	Filter accepts `*` as wildcard	[optional]
statusId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
dateOfShipment	Date	Expected date format is YYYY-MM-DD	[optional]
dateOfShipmentFrom	Date	Expected date format is YYYY-MM-DD	[optional]
dateOfShipmentTo	Date	Expected date format is YYYY-MM-DD	[optional]
senderId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
receiverId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
orderBy	String	Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`	[optional]

Return type

DeliveriesResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getDeliveryById

DeliveryResponse getDeliveryById(id)

Get a single delivery

Get a specific delivery in your accessible scope, identified by the id in the URL.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var id = 789; // Number | Id of the delivery to fetch

apiInstance.getDeliveryById(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	Number	Id of the delivery to fetch

Return type

DeliveryResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getDeliveryIdStatus

DeliveryStatusResponse getDeliveryIdStatus(deliveryId, opts)

Get the status of the specific delivery

Returns the status of the delivery. You can apply the query parameters listed below to get a filtered list. Required Permissions: ```can_read``` Parameters supporting translation: ```name, description```. To add a translation set Content-Language. Possible include value: ```tenant```

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | Id of the specified delivery

var opts = { 
  'include': "include_example", // String | Comma separated list of objects to include in response
  'acceptLanguage': "acceptLanguage_example" // String | The client's accepted languages. One or several (e.g. fr,de,en)
};
apiInstance.getDeliveryIdStatus(deliveryId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	Id of the specified delivery
include	String	Comma separated list of objects to include in response	[optional]
acceptLanguage	String	The client's accepted languages. One or several (e.g. fr,de,en)	[optional]

Return type

DeliveryStatusResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getDocumentsOfDelivery

DocumentsResponse getDocumentsOfDelivery(deliveryId, opts)

Get all documents of one delivery

Returns a list of documents. If the query has no matches, the response is an empty list. Possible include values: ```status, tenant, classification, categories, categories.parent, attachments```

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | The resource defined in the URL

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'include': "include_example", // String | Comma separated list of objects to include in response
  'name': "name_example", // String | Filter accepts `*` as wildcard
  'documentVersion': "documentVersion_example", // String | Filter accepts `*` as wildcard
  '_number': "_number_example", // String | Filter accepts `*` as wildcard
  'statusId': "statusId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'classificationId': "classificationId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'tenantId': "tenantId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'categoryId': "categoryId_example", // String | One or multiple ids (comma list). By adding `+` after the id, the filter considers the given category and all its children (e.g. 3+).
  'validFrom': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'validUntil': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'validAt': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD or YYYY-MM or YYYY
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`
  'acceptLanguage': "acceptLanguage_example" // String | The client's accepted languages. One or several (e.g. fr,de,en)
};
apiInstance.getDocumentsOfDelivery(deliveryId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	The resource defined in the URL
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
include	String	Comma separated list of objects to include in response	[optional]
name	String	Filter accepts `*` as wildcard	[optional]
documentVersion	String	Filter accepts `*` as wildcard	[optional]
_number	String	Filter accepts `*` as wildcard	[optional]
statusId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
classificationId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
tenantId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
categoryId	String	One or multiple ids (comma list). By adding `+` after the id, the filter considers the given category and all its children (e.g. 3+).	[optional]
validFrom	Date	Expected date format is YYYY-MM-DD	[optional]
validUntil	Date	Expected date format is YYYY-MM-DD	[optional]
validAt	Date	Expected date format is YYYY-MM-DD or YYYY-MM or YYYY	[optional]
orderBy	String	Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`	[optional]
acceptLanguage	String	The client's accepted languages. One or several (e.g. fr,de,en)	[optional]

Return type

DocumentsResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getPurchaseOrdersOfDelivery

PurchaseOrdersResponse getPurchaseOrdersOfDelivery(deliveryId, opts)

Get all purchase orders of one delivery

Returns a list of all all purchase oder that are available in your scope. You can apply query parameters in the request to get a filtered list. If the query has no matches, the response will show an empty array.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | The resource defined in the URL

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'name': "name_example", // String | Filter accepts `*` as wildcard
  '_number': "_number_example", // String | Filter accepts `*` as wildcard
  'statusId': "statusId_example", // String | One or multiple ids (comma list). Expected id format is integer
  '_date': "_date_example", // String | Expected date format is YYYY-MM-DD
  'dateFrom': "dateFrom_example", // String | Expected date format is YYYY-MM-DD
  'dateTo': "dateTo_example", // String | Expected date format is YYYY-MM-DD
  'senderId': "senderId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'receiverId': "receiverId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'quotationId': "quotationId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`
};
apiInstance.getPurchaseOrdersOfDelivery(deliveryId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	The resource defined in the URL
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
name	String	Filter accepts `*` as wildcard	[optional]
_number	String	Filter accepts `*` as wildcard	[optional]
statusId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
_date	String	Expected date format is YYYY-MM-DD	[optional]
dateFrom	String	Expected date format is YYYY-MM-DD	[optional]
dateTo	String	Expected date format is YYYY-MM-DD	[optional]
senderId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
receiverId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
quotationId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
orderBy	String	Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`	[optional]

Return type

PurchaseOrdersResponse

Authorization

API-Key, Authentication

HTTP request headers

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

removeAssetsFromDelivery

removeAssetsFromDelivery(deliveryId, body)

Remove assets from a delivery

Remove one or more assets from a delivery in your accessible scope.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | Id of the delivery from which the assets will be removed

var body = new NetilionApiDocumentation.AssetIDs(); // AssetIDs | Resources that shall be removed.

apiInstance.removeAssetsFromDelivery(deliveryId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	Id of the delivery from which the assets will be removed
body	AssetIDs	Resources that shall be removed.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

removeDocumentsFromDelivery

removeDocumentsFromDelivery(deliveryId, body)

Remove documents from a delivery

Remove one or more documents from a delivery in your accessible scope.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | Id of the delivery from which the documents will be removed

var body = new NetilionApiDocumentation.DocumentIDs(); // DocumentIDs | Resources that shall be removed.

apiInstance.removeDocumentsFromDelivery(deliveryId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	Id of the delivery from which the documents will be removed
body	DocumentIDs	Resources that shall be removed.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

removePurchaseOrdersFromDelivery

removePurchaseOrdersFromDelivery(deliveryId, body)

Remove purchase orders from a delivery

Remove one or more purchase orders from a delivery in your accessible scope.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | Id of the delivery from which the purchase orders will be removed

var body = new NetilionApiDocumentation.PurchaseOrderIDs(); // PurchaseOrderIDs | Resources that shall be removed.

apiInstance.removePurchaseOrdersFromDelivery(deliveryId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	Id of the delivery from which the purchase orders will be removed
body	PurchaseOrderIDs	Resources that shall be removed.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

replaceAssetsOfDelivery

replaceAssetsOfDelivery(deliveryId, body)

Replace the assets of a delivery

Replaces all assets belonging to a delivery. You can send a list of resources that will replace all previous values.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | Id of the delivery of which the assets will be replaced

var body = new NetilionApiDocumentation.AssetIDs(); // AssetIDs | Resources that shall be replaced

apiInstance.replaceAssetsOfDelivery(deliveryId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	Id of the delivery of which the assets will be replaced
body	AssetIDs	Resources that shall be replaced

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

replaceDocumentsOfDelivery

replaceDocumentsOfDelivery(deliveryId, body)

Replace the documents of a delivery

Replaces all documents belonging to a delivery. You can send a list of resources that will replace all previous values.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | Id of the delivery of which the documents will be replaced

var body = new NetilionApiDocumentation.DocumentIDs(); // DocumentIDs | Resources that shall be replaced

apiInstance.replaceDocumentsOfDelivery(deliveryId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	Id of the delivery of which the documents will be replaced
body	DocumentIDs	Resources that shall be replaced

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

replacePurchaseOrdersOfDelivery

replacePurchaseOrdersOfDelivery(deliveryId, body)

Replace the purchase orders of a delivery

Replaces all purchase orders belonging to a delivery. You can send a list of resources that will replace all previous values.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var deliveryId = 789; // Number | Id of the delivery of which the purchase orders will be replaced

var body = new NetilionApiDocumentation.PurchaseOrderIDs(); // PurchaseOrderIDs | Resources that shall be replaced

apiInstance.replacePurchaseOrdersOfDelivery(deliveryId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deliveryId	Number	Id of the delivery of which the purchase orders will be replaced
body	PurchaseOrderIDs	Resources that shall be replaced

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

updateDelivery

updateDelivery(id, body)

Update a delivery

Update accessible parameters of the requested resource in your accessible scope.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.DeliveryApi();

var id = 789; // Number | Id of the delivery to update

var body = new NetilionApiDocumentation.DeliveryRequest(); // DeliveryRequest | Parameters that shall be updated.

apiInstance.updateDelivery(id, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	Number	Id of the delivery to update
body	DeliveryRequest	Parameters that shall be updated.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

Collapse file tree

Files

DeliveryApi.md

Latest commit

History

DeliveryApi.md

File metadata and controls

NetilionApiDocumentation.DeliveryApi

addAssetsToDelivery

Example

Parameters

Return type

Authorization

HTTP request headers

addDocumentsToDelivery

Example

Parameters

Return type

Authorization

HTTP request headers

addPurchaseOrdersToDelivery

Example

Parameters

Return type

Authorization

HTTP request headers

createDelivery

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDelivery

Example

Parameters

Return type

Authorization

HTTP request headers

getAssetsOfDelivery

Example

Parameters

Return type

Authorization

HTTP request headers

getDeliveries

Example

Parameters

Return type

Authorization

HTTP request headers

getDeliveryById

Example

Parameters

Return type

Authorization

HTTP request headers

getDeliveryIdStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getDocumentsOfDelivery

Example

Parameters

Return type

Authorization

HTTP request headers

getPurchaseOrdersOfDelivery

Example

Parameters

Return type

Authorization

HTTP request headers

removeAssetsFromDelivery

Example

Parameters

Return type

Authorization

HTTP request headers