Logistics | Stock Settings
Service to manage entities of type 'Stock Settings'.
Overview
| 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:
GET LogisticsSetups (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. |
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:
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:
GET LogisticsSetup by key
Returns the entity record that matches the specified key.
The following elements are required:
| company | (string) 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:
PUT Set Company LogisticsSetup
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
| company | (string) 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:
PUT Set DefaultStockTransferOrderType LogisticsSetup
Updates the value of attribute 'DefaultStockTransferOrderType' in the specified entity record.
The following elements are required:
| company | (string) 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:
PUT Set DefaultWarehouse LogisticsSetup
Updates the value of attribute 'DefaultWarehouse' in the specified entity record.
The following elements are required:
| company | (string) 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:
PUT Set InventoryManagementForNewItems LogisticsSetup
Updates the value of attribute 'InventoryManagementForNewItems' in the specified entity record.
The following elements are required:
| company | (string) 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:
PUT Set IsActive LogisticsSetup
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| company | (string) 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:
PUT Set NegativeStock LogisticsSetup
Updates the value of attribute 'NegativeStock' in the specified entity record.
The following elements are required:
| company | (string) 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:
Resources
LogisticsSetupResource
The following elements are required:
| company | (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| negativeStock | (bool) Allow Negative Stock. |
| inventoryManagementForNewItems | (bool) Indicates whether it's suggested inventory management for new Items. |
The following elements are optional:
| defaultStockTransferOrderType | (string) Stock Transfer Order Type.
(fk) Allowed value: the natural key of a record of type DeliveryType. These records are accessibly through the DeliveryTypes service. |
| lastInventoryCloseDate | (DateTime) Last Inventory Close Date. |
| defaultWarehouse | (string) The default warehouse for the Logistics Setup.
(fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service. |