Sales | Sales Channel

Service to manage entities of type 'SalesChannel'.

Overview

api/{tenantKey}/{orgKey}/salesCore/salesChannels

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

All Operations

This service includes the following operations:

GET:
POST:
- POST SalesChannels
- POST Sales Channel
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiSalesChannelAlternativePriceListsResource
ApiSalesChannelResource
SalesChannelAlternativePriceResource
SalesChannelResource

GET Operations

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels

GET /salesCore/salesChannels

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels?page={page}&pageSize={pageSize}

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

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{id}

GET /salesCore/salesChannels/{id}

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}

GET /salesCore/salesChannels/{salesChannelKey}

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{id}/print?template={template}

GET /salesCore/salesChannels/{id}/print?template={template}

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/print

GET /salesCore/salesChannels/{salesChannelKey}/print

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{id}/printOriginal?template={template}

GET /salesCore/salesChannels/{id}/printOriginal?template={template}

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/printOriginal

GET /salesCore/salesChannels/{salesChannelKey}/printOriginal

POST Operations

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels

POST /salesCore/salesChannels

POST Sales Channel

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/alternativePriceLists

POST /salesCore/salesChannels/{salesChannelKey}/alternativePriceLists

PUT Operations

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/comparativePriceList

PUT /salesCore/salesChannels/{salesChannelKey}/comparativePriceList

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/currentPriceList

PUT /salesCore/salesChannels/{salesChannelKey}/currentPriceList

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/description

PUT /salesCore/salesChannels/{salesChannelKey}/description

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/isActive

PUT /salesCore/salesChannels/{salesChannelKey}/isActive

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/alternativePriceLists/{lineId}/priceList

PUT /salesCore/salesChannels/{salesChannelKey}/alternativePriceLists/{lineId}/priceList

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/alternativePriceLists/{lineId}/priority

PUT /salesCore/salesChannels/{salesChannelKey}/alternativePriceLists/{lineId}/priority

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/salesChannelKey

PUT /salesCore/salesChannels/{salesChannelKey}/salesChannelKey

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/alternativePriceLists/{lineId}/taxIncluded

PUT /salesCore/salesChannels/{salesChannelKey}/alternativePriceLists/{lineId}/taxIncluded

DELETE Operations

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}/alternativePriceLists/{lineId}

DELETE /salesCore/salesChannels/{salesChannelKey}/alternativePriceLists/{lineId}

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{id}

DELETE /salesCore/salesChannels/{id}

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:

api/{tenantKey}/{orgKey}/salesCore/salesChannels/{salesChannelKey}

DELETE /salesCore/salesChannels/{salesChannelKey}

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.

SalesChannelAlternativePriceResource

The following elements are required:

priceList

(string) Price List.

The following elements are optional:

taxIncluded	(bool) Tax Included.
priority	(int) Priority.

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.