Master Data Business Entities | Item

Service to manage entities of type 'Item'. The item is also designated as product or good, an item is the element that uniquely identifies the product or service involved in a transaction.

Overview

api/{tenantKey}/{orgKey}/businessCore/items

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

All Operations

This service includes the following operations:

GET:
POST:
- POST Items
PUT:
DELETE:
- DELETE Item by identifier
- DELETE Item by key

All Resources

This service uses the following resources:

ApiItemResource
ItemResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

ItemType

GET Operations

GET Items (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 ItemResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/items/odata

GET /businessCore/items/odata

GET Item 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 ItemResource.

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/items/{id}

GET /businessCore/items/{id}

GET Item by key

Returns the entity record that matches the specified key.

The following elements are required:

itemKey

(string) The key for the item. Uniquely identifies the item within the organization.

Response:

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

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/items/{itemKey}

GET /businessCore/items/{itemKey}

GET Item Image.

Returns the value of attribute 'Image' of the specified entity record.

The following elements are required:

id	(string) The record identifier.
fileName	(string) The file name.

Response:

When successful, the response is a stream with the image 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/items/{id}/image

GET /businessCore/items/{id}/image

POST Operations

POST Items

Creates a new entity record.

The following elements are required:

itemResource

(ApiItemResource) The request body should contain the entity record that should be created.
See ApiItemResource.

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 ApiItemResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/items

POST /businessCore/items

PUT Operations

PUT Set Assortment Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/assortment

PUT /businessCore/items/{itemKey}/assortment

PUT Set AvailableInPurchases Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/availableInPurchases

PUT /businessCore/items/{itemKey}/availableInPurchases

PUT Set AvailableInSales Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/availableInSales

PUT /businessCore/items/{itemKey}/availableInSales

PUT Set Barcode Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/barcode

PUT /businessCore/items/{itemKey}/barcode

PUT Set BaseUnit Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/baseUnit

PUT /businessCore/items/{itemKey}/baseUnit

PUT Set Brand Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/brand

PUT /businessCore/items/{itemKey}/brand

PUT Set BrandModel Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/brandModel

PUT /businessCore/items/{itemKey}/brandModel

PUT Set ComplementaryDescription Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/complementaryDescription

PUT /businessCore/items/{itemKey}/complementaryDescription

PUT Set Description Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/description

PUT /businessCore/items/{itemKey}/description

PUT Set Image Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/image

PUT /businessCore/items/{itemKey}/image

PUT Set IsActive Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/isActive

PUT /businessCore/items/{itemKey}/isActive

PUT Set ItemKey Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/itemKey

PUT /businessCore/items/{itemKey}/itemKey

PUT Set ItemType Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
value	(enum ItemType) The request body should contain the new value for the attribute. See ItemType.

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/items/{itemKey}/itemType

PUT /businessCore/items/{itemKey}/itemType

PUT Set ManageInventory Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/manageInventory

PUT /businessCore/items/{itemKey}/manageInventory

PUT Set Remarks Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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/items/{itemKey}/remarks

PUT /businessCore/items/{itemKey}/remarks

PUT Set Custom Attribute Item

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

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
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}/businessCore/items/{itemKey}/{customAttributeName}

PUT /businessCore/items/{itemKey}/{customAttributeName}

DELETE Operations

DELETE Item 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/items/{id}

DELETE /businessCore/items/{id}

DELETE Item by key

Deletes the entity record that matches the specified key.

The following elements are required:

itemKey

(string) The key for the item. Uniquely identifies the item within the organization.

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/items/{itemKey}

DELETE /businessCore/items/{itemKey}

Resources

ApiItemResource

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
description	(string) The description for the item.
isExternallyManaged	(bool) A flag indicating if the item is externally managed.
baseUnit	(string) The base unit for the item.
itemType	(enum ItemType) The item type for the item. See ItemType.
manageInventory	(bool) Manage Inventory.
availableInSales	(bool) Available for Sales.
availableInPurchases	(bool) Available for Purchases.

The following elements are optional:

complementaryDescription	(string) The extended description for the item.
assortment	(string) The assortment for the item.
barcode	(string) The barcode for the item.
brand	(string) The brand for the item.
image	(string) The picture for the item.
remarks	(string) The remarks for the item.
externalId	(string) The external identifier for the item.
externalVersion	(string) The external version for the item.
brandModel	(string) The brand model for the item.

ItemResource

The following elements are required:

itemKey	(string) The key for the item. Uniquely identifies the item within the organization.
description	(string) The description for the item.
isExternallyManaged	(bool) A flag indicating if the item is externally managed.
baseUnit	(string) The base unit for the item. (fk) Allowed value: the natural key of a record of type Unit. These records are accessibly through the Units service.
itemType	(enum ItemType) The item type for the item. See ItemType.
manageInventory	(bool) Manage Inventory.
availableInSales	(bool) Available for Sales.
availableInPurchases	(bool) Available for Purchases.

The following elements are optional:

complementaryDescription	(string) The extended description for the item.
assortment	(string) The assortment for the item. (fk) Allowed value: the natural key of a record of type Assortment. These records are accessibly through the Assortments service.
barcode	(string) The barcode for the item.
brand	(string) The brand for the item. (fk) Allowed value: the natural key of a record of type Brand. These records are accessibly through the Brands service.
image	(string) The picture for the item.
remarks	(string) The remarks for the item.
externalId	(string) The external identifier for the item.
externalVersion	(string) The external version for the item.
brandModel	(string) The brand model for the item. (fk) Allowed value: the natural key of a record of type BrandModel. These records are accessibly through the BrandModels service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

ItemType

1	Item
2	Service
3	SpecialSalesTaxes
4	Tax
5	Other