Sales | Sales Channel
The Sales Channel represents the sale source where the company sells items or services.
Overview
| URL | api/{tenantKey}/{orgKey}/salesCore/salesChannels |
| 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 SalesChannels
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See SalesChannelResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET SalesChannels (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 SalesChannelResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET SalesChannel 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 SalesChannelResource. |
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 SalesChannel by key
Returns the entity record that matches the specified key.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
Response:
| When successful, the response body contains the entity record. See SalesChannelResource. |
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 Print SalesChannel 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:
GET Print SalesChannel by key
Prints the specified entity record.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
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:
GET Original Print SalesChannelOriginal 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:
GET Original Print SalesChannel by key
Prints the specified entity record.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
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:
POST SalesChannels
Creates a new entity record.
The following elements are required:
| salesChannelResource | (ApiSalesChannelResource) The request body should contain the entity record that should be created. See ApiSalesChannelResource. |
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 ApiSalesChannelResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Sales Channel
Inserts a new 'Sales Channel Dimension' in the 'Sales Channel'.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
| value | (ApiSalesChannelEntityDimensionDetailsResource) The ApiSalesChannelEntityDimensionDetailsResource instance. See ApiSalesChannelEntityDimensionDetailsResource. |
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:
PUT Set Description SalesChannel
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
| 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 DimensionValue SalesChannelDimension
Updates the value of attribute 'DimensionValue' in the specified entity record.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
| 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 Set IsActive SalesChannel
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
| 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 SalesChannelKey SalesChannel
Updates the value of attribute 'SalesChannelKey' in the specified entity record.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
| 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 Custom Attribute SalesChannel
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
| 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:
DELETE Sales Channel Dimension by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
| 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 SalesChannel 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 SalesChannel by key
Deletes the entity record that matches the specified key.
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
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
ApiSalesChannelEntityDimensionDetailsResource
The following elements are required:
| dimension | (string) The dimension. |
| dimensionValue | (string) The dimension value. |
ApiSalesChannelResource
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
The following elements are optional:
| description | (string) The description for the sales channel. |
| entityDimensionDetails | (List of ApiSalesChannelEntityDimensionDetailsResource) The list of sales channel dimensions.
See ApiSalesChannelEntityDimensionDetailsResource. |
SalesChannelDimensionResource
The following elements are required:
| dimension | (string) The dimension. |
| dimensionValue | (string) The dimension value. |
SalesChannelResource
The following elements are required:
| salesChannelKey | (string) The key for the sales channel. |
The following elements are optional:
| description | (string) The description for the sales channel. |
| entityDimensionDetails | (List of SalesChannelDimensionResource) The list of sales channel dimensions.
See SalesChannelDimensionResource. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |