Master Data Business Entities | Brand

A Brand represents one seller's set of products or services as distinct from those of other sellers.

Overview

api/{tenantKey}/{orgKey}/businessCore/brands

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

All Operations

This service includes the following operations:

GET:
POST:
- POST Brands
- POST Brand
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiBrandEntityDimensionDetailsResource
ApiBrandResource
BrandDimensionResource
BrandResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET Brands

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/brands

GET /businessCore/brands

GET Brands (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 BrandResource.

Response status codes:

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

Resource URL:

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

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

GET Brand 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 BrandResource.

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

GET /businessCore/brands/{id}

GET Brand by key

Returns the entity record that matches the specified key.

The following elements are required:

brandKey

(string) The key for the item brand.

Response:

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

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/brands/{brandKey}

GET /businessCore/brands/{brandKey}

GET Print Brand 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/brands/{id}/print?template={template}

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

GET Print Brand by key

Prints the specified entity record.

The following elements are required:

brandKey

(string) The key for the item brand.

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/brands/{brandKey}/print

GET /businessCore/brands/{brandKey}/print

GET Original Print BrandOriginal 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/brands/{id}/printOriginal?template={template}

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

GET Original Print Brand by key

Prints the specified entity record.

The following elements are required:

brandKey

(string) The key for the item brand.

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/brands/{brandKey}/printOriginal

GET /businessCore/brands/{brandKey}/printOriginal

GET Brand Picture.

Returns the value of attribute 'Picture' 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/brands/{id}/picture

GET /businessCore/brands/{id}/picture

POST Operations

POST Brands

Creates a new entity record.

The following elements are required:

brandResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/brands

POST /businessCore/brands

POST Brand

Inserts a new 'Brand Dimension' in the 'Brand'.

The following elements are required:

brandKey	(string) The key for the item brand.
value	(ApiBrandEntityDimensionDetailsResource) The ApiBrandEntityDimensionDetailsResource instance. See ApiBrandEntityDimensionDetailsResource.

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:

api/{tenantKey}/{orgKey}/businessCore/brands/{brandKey}/entityDimensionDetails

POST /businessCore/brands/{brandKey}/entityDimensionDetails

PUT Operations

PUT Set BrandKey Brand

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

The following elements are required:

brandKey	(string) The key for the item brand.
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/brands/{brandKey}/brandKey

PUT /businessCore/brands/{brandKey}/brandKey

PUT Set Description Brand

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

The following elements are required:

brandKey	(string) The key for the item brand.
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/brands/{brandKey}/description

PUT /businessCore/brands/{brandKey}/description

PUT Set DimensionValue BrandDimension

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

The following elements are required:

brandKey	(string) The key for the item brand.
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:

api/{tenantKey}/{orgKey}/businessCore/brands/{brandKey}/entityDimensionDetails/{lineId}/dimensionValue

PUT /businessCore/brands/{brandKey}/entityDimensionDetails/{lineId}/dimensionValue

PUT Set ExternalId Brand

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

The following elements are required:

brandKey	(string) The key for the item brand.
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/brands/{brandKey}/externalId

PUT /businessCore/brands/{brandKey}/externalId

PUT Set ExternalVersion Brand

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

The following elements are required:

brandKey	(string) The key for the item brand.
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/brands/{brandKey}/externalVersion

PUT /businessCore/brands/{brandKey}/externalVersion

PUT Set IsActive Brand

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

The following elements are required:

brandKey	(string) The key for the item brand.
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/brands/{brandKey}/isActive

PUT /businessCore/brands/{brandKey}/isActive

PUT Set IsExternallyManaged Brand

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

The following elements are required:

brandKey	(string) The key for the item brand.
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/brands/{brandKey}/isExternallyManaged

PUT /businessCore/brands/{brandKey}/isExternallyManaged

PUT Set Picture Brand

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

The following elements are required:

brandKey	(string) The key for the item brand.
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/brands/{brandKey}/picture

PUT /businessCore/brands/{brandKey}/picture

PUT Set Remarks Brand

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

The following elements are required:

brandKey	(string) The key for the item brand.
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/brands/{brandKey}/remarks

PUT /businessCore/brands/{brandKey}/remarks

PUT Set Custom Attribute Brand

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

The following elements are required:

brandKey	(string) The key for the item brand.
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/brands/{brandKey}/{customAttributeName}

PUT /businessCore/brands/{brandKey}/{customAttributeName}

DELETE Operations

DELETE Brand Dimension by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

brandKey	(string) The key for the item brand.
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:

api/{tenantKey}/{orgKey}/businessCore/brands/{brandKey}/entityDimensionDetails/{lineId}

DELETE /businessCore/brands/{brandKey}/entityDimensionDetails/{lineId}

DELETE Brand 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/brands/{id}

DELETE /businessCore/brands/{id}

DELETE Brand by key

Deletes the entity record that matches the specified key.

The following elements are required:

brandKey

(string) The key for the item brand.

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/brands/{brandKey}

DELETE /businessCore/brands/{brandKey}

Resources

ApiBrandEntityDimensionDetailsResource

The following elements are required:

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

ApiBrandResource

The following elements are required:

brandKey	(string) The key for the item brand.
isExternallyManaged	(bool) A flag indicating if the item brand is externally managed.

The following elements are optional:

description	(string) The description for the item brand.
externalId	(string) The external identifier for the item brand.
externalVersion	(string) The external version for the item brand.
picture	(string) The picture for the item brand.
remarks	(string) The remarks for the item brand.
entityDimensionDetails	(List of ApiBrandEntityDimensionDetailsResource) The set of dimensions that caracterize a brand. See ApiBrandEntityDimensionDetailsResource.

BrandDimensionResource

The following elements are required:

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

BrandResource

The following elements are required:

brandKey	(string) The key for the item brand.
isExternallyManaged	(bool) A flag indicating if the item brand is externally managed.

The following elements are optional:

description	(string) The description for the item brand.
externalId	(string) The external identifier for the item brand.
externalVersion	(string) The external version for the item brand.
picture	(string) The picture for the item brand.
remarks	(string) The remarks for the item brand.
entityDimensionDetails	(List of BrandDimensionResource) The set of dimensions that caracterize a brand. See BrandDimensionResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.