Sales | Sales Channel
Service to manage entities of type 'SalesChannel'.
Overview
URL | api/{tenantKey}/{orgKey}/salesCore/salesChannels |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive SalesChannel
- PUT Set SalesChannelKey SalesChannel
- PUT Set Description SalesChannel
- PUT Set CurrentPriceList SalesChannel
- PUT Set ComparativePriceList SalesChannel
- PUT Set PriceList SalesChannelAlternativePrice
- PUT Set TaxIncluded SalesChannelAlternativePrice
- PUT Set Priority SalesChannelAlternativePrice
- DELETE:
All Resources
This service uses the following resources:
GET SalesChannels (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 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:
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. |
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 Alternative Price
Inserts a new 'Sales Channel Alternative Price' in the 'Sales Channel'.
The following elements are required:
salesChannelKey | (string) The key for the sales channel. |
value | (ApiSalesChannelAlternativePriceListsResource) The ApiSalesChannelAlternativePriceListsResource instance. See ApiSalesChannelAlternativePriceListsResource. |
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 ComparativePriceList SalesChannel
Updates the value of attribute 'ComparativePriceList' 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 CurrentPriceList SalesChannel
Updates the value of attribute 'CurrentPriceList' 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 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 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 PriceList SalesChannelAlternativePrice
Updates the value of attribute 'PriceList' 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 Priority SalesChannelAlternativePrice
Updates the value of attribute 'Priority' in the specified entity record.
The following elements are required:
salesChannelKey | (string) The key for the sales channel. |
lineId | (string) The detail identifier. |
value | (int) 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 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 TaxIncluded SalesChannelAlternativePrice
Updates the value of attribute 'TaxIncluded' in the specified entity record.
The following elements are required:
salesChannelKey | (string) The key for the sales channel. |
lineId | (string) The detail identifier. |
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:
DELETE Sales Channel Alternative Price 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
ApiSalesChannelAlternativePriceListsResource
The following elements are required:
priceList | (string) Price List. |
The following elements are optional:
taxIncluded | (bool) Tax Included. |
priority | (int) Priority. |
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. |
currentPriceList | (string) Current Price List. |
comparativePriceList | (string) Comparative Price List. |
alternativePriceLists | (List of ApiSalesChannelAlternativePriceListsResource) Alternative Price Lists.
See ApiSalesChannelAlternativePriceListsResource. |
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. |
currentPriceList | (string) Current Price List.
(fk) Allowed value: the natural key of a record of type PriceList. These records are accessibly through the PriceLists service. |
comparativePriceList | (string) Comparative Price List.
(fk) Allowed value: the natural key of a record of type PriceList. These records are accessibly through the PriceLists service. |
alternativePriceLists | (List of SalesChannelAlternativePriceResource) Alternative Price Lists.
See SalesChannelAlternativePriceResource. |