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

api/{tenantKey}/{orgKey}/businessCore/assortments

URL	api/{tenantKey}/{orgKey}/businessCore/assortments
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Assortments
PUT:
DELETE:
- DELETE Assortment by identifier
- DELETE Assortment by key

All Resources

This service uses the following resources:

ApiAssortmentResource
AssortmentResource

GET Operations

GET Assortments

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/businessCore/assortments

GET /businessCore/assortments

GET Assortments (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 AssortmentResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/assortments?page={page}&pageSize={pageSize}

GET /businessCore/assortments?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{id}

GET /businessCore/assortments/{id}

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{assortmentKey}

GET /businessCore/assortments/{assortmentKey}

GET Print Assortment 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}/businessCore/assortments/{id}/print?template={template}

GET /businessCore/assortments/{id}/print?template={template}

GET Print Assortment by key

Prints the specified entity record.

The following elements are required:

assortmentKey

(string) The key for the item assortment.

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}/businessCore/assortments/{assortmentKey}/print

GET /businessCore/assortments/{assortmentKey}/print

GET Original Print AssortmentOriginal 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}/businessCore/assortments/{id}/printOriginal?template={template}

GET /businessCore/assortments/{id}/printOriginal?template={template}

GET Original Print Assortment by key

Prints the specified entity record.

The following elements are required:

assortmentKey

(string) The key for the item assortment.

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}/businessCore/assortments/{assortmentKey}/printOriginal

GET /businessCore/assortments/{assortmentKey}/printOriginal

POST Operations

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:

api/{tenantKey}/{orgKey}/businessCore/assortments

POST /businessCore/assortments

PUT Operations

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{assortmentKey}/assortmentKey

PUT /businessCore/assortments/{assortmentKey}/assortmentKey

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{assortmentKey}/description

PUT /businessCore/assortments/{assortmentKey}/description

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{assortmentKey}/externalId

PUT /businessCore/assortments/{assortmentKey}/externalId

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{assortmentKey}/externalVersion

PUT /businessCore/assortments/{assortmentKey}/externalVersion

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{assortmentKey}/isActive

PUT /businessCore/assortments/{assortmentKey}/isActive

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{assortmentKey}/isExternallyManaged

PUT /businessCore/assortments/{assortmentKey}/isExternallyManaged

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{assortmentKey}/remarks

PUT /businessCore/assortments/{assortmentKey}/remarks

DELETE Operations

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{id}

DELETE /businessCore/assortments/{id}

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:

api/{tenantKey}/{orgKey}/businessCore/assortments/{assortmentKey}

DELETE /businessCore/assortments/{assortmentKey}

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.