ROSE Developers - Web API Reference

Sales | Sales Item

The Sales Item represents a service or product that your company provides.

This service extends Items.

Overview


URL api/{tenantKey}/{orgKey}/salesCore/salesItems
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET SalesItems

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See SalesItemResource.

Response status codes:

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

Resource URL:

GET /salesCore/salesItems/extension

GET SalesItems (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 SalesItemResource.

Response status codes:

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

Resource URL:

GET /salesCore/salesItems/extension?page={page}&pageSize={pageSize}

GET SalesItem 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 SalesItemResource.

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 /salesCore/salesItems/{id}/extension

GET SalesItem 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 SalesItemResource.

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 /salesCore/salesItems/{itemKey}/extension

GET SalesItems (with Item)

Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.

Response:

When successful, the response body contains the list of records available. See BaseSalesItemResource.

Response status codes:

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

Resource URL:

GET /salesCore/salesItems

GET SalesItems (with Item) (paged)

Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.

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

Response status codes:

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

Resource URL:

GET /salesCore/salesItems?page={page}&pageSize={pageSize}

GET SalesItem (with Item) by identifier

Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.

The following elements are required:

id (string) The record identifier.

Response:

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

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

GET SalesItem (with Item) by key

Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.

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

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

POST Operations

POST SalesItems

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /salesCore/salesItems/extension

POST SalesItems (with ApiBaseSalesItem)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /salesCore/salesItems

POST Sales Item

Inserts a new 'Price List Line' in the 'Sales Item'.

The following elements are required:

itemKey (string) The key for the item. Uniquely identifies the item within the organization.
value (ApiSalesItemPriceListLinesResource) The ApiSalesItemPriceListLinesResource instance.
See ApiSalesItemPriceListLinesResource.

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:

POST /salesCore/salesItems/{itemKey}/priceListLines

POST Sales Item

Inserts a new 'Sales Item Dimension' in the 'Sales Item'.

The following elements are required:

itemKey (string) The key for the item. Uniquely identifies the item within the organization.
value (ApiSalesItemEntityDimensionDetailsResource) The ApiSalesItemEntityDimensionDetailsResource instance.
See ApiSalesItemEntityDimensionDetailsResource.

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:

POST /salesCore/salesItems/{itemKey}/entityDimensionDetails

PUT Operations

PUT Set Currency PriceListLine

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

The following elements are required:

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

PUT Set DimensionValue SalesItemDimension

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

The following elements are required:

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

PUT Set IsActive SalesItem

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:

PUT /salesCore/salesItems/{itemKey}/isActive

PUT Set ItemTaxSchema SalesItem

Updates the value of attribute 'ItemTaxSchema' 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:

PUT /salesCore/salesItems/{itemKey}/itemTaxSchema

PUT Set ItemWithholdingTaxSchema SalesItem

Updates the value of attribute 'ItemWithholdingTaxSchema' 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:

PUT /salesCore/salesItems/{itemKey}/itemWithholdingTaxSchema

PUT Set Locked SalesItem

Updates the value of attribute 'Locked' 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:

PUT /salesCore/salesItems/{itemKey}/locked

PUT Set PriceAmount PriceListLine

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

The following elements are required:

itemKey (string) The key for the item. Uniquely identifies the item within the organization.
lineId (string) The detail identifier.
value (decimal) 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 /salesCore/salesItems/{itemKey}/priceListLines/{lineId}/priceAmount

PUT Set PriceList PriceListLine

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

The following elements are required:

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

PUT Set Unit PriceListLine

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

The following elements are required:

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

PUT Set Unit SalesItem

Updates the value of attribute 'Unit' 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:

PUT /salesCore/salesItems/{itemKey}/unit

PUT Set Custom Attribute SalesItem

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:

PUT /salesCore/salesItems/{itemKey}/{customAttributeName}

PUT Set Custom Attribute PriceListLine

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.
lineId (string) The detail identifier.
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:

PUT /salesCore/salesItems/{itemKey}/priceListLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Price List Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

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

DELETE Sales Item Dimension by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

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

DELETE SalesItem 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 /salesCore/salesItems/{id}

DELETE SalesItem 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:

DELETE /salesCore/salesItems/{itemKey}

Resources


ApiBaseSalesItemEntityDimensionDetailsResource

The following elements are required:

dimension (string) The dimension.
dimensionValue (string) The dimension value.


ApiBaseSalesItemPriceListLinesResource

The following elements are required:

priceAmount (MoneyResource) The unit price.
See MoneyResource .
unit (string) The price list's line unit.
currency (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values.

The following elements are optional:

priceList (string) The pricelist that corresponds to this price list line.


ApiBaseSalesItemResource

The following elements are required:

unit (string) The unit of measure for the sales item.
itemTaxSchema (string) The sales item's tax schema. The tax schema identifies the group of taxes a item is liable for.
locked (bool) Defines the entity stat, this is whether the sales item is locked.
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.
itemAccountType (string) The item type for accounting purposes.
itemSet (string) The item set is used to associate the item to a set of items.

The following elements are optional:

itemWithholdingTaxSchema (string) The sales item's withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for.
priceListLines (List of ApiBaseSalesItemPriceListLinesResource) The corresponding price list lines.
See ApiBaseSalesItemPriceListLinesResource.
entityDimensionDetails (List of ApiBaseSalesItemEntityDimensionDetailsResource) The sales item dimensions.
See ApiBaseSalesItemEntityDimensionDetailsResource.
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.


ApiSalesItemEntityDimensionDetailsResource

The following elements are required:

dimension (string) The dimension.
dimensionValue (string) The dimension value.


ApiSalesItemPriceListLinesResource

The following elements are required:

priceAmount (MoneyResource) The unit price.
See MoneyResource .
unit (string) The price list's line unit.
currency (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values.

The following elements are optional:

priceList (string) The pricelist that corresponds to this price list line.


ApiSalesItemResource

The following elements are required:

unit (string) The unit of measure for the sales item.
itemTaxSchema (string) The sales item's tax schema. The tax schema identifies the group of taxes a item is liable for.
locked (bool) Defines the entity stat, this is whether the sales item is locked.
itemKey (string) The key for the item. Uniquely identifies the item within the organization.

The following elements are optional:

itemWithholdingTaxSchema (string) The sales item's withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for.
priceListLines (List of ApiSalesItemPriceListLinesResource) The corresponding price list lines.
See ApiSalesItemPriceListLinesResource.
entityDimensionDetails (List of ApiSalesItemEntityDimensionDetailsResource) The sales item dimensions.
See ApiSalesItemEntityDimensionDetailsResource.


BaseSalesItemEntityDimensionDetailsResource

The following elements are required:

dimension (string) The dimension.
dimensionValue (string) The dimension value.


BaseSalesItemPriceListLinesResource

The following elements are required:

priceAmount (MoneyResource) The unit price.
See MoneyResource .
unit (string) The price list's line unit.
currency (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values.

The following elements are optional:

priceList (string) The pricelist that corresponds to this price list line.


BaseSalesItemResource

The following elements are required:

unit (string) The unit of measure for the sales item.
itemTaxSchema (string) The sales item's tax schema. The tax schema identifies the group of taxes a item is liable for.
locked (bool) Defines the entity stat, this is whether the sales item is locked.
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.
itemAccountType (string) The item type for accounting purposes.
itemSet (string) The item set is used to associate the item to a set of items.

The following elements are optional:

itemWithholdingTaxSchema (string) The sales item's withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for.
priceListLines (List of BaseSalesItemPriceListLinesResource) The corresponding price list lines.
See BaseSalesItemPriceListLinesResource.
entityDimensionDetails (List of BaseSalesItemEntityDimensionDetailsResource) The sales item dimensions.
See BaseSalesItemEntityDimensionDetailsResource.
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.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



PriceListLineResource

The following elements are required:

priceAmount (MoneyResource) The unit price.
See MoneyResource .
unit (string) The price list's line unit.
currency (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values.

The following elements are optional:

priceList (string) The pricelist that corresponds to this price list line.


SalesItemDimensionResource

The following elements are required:

dimension (string) The dimension.
dimensionValue (string) The dimension value.


SalesItemResource

The following elements are required:

unit (string) The unit of measure for the sales item.
(fk) Allowed value: the natural key of a record of type Unit. These records are accessibly through the Units service.
itemTaxSchema (string) The sales item's tax schema. The tax schema identifies the group of taxes a item is liable for.
(fk) Allowed value: the natural key of a record of type ItemTaxSchema. These records are accessibly through the ItemTaxSchemas service.
locked (bool) Defines the entity stat, this is whether the sales item is locked.
itemKey (string) The key for the item. Uniquely identifies the item within the organization.

The following elements are optional:

itemWithholdingTaxSchema (string) The sales item's withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for.
(fk) Allowed value: the natural key of a record of type ItemWithholdingTaxSchema. These records are accessibly through the ItemWithholdingTaxSchemas service.
priceListLines (List of PriceListLineResource) The corresponding price list lines.
See PriceListLineResource.
entityDimensionDetails (List of SalesItemDimensionResource) The sales item dimensions.
See SalesItemDimensionResource.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


ItemType

1 Item
2 Service