Materials Management | Warehouse
The warehouse is used to manage information related with the warehouse such as name, location.
Overview
URL | api/{tenantKey}/{orgKey}/materialsCore/warehouses |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute Warehouse
- PUT Set IsActive Warehouse
- PUT Set WarehouseKey Warehouse
- PUT Set Company Warehouse
- PUT Set Description Warehouse
- PUT Set AllowItemEntries Warehouse
- PUT Set AllowItemIssues Warehouse
- PUT Set StreetName Warehouse
- PUT Set BuildingNumber Warehouse
- PUT Set CityName Warehouse
- PUT Set PostalZone Warehouse
- PUT Set ClosedExercise Warehouse
- PUT Set ExternalId Warehouse
- PUT Set ExternalVersion Warehouse
- PUT Set IsExternallyManaged Warehouse
- PUT Set Region Warehouse
- PUT Set Country Warehouse
- PUT Set IsLocked Warehouse
- PUT Set DimensionValue WarehouseDimension
- DELETE:
All Resources
This service uses the following resources:
GET Warehouses
Returns the list of all the entity records available.
Response:
When successful, the response body contains the list of records available. See WarehouseResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Warehouses (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 WarehouseResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Warehouse 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 WarehouseResource. |
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 Warehouse by key
Returns the entity record that matches the specified key.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
Response:
When successful, the response body contains the entity record. See WarehouseResource. |
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 Print Warehouse 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:
GET Print Warehouse by key
Prints the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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:
GET Original Print WarehouseOriginal 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:
GET Original Print Warehouse by key
Prints the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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:
POST Warehouses
Creates a new entity record.
The following elements are required:
warehouseResource | (ApiWarehouseResource) The request body should contain the entity record that should be created. See ApiWarehouseResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiWarehouseResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Warehouse
Inserts a new 'Warehouse Dimension' in the 'Warehouse'.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
value | (ApiWarehouseEntityDimensionDetailsResource) The ApiWarehouseEntityDimensionDetailsResource instance. See ApiWarehouseEntityDimensionDetailsResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AllowItemEntries Warehouse
Updates the value of attribute 'AllowItemEntries' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 AllowItemIssues Warehouse
Updates the value of attribute 'AllowItemIssues' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 BuildingNumber Warehouse
Updates the value of attribute 'BuildingNumber' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 CityName Warehouse
Updates the value of attribute 'CityName' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 ClosedExercise Warehouse
Updates the value of attribute 'ClosedExercise' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
value | (DateTime) 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 Company Warehouse
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 Country Warehouse
Updates the value of attribute 'Country' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 Description Warehouse
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 DimensionValue WarehouseDimension
Updates the value of attribute 'DimensionValue' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
lineId | (string) The detail identifier. |
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 ExternalId Warehouse
Updates the value of attribute 'ExternalId' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 ExternalVersion Warehouse
Updates the value of attribute 'ExternalVersion' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 IsActive Warehouse
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 IsExternallyManaged Warehouse
Updates the value of attribute 'IsExternallyManaged' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 IsLocked Warehouse
Updates the value of attribute 'IsLocked' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 PostalZone Warehouse
Updates the value of attribute 'PostalZone' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 Region Warehouse
Updates the value of attribute 'Region' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 StreetName Warehouse
Updates the value of attribute 'StreetName' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 WarehouseKey Warehouse
Updates the value of attribute 'WarehouseKey' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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 Custom Attribute Warehouse
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
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:
DELETE Warehouse Dimension by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
lineId | (string) The line identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Warehouse by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Warehouse by key
Deletes the entity record that matches the specified key.
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiWarehouseEntityDimensionDetailsResource
The following elements are required:
dimension | (string) The dimension. |
dimensionValue | (string) The dimension value. |
ApiWarehouseResource
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
company | (string) The company for the Warehouse. |
allowItemEntries | (bool) Determines if this warehouse accepts item entries. |
allowItemIssues | (bool) Determines if this warehouse accepts item issues. |
isExternallyManaged | (bool) Indicates whether the warehouse is externally managed. |
isLocked | (bool) Indicates if the warehouse is currently locked. |
The following elements are optional:
description | (string) The description for the Warehouse. |
streetName | (string) The street name for the Warehouse. |
buildingNumber | (string) The building number for the Warehouse. |
cityName | (string) The city name for the Warehouse. |
postalZone | (string) The postal zone for the Warehouse. |
closedExercise | (DateTime) The closed exercise date for the Warehouse. |
externalId | (string) The external identification for the Warehouse. |
externalVersion | (string) The external version for the Warehouse. |
region | (string) The region for the Warehouse. |
country | (string) The country for the Warehouse. |
entityDimensionDetails | (List of ApiWarehouseEntityDimensionDetailsResource) The list of dimensions of the warehouse.
See ApiWarehouseEntityDimensionDetailsResource. |
WarehouseDimensionResource
The following elements are required:
dimension | (string) The dimension. |
dimensionValue | (string) The dimension value. |
WarehouseResource
The following elements are required:
warehouseKey | (string) The key for the Warehouse. |
company | (string) The company for the Warehouse.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
allowItemEntries | (bool) Determines if this warehouse accepts item entries. |
allowItemIssues | (bool) Determines if this warehouse accepts item issues. |
isExternallyManaged | (bool) Indicates whether the warehouse is externally managed. |
isLocked | (bool) Indicates if the warehouse is currently locked. |
The following elements are optional:
description | (string) The description for the Warehouse. |
streetName | (string) The street name for the Warehouse. |
buildingNumber | (string) The building number for the Warehouse. |
cityName | (string) The city name for the Warehouse. |
postalZone | (string) The postal zone for the Warehouse. |
closedExercise | (DateTime) The closed exercise date for the Warehouse. |
externalId | (string) The external identification for the Warehouse. |
externalVersion | (string) The external version for the Warehouse. |
region | (string) The region for the Warehouse.
(fk) Allowed value: the natural key of a record of type Region. These records are accessibly through the Regions service. |
country | (string) The country for the Warehouse.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
entityDimensionDetails | (List of WarehouseDimensionResource) The list of dimensions of the warehouse.
See WarehouseDimensionResource. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
value | (object) The custom attribute value. |