Master Data Business Entities | Assortment
Service to manage entities of type 'Assortment'. Classification of the item in big families. For example, in a hospitality industry company, we can have the items grouped in kitchen items, office items, decoration items, electrical devices etc.
Overview
URL | api/{tenantKey}/{orgKey}/businessCore/assortments |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET Assortments (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 AssortmentResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Assortment 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 AssortmentResource. |
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 Assortment by key
Returns the entity record that matches the specified key.
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
Response:
When successful, the response body contains the entity record. See AssortmentResource. |
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 Assortments
Creates a new entity record.
The following elements are required:
assortmentResource | (ApiAssortmentResource) The request body should contain the entity record that should be created. See ApiAssortmentResource. |
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 ApiAssortmentResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AssortmentKey Assortment
Updates the value of attribute 'AssortmentKey' in the specified entity record.
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
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 Assortment
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
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 Assortment
Updates the value of attribute 'ExternalId' in the specified entity record.
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
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 Assortment
Updates the value of attribute 'ExternalVersion' in the specified entity record.
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
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 Assortment
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
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 Assortment
Updates the value of attribute 'IsExternallyManaged' in the specified entity record.
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
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 Remarks Assortment
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
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:
DELETE Assortment 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 Assortment by key
Deletes the entity record that matches the specified key.
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
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
ApiAssortmentResource
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
isExternallyManaged | (bool) A flag indicating if the item assortment is externally managed. |
The following elements are optional:
description | (string) The description for the item assortment. |
externalId | (string) The item assortment's external identifier. |
externalVersion | (string) The item assortment's external version. |
remarks | (string) The remarks for the item assortment. |
AssortmentResource
The following elements are required:
assortmentKey | (string) The key for the item assortment. |
isExternallyManaged | (bool) A flag indicating if the item assortment is externally managed. |
The following elements are optional:
description | (string) The description for the item assortment. |
externalId | (string) The item assortment's external identifier. |
externalVersion | (string) The item assortment's external version. |
remarks | (string) The remarks for the item assortment. |