Logistics | Materials Parameters

The Logistics Setup is used to manage default values for each company, such as the default stock transfer order.

Overview

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups

URL	api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups
Methods Supported	GET, PUT

All Operations

This service includes the following operations:

GET:
PUT:

All Resources

This service uses the following resources:

LogisticsSetupResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET LogisticsSetups

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See LogisticsSetupResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups

GET /logisticsCore/logisticsSetups

GET LogisticsSetups (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See LogisticsSetupResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups?page={page}&pageSize={pageSize}

GET /logisticsCore/logisticsSetups?page={page}&pageSize={pageSize}

GET LogisticsSetup by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See LogisticsSetupResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{id}

GET /logisticsCore/logisticsSetups/{id}

GET LogisticsSetup by key

Returns the entity record that matches the specified key.

The following elements are required:

company

(string) The company.

Response:

When successful, the response body contains the entity record. See LogisticsSetupResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{company}

GET /logisticsCore/logisticsSetups/{company}

GET Print LogisticsSetup by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{id}/print?template={template}

GET /logisticsCore/logisticsSetups/{id}/print?template={template}

GET Print LogisticsSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The company.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{company}/print

GET /logisticsCore/logisticsSetups/{company}/print

GET Original Print LogisticsSetupOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{id}/printOriginal?template={template}

GET /logisticsCore/logisticsSetups/{id}/printOriginal?template={template}

GET Original Print LogisticsSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The company.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{company}/printOriginal

GET /logisticsCore/logisticsSetups/{company}/printOriginal

PUT Operations

PUT Set Company LogisticsSetup

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

company	(string) The company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{company}/company

PUT /logisticsCore/logisticsSetups/{company}/company

PUT Set DefaultStockTransferOrderType LogisticsSetup

Updates the value of attribute 'DefaultStockTransferOrderType' in the specified entity record.

The following elements are required:

company	(string) The company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{company}/defaultStockTransferOrderType

PUT /logisticsCore/logisticsSetups/{company}/defaultStockTransferOrderType

PUT Set IsActive LogisticsSetup

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

company	(string) The company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{company}/isActive

PUT /logisticsCore/logisticsSetups/{company}/isActive

PUT Set JournalType LogisticsSetup

Updates the value of attribute 'JournalType' in the specified entity record.

The following elements are required:

company	(string) The company.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{company}/journalType

PUT /logisticsCore/logisticsSetups/{company}/journalType

PUT Set NegativeStock LogisticsSetup

Updates the value of attribute 'NegativeStock' in the specified entity record.

The following elements are required:

company	(string) The company.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{company}/negativeStock

PUT /logisticsCore/logisticsSetups/{company}/negativeStock

PUT Set Custom Attribute LogisticsSetup

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
company	(string) The company.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/logisticsSetups/{companyKey}/{company}/{customAttributeName}

PUT /logisticsCore/logisticsSetups/{companyKey}/{company}/{customAttributeName}

Resources

LogisticsSetupResource

The following elements are required:

company	(string) The company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
negativeStock	(bool) Check if is allowed negative stock.

The following elements are optional:

defaultStockTransferOrderType	(string) Defined the default value of stock transfer type. (fk) Allowed value: the natural key of a record of type DeliveryType. These records are accessibly through the DeliveryTypes service.
lastInventoryCloseDate	(DateTime) The date of the last inventory close.
journalType	(string) The journal type. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.